MediaWiki  master
ApiErrorFormatter.php
Go to the documentation of this file.
1 <?php
32  private static $dummyTitle = null;
33 
35  protected $result;
36 
38  protected $lang;
39  protected $useDB = false;
40  protected $format = 'none';
41 
54  public function __construct( ApiResult $result, Language $lang, $format, $useDB = false ) {
55  $this->result = $result;
56  $this->lang = $lang;
57  $this->useDB = $useDB;
58  $this->format = $format;
59  }
60 
73  public static function isValidApiCode( $code ) {
74  return is_string( $code ) && (
75  preg_match( '/^[a-zA-Z0-9_-]+$/', $code ) ||
76  // TODO: Deprecate this
77  preg_match( '/^internal_api_error_[^\0\r\n]+$/', $code )
78  );
79  }
80 
88  public function newWithFormat( $format ) {
89  return new self( $this->result, $this->lang, $format, $this->useDB );
90  }
91 
97  public function getFormat() {
98  return $this->format;
99  }
100 
106  public function getLanguage() {
107  return $this->lang;
108  }
109 
114  protected function getDummyTitle() {
115  if ( self::$dummyTitle === null ) {
116  self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
117  }
118  return self::$dummyTitle;
119  }
120 
128  public function addWarning( $modulePath, $msg, $code = null, $data = null ) {
129  $msg = ApiMessage::create( $msg, $code, $data )
130  ->inLanguage( $this->lang )
131  ->title( $this->getDummyTitle() )
132  ->useDatabase( $this->useDB );
133  $this->addWarningOrError( 'warning', $modulePath, $msg );
134  }
135 
143  public function addError( $modulePath, $msg, $code = null, $data = null ) {
144  $msg = ApiMessage::create( $msg, $code, $data )
145  ->inLanguage( $this->lang )
146  ->title( $this->getDummyTitle() )
147  ->useDatabase( $this->useDB );
148  $this->addWarningOrError( 'error', $modulePath, $msg );
149  }
150 
158  public function addMessagesFromStatus(
159  $modulePath, StatusValue $status, $types = [ 'warning', 'error' ], array $filter = []
160  ) {
161  if ( $status->isGood() || !$status->getErrors() ) {
162  return;
163  }
164 
165  $types = (array)$types;
166  foreach ( $status->getErrors() as $error ) {
167  if ( !in_array( $error['type'], $types, true ) ) {
168  continue;
169  }
170 
171  if ( $error['type'] === 'error' ) {
172  $tag = 'error';
173  } else {
174  // Assume any unknown type is a warning
175  $tag = 'warning';
176  }
177 
178  $msg = ApiMessage::create( $error )
179  ->inLanguage( $this->lang )
180  ->title( $this->getDummyTitle() )
181  ->useDatabase( $this->useDB );
182  if ( !in_array( $msg->getKey(), $filter, true ) ) {
183  $this->addWarningOrError( $tag, $modulePath, $msg );
184  }
185  }
186  }
187 
200  public function getMessageFromException( $exception, array $options = [] ) {
201  $options += [ 'code' => null, 'data' => [] ];
202 
203  if ( $exception instanceof ILocalizedException ) {
204  $msg = $exception->getMessageObject();
205  $params = [];
206  } elseif ( $exception instanceof MessageSpecifier ) {
207  $msg = Message::newFromSpecifier( $exception );
208  $params = [];
209  } else {
210  if ( isset( $options['wrap'] ) ) {
211  $msg = $options['wrap'];
212  } else {
213  $msg = new RawMessage( '$1' );
214  if ( !isset( $options['code'] ) ) {
215  $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $exception ) );
216  $options['code'] = 'internal_api_error_' . $class;
217  $options['data']['errorclass'] = get_class( $exception );
218  }
219  }
220  $params = [ wfEscapeWikiText( $exception->getMessage() ) ];
221  }
222  return ApiMessage::create( $msg, $options['code'], $options['data'] )
223  ->params( $params )
224  ->inLanguage( $this->lang )
225  ->title( $this->getDummyTitle() )
226  ->useDatabase( $this->useDB );
227  }
228 
237  public function formatException( $exception, array $options = [] ) {
238  return $this->formatMessage(
239  $this->getMessageFromException( $exception, $options ),
240  $options['format'] ?? null
241  );
242  }
243 
250  public function formatMessage( $msg, $format = null ) {
251  $msg = ApiMessage::create( $msg )
252  ->inLanguage( $this->lang )
253  ->title( $this->getDummyTitle() )
254  ->useDatabase( $this->useDB );
255  return $this->formatMessageInternal( $msg, $format ?: $this->format );
256  }
257 
265  public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
266  if ( $status->isGood() || !$status->getErrors() ) {
267  return [];
268  }
269 
270  $result = new ApiResult( 1e6 );
271  $formatter = new ApiErrorFormatter(
272  $result, $this->lang, $format ?: $this->format, $this->useDB
273  );
274  $formatter->addMessagesFromStatus( null, $status, [ $type ] );
275  switch ( $type ) {
276  case 'error':
277  return (array)$result->getResultData( [ 'errors' ] );
278  case 'warning':
279  return (array)$result->getResultData( [ 'warnings' ] );
280  }
281  }
282 
289  public static function stripMarkup( $text ) {
290  // Turn semantic quoting tags to quotes
291  $ret = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $text );
292 
293  // Strip tags and decode.
295 
296  return $ret;
297  }
298 
304  private function formatRawMessage( MessageSpecifier $msg ) {
305  $ret = [
306  'key' => $msg->getKey(),
307  'params' => $msg->getParams(),
308  ];
309  ApiResult::setIndexedTagName( $ret['params'], 'param' );
310 
311  // Transform Messages as parameters in the style of Message::fooParam().
312  foreach ( $ret['params'] as $i => $param ) {
313  if ( $param instanceof MessageSpecifier ) {
314  $ret['params'][$i] = [ 'message' => $this->formatRawMessage( $param ) ];
315  }
316  }
317  return $ret;
318  }
319 
327  protected function formatMessageInternal( $msg, $format ) {
328  $value = [ 'code' => $msg->getApiCode() ];
329  switch ( $format ) {
330  case 'plaintext':
331  $value += [
332  'text' => self::stripMarkup( $msg->text() ),
333  ApiResult::META_CONTENT => 'text',
334  ];
335  break;
336 
337  case 'wikitext':
338  $value += [
339  'text' => $msg->text(),
340  ApiResult::META_CONTENT => 'text',
341  ];
342  break;
343 
344  case 'html':
345  $value += [
346  'html' => $msg->parse(),
347  ApiResult::META_CONTENT => 'html',
348  ];
349  break;
350 
351  case 'raw':
352  $value += $this->formatRawMessage( $msg );
353  break;
354 
355  case 'none':
356  break;
357  }
358  $data = $msg->getApiData();
359  if ( $data ) {
360  $value['data'] = $msg->getApiData() + [
361  ApiResult::META_TYPE => 'assoc',
362  ];
363  }
364  return $value;
365  }
366 
373  protected function addWarningOrError( $tag, $modulePath, $msg ) {
374  $value = $this->formatMessageInternal( $msg, $this->format );
375  if ( $modulePath !== null ) {
376  $value += [ 'module' => $modulePath ];
377  }
378 
379  $path = [ $tag . 's' ];
380  $existing = $this->result->getResultData( $path );
381  if ( $existing === null || !in_array( $value, $existing ) ) {
382  $flags = ApiResult::NO_SIZE_CHECK;
383  if ( $existing === null ) {
384  $flags |= ApiResult::ADD_ON_TOP;
385  }
386  $this->result->addValue( $path, null, $value, $flags );
387  $this->result->addIndexedTagName( $path, $tag );
388  }
389  }
390 }
391 
398 // phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
400 
404  public function __construct( ApiResult $result ) {
405  parent::__construct( $result, Language::factory( 'en' ), 'none', false );
406  }
407 
408  public function getFormat() {
409  return 'bc';
410  }
411 
412  public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
413  if ( $status->isGood() || !$status->getErrors() ) {
414  return [];
415  }
416 
417  $result = [];
418  foreach ( $status->getErrorsByType( $type ) as $error ) {
419  $msg = ApiMessage::create( $error );
420  $error = [
421  'message' => $msg->getKey(),
422  'params' => $msg->getParams(),
423  'code' => $msg->getApiCode(),
424  ] + $error;
425  ApiResult::setIndexedTagName( $error['params'], 'param' );
426  $result[] = $error;
427  }
429 
430  return $result;
431  }
432 
433  protected function formatMessageInternal( $msg, $format ) {
434  return [
435  'code' => $msg->getApiCode(),
436  'info' => $msg->text(),
437  ] + $msg->getApiData();
438  }
439 
448  public function formatException( $exception, array $options = [] ) {
449  $ret = parent::formatException( $exception, $options );
450  return empty( $options['bc'] ) ? $ret : $ret['info'];
451  }
452 
453  protected function addWarningOrError( $tag, $modulePath, $msg ) {
454  $value = self::stripMarkup( $msg->text() );
455 
456  if ( $tag === 'error' ) {
457  // In BC mode, only one error
458  $existingError = $this->result->getResultData( [ 'error' ] );
459  if ( !is_array( $existingError ) ||
460  !isset( $existingError['code'] ) || !isset( $existingError['info'] )
461  ) {
462  $value = [
463  'code' => $msg->getApiCode(),
464  'info' => $value,
465  ] + $msg->getApiData();
466  $this->result->addValue( null, 'error', $value,
468  }
469  } else {
470  if ( $modulePath === null ) {
471  $moduleName = 'unknown';
472  } else {
473  $i = strrpos( $modulePath, '+' );
474  $moduleName = $i === false ? $modulePath : substr( $modulePath, $i + 1 );
475  }
476 
477  // Don't add duplicate warnings
478  $tag .= 's';
479  $path = [ $tag, $moduleName ];
480  $oldWarning = $this->result->getResultData( [ $tag, $moduleName, $tag ] );
481  if ( $oldWarning !== null ) {
482  $warnPos = strpos( $oldWarning, $value );
483  // If $value was found in $oldWarning, check if it starts at 0 or after "\n"
484  if ( $warnPos !== false && ( $warnPos === 0 || $oldWarning[$warnPos - 1] === "\n" ) ) {
485  // Check if $value is followed by "\n" or the end of the $oldWarning
486  $warnPos += strlen( $value );
487  if ( strlen( $oldWarning ) <= $warnPos || $oldWarning[$warnPos] === "\n" ) {
488  return;
489  }
490  }
491  // If there is a warning already, append it to the existing one
492  $value = "$oldWarning\n$value";
493  }
494  $this->result->addContentValue( $path, $tag, $value,
496  }
497  }
498 }
formatMessage( $msg, $format=null)
Format a message as an array.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
getErrorsByType( $type)
Returns a list of status messages of the given type.
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Formats errors and warnings for the API, and add them to the associated ApiResult.
static stripMarkup( $text)
Turn wikitext into something resembling plaintext.
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 & $ret
Definition: hooks.txt:1982
getKey()
Returns the message key.
static isValidApiCode( $code)
Test whether a code is a valid API error code.
$value
const NS_SPECIAL
Definition: Defines.php:53
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
isGood()
Returns whether the operation completed and didn&#39;t have any error or warnings.
addError( $modulePath, $msg, $code=null, $data=null)
Add an error to the result.
const ADD_ON_TOP
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first el...
Definition: ApiResult.php:49
addWarning( $modulePath, $msg, $code=null, $data=null)
Add a warning to the result.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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 since 1.28! 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:1980
formatMessageInternal( $msg, $format)
Format a message as an array.
formatRawMessage(MessageSpecifier $msg)
Format a Message object for raw format.
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 true
Definition: hooks.txt:1982
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
static stripAllTags( $html)
Take a fragment of (potentially invalid) HTML and return a version with any tags removed, encoded as plain text.
Definition: Sanitizer.php:1992
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
addMessagesFromStatus( $modulePath, StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
Add warnings and errors from a StatusValue object to the result.
$params
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 & $options
Definition: hooks.txt:1982
Format errors and warnings in the old style, for backwards compatibility.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don&#39;t use this unless yo...
Definition: ApiResult.php:58
$filter
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:215
This class represents the result of the API operations.
Definition: ApiResult.php:35
__construct(ApiResult $result, Language $lang, $format, $useDB=false)
formatException( $exception, array $options=[])
Format an exception as an array.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 modifiable & $code
Definition: hooks.txt:780
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
formatException( $exception, array $options=[])
Format an exception as an array.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
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
getDummyTitle()
Fetch a dummy title to set on Messages.
static newFromSpecifier( $value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:427
Variant of the Message class.
Definition: RawMessage.php:34
getFormat()
Fetch the format for this formatter.
getParams()
Returns the message parameters.
arrayFromStatus(StatusValue $status, $type='error', $format=null)
getMessageFromException( $exception, array $options=[])
Get an ApiMessage from an exception.
getErrors()
Get the list of errors.
const META_CONTENT
Key for the &#39;content&#39; metadata item.
Definition: ApiResult.php:90
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
addWarningOrError( $tag, $modulePath, $msg)
newWithFormat( $format)
Return a formatter like this one but with a different format.
const OVERRIDE
Override existing value in addValue(), setValue(), and similar functions.
Definition: ApiResult.php:41
getLanguage()
Fetch the Language for this formatter.
Interface for MediaWiki-localized exceptions.
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1641
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:40
static Title $dummyTitle
Dummy title to silence warnings from MessageCache::parse()