ilHttpSetupConfig Class Reference

Inheritance diagram for ilHttpSetupConfig:

Collaboration diagram for ilHttpSetupConfig:

Public Member Functions
	__construct (string $http_path, bool $autodetection_enabled, bool $forced, ?string $header_name, ?string $header_value, bool $proxy_enabled, ?string $proxy_host, ?string $proxy_port, ?array $allowed_hosts)
	isForced ()
	getHttpPath ()
	isAutodetectionEnabled ()
	getHeaderName ()
	getHeaderValue ()
	isProxyEnabled ()
	getProxyHost ()
	getProxyPort ()
	getAllowedHosts ()

Protected Attributes
string	$http_path
bool	$forced = false
bool	$autodetection_enabled
string	$header_name
string	$header_value
bool	$proxy_enabled
string	$proxy_host
string	$proxy_port
array	$allowed_hosts = null

Detailed Description

Definition at line 21 of file class.ilHttpSetupConfig.php.

Constructor & Destructor Documentation

__construct()

ilHttpSetupConfig::__construct	(	string	$http_path,
		bool	$autodetection_enabled,
		bool	$forced,
		?string	$header_name,
		?string	$header_value,
		bool	$proxy_enabled,
		?string	$proxy_host,
		?string	$proxy_port,
		?array	$allowed_hosts
	)

Parameters

list<string>|null

$allowed_hosts

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

      {
        if ($autodetection_enabled && (!$header_name || !$header_value)) {
            throw new \InvalidArgumentException(
                "Expected header name and value for https autodetection if that feature is enabled."
            );
        }
        if ($proxy_enabled && (!$proxy_host || !$proxy_port)) {
            throw new \InvalidArgumentException(
                "Expected setting for proxy host and port if proxy is enabled."
            );
        }
        $this->http_path = $http_path;
        $this->autodetection_enabled = $autodetection_enabled;
        $this->forced = $forced;
        $this->header_name = $header_name;
        $this->header_value = $header_value;
        $this->proxy_enabled = $proxy_enabled;
        $this->proxy_host = $proxy_host;
        $this->proxy_port = $proxy_port;
 
        if (is_array($allowed_hosts)) {
            $this->allowed_hosts = array_values(array_filter(array_map(strval(...), $allowed_hosts)));
        }
    }

References $allowed_hosts, $autodetection_enabled, $forced, $header_name, $header_value, $http_path, $proxy_enabled, $proxy_host, and $proxy_port.

Member Function Documentation

getAllowedHosts()

ilHttpSetupConfig::getAllowedHosts

(

)

Returns

list<string>|null

Definition at line 116 of file class.ilHttpSetupConfig.php.

                                     : ?array
    {
        return $this->allowed_hosts;
    }

References $allowed_hosts.

getHeaderName()

ilHttpSetupConfig::getHeaderName

(

)

Definition at line 88 of file class.ilHttpSetupConfig.php.

                                   : ?string
    {
        return $this->header_name;
    }

References $header_name.

getHeaderValue()

ilHttpSetupConfig::getHeaderValue

(

)

Definition at line 93 of file class.ilHttpSetupConfig.php.

                                    : ?string
    {
        return $this->header_value;
    }

References $header_value.

getHttpPath()

ilHttpSetupConfig::getHttpPath

(

)

Definition at line 78 of file class.ilHttpSetupConfig.php.

                                 : string
    {
        return $this->http_path;
    }

References $http_path.

Referenced by ilNICKeyRegisteredObjective\getURLStringForNIC().

Here is the caller graph for this function:

getProxyHost()

ilHttpSetupConfig::getProxyHost

(

)

Definition at line 103 of file class.ilHttpSetupConfig.php.

                                  : ?string
    {
        return $this->proxy_host;
    }

References $proxy_host.

getProxyPort()

ilHttpSetupConfig::getProxyPort

(

)

Definition at line 108 of file class.ilHttpSetupConfig.php.

                                  : ?string
    {
        return $this->proxy_port;
    }

References $proxy_port.

isAutodetectionEnabled()

ilHttpSetupConfig::isAutodetectionEnabled

(

)

Definition at line 83 of file class.ilHttpSetupConfig.php.

                                            : bool
    {
        return $this->autodetection_enabled;
    }

References $autodetection_enabled.

isForced()

ilHttpSetupConfig::isForced

(

)

Definition at line 73 of file class.ilHttpSetupConfig.php.

                              : bool
    {
        return $this->forced;
    }

References $forced.

isProxyEnabled()

ilHttpSetupConfig::isProxyEnabled

(

)

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

                                    : bool
    {
        return $this->proxy_enabled;
    }

References $proxy_enabled.

Field Documentation

$allowed_hosts

array ilHttpSetupConfig::$allowed_hosts = null

protected

Definition at line 32 of file class.ilHttpSetupConfig.php.

Referenced by __construct(), and getAllowedHosts().

$autodetection_enabled

bool ilHttpSetupConfig::$autodetection_enabled

protected

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

Referenced by __construct(), and isAutodetectionEnabled().

$forced

bool ilHttpSetupConfig::$forced = false

protected

Definition at line 24 of file class.ilHttpSetupConfig.php.

Referenced by __construct(), and isForced().

$header_name

string ilHttpSetupConfig::$header_name

protected

Definition at line 26 of file class.ilHttpSetupConfig.php.

Referenced by __construct(), and getHeaderName().

$header_value

string ilHttpSetupConfig::$header_value

protected

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

Referenced by __construct(), and getHeaderValue().

$http_path

string ilHttpSetupConfig::$http_path

protected

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

Referenced by __construct(), and getHttpPath().

$proxy_enabled

bool ilHttpSetupConfig::$proxy_enabled

protected

Definition at line 28 of file class.ilHttpSetupConfig.php.

Referenced by __construct(), and isProxyEnabled().

$proxy_host

string ilHttpSetupConfig::$proxy_host

protected

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

Referenced by __construct(), and getProxyHost().

$proxy_port

string ilHttpSetupConfig::$proxy_port

protected

Definition at line 30 of file class.ilHttpSetupConfig.php.

Referenced by __construct(), and getProxyPort().

---

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

• components/ILIAS/Http_/classes/Setup/class.ilHttpSetupConfig.php