ILIAS\LDAP\Setup\Agent Class Reference

Inheritance diagram for ILIAS\LDAP\Setup\Agent:

Collaboration diagram for ILIAS\LDAP\Setup\Agent:

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

Definition at line 30 of file Agent.php.

Member Function Documentation

getArrayToConfigTransformation()

ILIAS\LDAP\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 39 of file Agent.php.

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

getBuildArtifactObjective()

ILIAS\LDAP\Setup\Agent::getBuildArtifactObjective

(

)

Definition at line 56 of file Agent.php.

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

getBuildObjective()

ILIAS\LDAP\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 71 of file Agent.php.

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

getInstallObjective()

ILIAS\LDAP\Setup\Agent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 44 of file Agent.php.

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

getMigrations()

ILIAS\LDAP\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 66 of file Agent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ILIAS\LDAP\Setup\Agent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 61 of file Agent.php.

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

getUpdateObjective()

ILIAS\LDAP\Setup\Agent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 49 of file Agent.php.

                                                                    : Setup\Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(
            new LDAPBindPasswordFieldMigration()
        );
    }

hasConfig()

ILIAS\LDAP\Setup\Agent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 34 of file Agent.php.

                               : bool
    {
        return false;
    }

---

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

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