MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
42 class StatusValue {
44  protected $ok = true;
46  protected $errors = [];
49  public $value;
51  public $success = [];
53  public $successCount = 0;
55  public $failCount = 0;
63  public static function newFatal( $message /*, parameters...*/ ) {
64  $params = func_get_args();
65  $result = new static();
66  call_user_func_array( [ &$result, 'fatal' ], $params );
67  return $result;
68  }
76  public static function newGood( $value = null ) {
77  $result = new static();
78  $result->value = $value;
79  return $result;
80  }
93  public function splitByErrorType() {
94  $errorsOnlyStatusValue = clone $this;
95  $warningsOnlyStatusValue = clone $this;
96  $warningsOnlyStatusValue->ok = true;
98  $errorsOnlyStatusValue->errors = $warningsOnlyStatusValue->errors = [];
99  foreach ( $this->errors as $item ) {
100  if ( $item['type'] === 'warning' ) {
101  $warningsOnlyStatusValue->errors[] = $item;
102  } else {
103  $errorsOnlyStatusValue->errors[] = $item;
104  }
105  };
107  return [ $errorsOnlyStatusValue, $warningsOnlyStatusValue ];
108  }
116  public function isGood() {
117  return $this->ok && !$this->errors;
118  }
125  public function isOK() {
126  return $this->ok;
127  }
132  public function getValue() {
133  return $this->value;
134  }
143  public function getErrors() {
144  return $this->errors;
145  }
152  public function setOK( $ok ) {
153  $this->ok = $ok;
154  }
162  public function setResult( $ok, $value = null ) {
163  $this->ok = (bool)$ok;
164  $this->value = $value;
165  }
172  public function warning( $message /*, parameters... */ ) {
173  $this->errors[] = [
174  'type' => 'warning',
175  'message' => $message,
176  'params' => array_slice( func_get_args(), 1 )
177  ];
178  }
186  public function error( $message /*, parameters... */ ) {
187  $this->errors[] = [
188  'type' => 'error',
189  'message' => $message,
190  'params' => array_slice( func_get_args(), 1 )
191  ];
192  }
200  public function fatal( $message /*, parameters... */ ) {
201  $this->errors[] = [
202  'type' => 'error',
203  'message' => $message,
204  'params' => array_slice( func_get_args(), 1 )
205  ];
206  $this->ok = false;
207  }
215  public function merge( $other, $overwriteValue = false ) {
216  $this->errors = array_merge( $this->errors, $other->errors );
217  $this->ok = $this->ok && $other->ok;
218  if ( $overwriteValue ) {
219  $this->value = $other->value;
220  }
221  $this->successCount += $other->successCount;
222  $this->failCount += $other->failCount;
223  }
235  public function getErrorsByType( $type ) {
236  $result = [];
237  foreach ( $this->errors as $error ) {
238  if ( $error['type'] === $type ) {
239  $result[] = $error;
240  }
241  }
243  return $result;
244  }
253  public function hasMessage( $message ) {
254  if ( $message instanceof MessageSpecifier ) {
255  $message = $message->getKey();
256  }
257  foreach ( $this->errors as $error ) {
258  if ( $error['message'] instanceof MessageSpecifier
259  && $error['message']->getKey() === $message
260  ) {
261  return true;
262  } elseif ( $error['message'] === $message ) {
263  return true;
264  }
265  }
267  return false;
268  }
281  public function replaceMessage( $source, $dest ) {
282  $replaced = false;
284  foreach ( $this->errors as $index => $error ) {
285  if ( $error['message'] === $source ) {
286  $this->errors[$index]['message'] = $dest;
287  $replaced = true;
288  }
289  }
291  return $replaced;
292  }
297  public function __toString() {
298  $status = $this->isOK() ? "OK" : "Error";
299  if ( count( $this->errors ) ) {
300  $errorcount = "collected " . ( count( $this->errors ) ) . " error(s) on the way";
301  } else {
302  $errorcount = "no errors detected";
303  }
304  if ( isset( $this->value ) ) {
305  $valstr = gettype( $this->value ) . " value set";
306  if ( is_object( $this->value ) ) {
307  $valstr .= "\"" . get_class( $this->value ) . "\" instance";
308  }
309  } else {
310  $valstr = "no value set";
311  }
312  $out = sprintf( "<%s, %s, %s>",
313  $status,
314  $errorcount,
315  $valstr
316  );
317  if ( count( $this->errors ) > 0 ) {
318  $hdr = sprintf( "+-%'-4s-+-%'-25s-+-%'-40s-+\n", "", "", "" );
319  $i = 1;
320  $out .= "\n";
321  $out .= $hdr;
322  foreach ( $this->errors as $error ) {
323  if ( $error['message'] instanceof MessageSpecifier ) {
324  $key = $error['message']->getKey();
325  $params = $error['message']->getParams();
326  } elseif ( $error['params'] ) {
327  $key = $error['message'];
328  $params = $error['params'];
329  } else {
330  $key = $error['message'];
331  $params = [];
332  }
334  $out .= sprintf( "| %4d | %-25.25s | %-40.40s |\n",
335  $i,
336  $key,
337  implode( " ", $params )
338  );
339  $i += 1;
340  }
341  $out .= $hdr;
342  }
344  return $out;
345  }
346 }
Add a new warning.
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:802
setResult($ok, $value=null)
Change operation resuklt.
Change operation status.
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
Returns whether the operation completed and didn't have any error or warnings.
array $errors
Definition: StatusValue.php:46
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.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.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:1934
Add an error and set OK to false, indicating that the operation as a whole was fatal.
Splits this StatusValue object into two new StatusValue objects, one which contains only the error me...
Definition: StatusValue.php:93
merge($other, $overwriteValue=false)
Merge another status object into this one.
int $failCount
Counter for batch operations.
Definition: StatusValue.php:55
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
array $success
Map of (key => bool) to indicate success of each part of batch operations.
Definition: StatusValue.php:51
Returns whether the operation completed.
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
mixed $value
Definition: StatusValue.php:49
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:1701
Add an error, do not set fatal flag This can be used for non-fatal errors.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
replaceMessage($source, $dest)
If the specified source message exists, replace it with the specified destination message...
Returns a list of status messages of the given type.
Returns true if the specified message is present as a warning or error.
Get the list of errors.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
int $successCount
Counter for batch operations.
Definition: StatusValue.php:53
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491