ilTreeSetupAgent Class Reference

Inheritance diagram for ilTreeSetupAgent:

Collaboration diagram for ilTreeSetupAgent:

Public Member Functions
	__construct (Refinery $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. 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...
	getBuildArtifactObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (Metrics\Storage $storage)
	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...
Public Member Functions inherited from ILIAS\Setup\Agent
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...

Protected Attributes
Refinery	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilTreeSetupAgent::__construct

(

Refinery

$refinery

)

Definition at line 35 of file class.ilTreeSetupAgent.php.

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

    {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilTreeSetupAgent::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 45 of file class.ilTreeSetupAgent.php.

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

                                                    : Transformation
    {
        return $this->refinery->custom()->transformation(static function ($data): Config {
            return new NullConfig();
        });
    }

Here is the call graph for this function:

getBuildArtifactObjective()

ilTreeSetupAgent::getBuildArtifactObjective

(

)

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 62 of file class.ilTreeSetupAgent.php.

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

getInstallObjective()

ilTreeSetupAgent::getInstallObjective

(

Config

$config = null

)

Get the goals the agent wants to achieve on setup.

The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException

if Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 52 of file class.ilTreeSetupAgent.php.

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

getMigrations()

ilTreeSetupAgent::getMigrations

(

)

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns

array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 77 of file class.ilTreeSetupAgent.php.

                                   : array
    {
        return [];
    }

getNamedObjectives()

ilTreeSetupAgent::getNamedObjectives

(

?Config

$config = null

)

Gets all named objectives The keys of the returned array are the commands.

Only the AgentCollection should return an array where the cmd of the named objective is the array key.

Parameters

Config | null

$config

Returns

array<string|int, ObjectiveConstructor>

Implements ILIAS\Setup\Agent.

Definition at line 82 of file class.ilTreeSetupAgent.php.

References ilTreeImplementationSwitch\MATERIALIZED_PATH_TO_NESTED_SET, and ilTreeImplementationSwitch\NESTED_SET_TO_MATERIALIZED_PATH.

                                                              : array
    {
        return [
            'mp-to-ns' => new ObjectiveConstructor(
                'Migrate the ILIAS repository tree from Materialized Path to Nested Set',
                static function (): Objective {
                    return new ilTreeImplementationSwitch(
                        ilTreeImplementationSwitch::MATERIALIZED_PATH_TO_NESTED_SET
                    );
                }
            ),
            'ns-to-mp' => new ObjectiveConstructor(
                'Migrate the ILIAS repository tree from Nested to Materialized Path',
                static function (): Objective {
                    return new ilTreeImplementationSwitch(
                        ilTreeImplementationSwitch::NESTED_SET_TO_MATERIALIZED_PATH
                    );
                }
            )
        ];
    }

getStatusObjective()

ilTreeSetupAgent::getStatusObjective

(

Metrics\Storage

$storage

)

Definition at line 67 of file class.ilTreeSetupAgent.php.

                                                                : Objective
    {
        return new Setup\ObjectiveCollection(
            'Services/Tree',
            true,
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilTreeDBUpdateSteps8()),
            new ilTreeMetricsCollectedObjective($storage)
        );
    }

getUpdateObjective()

ilTreeSetupAgent::getUpdateObjective

(

Config

$config = null

)

Get the goal the agent wants to achieve on update.

The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.

The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.

If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException

if Config does not match the Agent..

Implements ILIAS\Setup\Agent.

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

                                                             : Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(new ilTreeDBUpdateSteps8());
    }

hasConfig()

ilTreeSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 40 of file class.ilTreeSetupAgent.php.

                               : bool
    {
        return false;
    }

Field Documentation

$refinery

Refinery ilTreeSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• Services/Tree/classes/Setup/class.ilTreeSetupAgent.php