Inheritance diagram for ilHttpConfigStoredObjective:

Collaboration diagram for ilHttpConfigStoredObjective:

Public Member Functions
	__construct (\ilHttpSetupConfig $config)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Protected Attributes
ilHttpSetupConfig	$config

Detailed Description

Definition at line 23 of file class.ilHttpConfigStoredObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ilHttpConfigStoredObjective::__construct ( \ilHttpSetupConfig $config )

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

      {
        $this->config = $config;
    }

References $config.

Member Function Documentation

◆ achieve()

ilHttpConfigStoredObjective::achieve ( Setup\Environment $environment )

Definition at line 59 of file class.ilHttpConfigStoredObjective.php.

                                                           : Setup\Environment
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        $ini->setVariable(
            ilHTTPS::SETTINGS_GROUP_SERVER,
            ilHTTPS::SETTING_HTTP_PATH,
            $this->config->getHttpPath()
        );
        $ini->setVariable(
            ilHTTPS::SETTINGS_GROUP_HTTPS,
            ilHTTPS::SETTING_FORCED,
            $this->config->isForced() ? "1" : "0"
        );
        $ini->setVariable(
            ilHTTPS::SETTINGS_GROUP_HTTPS,
            ilHTTPS::SETTING_AUTO_HTTPS_DETECT_ENABLED,
            $this->config->isAutodetectionEnabled() ? "1" : "0"
        );
        $ini->setVariable(
            ilHTTPS::SETTINGS_GROUP_HTTPS,
            ilHTTPS::SETTING_AUTO_HTTPS_DETECT_HEADER_NAME,
            (string) $this->config->getHeaderName()
        );
        $ini->setVariable(
            ilHTTPS::SETTINGS_GROUP_HTTPS,
            ilHTTPS::SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE,
            (string) $this->config->getHeaderValue()
        );
 
 
        if (!$ini->write()) {
            throw new Setup\UnachievableException("Could not write ilias.ini.php");
        }
 
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");
        $settings->set("proxy_status", (string) $this->config->isProxyEnabled());
        $settings->set("proxy_host", (string) $this->config->getProxyHost());
        $settings->set("proxy_port", (string) $this->config->getProxyPort());
 
        if (is_array($this->config->getAllowedHosts()) && $this->config->getAllowedHosts() !== []) {
            $settings->set('allowed_hosts', implode(',', $this->config->getAllowedHosts()));
        } else {
            $settings->delete('allowed_hosts');
        }
 
        return $environment;
    }

References $ini, ilHTTPS\SETTING_AUTO_HTTPS_DETECT_ENABLED, ilHTTPS\SETTING_AUTO_HTTPS_DETECT_HEADER_NAME, ilHTTPS\SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE, ilHTTPS\SETTING_FORCED, ilHTTPS\SETTING_HTTP_PATH, ilHTTPS\SETTINGS_GROUP_HTTPS, and ilHTTPS\SETTINGS_GROUP_SERVER.

◆ getHash()

ilHttpConfigStoredObjective::getHash ( )

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

                             : string
    {
        return hash("sha256", self::class);
    }

◆ getLabel()

ilHttpConfigStoredObjective::getLabel ( )

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

                              : string
    {
        return "Store configuration of Services/Http";
    }

◆ getPreconditions()

ilHttpConfigStoredObjective::getPreconditions ( Setup\Environment $environment )

Returns: \ilIniFilesLoadedObjective[]|\ilSettingsFactoryExistsObjective[]

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

                                                                    : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new \ilSettingsFactoryExistsObjective()
        ];
    }

◆ isApplicable()

ilHttpConfigStoredObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

Definition at line 112 of file class.ilHttpConfigStoredObjective.php.

                                                                : bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");
 
        $detect_enabled = $this->config->isAutodetectionEnabled() ? "1" : "0";
        $forced = $this->config->isForced() ? "1" : "0";
 
        return
            $ini->readVariable(ilHTTPS::SETTINGS_GROUP_SERVER, ilHTTPS::SETTING_HTTP_PATH) !== $this->config->getHttpPath() ||
            $ini->readVariable(ilHTTPS::SETTINGS_GROUP_HTTPS, ilHTTPS::SETTING_AUTO_HTTPS_DETECT_ENABLED) !== $detect_enabled ||
            $ini->readVariable(ilHTTPS::SETTINGS_GROUP_HTTPS, ilHTTPS::SETTING_FORCED) !== $forced ||
            $ini->readVariable(ilHTTPS::SETTINGS_GROUP_HTTPS, ilHTTPS::SETTING_AUTO_HTTPS_DETECT_HEADER_NAME) !== $this->config->getHeaderName() ||
            $ini->readVariable(ilHTTPS::SETTINGS_GROUP_HTTPS, ilHTTPS::SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE) !== $this->config->getHeaderValue() ||
            $settings->get("proxy_status") !== (int) $this->config->isProxyEnabled() ||
            $settings->get("proxy_host") !== $this->config->getProxyHost() ||
            $settings->get("proxy_port") !== $this->config->getProxyPort() ||
            $settings->get('allowed_hosts', '') !== implode(',', $this->config->getAllowedHosts() ?? [])
        ;
    }

References $ini, ILIAS\Repository\int(), ilHTTPS\SETTING_AUTO_HTTPS_DETECT_ENABLED, ilHTTPS\SETTING_AUTO_HTTPS_DETECT_HEADER_NAME, ilHTTPS\SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE, ilHTTPS\SETTING_FORCED, ilHTTPS\SETTING_HTTP_PATH, ilHTTPS\SETTINGS_GROUP_HTTPS, and ilHTTPS\SETTINGS_GROUP_SERVER.

Here is the call graph for this function:

◆ isNotable()

ilHttpConfigStoredObjective::isNotable ( )

Definition at line 43 of file class.ilHttpConfigStoredObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

◆ $config

ilHttpSetupConfig ilHttpConfigStoredObjective::$config

protected

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

Referenced by __construct().

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

components/ILIAS/Http_/classes/Setup/class.ilHttpConfigStoredObjective.php

Public Member Functions

Protected Attributes