ilCourseObjectiveSetupAgent Class Reference

Inheritance diagram for ilCourseObjectiveSetupAgent:

Collaboration diagram for ilCourseObjectiveSetupAgent:

Public Member Functions
	getUpdateObjective (ILIAS\Setup\Config $config=null)
	getStatusObjective (Metrics\Storage $storage)
	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...
	getBuildArtifactObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
Public Member Functions inherited from ILIAS\Setup\Agent\NullAgent
	__construct (Refinery $refinery)
	hasConfig ()
	getArrayToConfigTransformation ()
	getInstallObjective (Config $config=null)
	getUpdateObjective (Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Metrics\Storage $storage)
	getMigrations ()
	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
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...

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

Detailed Description

Definition at line 28 of file ilCourseObjectiveSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilCourseObjectiveSetupAgent::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 42 of file ilCourseObjectiveSetupAgent.php.

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

getBuildArtifactObjective()

ilCourseObjectiveSetupAgent::getBuildArtifactObjective

(

)

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 52 of file ilCourseObjectiveSetupAgent.php.

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

getInstallObjective()

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

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

getStatusObjective()

ilCourseObjectiveSetupAgent::getStatusObjective

(

Metrics\Storage

$storage

)

Definition at line 37 of file ilCourseObjectiveSetupAgent.php.

                                                                : Objective
    {
        return new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilCourseObjectiveDBUpdateSteps());
    }

getUpdateObjective()

ilCourseObjectiveSetupAgent::getUpdateObjective

(

ILIAS\Setup\Config

$config = null

)

Definition at line 32 of file ilCourseObjectiveSetupAgent.php.

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

---

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

• Modules/Course/classes/Objectives/Setup/ilCourseObjectiveSetupAgent.php