HTMLPurifier_LanguageFactory Class Reference

Class responsible for generating HTMLPurifier_Language objects, managing caching and fallbacks. More...

Collaboration diagram for HTMLPurifier_LanguageFactory:

Public Member Functions
	setup ()
	Sets up the singleton, much like a constructor. More...
	create ($config, $context, $code=false)
	Creates a language object, handles class fallbacks. More...
	getFallbackFor ($code)
	Returns the fallback language for language. More...
	loadLanguage ($code)
	Loads language into the cache, handles message file and fallbacks. More...

Static Public Member Functions
static	instance ($prototype=null)
	Retrieve sole instance of the factory. More...

Data Fields
	$cache
	Cache of language code information used to load HTMLPurifier_Language objects. More...
	$keys = array('fallback', 'messages', 'errorNames')
	Valid keys in the HTMLPurifier_Language object. More...

Protected Attributes
	$validator
	Instance to validate language codes. More...
	$dir
	Cached copy of dirname(FILE), directory of current file without trailing slash. More...
	$mergeable_keys_map = array('messages' => true, 'errorNames' => true)
	Keys whose contents are a hash map and can be merged. More...
	$mergeable_keys_list = array()
	Keys whose contents are a list and can be merged. More...

Detailed Description

Class responsible for generating HTMLPurifier_Language objects, managing caching and fallbacks.

Note

Thanks to MediaWiki for the general logic, although this version has been entirely rewritten

Todo:

Serialized cache for languages

Definition at line 10 of file LanguageFactory.php.

Member Function Documentation

create()

HTMLPurifier_LanguageFactory::create	(		$config,
			$context,
			$code = false
	)

Creates a language object, handles class fallbacks.

Parameters

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context
bool | string	$code	Code to override configuration with. Private parameter.

Returns

HTMLPurifier_Language

Definition at line 88 of file LanguageFactory.php.

References $code, $fallback, $file, $lang, and getFallbackFor().

    {
        // validate language code
        if ($code === false) {
            $code = $this->validator->validate(
                $config->get('Core.Language'),
                $config,
                $context
            );
        } else {
            $code = $this->validator->validate($code, $config, $context);
        }
        if ($code === false) {
            $code = 'en'; // malformed code becomes English
        }

        $pcode = str_replace('-', '_', $code); // make valid PHP classname
        static $depth = 0; // recursion protection

        if ($code == 'en') {
            $lang = new HTMLPurifier_Language($config, $context);
        } else {
            $class = 'HTMLPurifier_Language_' . $pcode;
            $file  = $this->dir . '/Language/classes/' . $code . '.php';
            if (file_exists($file) || class_exists($class, false)) {
                $lang = new $class($config, $context);
            } else {
                // Go fallback
                $raw_fallback = $this->getFallbackFor($code);
                $fallback = $raw_fallback ? $raw_fallback : 'en';
                $depth++;
                $lang = $this->create($config, $context, $fallback);
                if (!$raw_fallback) {
                    $lang->error = true;
                }
                $depth--;
            }
        }
        $lang->code = $code;
        return $lang;
    }

Here is the call graph for this function:

getFallbackFor()

HTMLPurifier_LanguageFactory::getFallbackFor

(

$code

)

Returns the fallback language for language.

Note

Loads the original language into cache

Parameters

string

$code

language code

Returns

string|bool

Definition at line 136 of file LanguageFactory.php.

References $code, and loadLanguage().

Referenced by create().

    {
        $this->loadLanguage($code);
        return $this->cache[$code]['fallback'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

instance()

static HTMLPurifier_LanguageFactory::instance (   $prototype = null )

static

Retrieve sole instance of the factory.

Parameters

HTMLPurifier_LanguageFactory

$prototype

Optional prototype to overload sole instance with, or bool true to reset to default factory.

Returns

HTMLPurifier_LanguageFactory

Definition at line 59 of file LanguageFactory.php.

Referenced by HTMLPurifier_Language\load(), and HTMLPurifier\purify().

    {
        static $instance = null;
        if ($prototype !== null) {
            $instance = $prototype;
        } elseif ($instance === null || $prototype == true) {
            $instance = new HTMLPurifier_LanguageFactory();
            $instance->setup();
        }
        return $instance;
    }

Here is the caller graph for this function:

loadLanguage()

HTMLPurifier_LanguageFactory::loadLanguage

(

$code

)

Loads language into the cache, handles message file and fallbacks.

Parameters

string

$code

language code

Definition at line 146 of file LanguageFactory.php.

References $cache, $code, $fallback, and $filename.

Referenced by getFallbackFor().

    {
        static $languages_seen = array(); // recursion guard

        // abort if we've already loaded it
        if (isset($this->cache[$code])) {
            return;
        }

        // generate filename
        $filename = $this->dir . '/Language/messages/' . $code . '.php';

        // default fallback : may be overwritten by the ensuing include
        $fallback = ($code != 'en') ? 'en' : false;

        // load primary localisation
        if (!file_exists($filename)) {
            // skip the include: will rely solely on fallback
            $filename = $this->dir . '/Language/messages/en.php';
            $cache = array();
        } else {
            include $filename;
            $cache = compact($this->keys);
        }

        // load fallback localisation
        if (!empty($fallback)) {

            // infinite recursion guard
            if (isset($languages_seen[$code])) {
                trigger_error(
                    'Circular fallback reference in language ' .
                    $code,
                    E_USER_ERROR
                );
                $fallback = 'en';
            }
            $language_seen[$code] = true;

            // load the fallback recursively
            $this->loadLanguage($fallback);
            $fallback_cache = $this->cache[$fallback];

            // merge fallback with current language
            foreach ($this->keys as $key) {
                if (isset($cache[$key]) && isset($fallback_cache[$key])) {
                    if (isset($this->mergeable_keys_map[$key])) {
                        $cache[$key] = $cache[$key] + $fallback_cache[$key];
                    } elseif (isset($this->mergeable_keys_list[$key])) {
                        $cache[$key] = array_merge($fallback_cache[$key], $cache[$key]);
                    }
                } else {
                    $cache[$key] = $fallback_cache[$key];
                }
            }
        }

        // save to cache for later retrieval
        $this->cache[$code] = $cache;
        return;
    }

Here is the caller graph for this function:

setup()

HTMLPurifier_LanguageFactory::setup

(

)

Sets up the singleton, much like a constructor.

Note

Prevents people from getting this outside of the singleton

Definition at line 75 of file LanguageFactory.php.

    {
        $this->validator = new HTMLPurifier_AttrDef_Lang();
        $this->dir = HTMLPURIFIER_PREFIX . '/HTMLPurifier';
    }

Field Documentation

$cache

HTMLPurifier_LanguageFactory::$cache

Cache of language code information used to load HTMLPurifier_Language objects.

Structure is: $factory->cache[$language_code][$key] = $value array

Definition at line 18 of file LanguageFactory.php.

Referenced by loadLanguage().

$dir

HTMLPurifier_LanguageFactory::$dir

protected

Cached copy of dirname(FILE), directory of current file without trailing slash.

string

Definition at line 39 of file LanguageFactory.php.

$keys

HTMLPurifier_LanguageFactory::$keys = array('fallback', 'messages', 'errorNames')

Valid keys in the HTMLPurifier_Language object.

Designates which variables to slurp out of a message file. array

Definition at line 25 of file LanguageFactory.php.

$mergeable_keys_list

HTMLPurifier_LanguageFactory::$mergeable_keys_list = array()

protected

Keys whose contents are a list and can be merged.

array lookup

Definition at line 51 of file LanguageFactory.php.

$mergeable_keys_map

HTMLPurifier_LanguageFactory::$mergeable_keys_map = array('messages' => true, 'errorNames' => true)

protected

Keys whose contents are a hash map and can be merged.

array

Definition at line 45 of file LanguageFactory.php.

$validator

HTMLPurifier_LanguageFactory::$validator

protected

Instance to validate language codes.

HTMLPurifier_AttrDef_Lang

Definition at line 32 of file LanguageFactory.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/LanguageFactory.php