Inheritance diagram for SimpleSAML_Configuration:

Collaboration diagram for SimpleSAML_Configuration:

Public Member Functions
	__construct ($config, $location)
	Initializes a configuration from the given array. More...

	copyFromBase ($instancename, $filename)
	Load a configuration file which is located in the same directory as this configuration file. More...

	getVersion ()
	Retrieve the current version of SimpleSAMLphp. More...

	getValue ($name, $default=null)
	Retrieve a configuration option set in config.php. More...

	hasValue ($name)
	Check whether a key in the configuration exists or not. More...

	hasValueOneOf ($names)
	Check whether any key of the set given exists in the configuration. More...

	getBaseURL ()
	Retrieve the absolute path of the SimpleSAMLphp installation, relative to the root of the website. More...

	getBasePath ()
	Retrieve the absolute path pointing to the SimpleSAMLphp installation. More...

	resolvePath ($path)
	This function resolves a path which may be relative to the SimpleSAMLphp base directory. More...

	getPathValue ($name, $default=null)
	Retrieve a path configuration option set in config.php. More...

	getBaseDir ()
	Retrieve the base directory for this SimpleSAMLphp installation. More...

	getBoolean ($name, $default=self::REQUIRED_OPTION)
	This function retrieves a boolean configuration option. More...

	getString ($name, $default=self::REQUIRED_OPTION)
	This function retrieves a string configuration option. More...

	getInteger ($name, $default=self::REQUIRED_OPTION)
	This function retrieves an integer configuration option. More...

	getIntegerRange ($name, $minimum, $maximum, $default=self::REQUIRED_OPTION)
	This function retrieves an integer configuration option where the value must be in the specified range. More...

	getValueValidate ($name, $allowedValues, $default=self::REQUIRED_OPTION)
	Retrieve a configuration option with one of the given values. More...

	getArray ($name, $default=self::REQUIRED_OPTION)
	This function retrieves an array configuration option. More...

	getArrayize ($name, $default=self::REQUIRED_OPTION)
	This function retrieves an array configuration option. More...

	getArrayizeString ($name, $default=self::REQUIRED_OPTION)
	This function retrieves a configuration option with a string or an array of strings. More...

	getConfigItem ($name, $default=self::REQUIRED_OPTION)
	Retrieve an array as a SimpleSAML_Configuration object. More...

	getConfigList ($name, $default=self::REQUIRED_OPTION)
	Retrieve an array of arrays as an array of SimpleSAML_Configuration objects. More...

	getOptions ()
	Retrieve list of options. More...

	toArray ()
	Convert this configuration object back to an array. More...

	getEndpoints ($endpointType)
	Helper function for dealing with metadata endpoints. More...

	getEndpointPrioritizedByBinding ($endpointType, array $bindings, $default=self::REQUIRED_OPTION)
	Find an endpoint of the given type, using a list of supported bindings as a way to prioritize. More...

	getDefaultEndpoint ($endpointType, array $bindings=null, $default=self::REQUIRED_OPTION)
	Find the default endpoint of the given type. More...

	getLocalizedString ($name, $default=self::REQUIRED_OPTION)
	Retrieve a string which may be localized into many languages. More...

	getPublicKeys ($use=null, $required=false, $prefix='')
	Get public key from metadata. More...

Static Public Member Functions
static	setConfigDir ($path, $configSet='simplesaml')
	Set the directory for configuration files for the given configuration set. More...

static	setPreLoadedConfig (SimpleSAML_Configuration $config, $filename='config.php', $configSet='simplesaml')
	Store a pre-initialized configuration. More...

static	getConfig ($filename='config.php', $configSet='simplesaml')
	Load a configuration file from a configuration set. More...

static	getOptionalConfig ($filename='config.php', $configSet='simplesaml')
	Load a configuration file from a configuration set. More...

static	loadFromArray ($config, $location='[ARRAY]', $instance=null)
	Loads a configuration from the given array. More...

static	getInstance ($instancename='simplesaml')
	Get a configuration file by its instance name. More...

static	init ($path, $instancename='simplesaml', $configfilename='config.php')
	Initialize a instance name with the given configuration file. More...

static	clearInternalState ()
	Clear any configuration information cached. More...

Data Fields
const	REQUIRED_OPTION = '___REQUIRED_OPTION___'

Private Member Functions
	getDefaultBinding ($endpointType)
	Retrieve the default binding for the given endpoint type. More...

Static Private Member Functions
static	loadFromFile ($filename, $required)
	Load the given configuration file. More...

Private Attributes
	$configuration

	$location

	$filename = null

	$deprecated_base_url_used = false

Static Private Attributes
static	$instance = array()

static	$configDirs = array()

static	$loadedConfigs = array()

Detailed Description

Definition at line 11 of file Configuration.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML_Configuration::__construct	(	$config,
		$location
	)

Initializes a configuration from the given array.

Parameters

array	$config	The configuration array.
string	$location	The location which will be given when an error occurs.

Definition at line 88 of file Configuration.php.

References $config, and $location.

     {
         assert(is_array($config));
         assert(is_string($location));
 
         $this->configuration = $config;
         $this->location = $location;
     }

Member Function Documentation

◆ clearInternalState()

static SimpleSAML_Configuration::clearInternalState ( )

static

Clear any configuration information cached.

Allows for configuration files to be changed and reloaded during a given request. Most useful when running phpunit tests and needing to alter config.php between test cases

Implements SimpleSAML\Utils\ClearableState.

Definition at line 1386 of file Configuration.php.

     {
         self::$configDirs = array();
         self::$instance = array();
         self::$loadedConfigs = array();
     }

◆ copyFromBase()

SimpleSAML_Configuration::copyFromBase	(	$instancename,
		$filename
	)

Load a configuration file which is located in the same directory as this configuration file.

TODO: remove.

Parameters

string	$instancename
string	$filename

See also: getConfig()

Deprecated:: This function is superseeded by the getConfig() function.

Definition at line 392 of file Configuration.php.

     {
         assert(is_string($instancename));
         assert(is_string($filename));
         assert($this->filename !== null);
 
         // check if we already have loaded the given config - return the existing instance if we have
         if (array_key_exists($instancename, self::$instance)) {
             return self::$instance[$instancename];
         }
 
         $dir = dirname($this->filename);
 
         self::$instance[$instancename] = self::loadFromFile($dir.'/'.$filename, true);
         return self::$instance[$instancename];
     }

◆ getArray()

SimpleSAML_Configuration::getArray	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves an array configuration option.

An exception will be thrown if this option isn't an array, or if this option isn't found, and no default value is given.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: array|mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not an array.

Definition at line 873 of file Configuration.php.

References $default, $name, $ret, and getValue().

Referenced by SimpleSAML_Metadata_SAMLBuilder\addAttributeConsumingService(), SimpleSAML_Metadata_SAMLBuilder\addExtensions(), sspmod_saml_IdP_SAML2\encodeAttributes(), SimpleSAML\XML\Shib13\AuthnResponse\generate(), sspmod_saml_Message\getBlacklistedAlgorithms(), getPublicKeys(), SAML2\Configuration\SimpleSAMLConverter\pluckConfiguration(), and sspmod_saml_Auth_Source_SP\startSSO2().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_array($ret)) {
             throw new Exception($this->location.': The option '.var_export($name, true).' is not an array.');
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArrayize()

SimpleSAML_Configuration::getArrayize	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves an array configuration option.

If the configuration option isn't an array, it will be converted to an array.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: array The option with the given name, or $default if the option isn't found and $default is specified.

Definition at line 904 of file Configuration.php.

References $default, $name, $ret, and getValue().

Referenced by getArrayizeString().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_array($ret)) {
             $ret = array($ret);
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArrayizeString()

SimpleSAML_Configuration::getArrayizeString	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves a configuration option with a string or an array of strings.

If the configuration option is a string, it will be converted to an array with a single string

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: array The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not a string or an array of strings.

Definition at line 937 of file Configuration.php.

References $default, $name, $ret, and getArrayize().

Referenced by sspmod_saml_Message\buildAuthnRequest(), sspmod_saml_Message\checkSign(), SimpleSAML\Utils\Crypto\loadPublicKey(), and SAML2\Configuration\SimpleSAMLConverter\pluckConfiguration().

     {
         assert(is_string($name));
 
         $ret = $this->getArrayize($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         foreach ($ret as $value) {
             if (!is_string($value)) {
                 throw new Exception(
                     $this->location.': The option '.var_export($name, true).
                     ' must be a string or an array of strings.'
                 );
             }
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseDir()

SimpleSAML_Configuration::getBaseDir ( )

Retrieve the base directory for this SimpleSAMLphp installation.

This function first checks the 'basedir' configuration option. If this option is undefined or null, then we fall back to looking at the current filename.

Returns: string The absolute path to the base directory for this SimpleSAMLphp installation. This path will always end with a slash.

Definition at line 616 of file Configuration.php.

References getString().

Referenced by resolvePath().

     {
         // check if a directory is configured in the configuration file
         $dir = $this->getString('basedir', null);
         if ($dir !== null) {
             // add trailing slash if it is missing
             if (substr($dir, -1) !== DIRECTORY_SEPARATOR) {
                 $dir .= DIRECTORY_SEPARATOR;
             }
 
             return $dir;
         }
 
         // the directory wasn't set in the configuration file, path is <base directory>/lib/SimpleSAML/Configuration.php
         $dir = __FILE__;
         assert(basename($dir) === 'Configuration.php');
 
         $dir = dirname($dir);
         assert(basename($dir) === 'SimpleSAML');
 
         $dir = dirname($dir);
         assert(basename($dir) === 'lib');
 
         $dir = dirname($dir);
 
         // Add trailing directory separator
         $dir .= DIRECTORY_SEPARATOR;
 
         return $dir;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBasePath()

SimpleSAML_Configuration::getBasePath ( )

Retrieve the absolute path pointing to the SimpleSAMLphp installation.

The path is guaranteed to start and end with a slash ('/'). E.g.: /simplesaml/

Returns: string The absolute path where SimpleSAMLphp can be reached in the web server.

Exceptions

SimpleSAML

Definition at line 519 of file Configuration.php.

References $c, getString(), SimpleSAML\Utils\HTTP\guessBasePath(), and toArray().

     {
         $baseURL = $this->getString('baseurlpath', 'simplesaml/');
 
         if (preg_match('#^https?://[^/]*(?:/(.+/?)?)?$#', $baseURL, $matches)) {
             // we have a full url, we need to strip the path
             if (!array_key_exists(1, $matches)) {
                 // absolute URL without path
                 return '/';
             }
             return '/'.rtrim($matches[1], '/')."/";
         } elseif ($baseURL === '' || $baseURL === '/') {
             // root directory of site
             return '/';
         } elseif (preg_match('#^/?((?:[^/\s]+/?)+)#', $baseURL, $matches)) {
             // local path only
             return '/'.rtrim($matches[1], '/').'/';
         } else {
             /*
              * Invalid 'baseurlpath'. We cannot recover from this, so throw a critical exception and try to be graceful
              * with the configuration. Use a guessed base path instead of the one provided.
              */
             $c = $this->toArray();
             $c['baseurlpath'] = SimpleSAML\Utils\HTTP::guessBasePath();
             throw new SimpleSAML\Error\CriticalConfigurationError(
                 'Incorrect format for option \'baseurlpath\'. Value is: "'.
                 $this->getString('baseurlpath', 'simplesaml/').'". Valid format is in the form'.
                 ' [(http|https)://(hostname|fqdn)[:port]]/[path/to/simplesaml/].',
                 $this->filename,
                 $c
             );
         }
     }

Here is the call graph for this function:

◆ getBaseURL()

SimpleSAML_Configuration::getBaseURL ( )

Retrieve the absolute path of the SimpleSAMLphp installation, relative to the root of the website.

For example: simplesaml/

The path will always end with a '/' and never have a leading slash.

Returns: string The absolute path relative to the root of the website.

Exceptions

SimpleSAML

Definition at line 494 of file Configuration.php.

     {
         if (!$this->deprecated_base_url_used) {
             $this->deprecated_base_url_used = true;
             SimpleSAML\Logger::warning(
                 "SimpleSAML_Configuration::getBaseURL() is deprecated, please use getBasePath() instead."
             );
         }
         if (preg_match('/^\*(.*)$/D', $this->getString('baseurlpath', 'simplesaml/'), $matches)) {
             // deprecated behaviour, will be removed in the future
             return \SimpleSAML\Utils\HTTP::getFirstPathElement(false).$matches[1];
         }
         return ltrim($this->getBasePath(), '/');
     }

◆ getBoolean()

SimpleSAML_Configuration::getBoolean	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves a boolean configuration option.

An exception will be thrown if this option isn't a boolean, or if this option isn't found, and no default value is given.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: boolean|mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not boolean.

Definition at line 664 of file Configuration.php.

References $default, $name, $ret, and getValue().

Referenced by SimpleSAML_Metadata_SAMLBuilder\addAttributeConsumingService(), sspmod_saml_Message\addRedirectSign(), sspmod_saml_IdP_SAML2\buildAssertion(), sspmod_saml_Message\buildAuthnRequest(), sspmod_saml_IdP_SAML2\buildLogoutRequest(), sspmod_saml_IdP_SAML2\buildResponse(), sspmod_statistics_AccessCheck\checkAccess(), sspmod_saml_Message\decryptAssertion(), sspmod_saml_IdP_SAML2\encodeAttributes(), sspmod_saml_IdP_SAML2\encryptAssertion(), SAML2\Configuration\SimpleSAMLConverter\enrichForDecryptionProvider(), SAML2\Configuration\SimpleSAMLConverter\enrichForIdentityProvider(), SimpleSAML\XML\Shib13\AuthnResponse\generate(), SAML2\Configuration\SimpleSAMLConverter\pluckConfiguration(), sspmod_saml_Message\processAssertion(), SimpleSAML\Bindings\Shib13\HTTPPost\sendResponse(), sspmod_saml_Auth_Source_SP\startSSO1(), and sspmod_saml_Message\validateMessage().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_bool($ret)) {
             throw new Exception(
                 $this->location.': The option '.var_export($name, true).
                 ' is not a valid boolean value.'
             );
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConfig()

static SimpleSAML_Configuration::getConfig	(	$filename = `'config.php'`,
		$configSet = `'simplesaml'`
	)

static

Load a configuration file from a configuration set.

Parameters

string	$filename	The name of the configuration file.
string	$configSet	The configuration set. Optional, defaults to 'simplesaml'.

Returns: SimpleSAML_Configuration The SimpleSAML_Configuration object.

Exceptions

Exception If the configuration set is not initialized.

Definition at line 237 of file Configuration.php.

Referenced by sspmod_statistics_LogCleaner\__construct(), SimpleSAML\Module\cron\Cron\__construct(), sspmod_statistics_Aggregator\__construct(), sspmod_riak_Store_Store\__construct(), sspmod_multiauth_Auth_Source_MultiAuth\__construct(), SimpleSAML_AuthMemCookie\__construct(), sspmod_cdc_Server\__construct(), sspmod_discopower_PowerIdPDisco\__construct(), sspmod_ldap_Auth_Process_BaseFilter\__construct(), cron_hook_cron(), SimpleSAML_Auth_Source\getById(), SimpleSAML_Auth_Source\getSourcesOfType(), statistics_hook_cron(), and statistics_hook_sanitycheck().

     {
         assert(is_string($filename));
         assert(is_string($configSet));
 
         if (!array_key_exists($configSet, self::$configDirs)) {
             if ($configSet !== 'simplesaml') {
                 throw new Exception('Configuration set \''.$configSet.'\' not initialized.');
             } else {
                 self::$configDirs['simplesaml'] = SimpleSAML\Utils\Config::getConfigDir();
             }
         }
 
         $dir = self::$configDirs[$configSet];
         $filePath = $dir.'/'.$filename;
         return self::loadFromFile($filePath, true);
     }

Here is the caller graph for this function:

◆ getConfigItem()

SimpleSAML_Configuration::getConfigItem	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

Retrieve an array as a SimpleSAML_Configuration object.

This function will load the value of an option into a SimpleSAML_Configuration object. The option must contain an array.

An exception will be thrown if this option isn't an array, or if this option isn't found, and no default value is given.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not an array.

Definition at line 979 of file Configuration.php.

References $default, $name, $ret, and getValue().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_array($ret)) {
             throw new Exception(
                 $this->location.': The option '.var_export($name, true).
                 ' is not an array.'
             );
         }
 
         return self::loadFromArray($ret, $this->location.'['.var_export($name, true).']');
     }

Here is the call graph for this function:

◆ getConfigList()

SimpleSAML_Configuration::getConfigList	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

Retrieve an array of arrays as an array of SimpleSAML_Configuration objects.

This function will retrieve an option containing an array of arrays, and create an array of SimpleSAML_Configuration objects from that array. The indexes in the new array will be the same as the original indexes, but the values will be SimpleSAML_Configuration objects.

An exception will be thrown if this option isn't an array of arrays, or if this option isn't found, and no default value is given.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the value of this element is not an array.

Definition at line 1020 of file Configuration.php.

References $default, $index, $name, $out, $ret, and getValue().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_array($ret)) {
             throw new Exception(
                 $this->location.': The option '.var_export($name, true).
                 ' is not an array.'
             );
         }
 
         $out = array();
         foreach ($ret as $index => $config) {
             $newLoc = $this->location.'['.var_export($name, true).']['.
                 var_export($index, true).']';
             if (!is_array($config)) {
                 throw new Exception($newLoc.': The value of this element was expected to be an array.');
             }
             $out[$index] = self::loadFromArray($config, $newLoc);
         }
 
         return $out;
     }

Here is the call graph for this function:

◆ getDefaultBinding()

SimpleSAML_Configuration::getDefaultBinding ( $endpointType )

private

Retrieve the default binding for the given endpoint type.

This function combines the current metadata type (SAML 2 / SAML 1.1) with the endpoint type to determine which binding is the default.

Parameters

string $endpointType The endpoint type.

Returns: string The default binding.

Exceptions

Exception If the default binding is missing for this endpoint type.

Definition at line 1089 of file Configuration.php.

References getString().

Referenced by getEndpoints().

     {
         assert(is_string($endpointType));
 
         $set = $this->getString('metadata-set');
         switch ($set.':'.$endpointType) {
             case 'saml20-idp-remote:SingleSignOnService':
             case 'saml20-idp-remote:SingleLogoutService':
             case 'saml20-sp-remote:SingleLogoutService':
                 return \SAML2\Constants::BINDING_HTTP_REDIRECT;
             case 'saml20-sp-remote:AssertionConsumerService':
                 return \SAML2\Constants::BINDING_HTTP_POST;
             case 'saml20-idp-remote:ArtifactResolutionService':
                 return \SAML2\Constants::BINDING_SOAP;
             case 'shib13-idp-remote:SingleSignOnService':
                 return 'urn:mace:shibboleth:1.0:profiles:AuthnRequest';
             case 'shib13-sp-remote:AssertionConsumerService':
                 return 'urn:oasis:names:tc:SAML:1.0:profiles:browser-post';
             default:
                 throw new Exception('Missing default binding for '.$endpointType.' in '.$set);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultEndpoint()

SimpleSAML_Configuration::getDefaultEndpoint	(		$endpointType,
		array	$bindings = `null`,
			$default = `self::REQUIRED_OPTION`
	)

Find the default endpoint of the given type.

Parameters

string	$endpointType	The endpoint type.
array	$bindings	Array with acceptable bindings. Can be null if any binding is allowed.
mixed	$default	The default value to return if no matching endpoint is found. If no default is provided, an exception will be thrown.

Returns: array|null The default endpoint, or null if no acceptable endpoints are used.

Exceptions

Exception If no supported endpoint is found.

Definition at line 1238 of file Configuration.php.

References $bindings, $default, and getEndpoints().

Referenced by SimpleSAML\Bindings\Shib13\Artifact\extractResponse(), sspmod_saml_IdP_SAML2\getAssertionConsumerService(), and sspmod_saml_Auth_Source_SP\startSSO2().

     {
         assert(is_string($endpointType));
 
         $endpoints = $this->getEndpoints($endpointType);
 
         $defaultEndpoint = \SimpleSAML\Utils\Config\Metadata::getDefaultEndpoint($endpoints, $bindings);
         if ($defaultEndpoint !== null) {
             return $defaultEndpoint;
         }
 
         if ($default === self::REQUIRED_OPTION) {
             $loc = $this->location.'['.var_export($endpointType, true).']:';
             throw new Exception($loc.'Could not find a supported '.$endpointType.' endpoint.');
         }
 
         return $default;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEndpointPrioritizedByBinding()

SimpleSAML_Configuration::getEndpointPrioritizedByBinding	(		$endpointType,
		array	$bindings,
			$default = `self::REQUIRED_OPTION`
	)

Find an endpoint of the given type, using a list of supported bindings as a way to prioritize.

Parameters

string	$endpointType	The endpoint type.
array	$bindings	Sorted array of acceptable bindings.
mixed	$default	The default value to return if no matching endpoint is found. If no default is provided, an exception will be thrown.

Returns: array|null The default endpoint, or null if no acceptable endpoints are used.

Exceptions

Exception If no supported endpoint is found.

Definition at line 1203 of file Configuration.php.

References $binding, $default, and getEndpoints().

Referenced by sspmod_saml_Auth_Source_SP\startSSO2().

     {
         assert(is_string($endpointType));
 
         $endpoints = $this->getEndpoints($endpointType);
 
         foreach ($bindings as $binding) {
             foreach ($endpoints as $ep) {
                 if ($ep['Binding'] === $binding) {
                     return $ep;
                 }
             }
         }
 
         if ($default === self::REQUIRED_OPTION) {
             $loc = $this->location.'['.var_export($endpointType, true).']:';
             throw new Exception($loc.'Could not find a supported '.$endpointType.' endpoint.');
         }
 
         return $default;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEndpoints()

SimpleSAML_Configuration::getEndpoints ( $endpointType )

Helper function for dealing with metadata endpoints.

Parameters

string $endpointType The endpoint type.

Returns: array Array of endpoints of the given type.

Exceptions

Exception If any element of the configuration options for this endpoint type is incorrect.

Definition at line 1122 of file Configuration.php.

References $eps, $i, getDefaultBinding(), and getString().

Referenced by sspmod_saml_IdP_SAML2\getAssertionConsumerService(), getDefaultEndpoint(), and getEndpointPrioritizedByBinding().

     {
         assert(is_string($endpointType));
 
         $loc = $this->location.'['.var_export($endpointType, true).']:';
 
         if (!array_key_exists($endpointType, $this->configuration)) {
             // no endpoints of the given type
             return array();
         }
 
 
         $eps = $this->configuration[$endpointType];
         if (is_string($eps)) {
             // for backwards-compatibility
             $eps = array($eps);
         } elseif (!is_array($eps)) {
             throw new Exception($loc.': Expected array or string.');
         }
 
 
         foreach ($eps as $i => &$ep) {
             $iloc = $loc.'['.var_export($i, true).']';
 
             if (is_string($ep)) {
                 // for backwards-compatibility
                 $ep = array(
                     'Location' => $ep,
                     'Binding'  => $this->getDefaultBinding($endpointType),
                 );
                 $responseLocation = $this->getString($endpointType.'Response', null);
                 if ($responseLocation !== null) {
                     $ep['ResponseLocation'] = $responseLocation;
                 }
             } elseif (!is_array($ep)) {
                 throw new Exception($iloc.': Expected a string or an array.');
             }
 
             if (!array_key_exists('Location', $ep)) {
                 throw new Exception($iloc.': Missing Location.');
             }
             if (!is_string($ep['Location'])) {
                 throw new Exception($iloc.': Location must be a string.');
             }
 
             if (!array_key_exists('Binding', $ep)) {
                 throw new Exception($iloc.': Missing Binding.');
             }
             if (!is_string($ep['Binding'])) {
                 throw new Exception($iloc.': Binding must be a string.');
             }
 
             if (array_key_exists('ResponseLocation', $ep)) {
                 if (!is_string($ep['ResponseLocation'])) {
                     throw new Exception($iloc.': ResponseLocation must be a string.');
                 }
             }
 
             if (array_key_exists('index', $ep)) {
                 if (!is_int($ep['index'])) {
                     throw new Exception($iloc.': index must be an integer.');
                 }
             }
         }
 
         return $eps;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstance()

static SimpleSAML_Configuration::getInstance ( $instancename = 'simplesaml' )

static

Get a configuration file by its instance name.

This function retrieves a configuration file by its instance name. The instance name is initialized by the init function, or by copyFromBase function.

If no configuration file with the given instance name is found, an exception will be thrown.

Parameters

string $instancename The instance name of the configuration file. Deprecated.

Returns: SimpleSAML_Configuration The configuration object.

Exceptions

Exception If the configuration with $instancename name is not initialized.

Definition at line 325 of file Configuration.php.

     {
         assert(is_string($instancename));
 
         // check if the instance exists already
         if (array_key_exists($instancename, self::$instance)) {
             return self::$instance[$instancename];
         }
 
         if ($instancename === 'simplesaml') {
             try {
                 return self::getConfig();
             } catch (SimpleSAML\Error\ConfigurationError $e) {
                 throw \SimpleSAML\Error\CriticalConfigurationError::fromException($e);
             }
         }
 
         throw new \SimpleSAML\Error\CriticalConfigurationError(
             'Configuration with name '.$instancename.' is not initialized.'
         );
     }

Here is the caller graph for this function:

◆ getInteger()

SimpleSAML_Configuration::getInteger	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves an integer configuration option.

An exception will be thrown if this option isn't an integer, or if this option isn't found, and no default value is given.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: int|mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not an integer.

Definition at line 740 of file Configuration.php.

References $default, $name, $ret, and getValue().

Referenced by SimpleSAML\Logger\SyslogLoggingHandler\__construct(), SimpleSAML_Metadata_SAMLBuilder\addAttributeConsumingService(), sspmod_saml_IdP_SAML2\buildAssertion(), sspmod_saml_Message\buildAuthnRequest(), sspmod_saml_IdP_SAML2\buildLogoutRequest(), getIntegerRange(), and sspmod_saml_Auth_Source_SP\startSSO2().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_int($ret)) {
             throw new Exception(
                 $this->location.': The option '.var_export($name, true).
                 ' is not a valid integer value.'
             );
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIntegerRange()

SimpleSAML_Configuration::getIntegerRange	(	$name,
		$minimum,
		$maximum,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves an integer configuration option where the value must be in the specified range.

An exception will be thrown if:

the option isn't an integer
the option isn't found, and no default value is given
the value is outside of the allowed range

Parameters

string	$name	The name of the option.
int	$minimum	The smallest value which is allowed.
int	$maximum	The largest value which is allowed.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: int|mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not in the range specified.

Definition at line 782 of file Configuration.php.

References $default, $name, $ret, and getInteger().

     {
         assert(is_string($name));
         assert(is_int($minimum));
         assert(is_int($maximum));
 
         $ret = $this->getInteger($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if ($ret < $minimum || $ret > $maximum) {
             throw new Exception(
                 $this->location.': Value of option '.var_export($name, true).
                 ' is out of range. Value is '.$ret.', allowed range is ['
                 .$minimum.' - '.$maximum.']'
             );
         }
 
         return $ret;
     }

Here is the call graph for this function:

◆ getLocalizedString()

SimpleSAML_Configuration::getLocalizedString	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

Retrieve a string which may be localized into many languages.

The default language returned is always 'en'.

Parameters

string	$name	The name of the option.
mixed	$default	The default value. If no default is given, and the option isn't found, an exception will be thrown.

Returns: array Associative array with language => string pairs.

Exceptions

Exception If the translation is not an array or a string, or its index or value are not strings.

Definition at line 1271 of file Configuration.php.

References $default, $name, $ret, and getValue().

Referenced by SimpleSAML_Metadata_SAMLBuilder\addAttributeConsumingService().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         $loc = $this->location.'['.var_export($name, true).']';
 
         if (is_string($ret)) {
             $ret = array('en' => $ret,);
         }
 
         if (!is_array($ret)) {
             throw new Exception($loc.': Must be an array or a string.');
         }
 
         foreach ($ret as $k => $v) {
             if (!is_string($k)) {
                 throw new Exception($loc.': Invalid language code: '.var_export($k, true));
             }
             if (!is_string($v)) {
                 throw new Exception($loc.'['.var_export($v, true).']: Must be a string.');
             }
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptionalConfig()

static SimpleSAML_Configuration::getOptionalConfig	(	$filename = `'config.php'`,
		$configSet = `'simplesaml'`
	)

static

Load a configuration file from a configuration set.

This function will return a configuration object even if the file does not exist.

Parameters

string	$filename	The name of the configuration file.
string	$configSet	The configuration set. Optional, defaults to 'simplesaml'.

Returns: SimpleSAML_Configuration A configuration object.

Exceptions

Exception If the configuration set is not initialized.

Definition at line 267 of file Configuration.php.

Referenced by sspmod_oauth_OAuthStore\__construct(), sspmod_core_ACL\getById(), SimpleSAML_Auth_Source\getSources(), SimpleSAML\Module\isModuleEnabled(), metarefresh_hook_cron(), oauth_hook_cron(), portal_hook_htmlinject(), and sanitycheck_hook_cron().

     {
         assert(is_string($filename));
         assert(is_string($configSet));
 
         if (!array_key_exists($configSet, self::$configDirs)) {
             if ($configSet !== 'simplesaml') {
                 throw new Exception('Configuration set \''.$configSet.'\' not initialized.');
             } else {
                 self::$configDirs['simplesaml'] = SimpleSAML\Utils\Config::getConfigDir();
             }
         }
 
         $dir = self::$configDirs[$configSet];
         $filePath = $dir.'/'.$filename;
         return self::loadFromFile($filePath, false);
     }

Here is the caller graph for this function:

◆ getOptions()

SimpleSAML_Configuration::getOptions ( )

Retrieve list of options.

This function returns the name of all options which are defined in this configuration file, as an array of strings.

Returns: array Name of all options defined in this configuration file.

Definition at line 1060 of file Configuration.php.

     {
         return array_keys($this->configuration);
     }

◆ getPathValue()

SimpleSAML_Configuration::getPathValue	(	$name,
		$default = `null`
	)

Retrieve a path configuration option set in config.php.

The function will always return an absolute path unless the option is not set. It will then return the default value.

It checks if the value starts with a slash, and prefixes it with the value from getBaseDir if it doesn't.

Parameters

string	$name	Name of the configuration option.
string \| null	$default	Default value of the configuration option. This parameter will default to null if not specified.

Returns: string|null The path configuration option with name $name, or $default if the option was not found.

Definition at line 590 of file Configuration.php.

References $default, $name, $path, and resolvePath().

Referenced by sspmod_core_Stats_Output_File\__construct(), and SimpleSAML\Logger\FileLoggingHandler\__construct().

     {
         // return the default value if the option is unset
         if (!array_key_exists($name, $this->configuration)) {
             $path = $default;
         } else {
             $path = $this->configuration[$name];
         }
 
         if ($path === null) {
             return null;
         }
 
         return $this->resolvePath($path).'/';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPublicKeys()

SimpleSAML_Configuration::getPublicKeys	(	$use = `null`,
		$required = `false`,
		$prefix = `''`
	)

Get public key from metadata.

Parameters

string \| null	$use	The purpose this key can be used for. (encryption or signing).
bool	$required	Whether the public key is required. If this is true, a missing key will cause an exception. Default is false.
string	$prefix	The prefix which should be used when reading from the metadata array. Defaults to ''.

Returns: array Public key data, or empty array if no public key or was found.

Exceptions

Exception	If the certificate or public key cannot be loaded from a file.
SimpleSAML_Error_Exception	If the file does not contain a valid PEM-encoded certificate, or there is no certificate in the metadata.

Definition at line 1319 of file Configuration.php.

References $data, $key, $ret, getArray(), SimpleSAML\Utils\Config\getCertPath(), getString(), and hasValue().

Referenced by sspmod_saml_Message\checkSign(), sspmod_saml_IdP_SAML2\encryptAssertion(), SimpleSAML\Bindings\Shib13\Artifact\extractResponse(), sspmod_saml_Message\getEncryptionKey(), and SimpleSAML\Utils\Crypto\loadPublicKey().

     {
         assert(is_bool($required));
         assert(is_string($prefix));
 
         if ($this->hasValue($prefix.'keys')) {
             $ret = array();
             foreach ($this->getArray($prefix.'keys') as $key) {
                 if ($use !== null && isset($key[$use]) && !$key[$use]) {
                     continue;
                 }
                 if (isset($key['X509Certificate'])) {
                     // Strip whitespace from key
                     $key['X509Certificate'] = preg_replace('/\s+/', '', $key['X509Certificate']);
                 }
                 $ret[] = $key;
             }
             return $ret;
         } elseif ($this->hasValue($prefix.'certData')) {
             $certData = $this->getString($prefix.'certData');
             $certData = preg_replace('/\s+/', '', $certData);
             return array(
                 array(
                     'encryption'      => true,
                     'signing'         => true,
                     'type'            => 'X509Certificate',
                     'X509Certificate' => $certData,
                 ),
             );
         } elseif ($this->hasValue($prefix.'certificate')) {
             $file = $this->getString($prefix.'certificate');
             $file = \SimpleSAML\Utils\Config::getCertPath($file);
             $data = @file_get_contents($file);
 
             if ($data === false) {
                 throw new Exception($this->location.': Unable to load certificate/public key from file "'.$file.'".');
             }
 
             // extract certificate data (if this is a certificate)
             $pattern = '/^-----BEGIN CERTIFICATE-----([^-]*)^-----END CERTIFICATE-----/m';
             if (!preg_match($pattern, $data, $matches)) {
                 throw new SimpleSAML_Error_Exception(
                     $this->location.': Could not find PEM encoded certificate in "'.$file.'".'
                 );
             }
             $certData = preg_replace('/\s+/', '', $matches[1]);
 
             return array(
                 array(
                     'encryption'      => true,
                     'signing'         => true,
                     'type'            => 'X509Certificate',
                     'X509Certificate' => $certData,
                 ),
             );
         } elseif ($required === true) {
             throw new SimpleSAML_Error_Exception($this->location.': Missing certificate in metadata.');
         } else {
             return array();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getString()

SimpleSAML_Configuration::getString	(	$name,
		$default = `self::REQUIRED_OPTION`
	)

This function retrieves a string configuration option.

An exception will be thrown if this option isn't a string, or if this option isn't found, and no default value is given.

Parameters

string	$name	The name of the option.
mixed	$default	A default value which will be returned if the option isn't found. The option will be required if this parameter isn't given. The default value can be any value, including null.

Returns: string|mixed The option with the given name, or $default if the option isn't found and $default is specified.

Exceptions

Exception If the option is not a string.

Definition at line 702 of file Configuration.php.

References $default, $name, $ret, and getValue().

     {
         assert(is_string($name));
 
         $ret = $this->getValue($name, $default);
 
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!is_string($ret)) {
             throw new Exception(
                 $this->location.': The option '.var_export($name, true).
                 ' is not a valid string value.'
             );
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValue()

SimpleSAML_Configuration::getValue	(	$name,
		$default = `null`
	)

Retrieve a configuration option set in config.php.

Parameters

string	$name	Name of the configuration option.
mixed	$default	Default value of the configuration option. This parameter will default to null if not specified. This can be set to SimpleSAML_Configuration::REQUIRED_OPTION, which will cause an exception to be thrown if the option isn't found.

Returns: mixed The configuration option with name $name, or $default if the option was not found.

Exceptions

Exception If the required option cannot be retrieved.

Definition at line 433 of file Configuration.php.

Referenced by sspmod_saml_Message\buildAuthnRequest(), sspmod_statistics_AccessCheck\checkAccess(), getArray(), getArrayize(), getBoolean(), getConfigItem(), getConfigList(), getInteger(), getLocalizedString(), getString(), getValueValidate(), and SAML2\SOAPClient\send().

     {
         // return the default value if the option is unset
         if (!array_key_exists($name, $this->configuration)) {
             if ($default === self::REQUIRED_OPTION) {
                 throw new Exception(
                     $this->location.': Could not retrieve the required option '.
                     var_export($name, true)
                 );
             }
             return $default;
         }
 
         return $this->configuration[$name];
     }

Here is the caller graph for this function:

◆ getValueValidate()

SimpleSAML_Configuration::getValueValidate	(	$name,
		$allowedValues,
		$default = `self::REQUIRED_OPTION`
	)

Retrieve a configuration option with one of the given values.

This will check that the configuration option matches one of the given values. The match will use strict comparison. An exception will be thrown if it does not match.

The option can be mandatory or optional. If no default value is given, it will be considered to be mandatory, and an exception will be thrown if it isn't provided. If a default value is given, it is considered to be optional, and the default value is returned. The default value is automatically included in the list of allowed values.

Parameters

string	$name	The name of the option.
array	$allowedValues	The values the option is allowed to take, as an array.
mixed	$default	The default value which will be returned if the option isn't found. If this parameter isn't given, the option will be considered to be mandatory. The default value can be any value, including null.

Returns: mixed The option with the given name, or $default if the option isn't found and $default is given.

Exceptions

Exception If the option does not have any of the allowed values.

Definition at line 828 of file Configuration.php.

References $default, $name, $ret, and getValue().

Referenced by sspmod_saml_Message\buildAuthnRequest().

     {
         assert(is_string($name));
         assert(is_array($allowedValues));
 
         $ret = $this->getValue($name, $default);
         if ($ret === $default) {
             // the option wasn't found, or it matches the default value. In any case, return this value
             return $ret;
         }
 
         if (!in_array($ret, $allowedValues, true)) {
             $strValues = array();
             foreach ($allowedValues as $av) {
                 $strValues[] = var_export($av, true);
             }
             $strValues = implode(', ', $strValues);
 
             throw new Exception(
                 $this->location.': Invalid value given for the option '.
                 var_export($name, true).'. It should have one of the following values: '.
                 $strValues.'; but it had the following value: '.var_export($ret, true)
             );
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVersion()

SimpleSAML_Configuration::getVersion ( )

Retrieve the current version of SimpleSAMLphp.

Returns: string

Definition at line 415 of file Configuration.php.

     {
         return '1.16.2';
     }

◆ hasValue()

SimpleSAML_Configuration::hasValue ( $name )

Check whether a key in the configuration exists or not.

Parameters

string $name The key in the configuration to look for.

Returns: boolean If the value is set in this configuration.

Definition at line 457 of file Configuration.php.

Referenced by SimpleSAML_Metadata_SAMLBuilder\addAttributeConsumingService(), SimpleSAML_Metadata_SAMLBuilder\addExtensions(), sspmod_saml_Message\buildAuthnRequest(), sspmod_saml_Message\checkSign(), SimpleSAML\XML\Shib13\AuthnResponse\generate(), getPublicKeys(), SimpleSAML\Utils\Crypto\loadPrivateKey(), SimpleSAML\Utils\Crypto\loadPublicKey(), SAML2\Configuration\SimpleSAMLConverter\pluckConfiguration(), SAML2\SOAPClient\send(), and SimpleSAML\Bindings\Shib13\HTTPPost\sendResponse().

     {
         return array_key_exists($name, $this->configuration);
     }

Here is the caller graph for this function:

◆ hasValueOneOf()

SimpleSAML_Configuration::hasValueOneOf ( $names )

Check whether any key of the set given exists in the configuration.

Parameters

array $names An array of options to look for.

Returns: boolean If any of the keys in $names exist in the configuration

Definition at line 470 of file Configuration.php.

     {
         foreach ($names as $name) {
             if ($this->hasValue($name)) {
                 return true;
             }
         }
         return false;
     }

◆ init()

static SimpleSAML_Configuration::init	(	$path,
		$instancename = `'simplesaml'`,
		$configfilename = `'config.php'`
	)

static

Initialize a instance name with the given configuration file.

TODO: remove.

Parameters

string	$path
string	$instancename
string	$configfilename

See also: setConfigDir()

Deprecated:: This function is superseeded by the setConfigDir function.

Definition at line 360 of file Configuration.php.

     {
         assert(is_string($path));
         assert(is_string($instancename));
         assert(is_string($configfilename));
 
         if ($instancename === 'simplesaml') {
             // for backwards compatibility
             self::setConfigDir($path, 'simplesaml');
         }
 
         // check if we already have loaded the given config - return the existing instance if we have
         if (array_key_exists($instancename, self::$instance)) {
             return self::$instance[$instancename];
         }
 
         self::$instance[$instancename] = self::loadFromFile($path.'/'.$configfilename, true);
         return self::$instance[$instancename];
     }

◆ loadFromArray()

static SimpleSAML_Configuration::loadFromArray	(	$config,
		$location = `'[ARRAY]'`,
		$instance = `null`
	)

static

Loads a configuration from the given array.

Parameters

array	$config	The configuration array.
string	$location	The location which will be given when an error occurs. Optional.
string \| null	$instance	The name of this instance. If specified, the configuration will be loaded and an instance with that name will be kept for it to be retrieved later with getInstance($instance). If null, the configuration will not be kept for later use. Defaults to null.

Returns: SimpleSAML_Configuration The configuration object.

Definition at line 297 of file Configuration.php.

     {
         assert(is_array($config));
         assert(is_string($location));
 
         $c = new SimpleSAML_Configuration($config, $location);
         if ($instance !== null) {
             self::$instance[$instance] = $c;
         }
         return $c;
     }

Here is the caller graph for this function:

◆ loadFromFile()

static SimpleSAML_Configuration::loadFromFile	(	$filename,
		$required
	)

staticprivate

Load the given configuration file.

Parameters

string	$filename	The full path of the configuration file.
bool	$required	Whether the file is required.

Returns: SimpleSAML_Configuration The configuration file. An exception will be thrown if the configuration file is missing.

Exceptions

Exception If the configuration file is invalid or missing.

Definition at line 108 of file Configuration.php.

References $cfg, $config, $filename, and SimpleSAML\Logger\warning().

     {
         assert(is_string($filename));
         assert(is_bool($required));
 
         if (array_key_exists($filename, self::$loadedConfigs)) {
             return self::$loadedConfigs[$filename];
         }
 
         if (file_exists($filename)) {
             $config = 'UNINITIALIZED';
 
             // the file initializes a variable named '$config'
             ob_start();
             if (interface_exists('Throwable', false)) {
                 try {
                     require($filename);
                 } catch (ParseError $e) {
                     self::$loadedConfigs[$filename] = self::loadFromArray(array(), '[ARRAY]', 'simplesaml');
                     throw new SimpleSAML\Error\ConfigurationError($e->getMessage(), $filename, array());
                 }
             } else {
                 require($filename);
             }
 
             $spurious_output = ob_get_length() > 0;
             ob_end_clean();
 
             // check that $config exists
             if (!isset($config)) {
                 throw new \SimpleSAML\Error\ConfigurationError(
                     '$config is not defined in the configuration file.',
                     $filename
                 );
             }
 
             // check that $config is initialized to an array
             if (!is_array($config)) {
                 throw new \SimpleSAML\Error\ConfigurationError(
                     '$config is not an array.',
                     $filename
                 );
             }
 
             // check that $config is not empty
             if (empty($config)) {
                 throw new \SimpleSAML\Error\ConfigurationError(
                     '$config is empty.',
                     $filename
                 );
             }
         } elseif ($required) {
             // file does not exist, but is required
             throw new \SimpleSAML\Error\ConfigurationError('Missing configuration file', $filename);
         } else {
             // file does not exist, but is optional, so return an empty configuration object without saving it
             $cfg = new SimpleSAML_Configuration(array(), $filename);
             $cfg->filename = $filename;
             return $cfg;
         }
 
         $cfg = new SimpleSAML_Configuration($config, $filename);
         $cfg->filename = $filename;
 
         self::$loadedConfigs[$filename] = $cfg;
 
         if ($spurious_output) {
             SimpleSAML\Logger::warning(
                 "The configuration file '$filename' generates output. Please review your configuration."
             );
         }
 
         return $cfg;
     }

Here is the call graph for this function:

◆ resolvePath()

SimpleSAML_Configuration::resolvePath ( $path )

This function resolves a path which may be relative to the SimpleSAMLphp base directory.

The path will never end with a '/'.

Parameters

string | null $path The path we should resolve. This option may be null.

Returns: string|null $path if $path is an absolute path, or $path prepended with the base directory of this SimpleSAMLphp installation. We will return NULL if $path is null.

Definition at line 564 of file Configuration.php.

References $path, and getBaseDir().

Referenced by getPathValue().

     {
         if ($path === null) {
             return null;
         }
 
         assert(is_string($path));
 
         return System::resolvePath($path, $this->getBaseDir());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConfigDir()

static SimpleSAML_Configuration::setConfigDir	(	$path,
		$configSet = `'simplesaml'`
	)

static

Set the directory for configuration files for the given configuration set.

Parameters

string	$path	The directory which contains the configuration files.
string	$configSet	The configuration set. Defaults to 'simplesaml'.

Definition at line 190 of file Configuration.php.

References $path.

Referenced by ilSimpleSAMLphpWrapper\__construct().

     {
         assert(is_string($path));
         assert(is_string($configSet));
 
         self::$configDirs[$configSet] = $path;
     }

Here is the caller graph for this function:

◆ setPreLoadedConfig()

static SimpleSAML_Configuration::setPreLoadedConfig	(	SimpleSAML_Configuration	$config,
			$filename = `'config.php'`,
			$configSet = `'simplesaml'`
	)

static

Store a pre-initialized configuration.

Allows consumers to create configuration objects without having them loaded from a file.

Parameters

SimpleSAML_Configuration	$config	The configuration object to store
string	$filename	The name of the configuration file.
string	$configSet	The configuration set. Optional, defaults to 'simplesaml'.

Definition at line 208 of file Configuration.php.

References $filename.

     {
         assert(is_string($filename));
         assert(is_string($configSet));
 
         if (!array_key_exists($configSet, self::$configDirs)) {
             if ($configSet !== 'simplesaml') {
                 throw new Exception('Configuration set \'' . $configSet . '\' not initialized.');
             } else {
                 self::$configDirs['simplesaml'] = dirname(dirname(dirname(__FILE__))) . '/config';
             }
         }
 
         $dir = self::$configDirs[$configSet];
         $filePath = $dir . '/' . $filename;
 
         self::$loadedConfigs[$filePath] = $config;
     }

◆ toArray()

SimpleSAML_Configuration::toArray ( )

Convert this configuration object back to an array.

Returns: array An associative array with all configuration options and values.

Definition at line 1071 of file Configuration.php.

References $configuration.

Referenced by getBasePath().

     {
         return $this->configuration;
     }

Here is the caller graph for this function:

Field Documentation

◆ $configDirs

SimpleSAML_Configuration::$configDirs = array()

staticprivate

Definition at line 37 of file Configuration.php.

◆ $configuration

SimpleSAML_Configuration::$configuration

private

Definition at line 55 of file Configuration.php.

Referenced by toArray().

◆ $deprecated_base_url_used

SimpleSAML_Configuration::$deprecated_base_url_used = false

private

Definition at line 79 of file Configuration.php.

◆ $filename

SimpleSAML_Configuration::$filename = null

private

Definition at line 71 of file Configuration.php.

Referenced by loadFromFile(), and setPreLoadedConfig().

◆ $instance

SimpleSAML_Configuration::$instance = array()

staticprivate

Definition at line 26 of file Configuration.php.

◆ $loadedConfigs

SimpleSAML_Configuration::$loadedConfigs = array()

staticprivate

Definition at line 47 of file Configuration.php.

◆ $location

SimpleSAML_Configuration::$location

private

Definition at line 63 of file Configuration.php.

Referenced by __construct().

◆ REQUIRED_OPTION

const SimpleSAML_Configuration::REQUIRED_OPTION = '___REQUIRED_OPTION___'

Definition at line 18 of file Configuration.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Configuration.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearInternalState()

◆ copyFromBase()

◆ getArray()

◆ getArrayize()

◆ getArrayizeString()

◆ getBaseDir()

◆ getBasePath()

◆ getBaseURL()

◆ getBoolean()

◆ getConfig()

◆ getConfigItem()

◆ getConfigList()

◆ getDefaultBinding()

◆ getDefaultEndpoint()

◆ getEndpointPrioritizedByBinding()

◆ getEndpoints()

◆ getInstance()

◆ getInteger()

◆ getIntegerRange()

◆ getLocalizedString()

◆ getOptionalConfig()

◆ getOptions()

◆ getPathValue()

◆ getPublicKeys()

◆ getString()

◆ getValue()

◆ getValueValidate()

◆ getVersion()

◆ hasValue()

◆ hasValueOneOf()

◆ init()

◆ loadFromArray()

◆ loadFromFile()

◆ resolvePath()

◆ setConfigDir()

◆ setPreLoadedConfig()

◆ toArray()

Field Documentation

◆ $configDirs

◆ $configuration

◆ $deprecated_base_url_used

◆ $filename

◆ $instance

◆ $loadedConfigs

◆ $location

◆ REQUIRED_OPTION