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...
	getBuildArtifactObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (Metrics\Storage $storage)
	getMigrations ()
Public Member Functions inherited from ILIAS\Setup\Agent
	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...

Detailed Description

Class ilResourceStorageSetupAgent.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 32 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 41 of file class.ilResourceStorageSetupAgent.php.

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

getBuildArtifactObjective()

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

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

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

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

getMigrations()

ilResourceStorageSetupAgent::getMigrations

(

)

Returns

[]

Implements ILIAS\Setup\Agent.

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

                                   : array
    {
        return [new ilStorageHandlerV1Migration()];
    }

getStatusObjective()

ilResourceStorageSetupAgent::getStatusObjective

(

Metrics\Storage

$storage

)

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

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

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

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

hasConfig()

ilResourceStorageSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return false;
    }

---

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

• Services/ResourceStorage/classes/Setup/class.ilResourceStorageSetupAgent.php