SMW\Localizer\Localizer Class Reference

Public Member Functions
	__construct (Language $contentLanguage, NamespaceInfo $namespaceInfo)
	getContentLanguage ()
	getUserLanguage ()
	hasLocalTimeOffsetPreference ( $user=null)
	getLocalTime (DateTime $dateTime, $user=null)
	getPreferredContentLanguage ( $title=null)
	getLanguage ( $languageCode='')
	getLang ( $language='')
	getNsText ( $index)
	getCanonicalNamespaceTextById ( $index)
	getNsIndex ( $namespaceName)
	convertNamespace ( $ns, $variant=null)
	createTextWithNamespacePrefix ( $index, $text)
	getCanonicalizedUrlByNamespace ( $index, $url)
	normalizeTitleText (string $text)

Static Public Member Functions
static	getInstance ()
static	clear ()
static	isKnownLanguageTag ( $languageCode)
static	asBCP47FormattedLanguageCode ( $languageCode)
static	getLanguageCodeFrom (&$value)
static	getAnnotatedLanguageCodeFrom (&$value)
static	convertDoubleWidth ( $string)

Detailed Description

GNU GPL v2+

Since

2.1

Author

mwjames

Constructor & Destructor Documentation

__construct()

SMW\Localizer\Localizer::__construct	(	Language	$contentLanguage,
		NamespaceInfo	$namespaceInfo
	)

Since

2.1

Parameters

Language	$contentLanguage
NamespaceInfo	$namespaceInfo

Member Function Documentation

asBCP47FormattedLanguageCode()

static SMW\Localizer\Localizer::asBCP47FormattedLanguageCode (   $languageCode )

static

See also

IETF language tag / BCP 47 standards

Since

2.4

Parameters

string

$languageCode

Returns

string

clear()

static SMW\Localizer\Localizer::clear ( )

static

Since

2.1

convertDoubleWidth()

static SMW\Localizer\Localizer::convertDoubleWidth (   $string )

static

See also

Language::convertDoubleWidth

Convert double-width roman characters to single-width. range: ff00-ff5f ~= 0020-007f

Parameters

string

$string

Returns

string

convertNamespace()

SMW\Localizer\Localizer::convertNamespace	(		$ns,
			$variant = null
	)

Convert a namespace index to a string in the preferred variant

Since

3.2

Deprecated:

since 1.35 use LanguageConverter::convertNamespace instead

Parameters

int	$ns	namespace
string | null	$variant

Returns

string a string representation of the namespace

createTextWithNamespacePrefix()

SMW\Localizer\Localizer::createTextWithNamespacePrefix	(		$index,
			$text
	)

Since

2.5

Parameters

integer	$index
string	$text

Returns

string

getAnnotatedLanguageCodeFrom()

static SMW\Localizer\Localizer::getAnnotatedLanguageCodeFrom ( &  $value )

static

Since

2.4

Parameters

string

&$value

Returns

string|false

getCanonicalizedUrlByNamespace()

SMW\Localizer\Localizer::getCanonicalizedUrlByNamespace	(		$index,
			$url
	)

Since

2.5

Parameters

integer	$ns
string	$url

Returns

string

getCanonicalNamespaceTextById()

SMW\Localizer\Localizer::getCanonicalNamespaceTextById

(

$index

)

Since

2.5

Parameters

integer

$index

Returns

string

getContentLanguage()

SMW\Localizer\Localizer::getContentLanguage

(

)

Since

2.1

Returns

Language

getInstance()

static SMW\Localizer\Localizer::getInstance ( )

static

Since

2.1

Returns

Localizer

getLang()

SMW\Localizer\Localizer::getLang

(

$language = ''

)

Since

2.4

Parameters

Language | string

$languageCode

Returns

LocalLanguage

getLanguage()

SMW\Localizer\Localizer::getLanguage

(

$languageCode = ''

)

Since

2.4

Parameters

string

$languageCode

Returns

Language

getLanguageCodeFrom()

static SMW\Localizer\Localizer::getLanguageCodeFrom ( &  $value )

static

Deprecated:

2.5, use Localizer::getAnnotatedLanguageCodeFrom instead

Since

2.4

Parameters

string

&$value

Returns

string|false

getLocalTime()

SMW\Localizer\Localizer::getLocalTime	(	DateTime	$dateTime,
			$user = null
	)

Since

3.0

Parameters

DateTime	$dateTime
User | null	$user

Returns

DateTime

getNsIndex()

SMW\Localizer\Localizer::getNsIndex

(

$namespaceName

)

Since

2.1

Parameters

string

$namespaceName

Returns

integer|boolean

getNsText()

SMW\Localizer\Localizer::getNsText

(

$index

)

Since

2.1

Parameters

integer

$index

Returns

string

getPreferredContentLanguage()

SMW\Localizer\Localizer::getPreferredContentLanguage

(

$title = null

)

Note

1. If the page content language is available use it as preferred language (as it is clear that the page content was intended to be in a specific language)
2. If no page content language was assigned use the global content language

General rules:

• Special pages are in the user language
• Display of values (DV) should use the user language if available otherwise use the content language as fallback
• Storage of values (DI) should always use the content language

Notes:

• The page content language is the language in which the content of a page is written in wikitext

Since

2.4

Parameters

DIWikiPage | Title | null

$title

Returns

Language

getUserLanguage()

SMW\Localizer\Localizer::getUserLanguage

(

)

Since

2.4

Returns

Language

hasLocalTimeOffsetPreference()

SMW\Localizer\Localizer::hasLocalTimeOffsetPreference

(

$user = null

)

Since

3.0

Parameters

User | null

$user

Returns

boolean

isKnownLanguageTag()

static SMW\Localizer\Localizer::isKnownLanguageTag (   $languageCode )

static

Since

2.4

Parameters

string

$languageCode

Returns

boolean

normalizeTitleText()

SMW\Localizer\Localizer::normalizeTitleText

(

string

$text

)

Takes a text and turns it into a normalised version. This function reimplements the title normalization as done in Title.php in order to achieve conversion with less overhead. The official code could be called here if more advanced normalization is needed.

Since

3.2

Parameters

string

$text

Returns

string

---

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

• Localizer.php