ilHTLMSetupAgent Class Reference

Inheritance diagram for ilHTLMSetupAgent:

Collaboration diagram for ilHTLMSetupAgent:

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. More...
	getInstallObjective (?Setup\Config $config=null)
	getUpdateObjective (?Setup\Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
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...

Detailed Description

Definition at line 25 of file class.ilHTLMSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilHTLMSetupAgent::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 34 of file class.ilHTLMSetupAgent.php.

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

getBuildArtifactObjective()

ilHTLMSetupAgent::getBuildArtifactObjective

(

)

Definition at line 55 of file class.ilHTLMSetupAgent.php.

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

getBuildObjective()

ilHTLMSetupAgent::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 72 of file class.ilHTLMSetupAgent.php.

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

getInstallObjective()

ilHTLMSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

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

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

getMigrations()

ilHTLMSetupAgent::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 65 of file class.ilHTLMSetupAgent.php.

                                   : array
    {
        return [
            new ilHTLMMigration()
        ];
    }

getStatusObjective()

ilHTLMSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

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

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

getUpdateObjective()

ilHTLMSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

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

                                                                    : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'HTML Learning Module',
            true,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilHTLMDatabaseUpdateSteps10()
            )
        );
    }

hasConfig()

ilHTLMSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/HTMLLearningModule/classes/Setup/class.ilHTLMSetupAgent.php