ilMailSetupAgent Class Reference

Inheritance diagram for ilMailSetupAgent:

Collaboration diagram for ilMailSetupAgent:

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)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. 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 24 of file class.ilMailSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilMailSetupAgent::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 33 of file class.ilMailSetupAgent.php.

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

getBuildObjective()

ilMailSetupAgent::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 53 of file class.ilMailSetupAgent.php.

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

getInstallObjective()

ilMailSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

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

References ilFileSystemComponentDataDirectoryCreatedObjective\DATADIR.

                                                                     : Setup\Objective
    {
        return new ilFileSystemComponentDataDirectoryCreatedObjective(
            'mail',
            ilFileSystemComponentDataDirectoryCreatedObjective::DATADIR
        );
    }

getMigrations()

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

                                   : array
    {
        return [];
    }

getStatusObjective()

ilMailSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 58 of file class.ilMailSetupAgent.php.

                                                                      : Setup\Objective
    {
        return new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilMailDatabaseUpdateSteps());
    }

getUpdateObjective()

ilMailSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 46 of file class.ilMailSetupAgent.php.

                                                                    : Setup\Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(
            new ilMailDatabaseUpdateSteps()
        );
    }

hasConfig()

ilMailSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/Mail/classes/Setup/class.ilMailSetupAgent.php