Class ilUICoreSetupAgent. More...

Inheritance diagram for ilUICoreSetupAgent:

Collaboration diagram for ilUICoreSetupAgent:

Public Member Functions

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 (?Config $config=null)

Get the goals the agent wants to achieve on setup.The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException if Config does not match the Agent..

More...

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..

More...

getBuildObjective ()

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

Exceptions

InvalidArgumentException if Config does not match the Agent.

More...

getStatusObjective (Storage $storage)

getMigrations ()

@inheritDoc More...

getNamedObjectives (?Config $config=null)

@inheritDoc 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...

Detailed Description

Class ilUICoreSetupAgent.

Author: Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 35 of file class.ilUICoreSetupAgent.php.

Member Function Documentation

◆ getArrayToConfigTransformation()

ilUICoreSetupAgent::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 48 of file class.ilUICoreSetupAgent.php.

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

◆ getBuildObjective()

ilUICoreSetupAgent::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 74 of file class.ilUICoreSetupAgent.php.

                                       : Objective
    {
        return new ObjectiveCollection(
            'buildIlCtrlArtifacts',
            false,
            new ilCtrlBaseClassArtifactObjective(),
            new ilCtrlStructureArtifactObjective(),
            new ilCtrlSecurityArtifactObjective(),
        );
    }

Referenced by getNamedObjectives().

Here is the caller graph for this function:

◆ getInstallObjective()

ilUICoreSetupAgent::getInstallObjective ( ?Config $config = null )

Get the goals the agent wants to achieve on setup.The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException if Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 56 of file class.ilUICoreSetupAgent.php.

                                                               : Objective
    {
        return new NullObjective();
    }

◆ getMigrations()

ilUICoreSetupAgent::getMigrations ( )

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 96 of file class.ilUICoreSetupAgent.php.

                                   : array
    {
        return [];
    }

◆ getNamedObjectives()

ilUICoreSetupAgent::getNamedObjectives ( ?Config $config = null )

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 104 of file class.ilUICoreSetupAgent.php.

                                                              : array
    {
        return [
            'buildIlCtrlArtifacts' => new ObjectiveConstructor(
                'builds all necessary ilCtrl artifacts.',
                function () {
                    return $this->getBuildObjective();
                }
            ),
 
            'updateIlCtrlDatabase' => new ObjectiveConstructor(
                'executes all ilCtrl database update steps.',
                function () {
                    return $this->getUpdateObjective();
                }
            ),
        ];
    }

References getBuildObjective(), and getUpdateObjective().

Here is the call graph for this function:

◆ getStatusObjective()

ilUICoreSetupAgent::getStatusObjective ( Storage $storage )

Definition at line 88 of file class.ilUICoreSetupAgent.php.

                                                        : Objective
    {
        return new NullObjective();
    }

◆ getUpdateObjective()

ilUICoreSetupAgent::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 64 of file class.ilUICoreSetupAgent.php.

                                                              : Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(
            new ilCtrlDatabaseUpdateSteps()
        );
    }

Referenced by getNamedObjectives().

Here is the caller graph for this function:

◆ hasConfig()

ilUICoreSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 40 of file class.ilUICoreSetupAgent.php.

                               : bool
    {
        return false;
    }

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

components/ILIAS/UICore/classes/Setup/class.ilUICoreSetupAgent.php