A agent is some component that performs part of the setup process. More...

Inheritance diagram for ILIAS\Setup\Agent:

Collaboration diagram for ILIAS\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 (?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

A agent is some component that performs part of the setup process.

Definition at line 29 of file Agent.php.

Member Function Documentation

◆ getArrayToConfigTransformation()

ILIAS\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

Implemented in ilChatroomSetupAgent, ilCommonSetupAgent, ilPrivacySecuritySetupAgent, ILIAS\FileDelivery\Setup\Agent, ilWebServicesSetupAgent, ilBibliographicSetupAgent, ilDatabaseSetupAgent, ilLanguageSetupAgent, ilLoggingSetupAgent, ilStyleSetupAgent, ilSystemFolderSetupAgent, ilGlobalCacheSetupAgent, ilGlobalScreenSetupAgent, ilBackgroundTasksSetupAgent, ilDataCollectionSetupAgent, ilUICoreSetupAgent, ilADNAgent, ilComponentsSetupAgent, ilFileObjectAgent, ilFileSystemSetupAgent, ILIAS\GlobalScreen_\UI\Footer\Setup\Agent, ilHttpSetupAgent, ilPluginDefaultAgent, ilUtilitiesSetupAgent, ilMathJaxSetupAgent, ILIAS\OnScreenChat\Setup\Agent, ILIAS\DataProtection\Setup\Agent, ILIAS\LegalDocuments\Setup\Agent, ilMediaObjectSetupAgent, ilResourceStorageSetupAgent, ilVirusScannerSetupAgent, ilLearningModuleSetupAgent, ilAuthenticationSetupAgent, ilIndividualAssessmentSetupAgent, ilLearningSequenceSetupAgent, ilOrgUnitSetupAgent, ilWOPISetupAgent, ilContentPageSetupAgent, ilEventHandlingSetupAgent, ilGlossarySetupAgent, ILIAS\components\Table\Setup\LegacyTableSetupAgent, ilCertificatSetupAgent, ilCmiXapiSetupAgent, ilHTLMSetupAgent, ilLTIConsumerSetupAgent, ilLTISetupAgent, ilForumSetupAgent, ilMailSetupAgent, and ilNotificationUpdateAgent.

◆ getBuildObjective()

ILIAS\Setup\Agent::getBuildObjective ( )

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

Exceptions

InvalidArgumentException if Config does not match the Agent.

Implemented in ilChatroomSetupAgent, ilCommonSetupAgent, ilGlobalCacheSetupAgent, ilDatabaseSetupAgent, ilWebServicesSetupAgent, ilHttpSetupAgent, ilPrivacySecuritySetupAgent, ilSystemFolderSetupAgent, ilLoggingSetupAgent, ilAuthenticationSetupAgent, ilLanguageSetupAgent, ilBibliographicSetupAgent, ilPluginDefaultAgent, ilMathJaxSetupAgent, ilStyleSetupAgent, ilUtilitiesSetupAgent, ilBackgroundTasksSetupAgent, ilComponentsSetupAgent, ilFileSystemSetupAgent, ilMediaObjectSetupAgent, ilLearningSequenceSetupAgent, ilResourceStorageSetupAgent, ilUICoreSetupAgent, ilDataCollectionSetupAgent, ilFileObjectAgent, ilGlobalScreenSetupAgent, ilHTLMSetupAgent, ilADNAgent, ilVirusScannerSetupAgent, ilEventHandlingSetupAgent, ilLearningModuleSetupAgent, ILIAS\GlobalScreen_\UI\Footer\Setup\Agent, ilIndividualAssessmentSetupAgent, ilForumSetupAgent, ilWOPISetupAgent, ILIAS\OnScreenChat\Setup\Agent, ILIAS\DataProtection\Setup\Agent, ILIAS\LegalDocuments\Setup\Agent, ilNotificationUpdateAgent, ilGlossarySetupAgent, ilCertificatSetupAgent, ILIAS\components\Table\Setup\LegacyTableSetupAgent, ilOrgUnitSetupAgent, ilMailSetupAgent, ilContentPageSetupAgent, ilCmiXapiSetupAgent, ilLTIConsumerSetupAgent, ilLTISetupAgent, ILIAS\FileDelivery\Setup\Agent, and ILIAS\StaticURL\SetupAgent.

Referenced by ILIAS\Setup\AgentCollection\getBuildObjective().

Here is the caller graph for this function:

◆ getInstallObjective()

ILIAS\Setup\Agent::getInstallObjective ( ?Config $config = null )

Get the goals the agent wants to achieve on setup.

The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException if Config does not match the Agent..

Referenced by ilMediaObjectSetupAgent\getArrayToConfigTransformation(), ilMathJaxSetupAgent\getArrayToConfigTransformation(), ilUtilitiesSetupAgent\getArrayToConfigTransformation(), and ILIAS\Setup\AgentCollection\getInstallObjective().

Here is the caller graph for this function:

◆ getMigrations()

ILIAS\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[]

Implemented in ilChatroomSetupAgent, ilCommonSetupAgent, ilGlobalCacheSetupAgent, ilDatabaseSetupAgent, ilWebServicesSetupAgent, ilHttpSetupAgent, ilLoggingSetupAgent, ilPrivacySecuritySetupAgent, ilSystemFolderSetupAgent, ilComponentsSetupAgent, ilAuthenticationSetupAgent, ilBackgroundTasksSetupAgent, ilLanguageSetupAgent, ilBibliographicSetupAgent, ilPluginDefaultAgent, ilMathJaxSetupAgent, ilStyleSetupAgent, ilUtilitiesSetupAgent, ilLearningSequenceSetupAgent, ilUICoreSetupAgent, ilFileSystemSetupAgent, ilResourceStorageSetupAgent, ilMediaObjectSetupAgent, ilGlobalScreenSetupAgent, ilEventHandlingSetupAgent, ilFileObjectAgent, ilLearningModuleSetupAgent, ilADNAgent, ilIndividualAssessmentSetupAgent, ilVirusScannerSetupAgent, ILIAS\FileDelivery\Setup\Agent, ILIAS\GlobalScreen_\UI\Footer\Setup\Agent, ilForumSetupAgent, ilCertificatSetupAgent, ilGlossarySetupAgent, ilWOPISetupAgent, ILIAS\OnScreenChat\Setup\Agent, ILIAS\components\Table\Setup\LegacyTableSetupAgent, ILIAS\DataProtection\Setup\Agent, ILIAS\LegalDocuments\Setup\Agent, ilNotificationUpdateAgent, ilHTLMSetupAgent, ilCmiXapiSetupAgent, ilLTIConsumerSetupAgent, ilLTISetupAgent, ilOrgUnitSetupAgent, ilMailSetupAgent, ilContentPageSetupAgent, and ilDataCollectionSetupAgent.

◆ getNamedObjectives()

ILIAS\Setup\Agent::getNamedObjectives ( ?Config $config = null )

Gets all named objectives The keys of the returned array are the commands.

Only the AgentCollection should return an array where the cmd of the named objective is the array key.

Parameters

Config | null $config

Returns: array<string|int, ObjectiveConstructor>

◆ getStatusObjective()

ILIAS\Setup\Agent::getStatusObjective ( Metrics\Storage $storage )

Get the objective to be achieved when status is requested.

Make sure that this runs in a reasonable time and also uses a reasonable amount of ressources, since the command fed by this objective is meant to be called by monitoring systems in short intervalls. So no expansive queries, complicated calculations or long lasting network requests.

This is supposed to inform about any kind of metrics regarding the component.

Referenced by ILIAS\Setup\AgentCollection\getStatusObjective().

Here is the caller graph for this function:

◆ getUpdateObjective()

ILIAS\Setup\Agent::getUpdateObjective ( ?Config $config = null )

Get the goal the agent wants to achieve on update.

The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.

The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.

If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException if Config does not match the Agent..

Referenced by ilMediaObjectSetupAgent\getArrayToConfigTransformation(), ilMathJaxSetupAgent\getArrayToConfigTransformation(), ilUtilitiesSetupAgent\getArrayToConfigTransformation(), and ILIAS\Setup\AgentCollection\getUpdateObjective().

Here is the caller graph for this function: