MediaWiki  1.23.3
Status.php
Go to the documentation of this file.
1 <?php
40 class Status {
42  public $ok = true;
43 
45  public $value;
46 
49  public $successCount = 0;
50 
52  public $failCount = 0;
53 
56  public $success = array();
57 
59  public $errors = array();
60 
62  public $cleanCallback = false;
63 
70  static function newFatal( $message /*, parameters...*/ ) {
71  $params = func_get_args();
72  $result = new self;
73  call_user_func_array( array( &$result, 'error' ), $params );
74  $result->ok = false;
75  return $result;
76  }
77 
84  static function newGood( $value = null ) {
85  $result = new self;
86  $result->value = $value;
87  return $result;
88  }
89 
96  public function setResult( $ok, $value = null ) {
97  $this->ok = $ok;
98  $this->value = $value;
99  }
100 
107  public function isGood() {
108  return $this->ok && !$this->errors;
109  }
110 
116  public function isOK() {
117  return $this->ok;
118  }
119 
125  public function warning( $message /*, parameters... */ ) {
126  $params = array_slice( func_get_args(), 1 );
127  $this->errors[] = array(
128  'type' => 'warning',
129  'message' => $message,
130  'params' => $params );
131  }
132 
139  public function error( $message /*, parameters... */ ) {
140  $params = array_slice( func_get_args(), 1 );
141  $this->errors[] = array(
142  'type' => 'error',
143  'message' => $message,
144  'params' => $params );
145  }
146 
153  public function fatal( $message /*, parameters... */ ) {
154  $params = array_slice( func_get_args(), 1 );
155  $this->errors[] = array(
156  'type' => 'error',
157  'message' => $message,
158  'params' => $params );
159  $this->ok = false;
160  }
161 
165  public function __wakeup() {
166  $this->cleanCallback = false;
167  }
168 
173  protected function cleanParams( $params ) {
174  if ( !$this->cleanCallback ) {
175  return $params;
176  }
177  $cleanParams = array();
178  foreach ( $params as $i => $param ) {
179  $cleanParams[$i] = call_user_func( $this->cleanCallback, $param );
180  }
181  return $cleanParams;
182  }
183 
192  public function getWikiText( $shortContext = false, $longContext = false ) {
193  if ( count( $this->errors ) == 0 ) {
194  if ( $this->ok ) {
195  $this->fatal( 'internalerror_info',
196  __METHOD__ . " called for a good result, this is incorrect\n" );
197  } else {
198  $this->fatal( 'internalerror_info',
199  __METHOD__ . ": Invalid result object: no error text but not OK\n" );
200  }
201  }
202  if ( count( $this->errors ) == 1 ) {
203  $s = $this->getErrorMessage( $this->errors[0] )->plain();
204  if ( $shortContext ) {
205  $s = wfMessage( $shortContext, $s )->plain();
206  } elseif ( $longContext ) {
207  $s = wfMessage( $longContext, "* $s\n" )->plain();
208  }
209  } else {
210  $errors = $this->getErrorMessageArray( $this->errors );
211  foreach ( $errors as &$error ) {
212  $error = $error->plain();
213  }
214  $s = '* ' . implode( "\n* ", $errors ) . "\n";
215  if ( $longContext ) {
216  $s = wfMessage( $longContext, $s )->plain();
217  } elseif ( $shortContext ) {
218  $s = wfMessage( $shortContext, "\n$s\n" )->plain();
219  }
220  }
221  return $s;
222  }
223 
234  public function getMessage( $shortContext = false, $longContext = false ) {
235  if ( count( $this->errors ) == 0 ) {
236  if ( $this->ok ) {
237  $this->fatal( 'internalerror_info',
238  __METHOD__ . " called for a good result, this is incorrect\n" );
239  } else {
240  $this->fatal( 'internalerror_info',
241  __METHOD__ . ": Invalid result object: no error text but not OK\n" );
242  }
243  }
244  if ( count( $this->errors ) == 1 ) {
245  $s = $this->getErrorMessage( $this->errors[0] );
246  if ( $shortContext ) {
247  $s = wfMessage( $shortContext, $s );
248  } elseif ( $longContext ) {
249  $wrapper = new RawMessage( "* \$1\n" );
250  $wrapper->params( $s )->parse();
251  $s = wfMessage( $longContext, $wrapper );
252  }
253  } else {
254  $msgs = $this->getErrorMessageArray( $this->errors );
255  $msgCount = count( $msgs );
256 
257  if ( $shortContext ) {
258  $msgCount++;
259  }
260 
261  $s = new RawMessage( '* $' . implode( "\n* \$", range( 1, $msgCount ) ) );
262  $s->params( $msgs )->parse();
263 
264  if ( $longContext ) {
265  $s = wfMessage( $longContext, $s );
266  } elseif ( $shortContext ) {
267  $wrapper = new RawMessage( "\n\$1\n", $s );
268  $wrapper->parse();
269  $s = wfMessage( $shortContext, $wrapper );
270  }
271  }
272 
273  return $s;
274  }
275 
285  protected function getErrorMessage( $error ) {
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  } else {
298  $msg = wfMessage( $error );
299  }
300  return $msg;
301  }
302 
311  public function getHTML( $shortContext = false, $longContext = false ) {
312  $text = $this->getWikiText( $shortContext, $longContext );
313  $out = MessageCache::singleton()->parse( $text, null, true, true );
314  return $out instanceof ParserOutput ? $out->getText() : $out;
315  }
316 
322  protected function getErrorMessageArray( $errors ) {
323  return array_map( array( $this, 'getErrorMessage' ), $errors );
324  }
325 
332  public function merge( $other, $overwriteValue = false ) {
333  $this->errors = array_merge( $this->errors, $other->errors );
334  $this->ok = $this->ok && $other->ok;
335  if ( $overwriteValue ) {
336  $this->value = $other->value;
337  }
338  $this->successCount += $other->successCount;
339  $this->failCount += $other->failCount;
340  }
341 
348  public function getErrorsArray() {
349  return $this->getStatusArray( "error" );
350  }
351 
358  public function getWarningsArray() {
359  return $this->getStatusArray( "warning" );
360  }
361 
367  protected function getStatusArray( $type ) {
368  $result = array();
369  foreach ( $this->errors as $error ) {
370  if ( $error['type'] === $type ) {
371  if ( $error['message'] instanceof Message ) {
372  $result[] = array_merge(
373  array( $error['message']->getKey() ),
374  $error['message']->getParams()
375  );
376  } elseif ( $error['params'] ) {
377  $result[] = array_merge( array( $error['message'] ), $error['params'] );
378  } else {
379  $result[] = array( $error['message'] );
380  }
381  }
382  }
383 
384  return $result;
385  }
386 
395  public function getErrorsByType( $type ) {
396  $result = array();
397  foreach ( $this->errors as $error ) {
398  if ( $error['type'] === $type ) {
399  $result[] = $error;
400  }
401  }
402  return $result;
403  }
404 
414  public function hasMessage( $msg ) {
415  foreach ( $this->errors as $error ) {
416  if ( $error['message'] === $msg ) {
417  return true;
418  }
419  }
420  return false;
421  }
422 
434  public function replaceMessage( $source, $dest ) {
435  $replaced = false;
436  foreach ( $this->errors as $index => $error ) {
437  if ( $error['message'] === $source ) {
438  $this->errors[$index]['message'] = $dest;
439  $replaced = true;
440  }
441  }
442  return $replaced;
443  }
444 
448  public function getValue() {
449  return $this->value;
450  }
451 }
Status\getHTML
getHTML( $shortContext=false, $longContext=false)
Get the error message as HTML.
Definition: Status.php:304
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
ParserOutput
Definition: ParserOutput.php:24
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
Status\$success
array $success
Array to indicate which items of the batch operations were successful.
Definition: Status.php:51
Status\fatal
fatal( $message)
Add an error and set OK to false, indicating that the operation as a whole was fatal.
Definition: Status.php:146
Status\isOK
isOK()
Returns whether the operation completed.
Definition: Status.php:109
Status\merge
merge( $other, $overwriteValue=false)
Merge another status object into this one.
Definition: Status.php:325
Status\$cleanCallback
callable $cleanCallback
Definition: Status.php:55
Status\getStatusArray
getStatusArray( $type)
Returns a list of status messages of the given type.
Definition: Status.php:360
Status\cleanParams
cleanParams( $params)
Definition: Status.php:166
Status\setResult
setResult( $ok, $value=null)
Change operation result.
Definition: Status.php:89
Status\$ok
bool $ok
Definition: Status.php:41
Status\$successCount
int $successCount
Counters for batch operations.
Definition: Status.php:46
Status\newGood
static newGood( $value=null)
Factory function for good results.
Definition: Status.php:77
Status\getErrorsByType
getErrorsByType( $type)
Returns a list of status messages of the given type, with message and params left untouched,...
Definition: Status.php:388
$params
$params
Definition: styleTest.css.php:40
$s
$s
Definition: mergeMessageFileList.php:156
Status\$value
mixed $value
Definition: Status.php:43
Status\getErrorMessageArray
getErrorMessageArray( $errors)
Return an array with the wikitext for each item in the array.
Definition: Status.php:315
Status\isGood
isGood()
Returns whether the operation completed and didn't have any error or warnings.
Definition: Status.php:100
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
$out
$out
Definition: UtfNormalGenerate.php:167
wfMessage
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables 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
Status\hasMessage
hasMessage( $msg)
Returns true if the specified message is present as a warning or error.
Definition: Status.php:407
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
MessageCache\singleton
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:101
errors
if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special etc to show that they re errors
Definition: hooks.txt:1318
Status\__wakeup
__wakeup()
Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
Definition: Status.php:158
Status\$failCount
int $failCount
Definition: Status.php:48
Status\getMessage
getMessage( $shortContext=false, $longContext=false)
Get the error list as a Message object.
Definition: Status.php:227
Status\warning
warning( $message)
Add a new warning.
Definition: Status.php:118
Status\getWarningsArray
getWarningsArray()
Get the list of warnings (but not errors)
Definition: Status.php:351
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Status\getErrorMessage
getErrorMessage( $error)
Return the message for a single error.
Definition: Status.php:278
$source
if(PHP_SAPI !='cli') $source
Definition: mwdoc-filter.php:18
Status\$errors
array $errors
Definition: Status.php:53
Status\getValue
getValue()
Definition: Status.php:441
$error
usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object & $error
Definition: hooks.txt:2573
Status\getErrorsArray
getErrorsArray()
Get the list of errors (but not warnings)
Definition: Status.php:341
Status\replaceMessage
replaceMessage( $source, $dest)
If the specified source message exists, replace it with the specified destination message,...
Definition: Status.php:427
Status\error
error( $message)
Add an error, do not set fatal flag This can be used for non-fatal errors.
Definition: Status.php:132
Status\getWikiText
getWikiText( $shortContext=false, $longContext=false)
Get the error list as a wikitext formatted list.
Definition: Status.php:185
Status\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: Status.php:63
$type
$type
Definition: testCompression.php:46