ILIAS\User\Setup\Agent Class Reference

Inheritance diagram for ILIAS\User\Setup\Agent:

Collaboration diagram for ILIAS\User\Setup\Agent:

Public Member Functions
	__construct (private readonly array $user_settings_contributions, private readonly array $user_custom_profile_fields, private readonly array $user_field_attributes_change_listeners)
	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)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getUpdateObjective (?Setup\Config $config=null)
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
Public Member Functions inherited from ILIAS\StaticURL\SetupAgent
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getUpdateObjective (?Config $config=null)
	Get the goal the agent wants to achieve on update. More...
Public Member Functions inherited from ILIAS\Setup\Agent\NullAgent
	__construct (Refinery $refinery)
	hasConfig ()
	@inheritdocs More...
	getArrayToConfigTransformation ()
	@inheritdocs More...
	getInstallObjective (?Config $config=null)
	@inheritdocs More...
	getUpdateObjective (?Config $config=null)
	@inheritdocs More...
	getBuildObjective ()
	@inheritdocs More...
	getStatusObjective (Metrics\Storage $storage)
	@inheritdocs More...
	getMigrations ()
	@inheritDoc More...
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. 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...

Additional Inherited Members
Protected Attributes inherited from ILIAS\Setup\Agent\NullAgent
Refinery	$refinery

Detailed Description

Definition at line 33 of file Agent.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Setup\Agent::__construct	(	private readonly array	$user_settings_contributions,
		private readonly array	$user_custom_profile_fields,
		private readonly array	$user_field_attributes_change_listeners
	)

Definition at line 37 of file Agent.php.

      {
    }

Member Function Documentation

getArrayToConfigTransformation()

ILIAS\User\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 49 of file Agent.php.

                                                    : Transformation
    {
        throw new LogicException(self::class . ' has no Config.');
    }

getBuildObjective()

ILIAS\User\Setup\Agent::getBuildObjective

(

)

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException

if Config does not match the Agent.

Reimplemented from ILIAS\StaticURL\SetupAgent.

Definition at line 65 of file Agent.php.

                                       : Objective
    {
        return new ObjectiveCollection(
            'Updates for User',
            false,
            new CollectSettingsObjective($this->user_settings_contributions),
            new CollectTypesObjective($this->user_custom_profile_fields),
            new CollectListenersObjective($this->user_field_attributes_change_listeners)
        );
    }

getInstallObjective()

ILIAS\User\Setup\Agent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 54 of file Agent.php.

                                                                     : Setup\Objective
    {
        return new ObjectiveCollection(
            'Updates for User',
            false,
            new CollectSettingsObjective($this->user_settings_contributions),
            new CollectTypesObjective($this->user_custom_profile_fields),
            new CollectListenersObjective($this->user_field_attributes_change_listeners)
        );
    }

getMigrations()

ILIAS\User\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 99 of file Agent.php.

                                   : array
    {
        return [
            new MigrateNewAccountAttachments(),
            new UserProfileMigrations()
        ];
    }

getStatusObjective()

ILIAS\User\Setup\Agent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 91 of file Agent.php.

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

getUpdateObjective()

ILIAS\User\Setup\Agent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 76 of file Agent.php.

                                                                    : Setup\Objective
    {
        return new ObjectiveCollection(
            'Updates for User',
            false,
            new \ilDatabaseUpdateStepsExecutedObjective(
                new DBUpdateSteps11()
            ),
            new AddReadAllAccountsPermissionObjective(),
            new CollectSettingsObjective($this->user_settings_contributions),
            new CollectTypesObjective($this->user_custom_profile_fields),
            new CollectListenersObjective($this->user_field_attributes_change_listeners)
        );
    }

hasConfig()

ILIAS\User\Setup\Agent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 44 of file Agent.php.

                               : bool
    {
        return false;
    }

---

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

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