ILIAS\FileDelivery\Setup\Agent Class Reference

Inheritance diagram for ILIAS\FileDelivery\Setup\Agent:

Collaboration diagram for ILIAS\FileDelivery\Setup\Agent:

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

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

Definition at line 34 of file Agent.php.

Member Function Documentation

getArrayToConfigTransformation()

ILIAS\FileDelivery\Setup\Agent::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 57 of file Agent.php.

                                                    : Transformation
    {
        throw new LogicException("No Config");
    }

getBuildObjective()

ILIAS\FileDelivery\Setup\Agent::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 36 of file Agent.php.

                                       : Objective
    {
        return new ObjectiveCollection(
            'File StreamDelivery Artifacts',
            true,
            new KeyRotationObjective(),
            new DeliveryMethodObjective(),
            // new BaseDirObjective() // removed objective since it's not possible to run it in some environments
        );
    }

getInstallObjective()

ILIAS\FileDelivery\Setup\Agent::getInstallObjective

(

?Config

$config = null

)

Definition at line 62 of file Agent.php.

                                                               : Objective
    {
        return new DeliveryMethodObjective();
    }

getMigrations()

ILIAS\FileDelivery\Setup\Agent::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 Agent.php.

                                   : array
    {
        return [];
    }

getNamedObjectives()

ILIAS\FileDelivery\Setup\Agent::getNamedObjectives

(

?Config

$config = null

)

Definition at line 47 of file Agent.php.

                                                              : array
    {
        return [];
    }

getStatusObjective()

ILIAS\FileDelivery\Setup\Agent::getStatusObjective

(

Storage

$storage

)

Definition at line 72 of file Agent.php.

                                                        : Objective
    {
        return new NullObjective();
    }

getUpdateObjective()

ILIAS\FileDelivery\Setup\Agent::getUpdateObjective

(

?Config

$config = null

)

Definition at line 67 of file Agent.php.

                                                              : Objective
    {
        return new DeliveryMethodObjective();
    }

hasConfig()

ILIAS\FileDelivery\Setup\Agent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 52 of file Agent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/FileDelivery/src/Setup/Agent.php