Inheritance diagram for ILIAS\Questions\Setup\Agent:

Collaboration diagram for ILIAS\Questions\Setup\Agent:

Public Member Functions
	__construct (private readonly PersistenceFactory $persistence_factory, private readonly TableNameBuilder $question_table_names_builder, private readonly array $answer_form_migrations, private readonly array $capability_migrations)

	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...

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

	getStatusObjective (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...

	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...

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

Additional Inherited Members
Protected Attributes inherited from ILIAS\Setup\Agent\NullAgent
Refinery	$refinery

Detailed Description

Definition at line 38 of file Agent.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Questions\Setup\Agent::__construct	(	private readonly PersistenceFactory	$persistence_factory,
		private readonly TableNameBuilder	$question_table_names_builder,
		private readonly array	$answer_form_migrations,
		private readonly array	$capability_migrations
	)

Parameters

array<

ILIAS\Questions\AnswerForm\Migration\Migration> $answer_form_migrations

Parameters

array<

ILIAS\Questions\AnswerForm\Capabilities\Migration> $capability_migrations

Definition at line 46 of file Agent.php.

51 {

52 }

Member Function Documentation

◆ getArrayToConfigTransformation()

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

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

◆ getBuildObjective()

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

                                       : Objective
    {
        return new NullObjective();
    }

◆ getInstallObjective()

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

     : Objective {
        return new NullObjective();
    }

◆ getMigrations()

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

                                   : array
    {
        return [
            new QuestionsMigration(
                $this->persistence_factory,
                $this->question_table_names_builder,
                new QuestionTableDefinitions(
                    $this->persistence_factory
                ),
                new AnswerFormGenericTableDefinitions(
                    $this->persistence_factory
                ),
                $this->answer_form_migrations,
                $this->capability_migrations
            )
        ];
    }

◆ getStatusObjective()

ILIAS\Questions\Setup\Agent::getStatusObjective ( Storage $storage )

Definition at line 104 of file Agent.php.

     : Objective {
        return new ObjectiveCollection(
            'ILIAS\Questions',
            true,
            new \ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new OverarchingQuestionTables(
                    $this->question_table_names_builder
                )
            ),
            new \ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ClozeQuestionTables(
                    new SetupTableNameBuilder(
                        new TableSubNameSpace(
                            'ILIAS',
                            'cloze'
                        )
                    ),
                    new ClozeTableDefinitions(
                        $this->persistence_factory,
                        new TableSubNameSpace(
                            'ILIAS',
                            'cloze'
                        )
                    )
                )
            )
        );
    }

◆ getUpdateObjective()

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

Get the goal the agent wants to achieve on update.

The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.

The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.

If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException if Config does not match the Agent..

Reimplemented from ILIAS\StaticURL\SetupAgent.

Definition at line 65 of file Agent.php.

     : Objective {
        return new ObjectiveCollection(
            'Database is updated for ILIAS\Questions',
            false,
            new \ilDatabaseUpdateStepsExecutedObjective(
                new OverarchingQuestionTables(
                    $this->question_table_names_builder
                )
            ),
            new \ilDatabaseUpdateStepsExecutedObjective(
                new ClozeQuestionTables(
                    new SetupTableNameBuilder(
                        new TableSubNameSpace(
                            'ILIAS',
                            'cloze'
                        )
                    ),
                    new ClozeTableDefinitions(
                        $this->persistence_factory,
                        new TableSubNameSpace(
                            'ILIAS',
                            'cloze'
                        )
                    )
                )
            ),
            new \ilDatabaseUpdateStepsExecutedObjective(
                new TempTables()
            ),
            new \ilTreeAdminNodeAddedObjective(
                'qsts',
                'Questions'
            )
        );
    }

◆ hasConfig()

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

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 54 of file Agent.php.

                               : bool
    {
        return false;
    }

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getArrayToConfigTransformation()

◆ getBuildObjective()

◆ getInstallObjective()

◆ getMigrations()

◆ getStatusObjective()

◆ getUpdateObjective()

◆ hasConfig()