ilCmiXapiSetupAgent Class Reference

Inheritance diagram for ilCmiXapiSetupAgent:

Collaboration diagram for ilCmiXapiSetupAgent:

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. More...
	getInstallObjective (?Setup\Config $config=null)
	getUpdateObjective (?Setup\Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. 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 25 of file class.ilCmiXapiSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilCmiXapiSetupAgent::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 34 of file class.ilCmiXapiSetupAgent.php.

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

getBuildObjective()

ilCmiXapiSetupAgent::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 51 of file class.ilCmiXapiSetupAgent.php.

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

getInstallObjective()

ilCmiXapiSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 39 of file class.ilCmiXapiSetupAgent.php.

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

getMigrations()

ilCmiXapiSetupAgent::getMigrations

(

)

Returns

mixed[]

Implements ILIAS\Setup\Agent.

Definition at line 64 of file class.ilCmiXapiSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilCmiXapiSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

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

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

getUpdateObjective()

ilCmiXapiSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 44 of file class.ilCmiXapiSetupAgent.php.

                                                                    : Setup\Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(
            new ilCmiXapiDatabaseUpdateSteps()
        );
    }

hasConfig()

ilCmiXapiSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 29 of file class.ilCmiXapiSetupAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/CmiXapi/classes/Setup/class.ilCmiXapiSetupAgent.php