ilCommonSetupAgent Class Reference

Contains common objectives for the setup. More...

Inheritance diagram for ilCommonSetupAgent:

Collaboration diagram for ilCommonSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery, Data\Factory $data)
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. Exceptions LogicException if Agent has no Config More...
	getInstallObjective (Setup\Config $config=null)
	getUpdateObjective (Setup\Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. Exceptions InvalidArgumentException if Config does not match the Agent. More...
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	getNamedObjectives (?Config $config=null)
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 Member Functions
	getPHPMemoryLimitCondition ()

Protected Attributes
Refinery Factory	$refinery
Data Factory	$data

Private Attributes
const	PHP_MEMORY_LIMIT = "128M"
const	PHP_MIN_VERSION = "8.2.0"
const	PHP_MAX_VERSION = "8.3.999"

Detailed Description

Contains common objectives for the setup.

Do not make additions here, in general all this stuff here is supposed to go elsewhere once we find out which service it really belongs to.

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

Constructor & Destructor Documentation

__construct()

ilCommonSetupAgent::__construct	(	Refinery\Factory	$refinery,
		Data\Factory	$data
	)

Definition at line 40 of file class.ilCommonSetupAgent.php.

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

      {
        $this->refinery = $refinery;
        $this->data = $data;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilCommonSetupAgent::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 class.ilCommonSetupAgent.php.

References ILIAS\Repository\refinery().

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            $export_hooks_path = null;
            if (key_exists("export_hooks_path", $data)) {
                $export_hooks_path = $data["export_hooks_path"];
            }
            $datetimezone = $this->refinery->to()->toNew(\DateTimeZone::class);
            return new \ilSetupConfig(
                $this->data->clientId($data["client_id"] ?? ''),
                $datetimezone->transform([$data["server_timezone"] ?? "UTC"]),
                $data["register_nic"] ?? false,
                $export_hooks_path
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilCommonSetupAgent::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 144 of file class.ilCommonSetupAgent.php.

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

getInstallObjective()

ilCommonSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

Definition at line 79 of file class.ilCommonSetupAgent.php.

References getPHPMemoryLimitCondition().

                                                                    : Setup\Objective
    {
        return new Setup\Objective\ObjectiveWithPreconditions(
            new \ilMakeInstallationAccessibleObjective($config),
            new \ilOverwritesExistingInstallationConfirmed($config),
            new Setup\ObjectiveCollection(
                "Complete common ILIAS objectives.",
                false,
                new Setup\Condition\PHPVersionCondition(self::PHP_MIN_VERSION, self::PHP_MAX_VERSION, true),
                new Setup\Condition\PHPExtensionLoadedCondition("dom"),
                new Setup\Condition\PHPExtensionLoadedCondition("xsl"),
                new Setup\Condition\PHPExtensionLoadedCondition("gd"),
                $this->getPHPMemoryLimitCondition(),
                new ilSetupConfigStoredObjective($config),
                new ilNICKeyRegisteredObjective($config)
            )
        );
    }

Here is the call graph for this function:

getMigrations()

ilCommonSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 160 of file class.ilCommonSetupAgent.php.

                                   : array
    {
        return [];
    }

getNamedObjectives()

ilCommonSetupAgent::getNamedObjectives

(

?Config

$config = null

)

Definition at line 165 of file class.ilCommonSetupAgent.php.

                                                              : array
    {
        return [
            "registerNICKey" => new Setup\ObjectiveConstructor(
                "Register NIC key",
                static function () use ($config): Setup\Objective {
                    if (is_null($config)) {
                        throw new \RuntimeException(
                            "Missing Config for objective 'registerNICKey'."
                        );
                    }

                    return new ilNICKeyRegisteredObjective($config);
                }
            ),
            "buildExportZip" => new Setup\ObjectiveConstructor(
                "Build ILIAS export zip",
                static function () use ($config): Setup\Objective {
                    if (is_null($config)) {
                        throw new \RuntimeException(
                            "Missing Config for objective 'buildExportZip'."
                        );
                    }
                    return new ilExportZipBuiltObjective($config);
                }
            )
        ];
    }

getPHPMemoryLimitCondition()

ilCommonSetupAgent::getPHPMemoryLimitCondition ( )

protected

Definition at line 98 of file class.ilCommonSetupAgent.php.

Referenced by getInstallObjective().

                                                   : Setup\Objective
    {
        return new Setup\Condition\ExternalConditionObjective(
            "PHP memory limit >= " . self::PHP_MEMORY_LIMIT,
            function (Setup\Environment $env): bool {
                $limit = ini_get("memory_limit");
                if ($limit == -1) {
                    return true;
                }
                $expected = $this->data->dataSize(self::PHP_MEMORY_LIMIT);
                $current = $this->data->dataSize($limit);
                return $current->inBytes() >= $expected->inBytes();
            },
            "To properly execute ILIAS, please take care that the PHP memory limit is at least set to 128M."
        );
    }

Here is the caller graph for this function:

getStatusObjective()

ilCommonSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 152 of file class.ilCommonSetupAgent.php.

                                                                      : Setup\Objective
    {
        return new ilSetupMetricsCollectedObjective($storage);
    }

getUpdateObjective()

ilCommonSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 118 of file class.ilCommonSetupAgent.php.

References $objectives.

                                                                   : Setup\Objective
    {
        $objectives = [
            new Setup\Objective\ObjectiveWithPreconditions(
                new ilVersionWrittenToSettingsObjective($this->data),
                new Setup\Condition\PHPVersionCondition(self::PHP_MIN_VERSION, self::PHP_MAX_VERSION, true),
                new ilNoMajorVersionSkippedConditionObjective($this->data),
                new ilNoVersionDowngradeConditionObjective($this->data)
            )
        ];

        if ($config !== null) {
            $objectives[] = new ilSetupConfigStoredObjective($config);
            $objectives[] = new ilNICKeyRegisteredObjective($config);
        }

        return new Setup\ObjectiveCollection(
            "Complete common ILIAS objectives.",
            false,
            ...$objectives
        );
    }

hasConfig()

ilCommonSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 51 of file class.ilCommonSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$data

Data Factory ilCommonSetupAgent::$data

protected

Definition at line 38 of file class.ilCommonSetupAgent.php.

Referenced by __construct().

$refinery

Refinery Factory ilCommonSetupAgent::$refinery

protected

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

Referenced by __construct().

PHP_MAX_VERSION

const ilCommonSetupAgent::PHP_MAX_VERSION = "8.3.999"

private

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

PHP_MEMORY_LIMIT

const ilCommonSetupAgent::PHP_MEMORY_LIMIT = "128M"

private

Definition at line 33 of file class.ilCommonSetupAgent.php.

PHP_MIN_VERSION

const ilCommonSetupAgent::PHP_MIN_VERSION = "8.2.0"

private

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

---

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

• components/ILIAS/setup_/classes/class.ilCommonSetupAgent.php