HTMLPurifier_LanguageFactory Class Reference

Public Member Functions
	setup ()
	create ($config, $context, $code=false)
	getFallbackFor ($code)
	loadLanguage ($code)

Static Public Member Functions
static	instance ($prototype=null)

Public Attributes
	$cache
	$keys = array('fallback', 'messages', 'errorNames')

Protected Attributes
	$validator
	$dir
	$mergeable_keys_map = array('messages' => true, 'errorNames' => true)
	$mergeable_keys_list = array()

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

Definition at line 7259 of file HTMLPurifier.standalone.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 7337 of file HTMLPurifier.standalone.php.

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 7385 of file HTMLPurifier.standalone.php.

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 7308 of file HTMLPurifier.standalone.php.

loadLanguage()

HTMLPurifier_LanguageFactory::loadLanguage

(

$code

)

Loads language into the cache, handles message file and fallbacks

Parameters

string

$code

language code

Definition at line 7395 of file HTMLPurifier.standalone.php.

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 7324 of file HTMLPurifier.standalone.php.

Member Data Documentation

$cache

HTMLPurifier_LanguageFactory::$cache

Cache of language code information used to load HTMLPurifier_Language objects. Structure is: $factory->cache[$language_code][$key] = $value @type array

Definition at line 7267 of file HTMLPurifier.standalone.php.

$dir

HTMLPurifier_LanguageFactory::$dir

protected

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

Definition at line 7288 of file HTMLPurifier.standalone.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. @type array

Definition at line 7274 of file HTMLPurifier.standalone.php.

$mergeable_keys_list

HTMLPurifier_LanguageFactory::$mergeable_keys_list = array()

protected

Keys whose contents are a list and can be merged. @value array lookup

Definition at line 7300 of file HTMLPurifier.standalone.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. @type array

Definition at line 7294 of file HTMLPurifier.standalone.php.

$validator

HTMLPurifier_LanguageFactory::$validator

protected

Instance to validate language codes. @type HTMLPurifier_AttrDef_Lang

Definition at line 7281 of file HTMLPurifier.standalone.php.

---

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

• plugins/htmlpurifier/HTMLPurifier.standalone.php