MediaWiki master
TrivialLanguageConverter.php
Go to the documentation of this file.
1<?php
24
39
43 protected $language;
44
48 private $titleFormatter;
49
59 public function __construct(
60 $langobj,
61 TitleFormatter $titleFormatter = null
62 ) {
63 $this->language = $langobj;
64 $this->titleFormatter = $titleFormatter ?? MediaWikiServices::getInstance()->getTitleFormatter();
65 }
66
67 public function autoConvert( $text, $variant = false ) {
68 return $text;
69 }
70
71 public function autoConvertToAllVariants( $text ) {
72 return [ $this->language->getCode() => $text ];
73 }
74
75 public function convert( $t ) {
76 return $t;
77 }
78
79 public function convertTo( $text, $variant, bool $clearState = true ) {
80 return $text;
81 }
82
83 public function convertSplitTitle( $title ) {
84 $mainText = $this->titleFormatter->getText( $title );
85
86 $index = $title->getNamespace();
87 try {
88 $nsWithUnderscores = $this->titleFormatter->getNamespaceName( $index, $mainText );
89 } catch ( InvalidArgumentException $e ) {
90 // T165149: see MediaWikiTitleCodec::formatTitle()
91 $nsWithUnderscores = $this->language->getNsText( NS_SPECIAL );
92 $mainText = "Badtitle/NS$index:$mainText";
93 }
94 $nsText = str_replace( '_', ' ', $nsWithUnderscores );
95
96 return [ $nsText, ':', $mainText ];
97 }
98
99 public function convertTitle( $title ) {
100 return $this->titleFormatter->getPrefixedText( $title );
101 }
102
103 public function convertNamespace( $index, $variant = null ) {
104 return $this->language->getFormattedNsText( $index );
105 }
106
107 public function getVariants() {
108 return [ $this->language->getCode() ];
109 }
110
111 public function getVariantFallbacks( $variant ) {
112 return $this->language->getCode();
113 }
114
115 public function getPreferredVariant() {
116 return $this->language->getCode();
117 }
118
119 public function getDefaultVariant() {
120 return $this->language->getCode();
121 }
122
123 public function getURLVariant() {
124 return '';
125 }
126
127 public function getConvRuleTitle() {
128 return false;
129 }
130
131 public function findVariantLink( &$l, &$n, $ignoreOtherCond = false ) {
132 }
133
134 public function getExtraHashOptions() {
135 return '';
136 }
137
138 public function guessVariant( $text, $variant ) {
139 return false;
140 }
141
142 public function markNoConversion( $text, $noParse = false ) {
143 return $text;
144 }
145
146 public function convertCategoryKey( $key ) {
147 return $key;
148 }
149
150 public function validateVariant( $variant = null ) {
151 if ( $variant === null ) {
152 return null;
153 }
154 $variant = strtolower( $variant );
155 return $variant === $this->language->getCode() ? $variant : null;
156 }
157
158 public function translate( $text, $variant ) {
159 return $text;
160 }
161
162 public function updateConversionTable( LinkTarget $linkTarget ) {
163 }
164
170 private function reloadTables() {
171 }
172
173 public function hasVariants() {
174 return count( $this->getVariants() ) > 1;
175 }
176
177 public function hasVariant( $variant ) {
178 return $variant && ( $variant === $this->validateVariant( $variant ) );
179 }
180
181 public function convertHtml( $text ) {
182 return htmlspecialchars( $this->convert( $text ) );
183 }
184}
const NS_SPECIAL
Definition Defines.php:53
Base class for language-specific code.
Definition Language.php:63
Service locator for MediaWiki core services.
Stub object for the user language.
A trivial language converter.
convertHtml( $text)
Perform output conversion on a string, and encode for safe HTML output.
translate( $text, $variant)
Translate a string to a variant.
hasVariants()
Check if this is a language with variants.
convert( $t)
Convert text to different variants of a language.
getURLVariant()
Get the variant specified in the URL.
__construct( $langobj, TitleFormatter $titleFormatter=null)
Creates a converter for languages that don't have variants.
getPreferredVariant()
Get preferred language variant.
markNoConversion( $text, $noParse=false)
Enclose a string with the "no conversion" tag.
autoConvertToAllVariants( $text)
Call translate() to convert text to all valid variants.
getConvRuleTitle()
Get the title produced by the conversion rule.
convertSplitTitle( $title)
Automatically converts a LinkTarget or PageReference to a readable string in the preferred variant,...
getDefaultVariant()
This function would not be affected by user's settings.
findVariantLink(&$l, &$n, $ignoreOtherCond=false)
If a language supports multiple variants, it is possible that non-existing link in one variant actual...
autoConvert( $text, $variant=false)
Dictionary-based conversion.
getExtraHashOptions()
Returns language specific hash options.
guessVariant( $text, $variant)
Guess if a text is written in a variant.
updateConversionTable(LinkTarget $linkTarget)
Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.
convertTo( $text, $variant, bool $clearState=true)
Same as convert() except a extra parameter to custom variant.
validateVariant( $variant=null)
Validate the variant and return an appropriate strict internal variant code if one exists.
convertTitle( $title)
Automatically convert a LinkTarget or PageReference to a readable string in the preferred variant.
convertCategoryKey( $key)
Convert the sorting key for category links.
getVariants()
Get all valid variants.
convertNamespace( $index, $variant=null)
Get the namespace display name in the preferred variant.
hasVariant( $variant)
Strict check if the language has the specific variant.
getVariantFallbacks( $variant)
In case some variant is not defined in the markup, we need to have some fallback.
The shared interface for all language converters.
Represents the target of a wiki link.
A title formatter service for MediaWiki.