ilPluginDefaultAgent Class Reference

Inheritance diagram for ilPluginDefaultAgent:

Collaboration diagram for ilPluginDefaultAgent:

Public Member Functions
	__construct (string $plugin_name)
	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
string	$plugin_name

Detailed Description

Definition at line 24 of file class.ilPluginDefaultAgent.php.

Constructor & Destructor Documentation

__construct()

ilPluginDefaultAgent::__construct

(

string

$plugin_name

)

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

References $plugin_name.

    {
        $this->plugin_name = $plugin_name;
    }

Member Function Documentation

getArrayToConfigTransformation()

ilPluginDefaultAgent::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 46 of file class.ilPluginDefaultAgent.php.

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

getBuildObjective()

ilPluginDefaultAgent::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 82 of file class.ilPluginDefaultAgent.php.

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

getInstallObjective()

ilPluginDefaultAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 54 of file class.ilPluginDefaultAgent.php.

                                                                     : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Complete objectives from Services/Component',
            false,
            new ilComponentInstallPluginObjective($this->plugin_name),
            new ilComponentUpdatePluginObjective($this->plugin_name),
            new ilComponentActivatePluginsObjective($this->plugin_name)
        );
    }

getMigrations()

ilPluginDefaultAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 98 of file class.ilPluginDefaultAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilPluginDefaultAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 90 of file class.ilPluginDefaultAgent.php.

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

getUpdateObjective()

ilPluginDefaultAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 68 of file class.ilPluginDefaultAgent.php.

                                                                    : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Complete objectives from Services/Component',
            false,
            new ilComponentUpdatePluginObjective($this->plugin_name),
            new ilComponentActivatePluginsObjective($this->plugin_name),
            new ilPluginLanguageUpdatedObjective($this->plugin_name)
        );
    }

hasConfig()

ilPluginDefaultAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 38 of file class.ilPluginDefaultAgent.php.

                               : bool
    {
        return false;
    }

Field Documentation

$plugin_name

string ilPluginDefaultAgent::$plugin_name

protected

Definition at line 28 of file class.ilPluginDefaultAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/Component/classes/Setup/class.ilPluginDefaultAgent.php