ilDataCollectionSetupAgent Class Reference

Inheritance diagram for ilDataCollectionSetupAgent:

Collaboration diagram for ilDataCollectionSetupAgent:

Public Member Functions
	getUpdateObjective (?Config $config=null)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. More...
	getInstallObjective (?Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Storage $storage)
	getNamedObjectives (?Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
Public Member Functions inherited from ILIAS\Setup\Agent
	getInstallObjective (?Config $config=null)
	Get the goals the agent wants to achieve on setup. More...
	getUpdateObjective (?Config $config=null)
	Get the goal the agent wants to achieve on update. More...
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Detailed Description

Definition at line 28 of file class.ilDataCollectionSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilDataCollectionSetupAgent::getArrayToConfigTransformation

(

)

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException

if Agent has no Config

Implements ILIAS\Setup\Agent.

Definition at line 54 of file class.ilDataCollectionSetupAgent.php.

                                                    : Transformation
    {
        throw new LogicException(self::class . " has no config.");
    }

getBuildArtifactObjective()

ilDataCollectionSetupAgent::getBuildArtifactObjective

(

)

Definition at line 64 of file class.ilDataCollectionSetupAgent.php.

                                               : Objective
    {
        return new NullObjective();
    }

getBuildObjective()

ilDataCollectionSetupAgent::getBuildObjective

(

)

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException

if Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 79 of file class.ilDataCollectionSetupAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilDataCollectionSetupAgent::getInstallObjective

(

?Config

$config = null

)

Definition at line 59 of file class.ilDataCollectionSetupAgent.php.

                                                               : Objective
    {
        return new NullObjective();
    }

getMigrations()

ilDataCollectionSetupAgent::getMigrations

(

)

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns

array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 41 of file class.ilDataCollectionSetupAgent.php.

                                   : array
    {
        return [
            new ilDataCollectionStorageMigration(),
            new ilDataCollectionInitLOMMigration()
        ];
    }

getNamedObjectives()

ilDataCollectionSetupAgent::getNamedObjectives

(

?Config

$config = null

)

Definition at line 74 of file class.ilDataCollectionSetupAgent.php.

                                                              : array
    {
        return [];
    }

getStatusObjective()

ilDataCollectionSetupAgent::getStatusObjective

(

Storage

$storage

)

Definition at line 69 of file class.ilDataCollectionSetupAgent.php.

                                                        : Objective
    {
        return new NullObjective();
    }

getUpdateObjective()

ilDataCollectionSetupAgent::getUpdateObjective

(

?Config

$config = null

)

Definition at line 30 of file class.ilDataCollectionSetupAgent.php.

                                                              : Objective
    {
        return new Setup\ObjectiveCollection(
            'DataCollection Update',
            true,
            new ilDataCollectionObjective(new ilDataCollectionDBUpdateSteps9()),
            new ilDataCollectionObjective(new ilDataCollectionDBUpdateSteps10()),
            new ilDataCollectionObjective(new ilDataCollectionDBUpdateSteps11()),
        );
    }

hasConfig()

ilDataCollectionSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 49 of file class.ilDataCollectionSetupAgent.php.

                               : bool
    {
        return false;
    }

---

The documentation for this class was generated from the following file:

• components/ILIAS/DataCollection/classes/Setup/class.ilDataCollectionSetupAgent.php