ilOrgUnitSetupAgent Class Reference

Inheritance diagram for ilOrgUnitSetupAgent:

Collaboration diagram for ilOrgUnitSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery)
	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...
	getNamedObjectives (?Setup\Config $config=null)
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
ILIAS Refinery Factory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

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

      {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilOrgUnitSetupAgent::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 39 of file class.ilOrgUnitSetupAgent.php.

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

getBuildObjective()

ilOrgUnitSetupAgent::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 54 of file class.ilOrgUnitSetupAgent.php.

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

getInstallObjective()

ilOrgUnitSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

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

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

getMigrations()

ilOrgUnitSetupAgent::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 64 of file class.ilOrgUnitSetupAgent.php.

                                   : array
    {
        return [];
    }

getNamedObjectives()

ilOrgUnitSetupAgent::getNamedObjectives

(

?Setup\Config

$config = null

)

Definition at line 69 of file class.ilOrgUnitSetupAgent.php.

                                                                    : array
    {
        return [
            'removeDeletedUsersFromOrgUnits' => new Setup\ObjectiveConstructor(
                'clean assignments of deleted users',
                static fn(): Setup\Objective => new ilOrgUnitRemoveDeletedUsersObjective()
            )
        ];
    }

getStatusObjective()

ilOrgUnitSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 59 of file class.ilOrgUnitSetupAgent.php.

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

getUpdateObjective()

ilOrgUnitSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 49 of file class.ilOrgUnitSetupAgent.php.

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

hasConfig()

ilOrgUnitSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 34 of file class.ilOrgUnitSetupAgent.php.

                               : bool
    {
        return false;
    }

Field Documentation

$refinery

ILIAS Refinery Factory ilOrgUnitSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• components/ILIAS/OrgUnit/classes/Setup/class.ilOrgUnitSetupAgent.php