Inheritance diagram for ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent:

Collaboration diagram for ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent:

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 (?Config $config=null)
	Get the goals the agent wants to achieve on setup. More...

	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...

	getStatusObjective (Metrics\Storage $storage)

	getMigrations ()
	Get a named map of migrations available for this Agent. More...

	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

	getUpdateObjective (?Setup\Config $config=null)

Public Member Functions inherited from ILIAS\Setup\Agent
	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...

	getUpdateObjective (?Config $config=null)
	Get the goal the agent wants to achieve on update. More...

	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...

	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...

	getMigrations ()
	Get a named map of migrations available for this Agent. More...

	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Protected Member Functions
	getOrgUnitObjectives ()

Detailed Description

Author: Nicolas Schaefli nick@.nosp@m.flux.nosp@m.labs..nosp@m.ch

Definition at line 35 of file class.ilEmployeeTalkSetupAgent.php.

Member Function Documentation

◆ getArrayToConfigTransformation()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::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 42 of file class.ilEmployeeTalkSetupAgent.php.

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

◆ getBuildObjective()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::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.ilEmployeeTalkSetupAgent.php.

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

◆ getInstallObjective()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::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 49 of file class.ilEmployeeTalkSetupAgent.php.

                                                               : Objective
    {
        return new \ilTreeAdminNodeAddedObjective('tala', '__TalkTemplateAdministration');
    }

◆ getMigrations()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::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.ilEmployeeTalkSetupAgent.php.

                                   : array
    {
        return [];
    }

◆ getNamedObjectives()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::getNamedObjectives ( ?Config $config = null )

Gets all named objectives The keys of the returned array are the commands.

Only the AgentCollection should return an array where the cmd of the named objective is the array key.

Parameters

Config | null $config

Returns: array<string|int, ObjectiveConstructor>

Implements ILIAS\Setup\Agent.

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

◆ getOrgUnitObjectives()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::getOrgUnitObjectives ( )

protected

Definition at line 86 of file class.ilEmployeeTalkSetupAgent.php.

                                             : array
    {
        $objectives = [];
 
        $objectives[] = new \ilOrgUnitOperationContextRegisteredObjective(
            ilOrgUnitOperationContext::CONTEXT_ETAL,
            ilOrgUnitOperationContext::CONTEXT_OBJECT
        );
 
        $objectives[] = new \ilOrgUnitOperationRegisteredObjective(
            ilOrgUnitOperation::OP_READ_EMPLOYEE_TALK,
            'Read Employee Talk',
            ilOrgUnitOperationContext::CONTEXT_ETAL
        );
 
        $objectives[] = new \ilOrgUnitOperationRegisteredObjective(
            ilOrgUnitOperation::OP_CREATE_EMPLOYEE_TALK,
            'Create Employee Talk',
            ilOrgUnitOperationContext::CONTEXT_ETAL
        );
 
        $objectives[] = new \ilOrgUnitOperationRegisteredObjective(
            ilOrgUnitOperation::OP_EDIT_EMPLOYEE_TALK,
            'Edit Employee Talk (not only own)',
            ilOrgUnitOperationContext::CONTEXT_ETAL
        );
 
        return $objectives;
    }

References $objectives, ilOrgUnitOperationContext\CONTEXT_ETAL, ilOrgUnitOperationContext\CONTEXT_OBJECT, ilOrgUnitOperation\OP_CREATE_EMPLOYEE_TALK, ilOrgUnitOperation\OP_EDIT_EMPLOYEE_TALK, and ilOrgUnitOperation\OP_READ_EMPLOYEE_TALK.

Referenced by ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent\getUpdateObjective().

Here is the caller graph for this function:

◆ getStatusObjective()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::getStatusObjective ( Metrics\Storage $storage )

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

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

◆ getUpdateObjective()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::getUpdateObjective ( ?Setup\Config $config = null )

Definition at line 75 of file class.ilEmployeeTalkSetupAgent.php.

                                                                    : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Employee Talks',
            true,
            new \ilTreeAdminNodeAddedObjective('tala', '__TalkTemplateAdministration'),
            new \ilDatabaseUpdateStepsExecutedObjective(new ilEmployeeTalkDBUpdateSteps()),
            ...$this->getOrgUnitObjectives()
        );
    }

References ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent\getOrgUnitObjectives().

Here is the call graph for this function:

◆ hasConfig()

ILIAS\EmployeeTalk\Setup\ilEmployeeTalkSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 37 of file class.ilEmployeeTalkSetupAgent.php.

                               : bool
    {
        return false;
    }

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

components/ILIAS/EmployeeTalk/classes/Setup/class.ilEmployeeTalkSetupAgent.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ getArrayToConfigTransformation()

◆ getBuildObjective()

◆ getInstallObjective()

◆ getMigrations()

◆ getNamedObjectives()

◆ getOrgUnitObjectives()

◆ getStatusObjective()

◆ getUpdateObjective()

◆ hasConfig()