MediaWiki  REL1_31
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 
66  public function getLanguage() {
67  return $this->lang;
68  }
69 
74  protected function getDummyTitle() {
75  if ( self::$dummyTitle === null ) {
76  self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
77  }
78  return self::$dummyTitle;
79  }
80 
88  public function addWarning( $modulePath, $msg, $code = null, $data = null ) {
89  $msg = ApiMessage::create( $msg, $code, $data )
90  ->inLanguage( $this->lang )
91  ->title( $this->getDummyTitle() )
92  ->useDatabase( $this->useDB );
93  $this->addWarningOrError( 'warning', $modulePath, $msg );
94  }
95 
103  public function addError( $modulePath, $msg, $code = null, $data = null ) {
104  $msg = ApiMessage::create( $msg, $code, $data )
105  ->inLanguage( $this->lang )
106  ->title( $this->getDummyTitle() )
107  ->useDatabase( $this->useDB );
108  $this->addWarningOrError( 'error', $modulePath, $msg );
109  }
110 
117  public function addMessagesFromStatus(
118  $modulePath, StatusValue $status, $types = [ 'warning', 'error' ]
119  ) {
120  if ( $status->isGood() || !$status->getErrors() ) {
121  return;
122  }
123 
124  $types = (array)$types;
125  foreach ( $status->getErrors() as $error ) {
126  if ( !in_array( $error['type'], $types, true ) ) {
127  continue;
128  }
129 
130  if ( $error['type'] === 'error' ) {
131  $tag = 'error';
132  } else {
133  // Assume any unknown type is a warning
134  $tag = 'warning';
135  }
136 
137  $msg = ApiMessage::create( $error )
138  ->inLanguage( $this->lang )
139  ->title( $this->getDummyTitle() )
140  ->useDatabase( $this->useDB );
141  $this->addWarningOrError( $tag, $modulePath, $msg );
142  }
143  }
144 
157  public function getMessageFromException( $exception, array $options = [] ) {
158  $options += [ 'code' => null, 'data' => [] ];
159 
160  if ( $exception instanceof ILocalizedException ) {
161  $msg = $exception->getMessageObject();
162  $params = [];
163  } elseif ( $exception instanceof MessageSpecifier ) {
164  $msg = Message::newFromSpecifier( $exception );
165  $params = [];
166  } else {
167  // Extract code and data from the exception, if applicable
168  if ( $exception instanceof UsageException ) {
169  $data = $exception->getMessageArray();
170  if ( !$options['code'] ) {
171  $options['code'] = $data['code'];
172  }
173  unset( $data['code'], $data['info'] );
174  $options['data'] = array_merge( $data, $options['data'] );
175  }
176 
177  if ( isset( $options['wrap'] ) ) {
178  $msg = $options['wrap'];
179  } else {
180  $msg = new RawMessage( '$1' );
181  if ( !isset( $options['code'] ) ) {
182  $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $exception ) );
183  $options['code'] = 'internal_api_error_' . $class;
184  }
185  }
186  $params = [ wfEscapeWikiText( $exception->getMessage() ) ];
187  }
188  return ApiMessage::create( $msg, $options['code'], $options['data'] )
189  ->params( $params )
190  ->inLanguage( $this->lang )
191  ->title( $this->getDummyTitle() )
192  ->useDatabase( $this->useDB );
193  }
194 
203  public function formatException( $exception, array $options = [] ) {
204  return $this->formatMessage(
205  $this->getMessageFromException( $exception, $options ),
206  isset( $options['format'] ) ? $options['format'] : null
207  );
208  }
209 
216  public function formatMessage( $msg, $format = null ) {
217  $msg = ApiMessage::create( $msg )
218  ->inLanguage( $this->lang )
219  ->title( $this->getDummyTitle() )
220  ->useDatabase( $this->useDB );
221  return $this->formatMessageInternal( $msg, $format ?: $this->format );
222  }
223 
231  public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
232  if ( $status->isGood() || !$status->getErrors() ) {
233  return [];
234  }
235 
236  $result = new ApiResult( 1e6 );
237  $formatter = new ApiErrorFormatter(
238  $result, $this->lang, $format ?: $this->format, $this->useDB
239  );
240  $formatter->addMessagesFromStatus( null, $status, [ $type ] );
241  switch ( $type ) {
242  case 'error':
243  return (array)$result->getResultData( [ 'errors' ] );
244  case 'warning':
245  return (array)$result->getResultData( [ 'warnings' ] );
246  }
247  }
248 
255  public static function stripMarkup( $text ) {
256  // Turn semantic quoting tags to quotes
257  $ret = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $text );
258 
259  // Strip tags and decode.
261 
262  return $ret;
263  }
264 
270  private function formatRawMessage( MessageSpecifier $msg ) {
271  $ret = [
272  'key' => $msg->getKey(),
273  'params' => $msg->getParams(),
274  ];
275  ApiResult::setIndexedTagName( $ret['params'], 'param' );
276 
277  // Transform Messages as parameters in the style of Message::fooParam().
278  foreach ( $ret['params'] as $i => $param ) {
279  if ( $param instanceof MessageSpecifier ) {
280  $ret['params'][$i] = [ 'message' => $this->formatRawMessage( $param ) ];
281  }
282  }
283  return $ret;
284  }
285 
293  protected function formatMessageInternal( $msg, $format ) {
294  $value = [ 'code' => $msg->getApiCode() ];
295  switch ( $format ) {
296  case 'plaintext':
297  $value += [
298  'text' => self::stripMarkup( $msg->text() ),
299  ApiResult::META_CONTENT => 'text',
300  ];
301  break;
302 
303  case 'wikitext':
304  $value += [
305  'text' => $msg->text(),
306  ApiResult::META_CONTENT => 'text',
307  ];
308  break;
309 
310  case 'html':
311  $value += [
312  'html' => $msg->parse(),
313  ApiResult::META_CONTENT => 'html',
314  ];
315  break;
316 
317  case 'raw':
318  $value += $this->formatRawMessage( $msg );
319  break;
320 
321  case 'none':
322  break;
323  }
324  $data = $msg->getApiData();
325  if ( $data ) {
326  $value['data'] = $msg->getApiData() + [
327  ApiResult::META_TYPE => 'assoc',
328  ];
329  }
330  return $value;
331  }
332 
339  protected function addWarningOrError( $tag, $modulePath, $msg ) {
340  $value = $this->formatMessageInternal( $msg, $this->format );
341  if ( $modulePath !== null ) {
342  $value += [ 'module' => $modulePath ];
343  }
344 
345  $path = [ $tag . 's' ];
346  $existing = $this->result->getResultData( $path );
347  if ( $existing === null || !in_array( $value, $existing ) ) {
348  $flags = ApiResult::NO_SIZE_CHECK;
349  if ( $existing === null ) {
350  $flags |= ApiResult::ADD_ON_TOP;
351  }
352  $this->result->addValue( $path, null, $value, $flags );
353  $this->result->addIndexedTagName( $path, $tag );
354  }
355  }
356 }
357 
364 // phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
366 
370  public function __construct( ApiResult $result ) {
371  parent::__construct( $result, Language::factory( 'en' ), 'none', false );
372  }
373 
374  public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
375  if ( $status->isGood() || !$status->getErrors() ) {
376  return [];
377  }
378 
379  $result = [];
380  foreach ( $status->getErrorsByType( $type ) as $error ) {
381  $msg = ApiMessage::create( $error );
382  $error = [
383  'message' => $msg->getKey(),
384  'params' => $msg->getParams(),
385  'code' => $msg->getApiCode(),
386  ] + $error;
387  ApiResult::setIndexedTagName( $error['params'], 'param' );
388  $result[] = $error;
389  }
391 
392  return $result;
393  }
394 
395  protected function formatMessageInternal( $msg, $format ) {
396  return [
397  'code' => $msg->getApiCode(),
398  'info' => $msg->text(),
399  ] + $msg->getApiData();
400  }
401 
410  public function formatException( $exception, array $options = [] ) {
411  $ret = parent::formatException( $exception, $options );
412  return empty( $options['bc'] ) ? $ret : $ret['info'];
413  }
414 
415  protected function addWarningOrError( $tag, $modulePath, $msg ) {
416  $value = self::stripMarkup( $msg->text() );
417 
418  if ( $tag === 'error' ) {
419  // In BC mode, only one error
420  $existingError = $this->result->getResultData( [ 'error' ] );
421  if ( !is_array( $existingError ) ||
422  !isset( $existingError['code'] ) || !isset( $existingError['info'] )
423  ) {
424  $value = [
425  'code' => $msg->getApiCode(),
426  'info' => $value,
427  ] + $msg->getApiData();
428  $this->result->addValue( null, 'error', $value,
430  }
431  } else {
432  if ( $modulePath === null ) {
433  $moduleName = 'unknown';
434  } else {
435  $i = strrpos( $modulePath, '+' );
436  $moduleName = $i === false ? $modulePath : substr( $modulePath, $i + 1 );
437  }
438 
439  // Don't add duplicate warnings
440  $tag .= 's';
441  $path = [ $tag, $moduleName ];
442  $oldWarning = $this->result->getResultData( [ $tag, $moduleName, $tag ] );
443  if ( $oldWarning !== null ) {
444  $warnPos = strpos( $oldWarning, $value );
445  // If $value was found in $oldWarning, check if it starts at 0 or after "\n"
446  if ( $warnPos !== false && ( $warnPos === 0 || $oldWarning[$warnPos - 1] === "\n" ) ) {
447  // Check if $value is followed by "\n" or the end of the $oldWarning
448  $warnPos += strlen( $value );
449  if ( strlen( $oldWarning ) <= $warnPos || $oldWarning[$warnPos] === "\n" ) {
450  return;
451  }
452  }
453  // If there is a warning already, append it to the existing one
454  $value = "$oldWarning\n$value";
455  }
456  $this->result->addContentValue( $path, $tag, $value,
458  }
459  }
460 }
Message\newFromSpecifier
static newFromSpecifier( $value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:414
ApiErrorFormatter\getLanguage
getLanguage()
Fetch the Language for this formatter.
Definition: ApiErrorFormatter.php:66
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
ApiErrorFormatter\addError
addError( $modulePath, $msg, $code=null, $data=null)
Add an error to the result.
Definition: ApiErrorFormatter.php:103
ApiErrorFormatter_BackCompat
Format errors and warnings in the old style, for backwards compatibility.
Definition: ApiErrorFormatter.php:365
Sanitizer\stripAllTags
static stripAllTags( $html)
Take a fragment of (potentially invalid) HTML and return a version with any tags removed,...
Definition: Sanitizer.php:1981
ApiErrorFormatter_BackCompat\formatException
formatException( $exception, array $options=[])
Format an exception as an array.
Definition: ApiErrorFormatter.php:410
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiResult\META_TYPE
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
ApiErrorFormatter_BackCompat\__construct
__construct(ApiResult $result)
Definition: ApiErrorFormatter.php:370
$ret
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:2005
MessageSpecifier\getKey
getKey()
Returns the message key.
MessageSpecifier
Definition: MessageSpecifier.php:21
$params
$params
Definition: styleTest.css.php:40
ApiResult\NO_SIZE_CHECK
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition: ApiResult.php:56
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. '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: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! 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:1993
ApiErrorFormatter\addWarning
addWarning( $modulePath, $msg, $code=null, $data=null)
Add a warning to the result.
Definition: ApiErrorFormatter.php:88
php
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:37
MessageSpecifier\getParams
getParams()
Returns the message parameters.
ApiErrorFormatter_BackCompat\formatMessageInternal
formatMessageInternal( $msg, $format)
Format a message as an array.
Definition: ApiErrorFormatter.php:395
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:63
ApiErrorFormatter\formatMessageInternal
formatMessageInternal( $msg, $format)
Format a message as an array.
Definition: ApiErrorFormatter.php:293
ApiErrorFormatter\$lang
Language $lang
Definition: ApiErrorFormatter.php:38
ApiErrorFormatter\$result
ApiResult $result
Definition: ApiErrorFormatter.php:35
ApiErrorFormatter\stripMarkup
static stripMarkup( $text)
Turn wikitext into something resembling plaintext.
Definition: ApiErrorFormatter.php:255
ApiResult
This class represents the result of the API operations.
Definition: ApiResult.php:33
UsageException
This exception will be thrown when dieUsage is called to stop module execution.
Definition: ApiUsageException.php:27
ApiErrorFormatter\addWarningOrError
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
Definition: ApiErrorFormatter.php:339
ApiErrorFormatter_BackCompat\addWarningOrError
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
Definition: ApiErrorFormatter.php:415
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
ApiErrorFormatter\getMessageFromException
getMessageFromException( $exception, array $options=[])
Get an ApiMessage from an exception.
Definition: ApiErrorFormatter.php:157
ApiMessage\create
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:219
ApiErrorFormatter\formatRawMessage
formatRawMessage(MessageSpecifier $msg)
Format a Message object for raw format.
Definition: ApiErrorFormatter.php:270
ILocalizedException
Interface for MediaWiki-localized exceptions.
Definition: LocalizedException.php:27
ApiErrorFormatter\__construct
__construct(ApiResult $result, Language $lang, $format, $useDB=false)
Definition: ApiErrorFormatter.php:54
ApiErrorFormatter\$dummyTitle
static Title $dummyTitle
Dummy title to silence warnings from MessageCache::parse()
Definition: ApiErrorFormatter.php:32
$options
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:2001
ApiErrorFormatter\$format
$format
Definition: ApiErrorFormatter.php:40
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
$value
$value
Definition: styleTest.css.php:45
ApiErrorFormatter\formatMessage
formatMessage( $msg, $format=null)
Format a message as an array.
Definition: ApiErrorFormatter.php:216
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
ApiErrorFormatter_BackCompat\arrayFromStatus
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
Definition: ApiErrorFormatter.php:374
$status
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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:1255
ApiErrorFormatter
Formats errors and warnings for the API, and add them to the associated ApiResult.
Definition: ApiErrorFormatter.php:30
ApiErrorFormatter\formatException
formatException( $exception, array $options=[])
Format an exception as an array.
Definition: ApiErrorFormatter.php:203
Title
Represents a title within MediaWiki.
Definition: Title.php:39
ApiResult\ADD_ON_TOP
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:47
$code
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 modifiable & $code
Definition: hooks.txt:865
$path
$path
Definition: NoLocalSettings.php:25
ApiErrorFormatter\arrayFromStatus
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
Definition: ApiErrorFormatter.php:231
format
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1656
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:22
ApiResult\OVERRIDE
const OVERRIDE
Override existing value in addValue(), setValue(), and similar functions.
Definition: ApiResult.php:39
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:183
RawMessage
Variant of the Message class.
Definition: RawMessage.php:34
ApiResult\META_CONTENT
const META_CONTENT
Key for the 'content' metadata item.
Definition: ApiResult.php:88
ApiErrorFormatter\getDummyTitle
getDummyTitle()
Fetch a dummy title to set on Messages.
Definition: ApiErrorFormatter.php:74
ApiErrorFormatter\addMessagesFromStatus
addMessagesFromStatus( $modulePath, StatusValue $status, $types=[ 'warning', 'error'])
Add warnings and errors from a StatusValue object to the result.
Definition: ApiErrorFormatter.php:117
Language
Internationalisation code.
Definition: Language.php:35
ApiErrorFormatter\$useDB
$useDB
Definition: ApiErrorFormatter.php:39
$type
$type
Definition: testCompression.php:48