Inheritance diagram for ilLearningSequenceSetupAgent:

Collaboration diagram for ilLearningSequenceSetupAgent:

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 (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 24 of file class.ilLearningSequenceSetupAgent.php.

Member Function Documentation

◆ getArrayToConfigTransformation()

ilLearningSequenceSetupAgent::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 39 of file class.ilLearningSequenceSetupAgent.php.

                                                     : Refinery\Transformation
     {
         throw new \LogicException("Agent has no config.");
     }

◆ getBuildObjective()

ilLearningSequenceSetupAgent::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 75 of file class.ilLearningSequenceSetupAgent.php.

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

◆ getInstallObjective()

ilLearningSequenceSetupAgent::getInstallObjective ( Setup\Config $config = null )

Definition at line 47 of file class.ilLearningSequenceSetupAgent.php.

References ilLearningSequenceFilesystem\PATH_PRE, and ilFileSystemComponentDataDirectoryCreatedObjective\WEBDIR.

                                                                     : Setup\Objective
     {
         return new ilFileSystemComponentDataDirectoryCreatedObjective(
             ilLearningSequenceFilesystem::PATH_PRE,
             ilFileSystemComponentDataDirectoryCreatedObjective::WEBDIR
         );
     }

◆ getMigrations()

ilLearningSequenceSetupAgent::getMigrations ( )

Implements ILIAS\Setup\Agent.

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

                                    : array
     {
         return [];
     }

◆ getStatusObjective()

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

Definition at line 83 of file class.ilLearningSequenceSetupAgent.php.

                                                                       : Setup\Objective
     {
         return new Setup\ObjectiveCollection(
             'Component LearningSequence',
             true,
             new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilLearningSequenceRectifyPostConditionsTableDBUpdateSteps()),
             new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilLearningSequenceRegisterNotificationType())
         );
     }

◆ getUpdateObjective()

ilLearningSequenceSetupAgent::getUpdateObjective ( Setup\Config $config = null )

Definition at line 58 of file class.ilLearningSequenceSetupAgent.php.

                                                                    : Setup\Objective
     {
         return new Setup\ObjectiveCollection(
             'Database is updated for Module/LearningSequence',
             false,
             new ilDatabaseUpdateStepsExecutedObjective(
                 new ilLearningSequenceRectifyPostConditionsTableDBUpdateSteps()
             ),
             new ilDatabaseUpdateStepsExecutedObjective(
                 new ilLearningSequenceRegisterNotificationType()
             )
         );
     }

◆ hasConfig()

ilLearningSequenceSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 31 of file class.ilLearningSequenceSetupAgent.php.

                                : bool
     {
         return false;
     }

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

components/ILIAS/LearningSequence/classes/Setup/class.ilLearningSequenceSetupAgent.php