ilSystemFolderSetupAgent Class Reference

Inheritance diagram for ilSystemFolderSetupAgent:

Collaboration diagram for ilSystemFolderSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery)
	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...

Protected Attributes
	$refinery

Detailed Description

Definition at line 24 of file class.ilSystemFolderSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilSystemFolderSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

References $refinery, and ILIAS\Repository\refinery().

      {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilSystemFolderSetupAgent::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 50 of file class.ilSystemFolderSetupAgent.php.

References $data, null, and ILIAS\Repository\refinery().

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilSystemFolderSetupConfig(
                $data["client"]["name"] ?? null,
                $data["client"]["description"] ?? null,
                $data["client"]["institution"] ?? null,
                $data["contact"]["firstname"],
                $data["contact"]["lastname"],
                $data["contact"]["title"] ?? null,
                $data["contact"]["position"] ?? null,
                $data["contact"]["institution"] ?? null,
                $data["contact"]["street"] ?? null,
                $data["contact"]["zipcode"] ?? null,
                $data["contact"]["city"] ?? null,
                $data["contact"]["country"] ?? null,
                $data["contact"]["phone"] ?? null,
                $data["contact"]["email"],
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilSystemFolderSetupAgent::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 94 of file class.ilSystemFolderSetupAgent.php.

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

getInstallObjective()

ilSystemFolderSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 75 of file class.ilSystemFolderSetupAgent.php.

                                                                     : Setup\Objective
    {
        return new ilInstallationInformationStoredObjective($config);
    }

getMigrations()

ilSystemFolderSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 110 of file class.ilSystemFolderSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilSystemFolderSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 102 of file class.ilSystemFolderSetupAgent.php.

                                                                      : Setup\Objective
    {
        return new ilSystemFolderMetricsCollectedObjective($storage);
    }

getUpdateObjective()

ilSystemFolderSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

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

References null.

                                                                    : Setup\Objective
    {
        if ($config !== null) {
            return new ilInstallationInformationStoredObjective($config);
        }
        return new Setup\Objective\NullObjective();
    }

hasConfig()

ilSystemFolderSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 42 of file class.ilSystemFolderSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

ilSystemFolderSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• components/ILIAS/SystemFolder/classes/Setup/class.ilSystemFolderSetupAgent.php