ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilBibliographicSetupAgent Class Reference

Class ilBibliographicSetupAgent. More...

+ Inheritance diagram for ilBibliographicSetupAgent:
+ Collaboration diagram for ilBibliographicSetupAgent:

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.
Exceptions
LogicExceptionif Agent has no Config
More...
 
 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
InvalidArgumentExceptionif Config does not match the Agent..
More...
 
 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
InvalidArgumentExceptionif Config does not match the Agent..
More...
 
 getBuildObjective ()
 Get the goal the agent wants to achieve to build artifacts.
Exceptions
InvalidArgumentExceptionif Config does not match the Agent.
More...
 
 getStatusObjective (Storage $storage)
 
 getMigrations ()
 @inheritDoc 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...
 

Data Fields

const COMPONENT_DIR = 'bibl'
 

Detailed Description

Member Function Documentation

◆ getArrayToConfigTransformation()

ilBibliographicSetupAgent::getArrayToConfigTransformation ( )

Agents must be able to tell how to create a configuration from a nested array.

Exceptions
LogicExceptionif Agent has no Config

Implements ILIAS\Setup\Agent.

Definition at line 52 of file class.ilBibliographicSetupAgent.php.

53 {
54 throw new LogicException("ilBibliographicSetupAgent has no config.");
55 }
A transformation is a function from one datatype to another.

◆ getBuildObjective()

ilBibliographicSetupAgent::getBuildObjective ( )

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

Exceptions
InvalidArgumentExceptionif Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 83 of file class.ilBibliographicSetupAgent.php.

83 : Objective
84 {
85 return new NullObjective();
86 }
A non-objective, nothing to do to achieve it...
An objective is a desired state of the system that is supposed to be created by the setup.
Definition: Objective.php:31

◆ getInstallObjective()

ilBibliographicSetupAgent::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
InvalidArgumentExceptionif Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 60 of file class.ilBibliographicSetupAgent.php.

References ilFileSystemComponentDataDirectoryCreatedObjective\DATADIR.

◆ getMigrations()

ilBibliographicSetupAgent::getMigrations ( )

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 99 of file class.ilBibliographicSetupAgent.php.

99 : array
100 {
101 return [];
102 }

◆ getStatusObjective()

ilBibliographicSetupAgent::getStatusObjective ( Storage  $storage)

Definition at line 91 of file class.ilBibliographicSetupAgent.php.

91 : Objective
92 {
94 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getUpdateObjective()

ilBibliographicSetupAgent::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
InvalidArgumentExceptionif Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 71 of file class.ilBibliographicSetupAgent.php.

71 : Objective
72 {
73 return new ObjectiveCollection('Setup Bibliografic directories and database', true, ...[
76 )
77 ]);
78 }
A objective collection is a objective that is achieved once all subobjectives are achieved.
This class attempt to achieve a set of database update steps.

◆ hasConfig()

ilBibliographicSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 44 of file class.ilBibliographicSetupAgent.php.

44 : bool
45 {
46 return false;
47 }

Field Documentation

◆ COMPONENT_DIR

const ilBibliographicSetupAgent::COMPONENT_DIR = 'bibl'

Definition at line 39 of file class.ilBibliographicSetupAgent.php.


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