ilMediaObjectSetupAgent Class Reference

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de More...

Inheritance diagram for ilMediaObjectSetupAgent:

Collaboration diagram for ilMediaObjectSetupAgent:

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...
	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...
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
Refinery Factory	$refinery

Detailed Description

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 25 of file class.ilMediaObjectSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilMediaObjectSetupAgent::__construct

(

Refinery\Factory

$refinery

)

Definition at line 31 of file class.ilMediaObjectSetupAgent.php.

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

      {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilMediaObjectSetupAgent::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.ilMediaObjectSetupAgent.php.

References $data, ILIAS\Setup\Agent\getInstallObjective(), ILIAS\Setup\Agent\getUpdateObjective(), null, ILIAS\Repository\refinery(), and ilFileSystemComponentDataDirectoryCreatedObjective\WEBDIR.

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilMediaObjectSetupConfig(
                $data["path_to_ffmpeg"] ?? null
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilMediaObjectSetupAgent::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 76 of file class.ilMediaObjectSetupAgent.php.

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

getMigrations()

ilMediaObjectSetupAgent::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 91 of file class.ilMediaObjectSetupAgent.php.

                                   : array
    {
        return [
            new ilMobMigration()
        ];
    }

getStatusObjective()

ilMediaObjectSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

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

                                                                      : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Component MediaObjects',
            true,
            new ilMediaObjectMetricsCollectedObjective($storage),
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new \ILIAS\MediaObjects\Setup\ilMediaObjectsDBUpdateSteps())
        );
    }

hasConfig()

ilMediaObjectSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Refinery Factory ilMediaObjectSetupAgent::$refinery

protected

Definition at line 29 of file class.ilMediaObjectSetupAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/MediaObjects/classes/Setup/class.ilMediaObjectSetupAgent.php