ilSetupAgent Class Reference

Contains common objectives for the setup. More...

Inheritance diagram for ilSetupAgent:

Collaboration diagram for ilSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery, Data\Factory $data)
	hasConfig ()
	getArrayToConfigTransformation ()
	getInstallObjective (Setup\Config $config=null)
	getUpdateObjective (Setup\Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	@inheritDoc More...
	getNamedObjective (string $name, Setup\Config $config=null)

Data Fields
const	PHP_MEMORY_LIMIT = "128M"

Protected Member Functions
	getPHPMemoryLimitCondition ()

Protected Attributes
	$refinery
	$data

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 15 of file class.ilSetupAgent.php.

Constructor & Destructor Documentation

__construct()

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

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

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

References $data, and $refinery.

Member Function Documentation

getArrayToConfigTransformation()

ilSetupAgent::getArrayToConfigTransformation

(

)

Definition at line 48 of file class.ilSetupAgent.php.

                                                     : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            $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
            );
        });
    }

References $data.

getBuildArtifactObjective()

ilSetupAgent::getBuildArtifactObjective

(

)

Definition at line 120 of file class.ilSetupAgent.php.

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

getInstallObjective()

ilSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

Definition at line 63 of file class.ilSetupAgent.php.

                                                                     : 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("7.2.0"),
                new Setup\Condition\PHPExtensionLoadedCondition("dom"),
                new Setup\Condition\PHPExtensionLoadedCondition("xsl"),
                new Setup\Condition\PHPExtensionLoadedCondition("gd"),
                $this->getPHPMemoryLimitCondition(),
                new ilSetupConfigStoredObjective($config, true),
                $config->getRegisterNIC()
                        ? new ilNICKeyRegisteredObjective($config)
                        : new Setup\ObjectiveCollection(
                            "",
                            false,
                            new ilNICKeyStoredObjective($config),
                            new ilInstIdDefaultStoredObjective($config)
                        )
            )
        );
    }

References $config, and getPHPMemoryLimitCondition().

Here is the call graph for this function:

getMigrations()

ilSetupAgent::getMigrations

(

)

@inheritDoc

Definition at line 136 of file class.ilSetupAgent.php.

                                    : array
    {
        return [];
    }

getNamedObjective()

ilSetupAgent::getNamedObjective	(	string	$name,
		Setup\Config	$config = null
	)

Definition at line 142 of file class.ilSetupAgent.php.

                                                                                 : Setup\Objective
    {
        if ($name == "registerNICKey") {
            if (is_null($config)) {
                throw new \RuntimeException(
                    "Missing Config for objective '$name'."
                );
            }
            return new ilNICKeyRegisteredObjective($config);
        }
        throw new \InvalidArgumentException(
            "There is no named objective '$name'"
        );
    }

References $config, and $name.

getPHPMemoryLimitCondition()

ilSetupAgent::getPHPMemoryLimitCondition ( )

protected

Definition at line 89 of file class.ilSetupAgent.php.

                                                    : 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."
        );
    }

Referenced by getInstallObjective().

Here is the caller graph for this function:

getStatusObjective()

ilSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 128 of file class.ilSetupAgent.php.

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

getUpdateObjective()

ilSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 109 of file class.ilSetupAgent.php.

                                                                    : Setup\Objective
    {
        if ($config !== null) {
            return new ilSetupConfigStoredObjective($config);
        }
        return new Setup\Objective\NullObjective();
    }

References $config.

hasConfig()

ilSetupAgent::hasConfig

(

)

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

                                : bool
    {
        return true;
    }

Field Documentation

$data

ilSetupAgent::$data

protected

Definition at line 27 of file class.ilSetupAgent.php.

Referenced by __construct(), and getArrayToConfigTransformation().

$refinery

ilSetupAgent::$refinery

protected

Definition at line 22 of file class.ilSetupAgent.php.

Referenced by __construct().

PHP_MEMORY_LIMIT

const ilSetupAgent::PHP_MEMORY_LIMIT = "128M"

Definition at line 17 of file class.ilSetupAgent.php.

---

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

• setup/classes/class.ilSetupAgent.php