ilStudyProgrammeSetupAgent Class Reference

Inheritance diagram for ilStudyProgrammeSetupAgent:

Collaboration diagram for ilStudyProgrammeSetupAgent:

Public Member Functions
	getUpdateObjective (?Config $config=null)
	@inheritdocs More...
	getStatusObjective (Metrics\Storage $storage)
	@inheritdocs More...
	hasConfig ()
	@inheritdocs More...
	getArrayToConfigTransformation ()
	@inheritdocs More...
	getInstallObjective (?Config $config=null)
	@inheritdocs More...
	getBuildObjective ()
	@inheritdocs More...
	getMigrations ()
	@inheritDoc 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 30 of file class.ilStudyProgrammeSetupAgent.php.

Member Function Documentation

getArrayToConfigTransformation()

ilStudyProgrammeSetupAgent::getArrayToConfigTransformation

(

)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 71 of file class.ilStudyProgrammeSetupAgent.php.

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

getBuildObjective()

ilStudyProgrammeSetupAgent::getBuildObjective

(

)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 81 of file class.ilStudyProgrammeSetupAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilStudyProgrammeSetupAgent::getInstallObjective

(

?Config

$config = null

)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 76 of file class.ilStudyProgrammeSetupAgent.php.

                                                               : Objective
    {
        return new NullObjective();
    }

getMigrations()

ilStudyProgrammeSetupAgent::getMigrations

(

)

@inheritDoc

Reimplemented from ILIAS\Setup\Agent\NullAgent.

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

                                   : array
    {
        return [];
    }

getStatusObjective()

ilStudyProgrammeSetupAgent::getStatusObjective

(

Metrics\Storage

$storage

)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

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

                                                                : Objective
    {
        return new ObjectiveCollection(
            'Database is updated for component/ILIAS/StudyProgramme',
            true,
            // ILIAS 10
            new ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ilMigrateStudyProgrammeCertificateProviderDBUpdateSteps()
            ),
            new ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ilStudyProgrammeAutoMembershipTableUpdateSteps()
            ),
        );
    }

getUpdateObjective()

ilStudyProgrammeSetupAgent::getUpdateObjective

(

?Config

$config = null

)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

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

                                                              : Objective
    {
        return new ObjectiveCollection(
            'Database is updated for component/ILIAS/StudyProgramme',
            false,
            // ILIAS 10
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilMigrateStudyProgrammeCertificateProviderDBUpdateSteps()
            ),
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilStudyProgrammeAutoMembershipTableUpdateSteps()
            ),
        );
    }

hasConfig()

ilStudyProgrammeSetupAgent::hasConfig

(

)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 66 of file class.ilStudyProgrammeSetupAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/StudyProgramme/classes/Setup/class.ilStudyProgrammeSetupAgent.php