An agent that just doesn't do a thing. More...

Inheritance diagram for ILIAS\Setup\Agent\NullAgent:

Collaboration diagram for ILIAS\Setup\Agent\NullAgent:

Public Member Functions
	__construct (Refinery $refinery)

	hasConfig ()
	@inheritdocs More...

	getArrayToConfigTransformation ()
	@inheritdocs More...

	getInstallObjective (?Config $config=null)
	@inheritdocs More...

	getUpdateObjective (?Config $config=null)
	@inheritdocs More...

	getBuildObjective ()
	@inheritdocs More...

	getStatusObjective (Metrics\Storage $storage)
	@inheritdocs More...

	getMigrations ()
	@inheritDoc More...

	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
	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 Attributes
Refinery	$refinery

Detailed Description

An agent that just doesn't do a thing.

Definition at line 34 of file NullAgent.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\Agent\NullAgent::__construct ( Refinery $refinery )

Definition at line 38 of file NullAgent.php.

      {
        $this->refinery = $refinery;
    }

References ILIAS\Setup\Agent\NullAgent\$refinery, and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ getArrayToConfigTransformation()

ILIAS\Setup\Agent\NullAgent::getArrayToConfigTransformation ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Reimplemented in ilCourseObjectiveSetupAgent, ilCourseSetupAgent, ilStudyProgrammeSetupAgent, ILIAS\Test\Setup\TestSetupAgent, and ILIAS\User\Setup\Agent.

Definition at line 55 of file NullAgent.php.

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

◆ getBuildObjective()

ILIAS\Setup\Agent\NullAgent::getBuildObjective ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Reimplemented in ilCourseObjectiveSetupAgent, ilCourseSetupAgent, ilExportSetupAgent, ILIAS\ILIASObject\Setup\Agent, ILIAS\StaticURL\SetupAgent, ilStudyProgrammeSetupAgent, ILIAS\Test\Setup\TestSetupAgent, and ILIAS\User\Setup\Agent.

Definition at line 81 of file NullAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

◆ getInstallObjective()

ILIAS\Setup\Agent\NullAgent::getInstallObjective ( ?Config $config = null )

@inheritdocs

Implements ILIAS\Setup\Agent.

Reimplemented in ilCourseObjectiveSetupAgent, ilCourseSetupAgent, ilFileServicesSetupAgent, ilStudyProgrammeSetupAgent, and ILIAS\Test\Setup\TestSetupAgent.

Definition at line 65 of file NullAgent.php.

                                                               : Objective
    {
        return new NullObjective();
    }

◆ getMigrations()

ILIAS\Setup\Agent\NullAgent::getMigrations ( )

@inheritDoc

Implements ILIAS\Setup\Agent.

Reimplemented in ILIAS\AdvancedMetaData\Setup\Agent, ILIAS\Blog\Setup\Agent, ILIAS\BookingManager\Setup\Agent, ilExportSetupAgent, ILIAS\Export\HTML\Setup\Agent, ILIAS\ILIASObject\Setup\Agent, ILIAS\MediaCast\Setup\Agent, ILIAS\MediaPool\Setup\Agent, ilStudyProgrammeSetupAgent, ILIAS\Test\Setup\TestSetupAgent, ilTestQuestionPoolSetupAgent, ILIAS\User\Setup\Agent, and ILIAS\Wiki\Setup\Agent.

Definition at line 97 of file NullAgent.php.

                                   : array
    {
        return [];
    }

◆ getNamedObjectives()

ILIAS\Setup\Agent\NullAgent::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 102 of file NullAgent.php.

◆ getStatusObjective()

ILIAS\Setup\Agent\NullAgent::getStatusObjective ( Metrics\Storage $storage )

@inheritdocs

Reimplemented in ilAccessControlSetupAgent, ILIAS\Administration\Setup\ilAdministrationSetupAgent, ILIAS\Blog\Setup\Agent, ILIAS\COPage\Setup\Agent, ILIAS\COPage\IntLink\Setup\Agent, ilCourseObjectiveSetupAgent, ilCourseSetupAgent, ilDidacticTemplateSetupAgent, ILIAS\Help\Setup\Agent, ILIAS\ILIASObject\Setup\Agent, ILIAS\LearningModule\Setup\DBUpdateAgent, ILIAS\MediaCast\Setup\Agent, ILIAS\MediaObjects\Setup\DBUpdateAgent, ILIAS\Notes\Setup\Agent, ILIAS\Repository\Setup\Agent, ilStudyProgrammeSetupAgent, ILIAS\SurveyQuestionPool\Setup\Agent, ilTestQuestionPoolSetupAgent, and ILIAS\Wiki\Setup\Agent.

Definition at line 89 of file NullAgent.php.

                                                                : Objective
    {
        return new NullObjective();
    }

◆ getUpdateObjective()

ILIAS\Setup\Agent\NullAgent::getUpdateObjective ( ?Config $config = null )

@inheritdocs

Implements ILIAS\Setup\Agent.

Reimplemented in ilAccessRBACSetupAgent, ILIAS\Administration\Setup\ilAdministrationSetupAgent, ILIAS\Cloud\Agent, ilCourseObjectiveSetupAgent, ILIAS\Dashboard\Setup\ilDashboardUpdateAgent, ilDidacticTemplateSetupAgent, ilExportSetupAgent, ILIAS\Export\HTML\Setup\Agent, ilFileServicesSetupAgent, ILIAS\ILIASObject\Setup\Agent, ilPollSetupAgent, ilStudyProgrammeSetupAgent, ILIAS\Test\Setup\TestSetupAgent, ILIAS\Tracking\Setup\Agent, ilAccessControlSetupAgent, and ilTestQuestionPoolSetupAgent.

Definition at line 73 of file NullAgent.php.

                                                              : Objective
    {
        return new NullObjective();
    }

◆ hasConfig()

ILIAS\Setup\Agent\NullAgent::hasConfig ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Reimplemented in ilStudyProgrammeSetupAgent, ILIAS\Test\Setup\TestSetupAgent, and ILIAS\User\Setup\Agent.

Definition at line 47 of file NullAgent.php.

                               : bool
    {
        return false;
    }

Field Documentation

◆ $refinery

Refinery ILIAS\Setup\Agent\NullAgent::$refinery

protected

Definition at line 36 of file NullAgent.php.

Referenced by ILIAS\Setup\Agent\NullAgent\__construct().

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

components/ILIAS/Setup/src/Agent/NullAgent.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getArrayToConfigTransformation()

◆ getBuildObjective()

◆ getInstallObjective()

◆ getMigrations()

◆ getNamedObjectives()

◆ getStatusObjective()

◆ getUpdateObjective()

◆ hasConfig()

Field Documentation

◆ $refinery