Inheritance diagram for ilComponentsSetupAgent:

Collaboration diagram for ilComponentsSetupAgent:

Public Member Functions

__construct (protected PublicAssetManager $public_asset_manager, protected array $public_assets)

hasConfig ()

Does this agent require a configuration? More...

getArrayToConfigTransformation ()

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

Exceptions

LogicException if Agent has no Config

More...

getInstallObjective (?Setup\Config $config=null)

getUpdateObjective (?Setup\Config $config=null)

getBuildObjective ()

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

Exceptions

InvalidArgumentException if Config does not match the Agent.

More...

getStatusObjective (Setup\Metrics\Storage $storage)

getMigrations ()

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 26 of file class.ilComponentsSetupAgent.php.

Constructor & Destructor Documentation

◆ __construct()

ilComponentsSetupAgent::__construct	(	protected PublicAssetManager	$public_asset_manager,
		protected array	$public_assets
	)

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

33 {

34 }

Member Function Documentation

◆ getArrayToConfigTransformation()

ilComponentsSetupAgent::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 47 of file class.ilComponentsSetupAgent.php.

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

◆ getBuildObjective()

ilComponentsSetupAgent::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 78 of file class.ilComponentsSetupAgent.php.

                                        : Setup\Objective
     {
         return new Setup\ObjectiveCollection(
             "Build Objectives of \\ILIAS\\Component",
             false,
             new Setup\ObjectiveCollection(
                 "Artifacts for \\ILIAS\\Component",
                 false,
                 new ilComponentBuildComponentInfoObjective(),
                 new ilComponentBuildPluginInfoObjective()
             ),
             new PublicAssetsBuildObjective(
                 $this->public_asset_manager,
                 $this->public_assets
             )
         );
     }

◆ getInstallObjective()

ilComponentsSetupAgent::getInstallObjective ( ?Setup\Config $config = null )

Definition at line 55 of file class.ilComponentsSetupAgent.php.

                                                                      : Setup\Objective
     {
         return new ilComponentDefinitionsStoredObjective();
     }

◆ getMigrations()

ilComponentsSetupAgent::getMigrations ( )

Implements ILIAS\Setup\Agent.

Definition at line 107 of file class.ilComponentsSetupAgent.php.

                                    : array
     {
         return [];
     }

◆ getStatusObjective()

ilComponentsSetupAgent::getStatusObjective ( Setup\Metrics\Storage $storage )

Definition at line 99 of file class.ilComponentsSetupAgent.php.

                                                                       : Setup\Objective
     {
         return new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilIntroduceComponentArtifactDBUpdateSteps());
     }

◆ getUpdateObjective()

ilComponentsSetupAgent::getUpdateObjective ( ?Setup\Config $config = null )

Definition at line 63 of file class.ilComponentsSetupAgent.php.

                                                                     : Setup\Objective
     {
         return new Setup\ObjectiveCollection(
             "Updates of Services/Components",
             false,
             new ilDatabaseUpdateStepsExecutedObjective(
                 new ilIntroduceComponentArtifactDBUpdateSteps()
             ),
             new ilComponentDefinitionsStoredObjective(false)
         );
     }

◆ hasConfig()

ilComponentsSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 39 of file class.ilComponentsSetupAgent.php.

                                : bool
     {
         return false;
     }

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

components/ILIAS/Component/classes/Setup/class.ilComponentsSetupAgent.php