ILIAS\StaticURL\SetupAgent Class Reference

Inheritance diagram for ILIAS\StaticURL\SetupAgent:

Collaboration diagram for ILIAS\StaticURL\SetupAgent:

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

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

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 33 of file SetupAgent.php.

Member Function Documentation

getBuildObjective()

ILIAS\StaticURL\SetupAgent::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.

Reimplemented in ILIAS\User\Setup\Agent.

Definition at line 36 of file SetupAgent.php.

                                       : Objective
    {
        return new ArtifactObjective();
    }

getUpdateObjective()

ILIAS\StaticURL\SetupAgent::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 42 of file SetupAgent.php.

                                                              : Objective
    {
        return new ObjectiveCollection(
            'Static URL Services',
            true,
            new \ilTreeAdminNodeAddedObjective(
                'stus',
                '__StaticURLServiceAdministration'
            ),
            new \ilDatabaseUpdateStepsExecutedObjective(
                new ShortlinksDBSteps11()
            )
        );
    }

---

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

• components/ILIAS/StaticURL/src/SetupAgent.php