ilResourceStorageSetupAgent Class Reference

Class ilResourceStorageSetupAgent. More...

Inheritance diagram for ilResourceStorageSetupAgent:

Collaboration diagram for ilResourceStorageSetupAgent:

Public Member Functions
	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 (Storage $storage)
	getMigrations ()
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

Class ilResourceStorageSetupAgent.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s.ch

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

Member Function Documentation

getArrayToConfigTransformation()

ilResourceStorageSetupAgent::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 42 of file class.ilResourceStorageSetupAgent.php.

                                                    : Transformation
    {
        throw new \LogicException("Agent has no config.");
    }

getBuildObjective()

ilResourceStorageSetupAgent::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 74 of file class.ilResourceStorageSetupAgent.php.

                                       : Objective
    {
        return new ilResourceStorageFlavourArtifact();
    }

getInstallObjective()

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

                                                               : Objective
    {
        return new ObjectiveCollection(
            'IRSS Installation',
            false,
            new ilStorageContainersExistingObjective(),
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilResourceStorageDB80()
            )
        );
    }

getMigrations()

ilResourceStorageSetupAgent::getMigrations

(

)

Returns

\ilStorageHandlerV1Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 92 of file class.ilResourceStorageSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilResourceStorageSetupAgent::getStatusObjective

(

Storage

$storage

)

Definition at line 79 of file class.ilResourceStorageSetupAgent.php.

                                                        : Objective
    {
        return new ObjectiveCollection(
            'Component ResourceStorage',
            true,
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilResourceStorageDB80()),
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilResourceStorageDB90())
        );
    }

getUpdateObjective()

ilResourceStorageSetupAgent::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 59 of file class.ilResourceStorageSetupAgent.php.

                                                              : Objective
    {
        return new ObjectiveCollection(
            'IRSS Update',
            false,
            new ilStorageContainersExistingObjective(),
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilResourceStorageDB80()
            ),
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilResourceStorageDB90()
            )
        );
    }

hasConfig()

ilResourceStorageSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 37 of file class.ilResourceStorageSetupAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/ResourceStorage/classes/Setup/class.ilResourceStorageSetupAgent.php