ilFileObjectAgent Class Reference

Inheritance diagram for ilFileObjectAgent:

Collaboration diagram for ilFileObjectAgent:

Public Member Functions
	__construct (protected 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. More...
	getInstallObjective (?Config $config=null)
	getUpdateObjective (?Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
	getNamedObjectives (?Config $config=null)
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...

Detailed Description

Author

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns AutoloadingIssuesInspection

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

Constructor & Destructor Documentation

__construct()

ilFileObjectAgent::__construct

(

protected Factory

$refinery

)

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

    {
    }

Member Function Documentation

getArrayToConfigTransformation()

ilFileObjectAgent::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.ilFileObjectAgent.php.

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

getBuildObjective()

ilFileObjectAgent::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 73 of file class.ilFileObjectAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilFileObjectAgent::getInstallObjective

(

?Config

$config = null

)

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

                                                               : Objective
    {
        return new ilObjFileDefaultIconsObjective(true, true);
    }

getMigrations()

ilFileObjectAgent::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 88 of file class.ilFileObjectAgent.php.

                                   : array
    {
        return [

        ];
    }

getNamedObjectives()

ilFileObjectAgent::getNamedObjectives

(

?Config

$config = null

)

Definition at line 95 of file class.ilFileObjectAgent.php.

                                                              : array
    {
        return [
            'resetDefaultIcons' => new ObjectiveConstructor(
                'resets the default suffix specific file icons.',
                fn(): Objective => new ilObjFileDefaultIconsObjective(true, false)
            ),
        ];
    }

getStatusObjective()

ilFileObjectAgent::getStatusObjective

(

Storage

$storage

)

Definition at line 78 of file class.ilFileObjectAgent.php.

                                                        : Objective
    {
        return new ObjectiveCollection(
            'Component File',
            true,
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilFileObjectDatabaseObjective()),
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilFileObjectRBACDatabaseSteps())
        );
    }

getUpdateObjective()

ilFileObjectAgent::getUpdateObjective

(

?Config

$config = null

)

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

                                                              : Objective
    {
        return new ObjectiveCollection(
            "",
            true,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilFileObjectDatabaseObjective()
            ),
            new ilObjFileDefaultIconsObjective(false, false),
            new ilFileObjectSettingsUpdatedObjective(),
            new ilFileObjectRBACDatabase(
                new ilFileObjectRBACDatabaseSteps()
            )
        );
    }

hasConfig()

ilFileObjectAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 42 of file class.ilFileObjectAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/File/classes/Setup/class.ilFileObjectAgent.php