ilLearningModuleSetupAgent Class Reference

Inheritance diagram for ilLearningModuleSetupAgent:

Collaboration diagram for ilLearningModuleSetupAgent:

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

Author

Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 26 of file class.ilLearningModuleSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilLearningModuleSetupAgent::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 41 of file class.ilLearningModuleSetupAgent.php.

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

getBuildObjective()

ilLearningModuleSetupAgent::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 68 of file class.ilLearningModuleSetupAgent.php.

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

getInstallObjective()

ilLearningModuleSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

Definition at line 49 of file class.ilLearningModuleSetupAgent.php.

References ilFileSystemComponentDataDirectoryCreatedObjective\WEBDIR.

                                                                    : Setup\Objective
    {
        return new ilFileSystemComponentDataDirectoryCreatedObjective(
            'lm_data',
            ilFileSystemComponentDataDirectoryCreatedObjective::WEBDIR
        );
    }

getMigrations()

ilLearningModuleSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 84 of file class.ilLearningModuleSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilLearningModuleSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 76 of file class.ilLearningModuleSetupAgent.php.

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

getUpdateObjective()

ilLearningModuleSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 60 of file class.ilLearningModuleSetupAgent.php.

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

hasConfig()

ilLearningModuleSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 33 of file class.ilLearningModuleSetupAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/LearningModule/classes/Setup/class.ilLearningModuleSetupAgent.php