ilWorkflowEngineSetupAgent Class Reference

Inheritance diagram for ilWorkflowEngineSetupAgent:

Collaboration diagram for ilWorkflowEngineSetupAgent:

Public Member Functions
	getUpdateObjective (ILIAS\Setup\Config $config=null)
	getStatusObjective (Metrics\Storage $storage)
	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...
	getBuildArtifactObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
Public Member Functions inherited from ILIAS\Setup\Agent\NullAgent
	__construct (Refinery $refinery)
	hasConfig ()
	getArrayToConfigTransformation ()
	getInstallObjective (Config $config=null)
	getUpdateObjective (Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Metrics\Storage $storage)
	getMigrations ()
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...
Public Member Functions inherited from ILIAS\Setup\Agent
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...

Additional Inherited Members
Protected Attributes inherited from ILIAS\Setup\Agent\NullAgent
Refinery	$refinery

Detailed Description

Definition at line 29 of file class.ilWorkflowEngineSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilWorkflowEngineSetupAgent::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 48 of file class.ilWorkflowEngineSetupAgent.php.

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

getBuildArtifactObjective()

ilWorkflowEngineSetupAgent::getBuildArtifactObjective

(

)

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 58 of file class.ilWorkflowEngineSetupAgent.php.

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

getInstallObjective()

ilWorkflowEngineSetupAgent::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..

Implements ILIAS\Setup\Agent.

Definition at line 53 of file class.ilWorkflowEngineSetupAgent.php.

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

getMigrations()

ilWorkflowEngineSetupAgent::getMigrations

(

)

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns

array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 63 of file class.ilWorkflowEngineSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilWorkflowEngineSetupAgent::getStatusObjective

(

Metrics\Storage

$storage

)

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

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

getUpdateObjective()

ilWorkflowEngineSetupAgent::getUpdateObjective

(

ILIAS\Setup\Config

$config = null

)

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

                                                                         : Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(new ilWorkflowEngine9DBUpdateSteps());
    }

hasConfig()

ilWorkflowEngineSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 43 of file class.ilWorkflowEngineSetupAgent.php.

                               : bool
    {
        return false;
    }

---

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

• Services/WorkflowEngine/Setup/class.ilWorkflowEngineSetupAgent.php