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 LogicException if Agent has no Config More...
	getInstallObjective (?Config $config=null)
	getUpdateObjective (?Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. Exceptions InvalidArgumentException if Config does not match the Agent. More...
	getStatusObjective (Storage $storage)
	getMigrations ()
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...

Data Fields
const	COMPONENT_DIR = 'bibl'

Detailed Description

Class ilBibliographicSetupAgent.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

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

Member Function Documentation

getArrayToConfigTransformation()

ilBibliographicSetupAgent::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 52 of file class.ilBibliographicSetupAgent.php.

                                                    : Transformation
    {
        throw new LogicException("ilBibliographicSetupAgent has no config.");
    }

getBuildObjective()

ilBibliographicSetupAgent::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 83 of file class.ilBibliographicSetupAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilBibliographicSetupAgent::getInstallObjective

(

?Config

$config = null

)

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

References ilFileSystemComponentDataDirectoryCreatedObjective\DATADIR.

                                                               : Objective
    {
        return new ilFileSystemComponentDataDirectoryCreatedObjective(
            self::COMPONENT_DIR,
            ilFileSystemComponentDataDirectoryCreatedObjective::DATADIR
        );
    }

getMigrations()

ilBibliographicSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

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

                                   : array
    {
        return [];
    }

getStatusObjective()

ilBibliographicSetupAgent::getStatusObjective

(

Storage

$storage

)

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

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

getUpdateObjective()

ilBibliographicSetupAgent::getUpdateObjective

(

?Config

$config = null

)

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

                                                              : Objective
    {
        return new ObjectiveCollection('Setup Bibliografic directories and database', true, ...[
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilBibliograficDB80()
            )
        ]);
    }

hasConfig()

ilBibliographicSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return false;
    }

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:

• components/ILIAS/Bibliographic/classes/Setup/class.ilBibliographicSetupAgent.php