ILIAS\Object\Setup\ilObjectSetupAgent Class Reference

Inheritance diagram for ILIAS\Object\Setup\ilObjectSetupAgent:

Collaboration diagram for ILIAS\Object\Setup\ilObjectSetupAgent:

Public Member Functions
	getUpdateObjective (Config $config=null)
	Get the goal the agent wants to achieve on update. More...
	getStatusObjective (Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
	getBuildArtifactObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
Public Member Functions inherited from ILIAS\Setup\Agent\NullAgent
	__construct (Refinery $refinery)
	hasConfig ()
	getArrayToConfigTransformation ()
	getInstallObjective (Config $config=null)
	getUpdateObjective (Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Metrics\Storage $storage)
	getMigrations ()
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...
Public Member Functions inherited from ILIAS\Setup\Agent
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...

Additional Inherited Members
Protected Attributes inherited from ILIAS\Setup\Agent\NullAgent
Refinery	$refinery

Detailed Description

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

Member Function Documentation

getBuildArtifactObjective()

ILIAS\Object\Setup\ilObjectSetupAgent::getBuildArtifactObjective

(

)

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 67 of file class.ilObjectSetupAgent.php.

                                               : Objective
    {
        return new ilObjectTypeSpecificPropertiesArtifactObjective();
    }

getMigrations()

ILIAS\Object\Setup\ilObjectSetupAgent::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 60 of file class.ilObjectSetupAgent.php.

                                   : array
    {
        return [
            new ilObjectTileImageMigration()
        ];
    }

getStatusObjective()

ILIAS\Object\Setup\ilObjectSetupAgent::getStatusObjective

(

Metrics\Storage

$storage

)

Definition at line 44 of file class.ilObjectSetupAgent.php.

                                                                : Objective
    {
        return new ObjectiveCollection(
            'Services/Object',
            true,
            new \ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ilObjectDBUpdateSteps()
            ),
            new \ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ilObject9DBUpdateSteps()
            )
        );
    }

getUpdateObjective()

ILIAS\Object\Setup\ilObjectSetupAgent::getUpdateObjective

(

Config

$config = null

)

Get the goal the agent wants to achieve on update.

The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.

The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.

If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException

if Config does not match the Agent..

Implements ILIAS\Setup\Agent.

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

                                                             : Objective
    {
        return new ObjectiveCollection(
            'Database is updated for Services/Object',
            false,
            new \ilDatabaseUpdateStepsExecutedObjective(
                new ilObjectDBUpdateSteps()
            ),
            new \ilDatabaseUpdateStepsExecutedObjective(
                new ilObject9DBUpdateSteps()
            )
        );
    }

---

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

• Services/Object/classes/Setup/class.ilObjectSetupAgent.php