MediaWiki REL1_39
|
Base class for language-specific code. More...
Public Member Functions | |
__construct ( $code=null, NamespaceInfo $namespaceInfo=null, LocalisationCache $localisationCache=null, LanguageNameUtils $langNameUtils=null, LanguageFallback $langFallback=null, LanguageConverterFactory $converterFactory=null, HookContainer $hookContainer=null, Config $config=null) | |
alignEnd () | |
Return 'right' or 'left' as appropriate alignment for line-end for this language's text direction. | |
alignStart () | |
Return 'left' or 'right' as appropriate alignment for line-start for this language's text direction. | |
autoConvert ( $text, $variant=false) | |
convert text to a variant | |
autoConvertToAllVariants ( $text) | |
convert text to all supported variants | |
caseFold ( $s) | |
Return a case-folded representation of $s. | |
checkTitleEncoding ( $s) | |
TODO: $s is not always a string per T218883. | |
commafy ( $number) | |
Adds commas to a given number. | |
commaList (array $list) | |
Take a list of strings and build a locale-friendly comma-separated list, using the local comma-separator message. | |
convert ( $text) | |
convert text to different variants of a language. | |
convertCategoryKey ( $key) | |
convertForSearchResult ( $termsArray) | |
convertGrammar ( $word, $case) | |
Grammatical transformations, needed for inflected languages Invoked by putting {{grammar:case|word}} in a message. | |
convertHtml ( $text) | |
Perform output conversion on a string, and encode for safe HTML output. | |
convertNamespace ( $ns, $variant=null) | |
Convert a namespace index to a string in the preferred variant. | |
convertPlural ( $count, $forms) | |
Plural form transformations, needed for some languages. | |
date ( $ts, $adj=false, $format=true, $timecorrection=false) | |
dateFormat ( $usePrefs=true) | |
This is meant to be used by time(), date(), and timeanddate() to get the date preference they're supposed to use, it should be used in all children. | |
digitGroupingPattern () | |
digitTransformTable () | |
embedBidi ( $text='') | |
Wraps argument with unicode control characters for directionality safety. | |
emphasize ( $text) | |
Italic is unsuitable for some languages. | |
equals (Language $lang) | |
Compare with an other language object. | |
fallback8bitEncoding () | |
firstChar ( $s) | |
Get the first character of a string. | |
formatBitrate ( $bps) | |
Format a bitrate for output, using an appropriate unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps, Ybps, Rbps or Qbps) according to the magnitude in question. | |
formatComputingNumbers ( $size, $boundary, $messageKey) | |
formatDuration ( $seconds, array $chosenIntervals=[]) | |
Takes a number of seconds and turns it into a text using values such as hours and minutes. | |
formatExpiry ( $expiry, $format=true, $infinity='infinity', $user=null) | |
Decode an expiry (block, protection, etc) which has come from the DB. | |
formatNum ( $number, $noSeparators=null) | |
Normally we output all numbers in plain en_US style, that is 293,291.235 for two hundred ninety-three thousand two hundred ninety-one point two hundred thirty-five. | |
formatNumNoSeparators ( $number) | |
Front-end for non-commafied formatNum. | |
formatSize ( $size) | |
Format a size in bytes for output, using an appropriate unit (B, KB, MB, GB, TB, PB, EB, ZB, YB, RB or QB) according to the magnitude in question. | |
formatTimePeriod ( $seconds, $format=[]) | |
Formats a time given in seconds into a string representation of that time. | |
gender ( $gender, $forms) | |
Provides an alternative text depending on specified gender. | |
getAllMessages () | |
getArrow ( $direction='forwards') | |
An arrow, depending on the language direction. | |
getBookstoreList () | |
Exports $wgBookstoreListEn. | |
getCode () | |
Get the internal language code for this language object. | |
getCompiledPluralRules () | |
Get the compiled plural rules for the language. | |
getConverter () | |
Return the LanguageConverter used in the Language. | |
getConvRuleTitle () | |
Get the conversion rule title, if any. | |
getDateFormats () | |
getDateFormatString ( $type, $pref) | |
Get a format string for a given type and preference. | |
getDatePreferenceMigrationMap () | |
getDatePreferences () | |
getDefaultDateFormat () | |
getDefaultVariant () | |
getDir () | |
Return the correct HTML 'dir' attribute value for this language. | |
getDirMark ( $opposite=false) | |
A hidden direction mark (LRM or RLM), depending on the language direction. | |
getDirMarkEntity ( $opposite=false) | |
A hidden direction mark (LRM or RLM), depending on the language direction. | |
getDurationIntervals ( $seconds, array $chosenIntervals=[]) | |
Takes a number of seconds and returns an array with a set of corresponding intervals. | |
getExtraHashOptions () | |
returns language specific options used by User::getPageRenderHash() for example, the preferred language variant | |
getFallbackLanguages () | |
getFormattedNamespaces () | |
A convenience function that returns getNamespaces() with spaces instead of underscores in values. | |
getFormattedNsText ( $index) | |
A convenience function that returns the same thing as getNsText() except with '_' changed to ' ', useful for producing output. | |
getGenderNsText ( $index, $gender) | |
Returns gender-dependent namespace alias if available. | |
getGrammarForms () | |
Get the grammar forms for the content language. | |
getGrammarTransformations () | |
Get the grammar transformations data for the language. | |
getGroupMemberName (string $group, $member) | |
Gets the localized name for a member of a group, if it exists. | |
getGroupName ( $group) | |
Gets the localized friendly name for a group, if it exists. | |
getHtmlCode () | |
Get the code in BCP 47 format which we can use inside of html lang="" tags. | |
getHumanTimestamp (MWTimestamp $time, MWTimestamp $relativeTo=null, UserIdentity $user=null) | |
Get the timestamp in a human-friendly relative format, e.g., "3 days ago". | |
getLocalNsIndex ( $text) | |
Get a namespace key by value, case insensitive. | |
getMagic ( $mw) | |
Fill a MagicWord object with data from here. | |
getMagicWords () | |
Get all magic words from cache. | |
getMessage ( $key) | |
getMessageFromDB ( $msg) | |
Get a message from the MediaWiki namespace. | |
getMonthAbbreviation ( $key) | |
getMonthAbbreviationsArray () | |
getMonthName ( $key) | |
getMonthNameGen ( $key) | |
getMonthNamesArray () | |
getNamespaceAliases () | |
getNamespaceIds () | |
getNamespaces () | |
Returns an array of localised namespaces indexed by their numbers. | |
getNsIndex ( $text) | |
Get a namespace key by value, case insensitive. | |
getNsText ( $index) | |
Get a namespace value by key. | |
getParentLanguage () | |
Get the "parent" language which has a converter to convert a "compatible" language (in another variant) to this language (eg. | |
getPluralRuleIndexNumber ( $number) | |
Find the index number of the plural rule appropriate for the given number. | |
getPluralRules () | |
Get the plural rules for the language. | |
getPluralRuleType ( $number) | |
Find the plural rule type appropriate for the given number For example, if the language is set to Arabic, getPluralType(5) should return 'few'. | |
getPluralRuleTypes () | |
Get the plural rule types for the language. | |
getPreferredVariant () | |
getSpecialPageAliases () | |
Get special page names, as an associative array canonical name => array of valid names, including aliases. | |
getURLVariant () | |
getVariantname ( $code, $usemsg=true) | |
short names for language variants used for language conversion links. | |
getVariants () | |
Get the list of variants supported by this language see sample implementation in LanguageZh.php. | |
getWeekdayAbbreviation ( $key) | |
getWeekdayName ( $key) | |
hasVariant ( $variant) | |
Strict check if the language has the specific variant. | |
hasVariants () | |
Check if this is a language with variants. | |
hasWordBreaks () | |
Most writing systems use whitespace to break up words. | |
iconv ( $in, $out, $string) | |
isRTL () | |
For right-to-left language support. | |
lc ( $str, $first=false) | |
lcfirst ( $str) | |
linkPrefixCharset () | |
A regular expression character set to match legal word-prefixing characters which should be merged onto a link of the form foo[[bar]]. | |
linkPrefixExtension () | |
To allow "foo[[bar]]" to extend the link over the whole word "foobar". | |
linkTrail () | |
A regular expression to match legal word-trailing characters which should be merged onto a link of the form [[foo]]bar. | |
listToText (array $list) | |
Take a list of strings and build a locale-friendly comma-separated list, using the local comma-separator message. | |
minimumGroupingDigits () | |
needsGenderDistinction () | |
Whether this language uses gender-dependent namespace aliases. | |
normalize ( $s) | |
Convert a UTF-8 string to normal form C. | |
normalizeForSearch ( $string) | |
Some languages have special punctuation need to be normalized. | |
parseFormattedNumber ( $number) | |
pipeList (array $list) | |
Same as commaList, but separate it with the pipe instead. | |
resetNamespaces () | |
Resets all of the namespace caches. | |
segmentByWord ( $string) | |
Some languages such as Chinese require word segmentation, Specify such segmentation when overridden in derived class. | |
segmentForDiff ( $text) | |
languages like Chinese need to be segmented in order for the diff to be of any use | |
semicolonList (array $list) | |
Take a list of strings and build a locale-friendly semicolon-separated list, using the local semicolon-separator message. | |
separatorTransformTable () | |
setNamespaces (array $namespaces) | |
Arbitrarily set all of the namespace names at once. | |
specialList ( $page, $details, $oppositedm=true) | |
Make a list item, used by various special pages. | |
sprintfDate ( $format, $ts, DateTimeZone $zone=null, &$ttl='unused') | |
This is a workalike of PHP's date() function, but with better internationalisation, a reduced set of format characters, and a better escaping format. | |
time ( $ts, $adj=false, $format=true, $timecorrection=false) | |
timeanddate ( $ts, $adj=false, $format=true, $timecorrection=false) | |
translateBlockExpiry ( $str, UserIdentity $user=null, $now=0) | |
truncateForDatabase ( $string, $length, $ellipsis='...', $adjustLength=true) | |
Truncate a string to a specified length in bytes, appending an optional string (e.g. | |
truncateForVisual ( $string, $length, $ellipsis='...', $adjustLength=true) | |
Truncate a string to a specified number of characters, appending an optional string (e.g. | |
truncateHtml ( $text, $length, $ellipsis='...') | |
Truncate a string of valid HTML to a specified length in bytes, appending an optional string (e.g. | |
uc ( $str, $first=false) | |
ucfirst ( $str) | |
ucwordbreaks ( $str) | |
capitalize words at word breaks | |
ucwords ( $str) | |
unsegmentForDiff ( $text) | |
and unsegment to show the result | |
userAdjust ( $ts, $tz=false) | |
Used by date() and time() to adjust the time output. | |
userDate ( $ts, UserIdentity $user, array $options=[]) | |
Get the formatted date for the given timestamp and formatted for the given user. | |
userTime ( $ts, UserIdentity $user, array $options=[]) | |
Get the formatted time for the given timestamp and formatted for the given user. | |
userTimeAndDate ( $ts, UserIdentity $user, array $options=[]) | |
Get the formatted date and time for the given timestamp and formatted for the given user. | |
Static Public Member Functions | |
static | factory ( $code) |
Get a cached or new language object for a given language code. | |
static | fetchLanguageName ( $code, $inLanguage=LanguageNameUtils::AUTONYMS, $include=LanguageNameUtils::ALL) |
static | fetchLanguageNames ( $inLanguage=LanguageNameUtils::AUTONYMS, $include=LanguageNameUtils::DEFINED) |
Get an array of language names, indexed by code. | |
static | getCodeFromFileName ( $filename, $prefix='Language', $suffix='.php') |
Get the language code from a file name. | |
static | getFallbackFor ( $code) |
Get the first fallback for a given language. | |
static | getFallbacksFor ( $code, $mode=LanguageFallback::MESSAGES) |
Get the ordered list of fallback languages. | |
static | getFallbacksIncludingSiteLanguage ( $code) |
Get the ordered list of fallback languages, ending with the fallback language chain for the site language. | |
static | getFileName ( $prefix, $code, $suffix='.php') |
Get the name of a file for a certain language code. | |
static | getJsonMessagesFileName ( $code) |
static | getLocalisationCache () |
static | getMessageFor ( $key, $code) |
Get a message for a given language. | |
static | getMessageKeysFor ( $code) |
Get all message keys for a given language. | |
static | getMessagesFileName ( $code) |
static | getMessagesFor ( $code) |
Get all messages for a given language WARNING: this may take a long time. | |
static | hebrewNumeral ( $num) |
Hebrew Gematria number formatting up to 9999. | |
static | isKnownLanguageTag ( $tag) |
Returns true if a language code is an IETF tag known to MediaWiki. | |
static | isSupportedLanguage ( $code) |
Checks whether any localisation is available for that language tag in MediaWiki (MessagesXx.php exists). | |
static | isValidBuiltInCode ( $code) |
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki, via Messages*.php or *.json. | |
static | isValidCode ( $code) |
Returns true if a language code string is of a valid form, whether or not it exists. | |
static | isWellFormedLanguageTag ( $code, $lenient=false) |
Returns true if a language code string is a well-formed language tag according to RFC 5646. | |
static | romanNumeral ( $num) |
Roman number formatting up to 10000. | |
Public Attributes | |
string[][] | $dateFormatStrings = [] |
memoize | |
string | $mCode |
string[][] null | $mExtendedSpecialPageAliases |
memoize | |
$mMagicExtensions = [] | |
const | ALL = LanguageNameUtils::ALL |
Return all known languages in fetchLanguageName(s). | |
const | HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES |
const | HEBREW_CALENDAR_MONTHS_MESSAGES |
const | HIJRI_CALENDAR_MONTH_MESSAGES |
const | IRANIAN_CALENDAR_MONTHS_MESSAGES |
const | MESSAGES_FALLBACKS = LanguageFallback::MESSAGES |
Return a fallback chain for messages in getFallbacksFor. | |
const | MONTH_ABBREVIATED_MESSAGES |
const | MONTH_GENITIVE_MESSAGES |
const | MONTH_MESSAGES |
const | STRICT_FALLBACKS = LanguageFallback::STRICT |
Return a strict fallback chain in getFallbacksFor. | |
const | SUPPORTED = LanguageNameUtils::SUPPORTED |
Return in fetchLanguageName(s) only the languages for which we have at least some localisation. | |
const | WEEKDAY_ABBREVIATED_MESSAGES |
const | WEEKDAY_MESSAGES |
Static Public Attributes | |
static int[] | $durationIntervals = self::DURATION_INTERVALS |
static | $mMonthAbbrevMsgs = self::MONTH_ABBREVIATED_MESSAGES |
static | $mMonthMsgs = self::MONTH_MESSAGES |
Protected Member Functions | |
getHookContainer () | |
Get a HookContainer, for hook metadata and running extension hooks. | |
getHookRunner () | |
Get a HookRunner, for running core hooks. | |
handleExplicitPluralForms ( $count, array $forms) | |
Handles explicit plural forms for Language::convertPlural() | |
mbUpperChar ( $char) | |
Convert character to uppercase, allowing overrides of the default mb_upper behaviour, which is buggy in many ways. | |
msg ( $msg,... $params) | |
Get message object in this language. | |
preConvertPlural ($forms, $count) | |
Checks that convertPlural was given an array and pads it to requested amount of forms by copying the last one. | |
removeBadCharFirst ( $string) | |
Remove bytes that represent an incomplete Unicode character at the start of string (e.g. | |
removeBadCharLast ( $string) | |
Remove bytes that represent an incomplete Unicode character at the end of string (e.g. | |
transformUsingPairFile (string $dataClass, string $input) | |
Transform a string using serialized data stored in the given file (which must be in the serialized subdirectory of $IP). | |
Static Protected Member Functions | |
static | convertDoubleWidth ( $string) |
convert double-width roman characters to single-width. | |
static | insertSpace ( $string, $pattern) |
Protected Attributes | |
array< string, int > null | $mNamespaceIds |
Indexed by localized lower-cased namespace name. | |
array< string, int > null | $namespaceAliases |
Map from alias to namespace ID. | |
array< int, string > null | $namespaceNames |
Indexed by numeric namespace ID. | |
const | DURATION_INTERVALS |
Base class for language-specific code.
See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
Definition at line 53 of file Language.php.
Language::__construct | ( | $code = null, | |
NamespaceInfo | $namespaceInfo = null, | ||
LocalisationCache | $localisationCache = null, | ||
LanguageNameUtils | $langNameUtils = null, | ||
LanguageFallback | $langFallback = null, | ||
LanguageConverterFactory | $converterFactory = null, | ||
HookContainer | $hookContainer = null, | ||
Config | $config = null ) |
string | null | $code | Which code to use. Passing null is deprecated in 1.35. |
NamespaceInfo | null | $namespaceInfo | |
LocalisationCache | null | $localisationCache | |
LanguageNameUtils | null | $langNameUtils | |
LanguageFallback | null | $langFallback | |
LanguageConverterFactory | null | $converterFactory | |
HookContainer | null | $hookContainer | |
Config | null | $config |
Definition at line 403 of file Language.php.
Language::alignEnd | ( | ) |
Return 'right' or 'left' as appropriate alignment for line-end for this language's text direction.
Should be equivalent to CSS3 'end' text-align value....
Definition at line 3025 of file Language.php.
Language::alignStart | ( | ) |
Return 'left' or 'right' as appropriate alignment for line-start for this language's text direction.
Should be equivalent to CSS3 'start' text-align value....
Definition at line 3013 of file Language.php.
Language::autoConvert | ( | $text, | |
$variant = false ) |
convert text to a variant
string | $text | text to convert |
string | false | $variant | variant to convert to, or false to use the user's preferred variant (if logged in), or the project default variant |
Definition at line 4150 of file Language.php.
Language::autoConvertToAllVariants | ( | $text | ) |
convert text to all supported variants
string | $text |
Definition at line 4162 of file Language.php.
Referenced by LanguageZh\convertForSearchResult().
Language::caseFold | ( | $s | ) |
Return a case-folded representation of $s.
This is a representation such that caseFold($s1)==caseFold($s2) if $s1 and $s2 are the same except for the case of their characters. It is not necessary for the value returned to make sense when displayed.
Do not perform any other normalisation in this function. If a caller uses this function when it should be using a more general normalisation function, then fix the caller.
string | $s |
Definition at line 2794 of file Language.php.
References $s.
Language::checkTitleEncoding | ( | $s | ) |
TODO: $s is not always a string per T218883.
string | $s |
Definition at line 2803 of file Language.php.
References $s, and StringUtils\isUtf8().
Language::commafy | ( | $number | ) |
Adds commas to a given number.
NumberFormatting class is used when available for correct implementation as per tr35 specification of unicode.
string | null | $number | Expected to be a numeric string without (thousand) group separators. Decimal separator, if present, must be a dot. Any non-string will be cast to string. |
Definition at line 3391 of file Language.php.
References wfDeprecated().
Language::commaList | ( | array | $list | ) |
Take a list of strings and build a locale-friendly comma-separated list, using the local comma-separator message.
string[] | $list | Array of strings to put in a comma list |
Definition at line 3461 of file Language.php.
References wfMessage().
Language::convert | ( | $text | ) |
convert text to different variants of a language.
string | $text | Content that has been already escaped for use in HTML |
Definition at line 4180 of file Language.php.
Language::convertCategoryKey | ( | $key | ) |
string | $key |
Definition at line 4244 of file Language.php.
|
staticprotected |
convert double-width roman characters to single-width.
range: ff00-ff5f ~= 0020-007f
string | $string |
Definition at line 2863 of file Language.php.
Referenced by LanguageZh\convertForSearchResult(), and LanguageYue\normalizeForSearch().
Language::convertForSearchResult | ( | $termsArray | ) |
string[] | $termsArray |
Reimplemented in LanguageZh.
Definition at line 2893 of file Language.php.
Language::convertGrammar | ( | $word, | |
$case ) |
Grammatical transformations, needed for inflected languages Invoked by putting {{grammar:case|word}} in a message.
string | $word | |
string | $case |
Reimplemented in LanguageBs, LanguageCu, LanguageDsb, LanguageFi, LanguageGa, LanguageHsb, LanguageHu, LanguageHy, LanguageKaa, LanguageKk, LanguageKsh, LanguageLa, LanguageOs, LanguageSl, and LanguageTyv.
Definition at line 3835 of file Language.php.
References wfLogWarning().
Language::convertHtml | ( | $text | ) |
Perform output conversion on a string, and encode for safe HTML output.
string | $text | Text to be converted |
Definition at line 4234 of file Language.php.
Language::convertNamespace | ( | $ns, | |
$variant = null ) |
Convert a namespace index to a string in the preferred variant.
int | $ns | namespace index (https://www.mediawiki.org/wiki/Manual:Namespace) |
string | null | $variant | variant to convert to, or null to use the user's preferred variant (if logged in), or the project default variant |
Definition at line 4194 of file Language.php.
Language::convertPlural | ( | $count, | |
$forms ) |
Plural form transformations, needed for some languages.
For example, there are 3 form of plural in Russian and Polish, depending on "count mod 10". See [[w:Plural]] For English it is pretty simple.
Invoked by putting {{plural:count|wordform1|wordform2}} or {{plural:count|wordform1|wordform2|wordform3}}
Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
int | $count | Non-localized number |
array | $forms | Different plural forms |
Reimplemented in LanguageKsh.
Definition at line 3972 of file Language.php.
Language::date | ( | $ts, | |
$adj = false, | |||
$format = true, | |||
$timecorrection = false ) |
string | $ts | The time format which needs to be turned into a date('YmdHis') format with wfTimestamp(TS_MW,$ts) |
bool | $adj | Whether to adjust the time output according to the user configured offset ($timecorrection) |
mixed | $format | True to use user's date format preference |
string | false | $timecorrection | The time offset as returned by validateTimeZone() in Special:Preferences |
Reimplemented in LanguageWa.
Definition at line 2205 of file Language.php.
References wfTimestamp().
Referenced by LanguageFi\translateBlockExpiry().
Language::dateFormat | ( | $usePrefs = true | ) |
This is meant to be used by time(), date(), and timeanddate() to get the date preference they're supposed to use, it should be used in all children.
function timeanddate([...], $format = true) { $datePreference = $this->dateFormat($format); [...] }
int | string | bool | $usePrefs | If true, the user's preference is used if false, the site/language default is used if int/string, assumed to be a format. |
Definition at line 2137 of file Language.php.
Referenced by LanguageWa\date(), and LanguageWa\timeanddate().
Language::digitGroupingPattern | ( | ) |
Definition at line 3403 of file Language.php.
Language::digitTransformTable | ( | ) |
Definition at line 3410 of file Language.php.
Language::embedBidi | ( | $text = '' | ) |
Wraps argument with unicode control characters for directionality safety.
This solves the problem where directionality-neutral characters at the edge of the argument string get interpreted with the wrong directionality from the enclosing context, giving renderings that look corrupted like "(Ben_(WMF".
The wrapping is LRE...PDF or RLE...PDF, depending on the detected directionality of the argument string, using the BIDI algorithm's own "First strong directional codepoint" rule. Essentially, this works round the fact that there is no embedding equivalent of U+2068 FSI (isolation with heuristic direction inference). The latter is cleaner but still not widely supported.
string | $text | Text to wrap |
Definition at line 4043 of file Language.php.
Language::emphasize | ( | $text | ) |
Italic is unsuitable for some languages.
string | $text | The text to be emphasized. |
Reimplemented in LanguageJa.
Definition at line 3146 of file Language.php.
Language::equals | ( | Language | $lang | ) |
Compare with an other language object.
Language | $lang |
Definition at line 4336 of file Language.php.
References $lang.
|
static |
Get a cached or new language object for a given language code.
string | $code |
MWException | if the language code is invalid |
Definition at line 298 of file Language.php.
Language::fallback8bitEncoding | ( | ) |
Definition at line 2817 of file Language.php.
|
static |
string | $code | The code of the language for which to get the name |
null | string | $inLanguage | Code of language in which to return the name (LanguageNameUtils::AUTONYMS for autonyms) |
string | $include | See fetchLanguageNames() |
Definition at line 826 of file Language.php.
|
static |
Get an array of language names, indexed by code.
null | string | $inLanguage | Code of language in which to return the names Use LanguageNameUtils::AUTONYMS for autonyms (native names) |
string | $include | One of: LanguageNameUtils::AUTONYMS all available languages LanguageNameUtils::DEFINED only if the language is defined in MediaWiki or wgExtraLanguageNames (default) LanguageNameUtils::SUPPORTED only if the language is in LanguageNameUtils::DEFINED and has a message file |
Definition at line 809 of file Language.php.
Language::firstChar | ( | $s | ) |
Get the first character of a string.
string | $s |
Definition at line 2905 of file Language.php.
References $s.
Language::formatBitrate | ( | $bps | ) |
Format a bitrate for output, using an appropriate unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps, Ybps, Rbps or Qbps) according to the magnitude in question.
This use base 1000. For base 1024 use formatSize(), for another base see formatComputingNumbers().
int | $bps |
Definition at line 4688 of file Language.php.
Language::formatComputingNumbers | ( | $size, | |
$boundary, | |||
$messageKey ) |
int | $size | Size of the unit |
int | $boundary | Size boundary (1000, or 1024 in most cases) |
string | $messageKey | Message key to be used |
Definition at line 4701 of file Language.php.
Language::formatDuration | ( | $seconds, | |
array | $chosenIntervals = [] ) |
Takes a number of seconds and turns it into a text using values such as hours and minutes.
int | $seconds | The amount of seconds. |
array | $chosenIntervals | The intervals to enable. |
Reimplemented in LanguageZh_hans.
Definition at line 2263 of file Language.php.
References wfMessage().
Language::formatExpiry | ( | $expiry, | |
$format = true, | |||
$infinity = 'infinity', | |||
$user = null ) |
Decode an expiry (block, protection, etc) which has come from the DB.
string | $expiry | Database expiry String |
true | int | $format | True to process using language functions, or TS_ constant to return the expiry in a given timestamp |
string | $infinity | If $format is not true, use this string for infinite expiry |
UserIdentity | null | $user | If $format is true, use this user for date format |
Definition at line 4547 of file Language.php.
References DB_REPLICA, wfGetDB(), and wfTimestamp().
Language::formatNum | ( | $number, | |
$noSeparators = null ) |
Normally we output all numbers in plain en_US style, that is 293,291.235 for two hundred ninety-three thousand two hundred ninety-one point two hundred thirty-five.
However this is not suitable for all languages, some such as Bengali (bn) want ২,৯৩,২৯১.২৩৫ and others such as Icelandic just want to use commas instead of dots, and dots instead of commas like "293.291,235".
An example of this function being called: wfMessage( 'message' )->numParams( $num )->text()
See $separatorTransformTable on MessageIs.php for the , => . and . => , implementation.
string | int | float | $number | Expected to be a pre-formatted (e.g. leading zeros, number of decimal places) numeric string. Any non-string will be cast to string. |
bool | null | $noSeparators | Set to true for special numbers like dates (deprecated: use ::formatNumNoSeparators instead of this param) |
Reimplemented in LanguageKm, and LanguageMy.
Definition at line 3172 of file Language.php.
References wfDeprecated().
Language::formatNumNoSeparators | ( | $number | ) |
Front-end for non-commafied formatNum.
string | int | float | $number | The string to be formatted, should be an integer or a floating point number. |
Definition at line 3340 of file Language.php.
Referenced by LanguageKm\formatNum(), and LanguageMy\formatNum().
Language::formatSize | ( | $size | ) |
Format a size in bytes for output, using an appropriate unit (B, KB, MB, GB, TB, PB, EB, ZB, YB, RB or QB) according to the magnitude in question.
This method use base 1024. For base 1000 use formatBitrate(), for another base see formatComputingNumbers()
int | $size | Size to format |
Definition at line 4739 of file Language.php.
Language::formatTimePeriod | ( | $seconds, | |
$format = [] ) |
Formats a time given in seconds into a string representation of that time.
int | float | $seconds | |
array | $format | An optional argument that formats the returned string in different ways: If $format['avoid'] === 'avoidhours': don't show hours, just show days If $format['avoid'] === 'avoidseconds': don't show seconds if $seconds >= 1 hour, If $format['avoid'] === 'avoidminutes': don't show seconds/minutes if $seconds > 48 hours, If $format['noabbrevs'] is true: use 'seconds' and friends instead of 'seconds-abbrev' and friends. |
Definition at line 4581 of file Language.php.
References $s, and wfMessage().
Language::gender | ( | $gender, | |
$forms ) |
Provides an alternative text depending on specified gender.
Usage {{gender:username|masculine|feminine|unknown}}. username is optional, in which case the gender of current user is used, but only in (some) interface messages; otherwise default gender is used.
If no forms are given, an empty string is returned. If only one form is given, it will be returned unconditionally. These details are implied by the caller and cannot be overridden in subclasses.
If three forms are given, the default is to use the third (unknown) form. If fewer than three forms are given, the default is to use the first (masculine) form. These details can be overridden in subclasses.
string | $gender | |
array | $forms |
Definition at line 3943 of file Language.php.
Language::getAllMessages | ( | ) |
Definition at line 2601 of file Language.php.
Language::getArrow | ( | $direction = 'forwards' | ) |
An arrow, depending on the language direction.
string | $direction | The direction of the arrow: forwards (default), backwards, left, right, up, down. |
Definition at line 3073 of file Language.php.
Language::getBookstoreList | ( | ) |
Language::getCode | ( | ) |
Get the internal language code for this language object.
NOTE: The return value of this function is NOT HTML-safe and must be escaped with htmlspecialchars() or similar
Definition at line 4348 of file Language.php.
Referenced by AllMessagesTablePager\__construct(), MessageCache\__construct(), LanguageHu\convertGrammar(), and Message\inLanguage().
|
static |
Get the language code from a file name.
Inverse of getFileName()
string | $filename | $prefix . $languageCode . $suffix |
string | $prefix | Prefix before the language code |
string | $suffix | Suffix after the language code |
Definition at line 4376 of file Language.php.
Language::getCompiledPluralRules | ( | ) |
Get the compiled plural rules for the language.
Definition at line 4782 of file Language.php.
Language::getConverter | ( | ) |
Return the LanguageConverter used in the Language.
Definition at line 4136 of file Language.php.
Referenced by LanguageZh\convertForSearchResult(), getNamespaceAliases(), and LanguageZh\normalizeForSearch().
Language::getConvRuleTitle | ( | ) |
Get the conversion rule title, if any.
Definition at line 4773 of file Language.php.
Language::getDateFormats | ( | ) |
Definition at line 771 of file Language.php.
Language::getDateFormatString | ( | $type, | |
$pref ) |
Get a format string for a given type and preference.
string | $type | May be 'date', 'time', 'both', or 'pretty'. |
string | $pref | The format name as it appears in Messages*.php under $datePreferences. |
Definition at line 2169 of file Language.php.
References $type.
Language::getDatePreferenceMigrationMap | ( | ) |
Definition at line 790 of file Language.php.
Language::getDatePreferences | ( | ) |
Definition at line 764 of file Language.php.
Language::getDefaultDateFormat | ( | ) |
Definition at line 778 of file Language.php.
Language::getDefaultVariant | ( | ) |
Definition at line 4272 of file Language.php.
Language::getDir | ( | ) |
Return the correct HTML 'dir' attribute value for this language.
Definition at line 3001 of file Language.php.
Language::getDirMark | ( | $opposite = false | ) |
A hidden direction mark (LRM or RLM), depending on the language direction.
This function produces them as invisible Unicode characters and the output may be hard to read and debug, so it should only be used when the output is plain text or can be escaped. When the output is HTML, use getDirMarkEntity() instead.
bool | $opposite | Get the direction mark opposite to your language |
Definition at line 3057 of file Language.php.
Language::getDirMarkEntity | ( | $opposite = false | ) |
A hidden direction mark (LRM or RLM), depending on the language direction.
Unlike getDirMark(), this function returns the character as an HTML entity. This function should be used when the output is guaranteed to be HTML, because it makes the output HTML source code more readable. When the output is plain text or can be escaped, getDirMark() should be used.
bool | $opposite | Get the direction mark opposite to your language |
Definition at line 3040 of file Language.php.
Language::getDurationIntervals | ( | $seconds, | |
array | $chosenIntervals = [] ) |
Takes a number of seconds and returns an array with a set of corresponding intervals.
For example 65 will be turned into [ minutes => 1, seconds => 5 ].
int | $seconds | The amount of seconds. |
array | $chosenIntervals | The intervals to enable. |
Definition at line 2289 of file Language.php.
Referenced by LanguageZh_hans\formatDuration().
Language::getExtraHashOptions | ( | ) |
returns language specific options used by User::getPageRenderHash() for example, the preferred language variant
Definition at line 4292 of file Language.php.
|
static |
Get the first fallback for a given language.
string | $code |
Definition at line 4431 of file Language.php.
Language::getFallbackLanguages | ( | ) |
|
static |
Get the ordered list of fallback languages.
string | $code | Language code |
int | $mode | Fallback mode, either MESSAGES_FALLBACKS (which always falls back to 'en'), or STRICT_FALLBACKS (which only falls back to 'en' when explicitly defined) |
InvalidArgumentException |
Definition at line 4448 of file Language.php.
|
static |
Get the ordered list of fallback languages, ending with the fallback language chain for the site language.
string | $code | Language code |
Definition at line 4462 of file Language.php.
|
static |
Get the name of a file for a certain language code.
string | $prefix | Prepend this to the filename |
string | $code | Language code |
string | $suffix | Append this to the filename |
MWException |
Definition at line 4396 of file Language.php.
Language::getFormattedNamespaces | ( | ) |
A convenience function that returns getNamespaces() with spaces instead of underscores in values.
Useful for producing output to be displayed e.g. in <select>
forms.
Definition at line 547 of file Language.php.
References getNamespaces().
Language::getFormattedNsText | ( | $index | ) |
A convenience function that returns the same thing as getNsText() except with '_' changed to ' ', useful for producing output.
$mw_ns = $lang->getFormattedNsText( NS_MEDIAWIKI_TALK ); echo $mw_ns; // prints 'MediaWiki talk'
int | $index | The array key of the namespace to return |
Definition at line 586 of file Language.php.
References getNsText().
Language::getGenderNsText | ( | $index, | |
$gender ) |
Returns gender-dependent namespace alias if available.
See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
int | $index | Namespace index |
string | $gender | Gender key (male, female... ) |
Definition at line 599 of file Language.php.
References getNsText().
Language::getGrammarForms | ( | ) |
Get the grammar forms for the content language.
Definition at line 3886 of file Language.php.
Language::getGrammarTransformations | ( | ) |
Get the grammar transformations data for the language.
Used like grammar forms, with {{GRAMMAR}} and cases, but uses pairs of regexes and replacements instead of code.
MWException |
Definition at line 3906 of file Language.php.
References $IP.
Language::getGroupMemberName | ( | string | $group, |
$member ) |
Gets the localized name for a member of a group, if it exists.
For example, "administrator" or "bureaucrat"
string | $group | Internal group name |
string | UserIdentity | $member |
Definition at line 2582 of file Language.php.
Language::getGroupName | ( | $group | ) |
Gets the localized friendly name for a group, if it exists.
For example, "Administrators" or "Bureaucrats"
string | $group | Internal group name |
Definition at line 2569 of file Language.php.
|
protected |
Get a HookContainer, for hook metadata and running extension hooks.
Definition at line 4871 of file Language.php.
|
protected |
Get a HookRunner, for running core hooks.
Definition at line 4883 of file Language.php.
Referenced by getNamespaces().
Language::getHtmlCode | ( | ) |
Get the code in BCP 47 format which we can use inside of html lang="" tags.
NOTE: The return value of this function is NOT HTML-safe and must be escaped with htmlspecialchars() or similar.
Definition at line 4362 of file Language.php.
Language::getHumanTimestamp | ( | MWTimestamp | $time, |
MWTimestamp | $relativeTo = null, | ||
UserIdentity | $user = null ) |
Get the timestamp in a human-friendly relative format, e.g., "3 days ago".
Determine the difference between the timestamp and the current time, and generate a readable timestamp by returning "<N> <units> ago", where the largest possible unit is used.
MWTimestamp | $time | |
MWTimestamp | null | $relativeTo | The base timestamp to compare to (defaults to now) |
UserIdentity | null | $user | User the timestamp is being generated for (or null to use main context's user) |
Definition at line 2450 of file Language.php.
References MWTimestamp\offsetForUser().
|
static |
string | $code |
MWException |
Definition at line 4418 of file Language.php.
|
static |
Definition at line 387 of file Language.php.
Language::getLocalNsIndex | ( | $text | ) |
Get a namespace key by value, case insensitive.
Only matches namespace names for the current language, not the canonical ones defined in Namespace.php.
string | $text |
Definition at line 639 of file Language.php.
References getNamespaceIds(), and lc().
Language::getMagic | ( | $mw | ) |
Fill a MagicWord object with data from here.
MagicWord | $mw |
Definition at line 3112 of file Language.php.
References wfWarn().
Language::getMagicWords | ( | ) |
Language::getMessage | ( | $key | ) |
string | $key |
Reimplemented in LanguageQqx.
Definition at line 2594 of file Language.php.
|
static |
Get a message for a given language.
string | $key | |
string | $code |
Definition at line 4492 of file Language.php.
Language::getMessageFromDB | ( | $msg | ) |
Get a message from the MediaWiki namespace.
string | $msg | Message name |
Definition at line 841 of file Language.php.
Referenced by getVariantname().
|
static |
Get all message keys for a given language.
This is a faster alternative to array_keys( Language::getMessagesFor( $code ) )
string | $code | Language code |
Definition at line 4506 of file Language.php.
|
static |
string | $code |
Definition at line 4406 of file Language.php.
|
static |
Get all messages for a given language WARNING: this may take a long time.
If you just need all message keys but need the contents of only a few messages, consider using getMessageKeysFor().
string | $code |
Definition at line 4478 of file Language.php.
Language::getMonthAbbreviation | ( | $key | ) |
Language::getMonthAbbreviationsArray | ( | ) |
Definition at line 894 of file Language.php.
Language::getMonthName | ( | $key | ) |
int | $key | Number from 1 to 12 |
Definition at line 860 of file Language.php.
Referenced by LanguageWa\date().
Language::getMonthNameGen | ( | $key | ) |
Language::getMonthNamesArray | ( | ) |
Definition at line 867 of file Language.php.
Language::getNamespaceAliases | ( | ) |
Definition at line 649 of file Language.php.
References $namespaceAliases, getConverter(), getNamespaces(), getVariants(), and NS_PROJECT_TALK.
Referenced by getNamespaceIds().
Language::getNamespaceIds | ( | ) |
Definition at line 706 of file Language.php.
References getNamespaceAliases(), getNamespaces(), and lc().
Referenced by getLocalNsIndex(), and getNsIndex().
Language::getNamespaces | ( | ) |
Returns an array of localised namespaces indexed by their numbers.
If the namespace is not available in localised form, it will be included in English.
Definition at line 483 of file Language.php.
References $namespaceNames, getHookRunner(), NS_PROJECT, and NS_PROJECT_TALK.
Referenced by getFormattedNamespaces(), getNamespaceAliases(), getNamespaceIds(), and getNsText().
Language::getNsIndex | ( | $text | ) |
Get a namespace key by value, case insensitive.
Canonical namespace names override custom ones defined for the current language.
string | $text |
Definition at line 730 of file Language.php.
References getNamespaceIds(), and lc().
Language::getNsText | ( | $index | ) |
Get a namespace value by key.
Namespace name uses underscores (not spaces), e.g. 'MediaWiki_talk'.
$mw_ns = $lang->getNsText( NS_MEDIAWIKI_TALK ); echo $mw_ns; // prints 'MediaWiki_talk'
int | $index | The array key of the namespace to return |
Definition at line 568 of file Language.php.
References getNamespaces().
Referenced by getFormattedNsText(), and getGenderNsText().
Language::getParentLanguage | ( | ) |
Get the "parent" language which has a converter to convert a "compatible" language (in another variant) to this language (eg.
zh for zh-cn, but not en for en-gb).
Definition at line 4324 of file Language.php.
Language::getPluralRuleIndexNumber | ( | $number | ) |
Find the index number of the plural rule appropriate for the given number.
int | $number |
Definition at line 4845 of file Language.php.
Language::getPluralRules | ( | ) |
Get the plural rules for the language.
Definition at line 4803 of file Language.php.
Language::getPluralRuleType | ( | $number | ) |
Find the plural rule type appropriate for the given number For example, if the language is set to Arabic, getPluralType(5) should return 'few'.
int | $number |
Definition at line 4859 of file Language.php.
Language::getPluralRuleTypes | ( | ) |
Get the plural rule types for the language.
Definition at line 4824 of file Language.php.
Language::getPreferredVariant | ( | ) |
Definition at line 4264 of file Language.php.
Referenced by LanguageKk\convertGrammar(), LanguageKk\lcfirst(), and LanguageKk\ucfirst().
Language::getSpecialPageAliases | ( | ) |
Get special page names, as an associative array canonical name => array of valid names, including aliases.
Definition at line 3129 of file Language.php.
Language::getURLVariant | ( | ) |
Definition at line 4280 of file Language.php.
Language::getVariantname | ( | $code, | |
$usemsg = true ) |
short names for language variants used for language conversion links.
string | $code | |
bool | $usemsg | Use the "variantname-xyz" message if it exists |
Definition at line 747 of file Language.php.
References getMessageFromDB(), and wfMessage().
Language::getVariants | ( | ) |
Get the list of variants supported by this language see sample implementation in LanguageZh.php.
Definition at line 4256 of file Language.php.
Referenced by getNamespaceAliases().
Language::getWeekdayAbbreviation | ( | $key | ) |
Language::getWeekdayName | ( | $key | ) |
|
protected |
Handles explicit plural forms for Language::convertPlural()
In {{PLURAL:$1|0=nothing|one|many}}, 0=nothing will be returned if $1 equals zero. If an explicitly defined plural form matches the $count, then string value returned, otherwise array returned for further consideration by CLDR rules or overridden convertPlural().
int | $count | Non-localized number |
string[] | $forms | Different plural forms |
Definition at line 4002 of file Language.php.
Referenced by LanguageKsh\convertPlural().
Language::hasVariant | ( | $variant | ) |
Strict check if the language has the specific variant.
Compare to LanguageConverter::validateVariant() which does a more lenient check and attempts to coerce the given code to a valid one.
string | $variant |
Definition at line 4221 of file Language.php.
Language::hasVariants | ( | ) |
Check if this is a language with variants.
Definition at line 4205 of file Language.php.
Language::hasWordBreaks | ( | ) |
Most writing systems use whitespace to break up words.
Some languages such as Chinese don't conventionally do this, which requires special handling when breaking up words for searching etc.
Reimplemented in LanguageYue, and LanguageZh_hans.
Definition at line 2829 of file Language.php.
|
static |
Hebrew Gematria number formatting up to 9999.
int | $num |
Definition at line 1966 of file Language.php.
Language::iconv | ( | $in, | |
$out, | |||
$string ) |
string | $in | |
string | $out | |
string | $string |
Definition at line 2611 of file Language.php.
|
staticprotected |
string | $string | |
string | $pattern |
Definition at line 2883 of file Language.php.
Referenced by LanguageJa\segmentByWord(), LanguageYue\segmentByWord(), and LanguageZh_hans\segmentByWord().
|
static |
Returns true if a language code is an IETF tag known to MediaWiki.
string | $tag |
Definition at line 378 of file Language.php.
Language::isRTL | ( | ) |
|
static |
Checks whether any localisation is available for that language tag in MediaWiki (MessagesXx.php exists).
string | $code | Language tag (in lower case) |
Definition at line 311 of file Language.php.
|
static |
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki, via Messages*.php or *.json.
string | $code |
Definition at line 363 of file Language.php.
|
static |
Returns true if a language code string is of a valid form, whether or not it exists.
This includes codes which are used solely for customisation via the MediaWiki namespace.
string | $code |
Definition at line 348 of file Language.php.
|
static |
Returns true if a language code string is a well-formed language tag according to RFC 5646.
This function only checks well-formedness; it doesn't check that language, script or variant codes actually exist in the repositories.
Based on regexes by Mark Davis of the Unicode Consortium: https://github.com/unicode-org/icu/blob/37e295627156bc334e1f1e88807025fac984da0e/icu4j/main/tests/translit/src/com/ibm/icu/dev/test/translit/langtagRegex.txt
string | $code | |
bool | $lenient | Whether to allow '_' as separator. The default is only '-'. |
Definition at line 332 of file Language.php.
Language::lc | ( | $str, | |
$first = false ) |
string | $str | |
bool | $first | Whether to lowercase only the first character |
Definition at line 2704 of file Language.php.
Referenced by getLocalNsIndex(), getNamespaceIds(), getNsIndex(), LanguageTr\lcfirst(), and LanguageTr\ucfirst().
Language::lcfirst | ( | $str | ) |
string | $str |
Reimplemented in LanguageKaa, LanguageKk, and LanguageTr.
Definition at line 2681 of file Language.php.
Language::linkPrefixCharset | ( | ) |
A regular expression character set to match legal word-prefixing characters which should be merged onto a link of the form foo[[bar]].
Definition at line 4312 of file Language.php.
Language::linkPrefixExtension | ( | ) |
To allow "foo[[bar]]" to extend the link over the whole word "foobar".
Definition at line 3095 of file Language.php.
Language::linkTrail | ( | ) |
A regular expression to match legal word-trailing characters which should be merged onto a link of the form [[foo]]bar.
Definition at line 4302 of file Language.php.
Language::listToText | ( | array | $list | ) |
Take a list of strings and build a locale-friendly comma-separated list, using the local comma-separator message.
The last two strings are chained with an "and".
string[] | $list |
Definition at line 3436 of file Language.php.
|
protected |
Convert character to uppercase, allowing overrides of the default mb_upper behaviour, which is buggy in many ways.
Having a conversion table can be useful during transitions between PHP versions where unicode changes happen. This can make some resources unreachable on-wiki, see discussion at T219279. Providing such a conversion table can allow to manage the transition period.
string | $char |
Definition at line 2671 of file Language.php.
Language::minimumGroupingDigits | ( | ) |
Definition at line 3424 of file Language.php.
|
protected |
Get message object in this language.
Only for use inside this class.
Definition at line 852 of file Language.php.
Language::needsGenderDistinction | ( | ) |
Whether this language uses gender-dependent namespace aliases.
See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
Definition at line 614 of file Language.php.
References NS_USER, and NS_USER_TALK.
Language::normalize | ( | $s | ) |
Convert a UTF-8 string to normal form C.
In Malayalam and Arabic, this also cleans up certain backwards-compatible sequences, converting them to the modern Unicode equivalent.
string | $s |
Reimplemented in LanguageAr, and LanguageMl.
Definition at line 2956 of file Language.php.
References $s.
Language::normalizeForSearch | ( | $string | ) |
Some languages have special punctuation need to be normalized.
Make such changes here.
string | $string |
Reimplemented in LanguageZh_hans, LanguageBe_tarask, and LanguageYue.
Definition at line 2851 of file Language.php.
Language::parseFormattedNumber | ( | $number | ) |
Language::pipeList | ( | array | $list | ) |
Same as commaList, but separate it with the pipe instead.
string[] | $list | Array of strings to put in a pipe list |
Definition at line 3486 of file Language.php.
References wfMessage().
|
protected |
Checks that convertPlural was given an array and pads it to requested amount of forms by copying the last one.
array | $forms | |
int | $count | How many forms should there be at least |
Definition at line 4023 of file Language.php.
Referenced by LanguageKsh\convertPlural().
|
protected |
Remove bytes that represent an incomplete Unicode character at the start of string (e.g.
bytes of the char are missing)
string | $string |
Definition at line 3644 of file Language.php.
|
protected |
Remove bytes that represent an incomplete Unicode character at the end of string (e.g.
bytes of the char are missing)
string | $string |
Definition at line 3618 of file Language.php.
Language::resetNamespaces | ( | ) |
Resets all of the namespace caches.
Mainly used for testing
Definition at line 535 of file Language.php.
|
static |
Roman number formatting up to 10000.
int | $num |
Definition at line 1935 of file Language.php.
References $s.
Language::segmentByWord | ( | $string | ) |
Some languages such as Chinese require word segmentation, Specify such segmentation when overridden in derived class.
string | $string |
Reimplemented in LanguageJa, LanguageYue, and LanguageZh_hans.
Definition at line 2840 of file Language.php.
Language::segmentForDiff | ( | $text | ) |
languages like Chinese need to be segmented in order for the diff to be of any use
string | $text |
Reimplemented in LanguageZh.
Definition at line 4113 of file Language.php.
Language::semicolonList | ( | array | $list | ) |
Take a list of strings and build a locale-friendly semicolon-separated list, using the local semicolon-separator message.
string[] | $list | Array of strings to put in a semicolon list |
Definition at line 3474 of file Language.php.
References wfMessage().
Language::separatorTransformTable | ( | ) |
Definition at line 3417 of file Language.php.
Language::setNamespaces | ( | array | $namespaces | ) |
Arbitrarily set all of the namespace names at once.
Mainly used for testing
string[] | $namespaces | Array of namespaces (id => name) |
Definition at line 526 of file Language.php.
Language::specialList | ( | $page, | |
$details, | |||
$oppositedm = true ) |
Make a list item, used by various special pages.
string | $page | Page link |
string | $details | HTML safe text between brackets |
bool | $oppositedm | Add the direction mark opposite to your language, to display text properly |
Definition at line 4754 of file Language.php.
Language::sprintfDate | ( | $format, | |
$ts, | |||
DateTimeZone | $zone = null, | ||
& | $ttl = 'unused' ) |
This is a workalike of PHP's date() function, but with better internationalisation, a reduced set of format characters, and a better escaping format.
Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See the PHP manual for definitions. There are a number of extensions, which start with "x":
xn Do not translate digits of the next numeric format character xN Toggle raw digit (xn) flag, stays set until explicitly unset xr Use roman numerals for the next numeric format character xh Use hebrew numerals for the next numeric format character xx Literal x xg Genitive month name
xij j (day number) in Iranian calendar xiF F (month name) in Iranian calendar xin n (month number) in Iranian calendar xiy y (two digit year) in Iranian calendar xiY Y (full year) in Iranian calendar xit t (days in month) in Iranian calendar xiz z (day of the year) in Iranian calendar
xjj j (day number) in Hebrew calendar xjF F (month name) in Hebrew calendar xjt t (days in month) in Hebrew calendar xjx xg (genitive month name) in Hebrew calendar xjn n (month number) in Hebrew calendar xjY Y (full year) in Hebrew calendar
xmj j (day number) in Hijri calendar xmF F (month name) in Hijri calendar xmn n (month number) in Hijri calendar xmY Y (full year) in Hijri calendar
xkY Y (full year) in Thai solar calendar. Months and days are identical to the Gregorian calendar xoY Y (full year) in Minguo calendar or Juche year. Months and days are identical to the Gregorian calendar xtY Y (full year) in Japanese nengo. Months and days are identical to the Gregorian calendar
Characters enclosed in double quotes will be considered literal (with the quotes themselves removed). Unmatched quotes will be considered literal quotes. Example:
"The month is" F => The month is January i's" => 20'11"
Backslash escaping is also supported.
Input timestamp is assumed to be pre-normalized to the desired local time zone, if any. Note that the format characters crUeIOPTZ will assume $ts is UTC if $zone is not given.
string | $format | |
string | $ts | 14-character timestamp YYYYMMDDHHMMSS 01234567890123 |
DateTimeZone | null | $zone | Timezone of $ts |
int | null | &$ttl | The amount of time (in seconds) the output may be cached for. Only makes sense if $ts is the current time. |
MWException |
Definition at line 1037 of file Language.php.
Language::time | ( | $ts, | |
$adj = false, | |||
$format = true, | |||
$timecorrection = false ) |
string | $ts | The time format which needs to be turned into a date('YmdHis') format with wfTimestamp(TS_MW,$ts) |
bool | $adj | Whether to adjust the time output according to the user configured offset ($timecorrection) |
mixed | $format | True to use user's date format preference |
string | false | $timecorrection | The time offset as returned by validateTimeZone() in Special:Preferences |
Definition at line 2224 of file Language.php.
References wfTimestamp().
Referenced by LanguageWa\timeanddate().
Language::timeanddate | ( | $ts, | |
$adj = false, | |||
$format = true, | |||
$timecorrection = false ) |
string | $ts | The time format which needs to be turned into a date('YmdHis') format with wfTimestamp(TS_MW,$ts) |
bool | $adj | Whether to adjust the time output according to the user configured offset ($timecorrection) |
mixed | $format | What format to return, if it's false output the default one (default true) |
string | false | $timecorrection | The time offset as returned by validateTimeZone() in Special:Preferences |
Reimplemented in LanguageWa.
Definition at line 2244 of file Language.php.
References wfTimestamp().
|
protected |
Transform a string using serialized data stored in the given file (which must be in the serialized subdirectory of $IP).
The file contains pairs mapping source characters to destination characters.
The data is cached in process memory.
string | $dataClass | Name of a normalize pairs data class |
string | $input |
Definition at line 2980 of file Language.php.
Referenced by LanguageAr\normalize(), and LanguageMl\normalize().
Language::translateBlockExpiry | ( | $str, | |
UserIdentity | $user = null, | ||
$now = 0 ) |
string | $str | The validated block duration in English |
UserIdentity | null | $user | User to use timezone from or null for the context user |
int | $now | Current timestamp, for formatting relative block durations |
Reimplemented in LanguageFi.
Definition at line 4070 of file Language.php.
References wfIsInfinity().
Language::truncateForDatabase | ( | $string, | |
$length, | |||
$ellipsis = '...', | |||
$adjustLength = true ) |
Truncate a string to a specified length in bytes, appending an optional string (e.g.
for ellipsis)
If $length is negative, the string will be truncated from the beginning
string | $string | String to truncate |
int | $length | Maximum length in bytes |
string | $ellipsis | String to append to the end of truncated text |
bool | $adjustLength | Subtract length of ellipsis from $length |
Definition at line 3508 of file Language.php.
Language::truncateForVisual | ( | $string, | |
$length, | |||
$ellipsis = '...', | |||
$adjustLength = true ) |
Truncate a string to a specified number of characters, appending an optional string (e.g.
for ellipsis).
This provides multibyte version of truncateForDatabase() method of this class, suitable for truncation based on number of characters, instead of number of bytes.
The input should be a raw UTF-8 string and NOT be HTML escaped. It is not safe to truncate HTML-escaped strings, because the entity can be truncated! Use ::truncateHtml() if you need a specific number of HTML-encoded bytes, or ::truncateForDatabase() if you need a specific number of PHP bytes.
If $length is negative, the string will be truncated from the beginning.
string | $string | String to truncate |
int | $length | Maximum number of characters |
string | $ellipsis | String to append to the end of truncated text |
bool | $adjustLength | Subtract length of ellipsis from $length |
Definition at line 3539 of file Language.php.
Referenced by TraditionalImageGallery\getCaptionHtml().
Language::truncateHtml | ( | $text, | |
$length, | |||
$ellipsis = '...' ) |
Truncate a string of valid HTML to a specified length in bytes, appending an optional string (e.g.
for ellipses), and return valid HTML
This is only intended for styled/linked text, such as HTML with tags like and , were the tags are self-contained (valid HTML). Also, this will not detect things like "display:none" CSS.
Note: since 1.18 you do not need to leave extra room in $length for ellipses.
string | $text | HTML string to truncate |
int | $length | (zero/positive) Maximum length (including ellipses) |
string | $ellipsis | String to append to the truncated text |
Definition at line 3670 of file Language.php.
References wfMessage().
Language::uc | ( | $str, | |
$first = false ) |
string | $str | |
bool | $first | Whether to uppercase only the first character |
Definition at line 2650 of file Language.php.
Referenced by LanguageTr\lcfirst(), and LanguageTr\ucfirst().
Language::ucfirst | ( | $str | ) |
string | $str |
Reimplemented in LanguageAz, LanguageKaa, LanguageKk, and LanguageTr.
Definition at line 2626 of file Language.php.
Language::ucwordbreaks | ( | $str | ) |
capitalize words at word breaks
string | $str |
Definition at line 2750 of file Language.php.
References $matches.
Language::ucwords | ( | $str | ) |
string | $str |
Definition at line 2724 of file Language.php.
References $matches.
Language::unsegmentForDiff | ( | $text | ) |
and unsegment to show the result
string | $text |
Reimplemented in LanguageZh.
Definition at line 4123 of file Language.php.
Language::userAdjust | ( | $ts, | |
$tz = false ) |
Used by date() and time() to adjust the time output.
string | $ts | The time in date('YmdHis') format |
string | false | $tz | Adjust the time by this amount (default false, mean we get user timecorrection setting) |
Definition at line 2053 of file Language.php.
Referenced by LanguageWa\date().
Language::userDate | ( | $ts, | |
UserIdentity | $user, | ||
array | $options = [] ) |
Get the formatted date for the given timestamp and formatted for the given user.
mixed | $ts | Mixed: the time format which needs to be turned into a date('YmdHis') format with wfTimestamp(TS_MW,$ts) |
UserIdentity | $user | User used to get preferences for timezone and format |
array | $options | Array, can contain the following keys:
|
Definition at line 2385 of file Language.php.
Language::userTime | ( | $ts, | |
UserIdentity | $user, | ||
array | $options = [] ) |
Get the formatted time for the given timestamp and formatted for the given user.
mixed | $ts | The time format which needs to be turned into a date('YmdHis') format with wfTimestamp(TS_MW,$ts) |
UserIdentity | $user | User used to get preferences for timezone and format |
array | $options | Array, can contain the following keys:
|
Definition at line 2408 of file Language.php.
Language::userTimeAndDate | ( | $ts, | |
UserIdentity | $user, | ||
array | $options = [] ) |
Get the formatted date and time for the given timestamp and formatted for the given user.
mixed | $ts | The time format which needs to be turned into a date('YmdHis') format with wfTimestamp(TS_MW,$ts) |
UserIdentity | $user | User used to get preferences for timezone and format |
array | $options | Array, can contain the following keys:
|
Definition at line 2431 of file Language.php.
string [][] Language::$dateFormatStrings = [] |
|
static |
Definition at line 266 of file Language.php.
string Language::$mCode |
Definition at line 70 of file Language.php.
string [][] null Language::$mExtendedSpecialPageAliases |
Language::$mMagicExtensions = [] |
Definition at line 75 of file Language.php.
|
static |
Definition at line 202 of file Language.php.
|
static |
Definition at line 180 of file Language.php.
|
protected |
Indexed by localized lower-cased namespace name.
Definition at line 97 of file Language.php.
|
protected |
Map from alias to namespace ID.
Definition at line 99 of file Language.php.
|
protected |
Indexed by numeric namespace ID.
Definition at line 95 of file Language.php.
const Language::ALL = LanguageNameUtils::ALL |
Return all known languages in fetchLanguageName(s).
Definition at line 59 of file Language.php.
|
protected |
Definition at line 249 of file Language.php.
const Language::HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES |
Definition at line 228 of file Language.php.
const Language::HEBREW_CALENDAR_MONTHS_MESSAGES |
Definition at line 217 of file Language.php.
const Language::HIJRI_CALENDAR_MONTH_MESSAGES |
Definition at line 239 of file Language.php.
const Language::IRANIAN_CALENDAR_MONTHS_MESSAGES |
Definition at line 207 of file Language.php.
const Language::MESSAGES_FALLBACKS = LanguageFallback::MESSAGES |
Return a fallback chain for messages in getFallbacksFor.
Definition at line 144 of file Language.php.
const Language::MONTH_ABBREVIATED_MESSAGES |
Definition at line 194 of file Language.php.
const Language::MONTH_GENITIVE_MESSAGES |
Definition at line 185 of file Language.php.
const Language::MONTH_MESSAGES |
Definition at line 171 of file Language.php.
const Language::STRICT_FALLBACKS = LanguageFallback::STRICT |
Return a strict fallback chain in getFallbacksFor.
Definition at line 151 of file Language.php.
const Language::SUPPORTED = LanguageNameUtils::SUPPORTED |
Return in fetchLanguageName(s) only the languages for which we have at least some localisation.
Definition at line 67 of file Language.php.
const Language::WEEKDAY_ABBREVIATED_MESSAGES |
Definition at line 164 of file Language.php.
const Language::WEEKDAY_MESSAGES |
Definition at line 156 of file Language.php.