ilLanguageSetupAgent Class Reference

Inheritance diagram for ilLanguageSetupAgent:

Collaboration diagram for ilLanguageSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery, \ilSetupLanguage $il_setup_language)
	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 (Setup\Config $config=null)
	getUpdateObjective (Setup\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 (Setup\Metrics\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...

Protected Attributes
Refinery Factory	$refinery
ilSetupLanguage	$il_setup_language

Detailed Description

Definition at line 26 of file class.ilLanguageSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilLanguageSetupAgent::__construct	(	Refinery\Factory	$refinery,
		\ilSetupLanguage	$il_setup_language
	)

Definition at line 33 of file class.ilLanguageSetupAgent.php.

References $il_setup_language, $refinery, and ILIAS\Repository\refinery().

      {
        $this->refinery = $refinery;
        $this->il_setup_language = $il_setup_language;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilLanguageSetupAgent::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.ilLanguageSetupAgent.php.

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

getBuildObjective()

ilLanguageSetupAgent::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 85 of file class.ilLanguageSetupAgent.php.

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

getInstallObjective()

ilLanguageSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

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

                                                                    : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            "Complete objectives from components/ILIAS/Language",
            false,
            new ilLanguagesInstalledAndUpdatedObjective($this->il_setup_language),
            new ilDefaultLanguageSetObjective()
        );
    }

getMigrations()

ilLanguageSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 101 of file class.ilLanguageSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilLanguageSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 93 of file class.ilLanguageSetupAgent.php.

                                                                      : Setup\Objective
    {
        return new ilLanguageMetricsCollectedObjective($storage, $this->il_setup_language);
    }

getUpdateObjective()

ilLanguageSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 73 of file class.ilLanguageSetupAgent.php.

                                                                   : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            "Complete objectives from components/ILIAS/Language",
            false,
            new ilLanguagesInstalledAndUpdatedObjective($this->il_setup_language),
        );
    }

hasConfig()

ilLanguageSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return false;
    }

Field Documentation

$il_setup_language

ilSetupLanguage ilLanguageSetupAgent::$il_setup_language

protected

Definition at line 31 of file class.ilLanguageSetupAgent.php.

Referenced by __construct().

$refinery

Refinery Factory ilLanguageSetupAgent::$refinery

protected

Definition at line 30 of file class.ilLanguageSetupAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/Language/classes/Setup/class.ilLanguageSetupAgent.php