ilFileSystemSetupAgent Class Reference

Inheritance diagram for ilFileSystemSetupAgent:

Collaboration diagram for ilFileSystemSetupAgent:

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

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilFileSystemSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

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

      {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

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

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

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(fn($data): \ilFileSystemSetupConfig => new \ilFileSystemSetupConfig(
            $data["data_dir"]
        ));
    }

Here is the call graph for this function:

getBuildObjective()

ilFileSystemSetupAgent::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 78 of file class.ilFileSystemSetupAgent.php.

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

getInstallObjective()

ilFileSystemSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

PhpParamsInspection

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

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

getMigrations()

ilFileSystemSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 94 of file class.ilFileSystemSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilFileSystemSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 86 of file class.ilFileSystemSetupAgent.php.

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

getUpdateObjective()

ilFileSystemSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

PhpParamsInspection

Definition at line 66 of file class.ilFileSystemSetupAgent.php.

                                                                   : Setup\Objective
    {
        if ($config) {
            return new ilFileSystemConfigNotChangedObjective($config);
        }
        return new Setup\Objective\NullObjective();
    }

hasConfig()

ilFileSystemSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Refinery Factory ilFileSystemSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• components/ILIAS/Filesystem/classes/Setup/class.ilFileSystemSetupAgent.php