ILIAS\LegalDocuments\Setup\Agent Class Reference

Inheritance diagram for ILIAS\LegalDocuments\Setup\Agent:

Collaboration diagram for ILIAS\LegalDocuments\Setup\Agent:

Public Member Functions
	__construct (private readonly 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)
	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

Definition at line 32 of file Agent.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\Setup\Agent::__construct

(

private readonly Refinery

$refinery

)

Definition at line 34 of file Agent.php.

    {
    }

Member Function Documentation

getArrayToConfigTransformation()

ILIAS\LegalDocuments\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 43 of file Agent.php.

References ILIAS\Repository\refinery().

                                                    : Transformation
    {
        return $this->refinery->identity();
    }

Here is the call graph for this function:

getBuildObjective()

ILIAS\LegalDocuments\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 58 of file Agent.php.

                                       : Objective
    {
        return new ConsumerObjective();
    }

getInstallObjective()

ILIAS\LegalDocuments\Setup\Agent::getInstallObjective

(

Config

$config = null

)

Definition at line 48 of file Agent.php.

                                                              : Objective
    {
        return new NullObjective();
    }

getMigrations()

ILIAS\LegalDocuments\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 68 of file Agent.php.

                                   : array
    {
        return [];
    }

getNamedObjectives()

ILIAS\LegalDocuments\Setup\Agent::getNamedObjectives

(

?Config

$config = null

)

Definition at line 73 of file Agent.php.

                                                              : array
    {
        return [];
    }

getStatusObjective()

ILIAS\LegalDocuments\Setup\Agent::getStatusObjective

(

Storage

$storage

)

Definition at line 63 of file Agent.php.

                                                        : Objective
    {
        return new \ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new UpdateSteps());
    }

getUpdateObjective()

ILIAS\LegalDocuments\Setup\Agent::getUpdateObjective

(

Config

$config = null

)

Definition at line 53 of file Agent.php.

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

hasConfig()

ILIAS\LegalDocuments\Setup\Agent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 38 of file Agent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/LegalDocuments/classes/Setup/Agent.php