MediaWiki REL1_30
Status.php
Go to the documentation of this file.
1<?php
40class Status extends StatusValue {
42 public $cleanCallback = false;
43
55 public static function wrap( $sv ) {
56 if ( $sv instanceof static ) {
57 return $sv;
58 }
59
60 $result = new static();
61 $result->ok =& $sv->ok;
62 $result->errors =& $sv->errors;
63 $result->value =& $sv->value;
64 $result->successCount =& $sv->successCount;
65 $result->failCount =& $sv->failCount;
66 $result->success =& $sv->success;
67
68 return $result;
69 }
70
78 function __get( $name ) {
79 if ( $name === 'ok' ) {
80 return $this->isOK();
81 } elseif ( $name === 'errors' ) {
82 return $this->getErrors();
83 }
84
85 throw new RuntimeException( "Cannot get '$name' property." );
86 }
87
96 function __set( $name, $value ) {
97 if ( $name === 'ok' ) {
98 $this->setOK( $value );
99 } elseif ( !property_exists( $this, $name ) ) {
100 // Caller is using undeclared ad-hoc properties
101 $this->$name = $value;
102 } else {
103 throw new RuntimeException( "Cannot set '$name' property." );
104 }
105 }
106
118 public function splitByErrorType() {
119 list( $errorsOnlyStatus, $warningsOnlyStatus ) = parent::splitByErrorType();
120 $errorsOnlyStatus->cleanCallback =
121 $warningsOnlyStatus->cleanCallback = $this->cleanCallback;
122
123 return [ $errorsOnlyStatus, $warningsOnlyStatus ];
124 }
125
131 public function getStatusValue() {
132 return $this;
133 }
134
139 protected function cleanParams( array $params ) {
140 if ( !$this->cleanCallback ) {
141 return $params;
142 }
143 $cleanParams = [];
144 foreach ( $params as $i => $param ) {
145 $cleanParams[$i] = call_user_func( $this->cleanCallback, $param );
146 }
147 return $cleanParams;
148 }
149
155 protected function languageFromParam( $lang ) {
156 global $wgLang;
157
158 if ( $lang === null ) {
159 // @todo: Use RequestContext::getMain()->getLanguage() instead
160 return $wgLang;
161 } elseif ( $lang instanceof Language || $lang instanceof StubUserLang ) {
162 return $lang;
163 } else {
164 return Language::factory( $lang );
165 }
166 }
167
177 public function getWikiText( $shortContext = false, $longContext = false, $lang = null ) {
178 $lang = $this->languageFromParam( $lang );
179
180 $rawErrors = $this->getErrors();
181 if ( count( $rawErrors ) == 0 ) {
182 if ( $this->isOK() ) {
183 $this->fatal( 'internalerror_info',
184 __METHOD__ . " called for a good result, this is incorrect\n" );
185 } else {
186 $this->fatal( 'internalerror_info',
187 __METHOD__ . ": Invalid result object: no error text but not OK\n" );
188 }
189 $rawErrors = $this->getErrors(); // just added a fatal
190 }
191 if ( count( $rawErrors ) == 1 ) {
192 $s = $this->getErrorMessage( $rawErrors[0], $lang )->plain();
193 if ( $shortContext ) {
194 $s = wfMessage( $shortContext, $s )->inLanguage( $lang )->plain();
195 } elseif ( $longContext ) {
196 $s = wfMessage( $longContext, "* $s\n" )->inLanguage( $lang )->plain();
197 }
198 } else {
199 $errors = $this->getErrorMessageArray( $rawErrors, $lang );
200 foreach ( $errors as &$error ) {
201 $error = $error->plain();
202 }
203 $s = '* ' . implode( "\n* ", $errors ) . "\n";
204 if ( $longContext ) {
205 $s = wfMessage( $longContext, $s )->inLanguage( $lang )->plain();
206 } elseif ( $shortContext ) {
207 $s = wfMessage( $shortContext, "\n$s\n" )->inLanguage( $lang )->plain();
208 }
209 }
210 return $s;
211 }
212
233 public function getMessage( $shortContext = false, $longContext = false, $lang = null ) {
234 $lang = $this->languageFromParam( $lang );
235
236 $rawErrors = $this->getErrors();
237 if ( count( $rawErrors ) == 0 ) {
238 if ( $this->isOK() ) {
239 $this->fatal( 'internalerror_info',
240 __METHOD__ . " called for a good result, this is incorrect\n" );
241 } else {
242 $this->fatal( 'internalerror_info',
243 __METHOD__ . ": Invalid result object: no error text but not OK\n" );
244 }
245 $rawErrors = $this->getErrors(); // just added a fatal
246 }
247 if ( count( $rawErrors ) == 1 ) {
248 $s = $this->getErrorMessage( $rawErrors[0], $lang );
249 if ( $shortContext ) {
250 $s = wfMessage( $shortContext, $s )->inLanguage( $lang );
251 } elseif ( $longContext ) {
252 $wrapper = new RawMessage( "* \$1\n" );
253 $wrapper->params( $s )->parse();
254 $s = wfMessage( $longContext, $wrapper )->inLanguage( $lang );
255 }
256 } else {
257 $msgs = $this->getErrorMessageArray( $rawErrors, $lang );
258 $msgCount = count( $msgs );
259
260 $s = new RawMessage( '* $' . implode( "\n* \$", range( 1, $msgCount ) ) );
261 $s->params( $msgs )->parse();
262
263 if ( $longContext ) {
264 $s = wfMessage( $longContext, $s )->inLanguage( $lang );
265 } elseif ( $shortContext ) {
266 $wrapper = new RawMessage( "\n\$1\n", [ $s ] );
267 $wrapper->parse();
268 $s = wfMessage( $shortContext, $wrapper )->inLanguage( $lang );
269 }
270 }
271
272 return $s;
273 }
274
285 protected function getErrorMessage( $error, $lang = null ) {
286 if ( is_array( $error ) ) {
287 if ( isset( $error['message'] ) && $error['message'] instanceof Message ) {
288 $msg = $error['message'];
289 } elseif ( isset( $error['message'] ) && isset( $error['params'] ) ) {
290 $msg = wfMessage( $error['message'],
291 array_map( 'wfEscapeWikiText', $this->cleanParams( $error['params'] ) ) );
292 } else {
293 $msgName = array_shift( $error );
294 $msg = wfMessage( $msgName,
295 array_map( 'wfEscapeWikiText', $this->cleanParams( $error ) ) );
296 }
297 } elseif ( is_string( $error ) ) {
298 $msg = wfMessage( $error );
299 } else {
300 throw new UnexpectedValueException( "Got " . get_class( $error ) . " for key." );
301 }
302
303 $msg->inLanguage( $this->languageFromParam( $lang ) );
304 return $msg;
305 }
306
315 public function getHTML( $shortContext = false, $longContext = false, $lang = null ) {
316 $lang = $this->languageFromParam( $lang );
317 $text = $this->getWikiText( $shortContext, $longContext, $lang );
318 $out = MessageCache::singleton()->parse( $text, null, true, true, $lang );
319 return $out instanceof ParserOutput ? $out->getText() : $out;
320 }
321
328 protected function getErrorMessageArray( $errors, $lang = null ) {
329 $lang = $this->languageFromParam( $lang );
330 return array_map( function ( $e ) use ( $lang ) {
331 return $this->getErrorMessage( $e, $lang );
332 }, $errors );
333 }
334
342 public function getErrorsArray() {
343 return $this->getStatusArray( 'error' );
344 }
345
353 public function getWarningsArray() {
354 return $this->getStatusArray( 'warning' );
355 }
356
365 protected function getStatusArray( $type = false ) {
366 $result = [];
367
368 foreach ( $this->getErrors() as $error ) {
369 if ( $type === false || $error['type'] === $type ) {
370 if ( $error['message'] instanceof MessageSpecifier ) {
371 $result[] = array_merge(
372 [ $error['message']->getKey() ],
373 $error['message']->getParams()
374 );
375 } elseif ( $error['params'] ) {
376 $result[] = array_merge( [ $error['message'] ], $error['params'] );
377 } else {
378 $result[] = [ $error['message'] ];
379 }
380 }
381 }
382
383 return $result;
384 }
385
390 function __sleep() {
391 $keys = array_keys( get_object_vars( $this ) );
392 return array_diff( $keys, [ 'cleanCallback' ] );
393 }
394
398 function __wakeup() {
399 $this->cleanCallback = false;
400 }
401}
Internationalisation code.
Definition Language.php:35
static singleton()
Get the signleton instance of this class.
The Message class provides methods which fulfil two basic services:
Definition Message.php:159
Variant of the Message class.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
array[] $errors
getErrors()
Get the list of errors.
setOK( $ok)
Change operation status.
isOK()
Returns whether the operation completed.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition Status.php:55
callable $cleanCallback
Definition Status.php:42
getWikiText( $shortContext=false, $longContext=false, $lang=null)
Get the error list as a wikitext formatted list.
Definition Status.php:177
splitByErrorType()
Splits this Status object into two new Status objects, one which contains only the error messages,...
Definition Status.php:118
getErrorsArray()
Get the list of errors (but not warnings)
Definition Status.php:342
getErrorMessage( $error, $lang=null)
Return the message for a single error.
Definition Status.php:285
__sleep()
Don't save the callback when serializing, because Closures can't be serialized and we're going to cle...
Definition Status.php:390
cleanParams(array $params)
Definition Status.php:139
__set( $name, $value)
Change operation result Backwards compatibility logic.
Definition Status.php:96
getErrorMessageArray( $errors, $lang=null)
Return an array with a Message object for each error.
Definition Status.php:328
getWarningsArray()
Get the list of warnings (but not errors)
Definition Status.php:353
getStatusValue()
Returns the wrapped StatusValue object.
Definition Status.php:131
languageFromParam( $lang)
Definition Status.php:155
getStatusArray( $type=false)
Returns a list of status messages of the given type (or all if false)
Definition Status.php:365
getHTML( $shortContext=false, $longContext=false, $lang=null)
Get the error message as HTML.
Definition Status.php:315
__wakeup()
Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
Definition Status.php:398
__get( $name)
Backwards compatibility logic.
Definition Status.php:78
getMessage( $shortContext=false, $longContext=false, $lang=null)
Get a bullet list of the errors as a Message object.
Definition Status.php:233
Stub object for the user language.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
namespace being checked & $result
Definition hooks.txt:2293
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:862
returning false will NOT prevent logging $e
Definition hooks.txt:2146
$params
if(!isset( $args[0])) $lang