SimpleSAML\Locale\Language Class Reference

Collaboration diagram for SimpleSAML\Locale\Language:

Public Member Functions
	__construct (\SimpleSAML_Configuration $configuration)
	Constructor. More...
	getPosixLanguage ($language)
	Rename to non-idiosyncratic language code. More...
	setLanguage ($language, $setLanguageCookie=true)
	This method will set a cookie for the user's browser to remember what language was selected. More...
	getLanguage ()
	This method will return the language selected by the user, or the default language. More...
	getLanguageLocalizedName ($code)
	Get the localized name of a language, by ISO 639-2 code. More...
	getLanguageParameterName ()
	Get the language parameter name. More...
	getDefaultLanguage ()
	Return the default language according to configuration. More...
	getLanguageCodeAlias ($langcode)
	Return an alias for a language code, if any. More...
	getLanguageList ()
	Return an indexed list of all languages available. More...
	isLanguageRTL ()
	Check whether a language is written from the right to the left or not. More...

Static Public Member Functions
static	getLanguageCookie ()
	Retrieve the user-selected language from a cookie. More...
static	setLanguageCookie ($language)
	This method will attempt to set the user-selected language in a cookie. More...

Private Member Functions
	getInstalledLanguages ()
	Filter configured (available) languages against installed languages. More...
	getHTTPLanguage ()
	This method returns the preferred language for the user based on the Accept-Language HTTP header. More...

Private Attributes
	$configuration
	$availableLanguages
	$language = null
	$defaultLanguage
	$rtlLanguages
	$languageParameterName
	$customFunction
	$language_names
	$languagePosixMapping

Static Private Attributes
static	$defaultLanguageMap = array('nb' => 'no')
	This is the default language map. More...

Detailed Description

Definition at line 15 of file Language.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Locale\Language::__construct

(

\SimpleSAML_Configuration

$configuration

)

Constructor.

Parameters

\SimpleSAML_Configuration

$configuration

Configuration object

Definition at line 138 of file Language.php.

References $_GET, SimpleSAML\Locale\Language\$configuration, array, SimpleSAML\Locale\Language\getInstalledLanguages(), and SimpleSAML\Locale\Language\setLanguage().

    {
        $this->configuration = $configuration;
        $this->availableLanguages = $this->getInstalledLanguages();
        $this->defaultLanguage = $this->configuration->getString('language.default', 'en');
        $this->languageParameterName = $this->configuration->getString('language.parameter.name', 'language');
        $this->customFunction = $this->configuration->getArray('language.get_language_function', null);
        $this->rtlLanguages = $this->configuration->getArray('language.rtl', array());
        if (isset($_GET[$this->languageParameterName])) {
            $this->setLanguage(
                $_GET[$this->languageParameterName],
                $this->configuration->getBoolean('language.parameter.setcookie', true)
            );
        }
    }

Here is the call graph for this function:

Member Function Documentation

getDefaultLanguage()

SimpleSAML\Locale\Language::getDefaultLanguage

(

)

Return the default language according to configuration.

Returns

string The default language that has been configured. Defaults to english if not configured.

Definition at line 325 of file Language.php.

References SimpleSAML\Locale\Language\$defaultLanguage.

Referenced by SimpleSAML\Locale\Language\getLanguage().

    {
        return $this->defaultLanguage;
    }

Here is the caller graph for this function:

getHTTPLanguage()

SimpleSAML\Locale\Language::getHTTPLanguage ( )

private

This method returns the preferred language for the user based on the Accept-Language HTTP header.

Returns

string The preferred language based on the Accept-Language HTTP header, or null if none of the languages in the header is available.

Definition at line 284 of file Language.php.

References SimpleSAML\Locale\Language\$language, and SimpleSAML\Utils\HTTP\getAcceptLanguage().

Referenced by SimpleSAML\Locale\Language\getLanguage().

    {
        $languageScore = HTTP::getAcceptLanguage();

        // for now we only use the default language map. We may use a configurable language map in the future
        $languageMap = self::$defaultLanguageMap;

        // find the available language with the best score
        $bestLanguage = null;
        $bestScore = -1.0;

        foreach ($languageScore as $language => $score) {
            // apply the language map to the language code
            if (array_key_exists($language, $languageMap)) {
                $language = $languageMap[$language];
            }

            if (!in_array($language, $this->availableLanguages, true)) {
                // skip this language - we don't have it
                continue;
            }

            /* Some user agents use very limited precision of the quality value, but order the elements in descending
             * order. Therefore we rely on the order of the output from getAcceptLanguage() matching the order of the
             * languages in the header when two languages have the same quality.
             */
            if ($score > $bestScore) {
                $bestLanguage = $language;
                $bestScore = $score;
            }
        }

        return $bestLanguage;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstalledLanguages()

SimpleSAML\Locale\Language::getInstalledLanguages ( )

private

Filter configured (available) languages against installed languages.

Returns

array The set of languages both in 'language.available' and $this->language_names.

Definition at line 160 of file Language.php.

References SimpleSAML\Locale\Language\$availableLanguages, $code, array, and SimpleSAML\Logger\error().

Referenced by SimpleSAML\Locale\Language\__construct().

    {
        $configuredAvailableLanguages = $this->configuration->getArray('language.available', array('en'));
        $availableLanguages = array();
        foreach ($configuredAvailableLanguages as $code) {
            if (array_key_exists($code, $this->language_names) && isset($this->language_names[$code])) {
                $availableLanguages[] = $code;
            } else {
                \SimpleSAML\Logger::error("Language \"$code\" not installed. Check config.");
            }
        }
        return $availableLanguages;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguage()

SimpleSAML\Locale\Language::getLanguage

(

)

This method will return the language selected by the user, or the default language.

It looks first for a cached language code, then checks for a language cookie, then it tries to calculate the preferred language from HTTP headers.

Returns

string The language selected by the user according to the processing rules specified, or the default language in any other case.

Definition at line 217 of file Language.php.

References SimpleSAML\Locale\Language\$language, SimpleSAML\Locale\Language\getDefaultLanguage(), SimpleSAML\Locale\Language\getHTTPLanguage(), and SimpleSAML\Locale\Language\getLanguageCookie().

Referenced by SimpleSAML\Locale\Language\getLanguageList(), and SimpleSAML\Locale\Language\isLanguageRTL().

    {
        // language is set in object
        if (isset($this->language)) {
            return $this->language;
        }

        // run custom getLanguage function if defined
        if (isset($this->customFunction) && is_callable($this->customFunction)) {
            $customLanguage = call_user_func($this->customFunction, $this);
            if ($customLanguage !== null && $customLanguage !== false) {
                return $customLanguage;
            }
        }

        // language is provided in a stored cookie
        $languageCookie = Language::getLanguageCookie();
        if ($languageCookie !== null) {
            $this->language = $languageCookie;
            return $languageCookie;
        }

        // check if we can find a good language from the Accept-Language HTTP header
        $httpLanguage = $this->getHTTPLanguage();
        if ($httpLanguage !== null) {
            return $httpLanguage;
        }

        // language is not set, and we get the default language from the configuration
        return $this->getDefaultLanguage();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguageCodeAlias()

SimpleSAML\Locale\Language::getLanguageCodeAlias

(

$langcode

)

Return an alias for a language code, if any.

Returns

string The alias, or null if the alias was not found.

Definition at line 336 of file Language.php.

    {
        if (isset(self::$defaultLanguageMap[$langcode])) {
            return self::$defaultLanguageMap[$langcode];
        }
        // No alias found, which is fine
        return null;
    }

getLanguageCookie()

static SimpleSAML\Locale\Language::getLanguageCookie ( )

static

Retrieve the user-selected language from a cookie.

Returns

string|null The selected language or null if unset.

Definition at line 377 of file Language.php.

References $_COOKIE, SimpleSAML\Locale\Language\$availableLanguages, $config, SimpleSAML\Locale\Language\$language, $name, array, and SimpleSAML_Configuration\getInstance().

Referenced by SimpleSAML\Locale\Language\getLanguage(), and sspmod_core_Auth_Process_LanguageAdaptor\process().

    {
        $config = \SimpleSAML_Configuration::getInstance();
        $availableLanguages = $config->getArray('language.available', array('en'));
        $name = $config->getString('language.cookie.name', 'language');

        if (isset($_COOKIE[$name])) {
            $language = strtolower((string) $_COOKIE[$name]);
            if (in_array($language, $availableLanguages, true)) {
                return $language;
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguageList()

SimpleSAML\Locale\Language::getLanguageList

(

)

Return an indexed list of all languages available.

Returns

array An array holding all the languages available as the keys of the array. The value for each key is true in case that the language specified by that key is currently active, or false otherwise.

Definition at line 352 of file Language.php.

References $current, $list, and SimpleSAML\Locale\Language\getLanguage().

    {
        $current = $this->getLanguage();
        $list = array_fill_keys($this->availableLanguages, false);
        $list[$current] = true;
        return $list;
    }

Here is the call graph for this function:

getLanguageLocalizedName()

SimpleSAML\Locale\Language::getLanguageLocalizedName

(

$code

)

Get the localized name of a language, by ISO 639-2 code.

Parameters

string

$code

The ISO 639-2 code of the language.

Returns

string The localized name of the language.

Definition at line 257 of file Language.php.

References $code, and SimpleSAML\Logger\error().

    {
        if (array_key_exists($code, $this->language_names) && isset($this->language_names[$code])) {
            return $this->language_names[$code];
        }
        \SimpleSAML\Logger::error("Name for language \"$code\" not found. Check config.");
        return null;
    }

Here is the call graph for this function:

getLanguageParameterName()

SimpleSAML\Locale\Language::getLanguageParameterName

(

)

Get the language parameter name.

Returns

string The language parameter name.

Definition at line 272 of file Language.php.

References SimpleSAML\Locale\Language\$languageParameterName.

    {
        return $this->languageParameterName;
    }

getPosixLanguage()

SimpleSAML\Locale\Language::getPosixLanguage

(

$language

)

Rename to non-idiosyncratic language code.

Parameters

string

$language

Language code for the language to rename, if necessary.

Returns

string The language code.

Definition at line 182 of file Language.php.

References SimpleSAML\Locale\Language\$language.

    {
        if (isset($this->languagePosixMapping[$language])) {
            return $this->languagePosixMapping[$language];
        }
        return $language;
    }

isLanguageRTL()

SimpleSAML\Locale\Language::isLanguageRTL

(

)

Check whether a language is written from the right to the left or not.

Returns

boolean True if the language is right-to-left, false otherwise.

Definition at line 366 of file Language.php.

References SimpleSAML\Locale\Language\getLanguage().

    {
        return in_array($this->getLanguage(), $this->rtlLanguages, true);
    }

Here is the call graph for this function:

setLanguage()

SimpleSAML\Locale\Language::setLanguage	(		$language,
			$setLanguageCookie = true
	)

This method will set a cookie for the user's browser to remember what language was selected.

Parameters

string	$language	Language code for the language to set.
boolean	$setLanguageCookie	Whether to set the language cookie or not. Defaults to true.

Definition at line 197 of file Language.php.

References SimpleSAML\Locale\Language\$language.

Referenced by SimpleSAML\Locale\Language\__construct().

    {
        $language = strtolower($language);
        if (in_array($language, $this->availableLanguages, true)) {
            $this->language = $language;
            if ($setLanguageCookie === true) {
                self::setLanguageCookie($language);
            }
        }
    }

Here is the caller graph for this function:

setLanguageCookie()

static SimpleSAML\Locale\Language::setLanguageCookie (   $language )

static

This method will attempt to set the user-selected language in a cookie.

It will do nothing if the language specified is not in the list of available languages, or the headers have already been sent to the browser.

Parameters

string

$language

The language set by the user.

Definition at line 400 of file Language.php.

References SimpleSAML\Locale\Language\$availableLanguages, $config, SimpleSAML\Locale\Language\$language, $name, $params, array, SimpleSAML_Configuration\getInstance(), and SimpleSAML\Utils\HTTP\setCookie().

Referenced by sspmod_core_Auth_Process_LanguageAdaptor\process().

    {
        assert('is_string($language)');

        $language = strtolower($language);
        $config = \SimpleSAML_Configuration::getInstance();
        $availableLanguages = $config->getArray('language.available', array('en'));

        if (!in_array($language, $availableLanguages, true) || headers_sent()) {
            return;
        }

        $name = $config->getString('language.cookie.name', 'language');
        $params = array(
            'lifetime' => ($config->getInteger('language.cookie.lifetime', 60 * 60 * 24 * 900)),
            'domain'   => ($config->getString('language.cookie.domain', null)),
            'path'     => ($config->getString('language.cookie.path', '/')),
            'secure'   => ($config->getBoolean('language.cookie.secure', false)),
            'httponly' => ($config->getBoolean('language.cookie.httponly', false)),
        );

        HTTP::setCookie($name, $language, $params, false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$availableLanguages

SimpleSAML\Locale\Language::$availableLanguages

private

Definition at line 35 of file Language.php.

Referenced by SimpleSAML\Locale\Language\getInstalledLanguages(), SimpleSAML\Locale\Language\getLanguageCookie(), and SimpleSAML\Locale\Language\setLanguageCookie().

$configuration

SimpleSAML\Locale\Language::$configuration

private

Definition at line 28 of file Language.php.

Referenced by SimpleSAML\Locale\Language\__construct().

$customFunction

SimpleSAML\Locale\Language::$customFunction

private

Definition at line 70 of file Language.php.

$defaultLanguage

SimpleSAML\Locale\Language::$defaultLanguage

private

Definition at line 49 of file Language.php.

Referenced by SimpleSAML\Locale\Language\getDefaultLanguage().

$defaultLanguageMap

SimpleSAML\Locale\Language::$defaultLanguageMap = array('nb' => 'no')

staticprivate

This is the default language map.

It is used to map languages codes from the user agent to other language codes.

Definition at line 21 of file Language.php.

$language

SimpleSAML\Locale\Language::$language = null

private

Definition at line 42 of file Language.php.

Referenced by SimpleSAML\Locale\Language\getHTTPLanguage(), SimpleSAML\Locale\Language\getLanguage(), SimpleSAML\Locale\Language\getLanguageCookie(), SimpleSAML\Locale\Language\getPosixLanguage(), SimpleSAML\Locale\Language\setLanguage(), and SimpleSAML\Locale\Language\setLanguageCookie().

$language_names

SimpleSAML\Locale\Language::$language_names

private

Definition at line 80 of file Language.php.

$languageParameterName

SimpleSAML\Locale\Language::$languageParameterName

private

Definition at line 63 of file Language.php.

Referenced by SimpleSAML\Locale\Language\getLanguageParameterName().

$languagePosixMapping

SimpleSAML\Locale\Language::$languagePosixMapping

private

Initial value:

= array(
        'no' => 'nb_NO',
        'nn' => 'nn_NO',
    )

Definition at line 127 of file Language.php.

$rtlLanguages

SimpleSAML\Locale\Language::$rtlLanguages

private

Definition at line 56 of file Language.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Locale/Language.php