ilUtilitiesSetupAgent Class Reference

Inheritance diagram for ilUtilitiesSetupAgent:

Collaboration diagram for ilUtilitiesSetupAgent:

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...
	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 Factory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilUtilitiesSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

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

    {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilUtilitiesSetupAgent::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 46 of file class.ilUtilitiesSetupAgent.php.

References $data, ILIAS\Setup\Agent\getInstallObjective(), ILIAS\Setup\Agent\getUpdateObjective(), null, and ILIAS\Repository\refinery().

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new ilUtilitiesSetupConfig(
                $data["path_to_convert"] ?? "/usr/bin/convert",
                $data["path_to_zip"] ?? "/usr/bin/zip",
                $data["path_to_unzip"] ?? "/usr/bin/unzip"
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilUtilitiesSetupAgent::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 81 of file class.ilUtilitiesSetupAgent.php.

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

getMigrations()

ilUtilitiesSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 97 of file class.ilUtilitiesSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilUtilitiesSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

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

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

hasConfig()

ilUtilitiesSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 38 of file class.ilUtilitiesSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Refinery Factory ilUtilitiesSetupAgent::$refinery

protected

Definition at line 28 of file class.ilUtilitiesSetupAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/Utilities/classes/Setup/class.ilUtilitiesSetupAgent.php