SimpleSAML\Locale\Localization Class Reference

Collaboration diagram for SimpleSAML\Locale\Localization:

Public Member Functions
	__construct (\SimpleSAML_Configuration $configuration)
	Constructor. More...
	getLocaleDir ()
	Dump the default locale directory. More...
	getDomainLocaleDir ($domain)
	Get the default locale dir for a specific module aka. More...
	addModuleDomain ($module, $localeDir=null)
	addDomain ($localeDir, $domain)
	getLangPath ($domain=self::DEFAULT_DOMAIN)
	isI18NBackendDefault ()
	Test to check if backend is set to default. More...
	getRegisteredDomains ()
	Show which domains are registered. More...

Data Fields
const	DEFAULT_DOMAIN = 'messages'
	The default gettext domain. More...
const	SSP_I18N_BACKEND = 'SimpleSAMLphp'
	Old internationalization backend included in SimpleSAMLphp. More...
const	GETTEXT_I18N_BACKEND = 'gettext/gettext'
	An internationalization backend implemented purely in PHP. More...
	$i18nBackend
	The language backend to use. More...

Private Member Functions
	setupTranslator ()
	Setup the translator. More...
	loadGettextGettextFromPO ($domain=self::DEFAULT_DOMAIN, $catchException=true)
	Load translation domain from Gettext/Gettext using .po. More...
	setupL10N ()
	Set up L18N if configured or fallback to old system. More...

Private Attributes
	$configuration
	$localeDir
	The default locale directory. More...
	$localeDomainMap = array()
	Where specific domains are stored. More...
	$translator
	Pointer to currently active translator. More...
	$language
	Pointer to current Language. More...
	$langcode
	Language code representing the current Language. More...

Detailed Description

Definition at line 15 of file Localization.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Locale\Localization::__construct

(

\SimpleSAML_Configuration

$configuration

)

Constructor.

Parameters

\SimpleSAML_Configuration

$configuration

Configuration object

Definition at line 75 of file Localization.php.

    {
        $this->configuration = $configuration;
        $this->localeDir = $this->configuration->resolvePath('locales');
        $this->language = new Language($configuration);
        $this->langcode = $this->language->getPosixLanguage($this->language->getLanguage());
        $this->i18nBackend = $this->configuration->getString('language.i18n.backend', self::SSP_I18N_BACKEND);
        $this->setupL10N();
    }

References SimpleSAML\Locale\Localization\$configuration, and SimpleSAML\Locale\Localization\setupL10N().

Here is the call graph for this function:

Member Function Documentation

addDomain()

SimpleSAML\Locale\Localization::addDomain	(		$localeDir,
			$domain
	)

Definition at line 130 of file Localization.php.

    {
        $this->localeDomainMap[$domain] = $localeDir;
        \SimpleSAML\Logger::debug("Localization: load domain '$domain' at '$localeDir'");
        $this->loadGettextGettextFromPO($domain);
    }

References $domain, SimpleSAML\Locale\Localization\$localeDir, SimpleSAML\Logger\debug(), and SimpleSAML\Locale\Localization\loadGettextGettextFromPO().

Referenced by SimpleSAML\Locale\Localization\addModuleDomain(), and SimpleSAML\Locale\Localization\setupL10N().

Here is the call graph for this function:

Here is the caller graph for this function:

addModuleDomain()

SimpleSAML\Locale\Localization::addModuleDomain	(		$module,
			$localeDir = null
	)

Definition at line 114 of file Localization.php.

    {
        if (!$localeDir) {
            $localeDir = $this->getDomainLocaleDir($module);
        }
        $this->addDomain($localeDir, $module);
    }

References SimpleSAML\Locale\Localization\$localeDir, $module, SimpleSAML\Locale\Localization\addDomain(), and SimpleSAML\Locale\Localization\getDomainLocaleDir().

Here is the call graph for this function:

getDomainLocaleDir()

SimpleSAML\Locale\Localization::getDomainLocaleDir

(

$domain

)

Get the default locale dir for a specific module aka.

domain

Parameters

string

$domain

Name of module/domain

Definition at line 100 of file Localization.php.

    {
        $localeDir = $this->configuration->resolvePath('modules') . '/' . $domain . '/locales';
        return $localeDir;
    }

References $domain, and SimpleSAML\Locale\Localization\$localeDir.

Referenced by SimpleSAML\Locale\Localization\addModuleDomain().

Here is the caller graph for this function:

getLangPath()

SimpleSAML\Locale\Localization::getLangPath

(

$domain = self::DEFAULT_DOMAIN

)

Definition at line 143 of file Localization.php.

    {
        $langcode = explode('_', $this->langcode);
        $langcode = $langcode[0];
        $localeDir = $this->localeDomainMap[$domain];
        $langPath = $localeDir.'/'.$langcode.'/LC_MESSAGES/';
        \SimpleSAML\Logger::debug("Trying langpath for '$langcode' as '$langPath'");
        if (is_dir($langPath) && is_readable($langPath)) {
            return $langPath;
        }
 
        // Some langcodes have aliases..
        $alias = $this->language->getLanguageCodeAlias($langcode);
        if (isset($alias)) {
            $langPath = $localeDir.'/'.$alias.'/LC_MESSAGES/';
            \SimpleSAML\Logger::debug("Trying langpath for alternative '$alias' as '$langPath'");
            if (is_dir($langPath) && is_readable($langPath)) {
                return $langPath;
            }
        }
 
        // Language not found, fall back to default
        $defLangcode = $this->language->getDefaultLanguage();
        $langPath = $localeDir.'/'.$defLangcode.'/LC_MESSAGES/';
        if (is_dir($langPath) && is_readable($langPath)) {
            // Report that the localization for the preferred language is missing
            $error = "Localization not found for langcode '$langcode' at '$langPath', falling back to langcode '".
                     $defLangcode."'";
            \SimpleSAML\Logger::error($_SERVER['PHP_SELF'].' - '.$error);
            return $langPath;
        }
 
        // Locale for default language missing even, error out
        $error = "Localization directory missing/broken for langcode '$langcode' and domain '$domain'";
        \SimpleSAML\Logger::critical($_SERVER['PHP_SELF'].' - '.$error);
        throw new \Exception($error);
    }

References $_SERVER, $domain, SimpleSAML\Locale\Localization\$langcode, SimpleSAML\Locale\Localization\$localeDir, SimpleSAML\Logger\critical(), SimpleSAML\Logger\debug(), and SimpleSAML\Logger\error().

Referenced by SimpleSAML\Locale\Localization\loadGettextGettextFromPO().

Here is the call graph for this function:

Here is the caller graph for this function:

getLocaleDir()

SimpleSAML\Locale\Localization::getLocaleDir

(

)

Dump the default locale directory.

Definition at line 89 of file Localization.php.

    {
        return $this->localeDir;
    }

References SimpleSAML\Locale\Localization\$localeDir.

getRegisteredDomains()

SimpleSAML\Locale\Localization::getRegisteredDomains

(

)

Show which domains are registered.

Definition at line 261 of file Localization.php.

    {
        return $this->localeDomainMap;
    }

References SimpleSAML\Locale\Localization\$localeDomainMap.

isI18NBackendDefault()

SimpleSAML\Locale\Localization::isI18NBackendDefault

(

)

Test to check if backend is set to default.

(if false: backend unset/there's an error)

Definition at line 234 of file Localization.php.

    {
        if ($this->i18nBackend === $this::SSP_I18N_BACKEND) {
            return true;
        }
        return false;
    }

loadGettextGettextFromPO()

SimpleSAML\Locale\Localization::loadGettextGettextFromPO (   $domain = self::DEFAULT_DOMAIN,   $catchException = true  )

private

Load translation domain from Gettext/Gettext using .po.

Note: Since Twig I18N does not support domains, all loaded files are merged. Use contexts if identical strings need to be disambiguated.

Parameters

string	$domain	Name of domain
boolean	$catchException	Whether to catch an exception on error or return early

Exceptions

Exception If something is wrong with the locale file for the domain and activated language

Definition at line 203 of file Localization.php.

    {
        try {
            $langPath = $this->getLangPath($domain);
        } catch (\Exception $e) {
            $error = "Something went wrong when trying to get path to language file, cannot load domain '$domain'.";
            \SimpleSAML\Logger::error($_SERVER['PHP_SELF'].' - '.$error);
            if ($catchException) {
                // bail out!
                return;
            } else {
                throw $e;
            }
        }
        $poFile = $domain.'.po';
        $poPath = $langPath.$poFile;
        if (file_exists($poPath) && is_readable($poPath)) {
            $translations = Translations::fromPoFile($poPath);
            $this->translator->loadTranslations($translations);
        } else {
            $error = "Localization file '$poFile' not found in '$langPath', falling back to default";
            \SimpleSAML\Logger::error($_SERVER['PHP_SELF'].' - '.$error);
        }
    }

References $_SERVER, $domain, SimpleSAML\Logger\error(), and SimpleSAML\Locale\Localization\getLangPath().

Referenced by SimpleSAML\Locale\Localization\addDomain().

Here is the call graph for this function:

Here is the caller graph for this function:

setupL10N()

SimpleSAML\Locale\Localization::setupL10N ( )

private

Set up L18N if configured or fallback to old system.

Definition at line 246 of file Localization.php.

    {
        if ($this->i18nBackend === self::SSP_I18N_BACKEND) {
            \SimpleSAML\Logger::debug("Localization: using old system");
            return;
        }
 
        $this->setupTranslator();
        // setup default domain
        $this->addDomain($this->localeDir, self::DEFAULT_DOMAIN);
    }

References SimpleSAML\Locale\Localization\addDomain(), SimpleSAML\Logger\debug(), and SimpleSAML\Locale\Localization\setupTranslator().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setupTranslator()

SimpleSAML\Locale\Localization::setupTranslator ( )

private

Setup the translator.

Definition at line 185 of file Localization.php.

    {
        $this->translator = new Translator();
        $this->translator->register();
    }

Referenced by SimpleSAML\Locale\Localization\setupL10N().

Here is the caller graph for this function:

Field Documentation

$configuration

SimpleSAML\Locale\Localization::$configuration

private

Definition at line 22 of file Localization.php.

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

$i18nBackend

SimpleSAML\Locale\Localization::$i18nBackend

The language backend to use.

Definition at line 68 of file Localization.php.

$langcode

SimpleSAML\Locale\Localization::$langcode

private

Language code representing the current Language.

Definition at line 62 of file Localization.php.

Referenced by SimpleSAML\Locale\Localization\getLangPath().

$language

SimpleSAML\Locale\Localization::$language

private

Pointer to current Language.

Definition at line 57 of file Localization.php.

$localeDir

SimpleSAML\Locale\Localization::$localeDir

private

The default locale directory.

Definition at line 42 of file Localization.php.

Referenced by SimpleSAML\Locale\Localization\addDomain(), SimpleSAML\Locale\Localization\addModuleDomain(), SimpleSAML\Locale\Localization\getDomainLocaleDir(), SimpleSAML\Locale\Localization\getLangPath(), and SimpleSAML\Locale\Localization\getLocaleDir().

$localeDomainMap

SimpleSAML\Locale\Localization::$localeDomainMap = array()

private

Where specific domains are stored.

Definition at line 47 of file Localization.php.

Referenced by SimpleSAML\Locale\Localization\getRegisteredDomains().

$translator

SimpleSAML\Locale\Localization::$translator

private

Pointer to currently active translator.

Definition at line 52 of file Localization.php.

DEFAULT_DOMAIN

const SimpleSAML\Locale\Localization::DEFAULT_DOMAIN = 'messages'

The default gettext domain.

Definition at line 27 of file Localization.php.

GETTEXT_I18N_BACKEND

const SimpleSAML\Locale\Localization::GETTEXT_I18N_BACKEND = 'gettext/gettext'

An internationalization backend implemented purely in PHP.

Definition at line 37 of file Localization.php.

SSP_I18N_BACKEND

const SimpleSAML\Locale\Localization::SSP_I18N_BACKEND = 'SimpleSAMLphp'

Old internationalization backend included in SimpleSAMLphp.

Definition at line 32 of file Localization.php.

---

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

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