ilGlobalScreenSetupAgent Class Reference

Inheritance diagram for ilGlobalScreenSetupAgent:

Collaboration diagram for ilGlobalScreenSetupAgent:

Public Member Functions
	__construct (protected Refinery $refinery)
	hasConfig ()
	@inheritdocs More...
	getArrayToConfigTransformation ()
	@inheritdocs More...
	getInstallObjective (?Config $config=null)
	@inheritdocs More...
	getUpdateObjective (?Config $config=null)
	@inheritdocs More...
	getBuildObjective ()
	@inheritdocs More...
	getStatusObjective (Storage $storage)
	getMigrations ()
	@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

Definition at line 30 of file class.ilGlobalScreenSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilGlobalScreenSetupAgent::__construct

(

protected Refinery

$refinery

)

Definition at line 34 of file class.ilGlobalScreenSetupAgent.php.

    {
    }

Member Function Documentation

getArrayToConfigTransformation()

ilGlobalScreenSetupAgent::getArrayToConfigTransformation

(

)

@inheritdocs

Implements ILIAS\Setup\Agent.

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

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

getBuildObjective()

ilGlobalScreenSetupAgent::getBuildObjective

(

)

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 73 of file class.ilGlobalScreenSetupAgent.php.

                                       : Objective
    {
        return new ilGlobalScreenBuildProviderMapObjective();
    }

getInstallObjective()

ilGlobalScreenSetupAgent::getInstallObjective

(

?Config

$config = null

)

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 57 of file class.ilGlobalScreenSetupAgent.php.

                                                               : Objective
    {
        return new NullObjective();
    }

getMigrations()

ilGlobalScreenSetupAgent::getMigrations

(

)

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 89 of file class.ilGlobalScreenSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilGlobalScreenSetupAgent::getStatusObjective

(

Storage

$storage

)

Definition at line 81 of file class.ilGlobalScreenSetupAgent.php.

                                                        : Objective
    {
        return new NullObjective();
    }

getUpdateObjective()

ilGlobalScreenSetupAgent::getUpdateObjective

(

?Config

$config = null

)

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 65 of file class.ilGlobalScreenSetupAgent.php.

                                                              : Objective
    {
        return new NullObjective();
    }

hasConfig()

ilGlobalScreenSetupAgent::hasConfig

(

)

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 41 of file class.ilGlobalScreenSetupAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/GlobalScreen/classes/Setup/class.ilGlobalScreenSetupAgent.php