MediaWiki REL1_32
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
68 public function newWithFormat( $format ) {
69 return new self( $this->result, $this->lang, $format, $this->useDB );
70 }
71
77 public function getFormat() {
78 return $this->format;
79 }
80
86 public function getLanguage() {
87 return $this->lang;
88 }
89
94 protected function getDummyTitle() {
95 if ( self::$dummyTitle === null ) {
96 self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
97 }
98 return self::$dummyTitle;
99 }
100
108 public function addWarning( $modulePath, $msg, $code = null, $data = null ) {
109 $msg = ApiMessage::create( $msg, $code, $data )
110 ->inLanguage( $this->lang )
111 ->title( $this->getDummyTitle() )
112 ->useDatabase( $this->useDB );
113 $this->addWarningOrError( 'warning', $modulePath, $msg );
114 }
115
123 public function addError( $modulePath, $msg, $code = null, $data = null ) {
124 $msg = ApiMessage::create( $msg, $code, $data )
125 ->inLanguage( $this->lang )
126 ->title( $this->getDummyTitle() )
127 ->useDatabase( $this->useDB );
128 $this->addWarningOrError( 'error', $modulePath, $msg );
129 }
130
138 public function addMessagesFromStatus(
139 $modulePath, StatusValue $status, $types = [ 'warning', 'error' ], array $filter = []
140 ) {
141 if ( $status->isGood() || !$status->getErrors() ) {
142 return;
143 }
144
145 $types = (array)$types;
146 foreach ( $status->getErrors() as $error ) {
147 if ( !in_array( $error['type'], $types, true ) ) {
148 continue;
149 }
150
151 if ( $error['type'] === 'error' ) {
152 $tag = 'error';
153 } else {
154 // Assume any unknown type is a warning
155 $tag = 'warning';
156 }
157
158 $msg = ApiMessage::create( $error )
159 ->inLanguage( $this->lang )
160 ->title( $this->getDummyTitle() )
161 ->useDatabase( $this->useDB );
162 if ( !in_array( $msg->getKey(), $filter, true ) ) {
163 $this->addWarningOrError( $tag, $modulePath, $msg );
164 }
165 }
166 }
167
180 public function getMessageFromException( $exception, array $options = [] ) {
181 $options += [ 'code' => null, 'data' => [] ];
182
183 if ( $exception instanceof ILocalizedException ) {
184 $msg = $exception->getMessageObject();
185 $params = [];
186 } elseif ( $exception instanceof MessageSpecifier ) {
187 $msg = Message::newFromSpecifier( $exception );
188 $params = [];
189 } else {
190 if ( isset( $options['wrap'] ) ) {
191 $msg = $options['wrap'];
192 } else {
193 $msg = new RawMessage( '$1' );
194 if ( !isset( $options['code'] ) ) {
195 $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $exception ) );
196 $options['code'] = 'internal_api_error_' . $class;
197 }
198 }
199 $params = [ wfEscapeWikiText( $exception->getMessage() ) ];
200 }
201 return ApiMessage::create( $msg, $options['code'], $options['data'] )
202 ->params( $params )
203 ->inLanguage( $this->lang )
204 ->title( $this->getDummyTitle() )
205 ->useDatabase( $this->useDB );
206 }
207
216 public function formatException( $exception, array $options = [] ) {
217 return $this->formatMessage(
218 $this->getMessageFromException( $exception, $options ),
219 $options['format'] ?? null
220 );
221 }
222
229 public function formatMessage( $msg, $format = null ) {
230 $msg = ApiMessage::create( $msg )
231 ->inLanguage( $this->lang )
232 ->title( $this->getDummyTitle() )
233 ->useDatabase( $this->useDB );
234 return $this->formatMessageInternal( $msg, $format ?: $this->format );
235 }
236
244 public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
245 if ( $status->isGood() || !$status->getErrors() ) {
246 return [];
247 }
248
249 $result = new ApiResult( 1e6 );
250 $formatter = new ApiErrorFormatter(
251 $result, $this->lang, $format ?: $this->format, $this->useDB
252 );
253 $formatter->addMessagesFromStatus( null, $status, [ $type ] );
254 switch ( $type ) {
255 case 'error':
256 return (array)$result->getResultData( [ 'errors' ] );
257 case 'warning':
258 return (array)$result->getResultData( [ 'warnings' ] );
259 }
260 }
261
268 public static function stripMarkup( $text ) {
269 // Turn semantic quoting tags to quotes
270 $ret = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $text );
271
272 // Strip tags and decode.
273 $ret = Sanitizer::stripAllTags( $ret );
274
275 return $ret;
276 }
277
283 private function formatRawMessage( MessageSpecifier $msg ) {
284 $ret = [
285 'key' => $msg->getKey(),
286 'params' => $msg->getParams(),
287 ];
288 ApiResult::setIndexedTagName( $ret['params'], 'param' );
289
290 // Transform Messages as parameters in the style of Message::fooParam().
291 foreach ( $ret['params'] as $i => $param ) {
292 if ( $param instanceof MessageSpecifier ) {
293 $ret['params'][$i] = [ 'message' => $this->formatRawMessage( $param ) ];
294 }
295 }
296 return $ret;
297 }
298
306 protected function formatMessageInternal( $msg, $format ) {
307 $value = [ 'code' => $msg->getApiCode() ];
308 switch ( $format ) {
309 case 'plaintext':
310 $value += [
311 'text' => self::stripMarkup( $msg->text() ),
312 ApiResult::META_CONTENT => 'text',
313 ];
314 break;
315
316 case 'wikitext':
317 $value += [
318 'text' => $msg->text(),
319 ApiResult::META_CONTENT => 'text',
320 ];
321 break;
322
323 case 'html':
324 $value += [
325 'html' => $msg->parse(),
326 ApiResult::META_CONTENT => 'html',
327 ];
328 break;
329
330 case 'raw':
331 $value += $this->formatRawMessage( $msg );
332 break;
333
334 case 'none':
335 break;
336 }
337 $data = $msg->getApiData();
338 if ( $data ) {
339 $value['data'] = $msg->getApiData() + [
340 ApiResult::META_TYPE => 'assoc',
341 ];
342 }
343 return $value;
344 }
345
352 protected function addWarningOrError( $tag, $modulePath, $msg ) {
353 $value = $this->formatMessageInternal( $msg, $this->format );
354 if ( $modulePath !== null ) {
355 $value += [ 'module' => $modulePath ];
356 }
357
358 $path = [ $tag . 's' ];
359 $existing = $this->result->getResultData( $path );
360 if ( $existing === null || !in_array( $value, $existing ) ) {
362 if ( $existing === null ) {
363 $flags |= ApiResult::ADD_ON_TOP;
364 }
365 $this->result->addValue( $path, null, $value, $flags );
366 $this->result->addIndexedTagName( $path, $tag );
367 }
368 }
369}
370
377// phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
379
383 public function __construct( ApiResult $result ) {
384 parent::__construct( $result, Language::factory( 'en' ), 'none', false );
385 }
386
387 public function getFormat() {
388 return 'bc';
389 }
390
391 public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
392 if ( $status->isGood() || !$status->getErrors() ) {
393 return [];
394 }
395
396 $result = [];
397 foreach ( $status->getErrorsByType( $type ) as $error ) {
398 $msg = ApiMessage::create( $error );
399 $error = [
400 'message' => $msg->getKey(),
401 'params' => $msg->getParams(),
402 'code' => $msg->getApiCode(),
403 ] + $error;
404 ApiResult::setIndexedTagName( $error['params'], 'param' );
405 $result[] = $error;
406 }
408
409 return $result;
410 }
411
412 protected function formatMessageInternal( $msg, $format ) {
413 return [
414 'code' => $msg->getApiCode(),
415 'info' => $msg->text(),
416 ] + $msg->getApiData();
417 }
418
427 public function formatException( $exception, array $options = [] ) {
428 $ret = parent::formatException( $exception, $options );
429 return empty( $options['bc'] ) ? $ret : $ret['info'];
430 }
431
432 protected function addWarningOrError( $tag, $modulePath, $msg ) {
433 $value = self::stripMarkup( $msg->text() );
434
435 if ( $tag === 'error' ) {
436 // In BC mode, only one error
437 $existingError = $this->result->getResultData( [ 'error' ] );
438 if ( !is_array( $existingError ) ||
439 !isset( $existingError['code'] ) || !isset( $existingError['info'] )
440 ) {
441 $value = [
442 'code' => $msg->getApiCode(),
443 'info' => $value,
444 ] + $msg->getApiData();
445 $this->result->addValue( null, 'error', $value,
447 }
448 } else {
449 if ( $modulePath === null ) {
450 $moduleName = 'unknown';
451 } else {
452 $i = strrpos( $modulePath, '+' );
453 $moduleName = $i === false ? $modulePath : substr( $modulePath, $i + 1 );
454 }
455
456 // Don't add duplicate warnings
457 $tag .= 's';
458 $path = [ $tag, $moduleName ];
459 $oldWarning = $this->result->getResultData( [ $tag, $moduleName, $tag ] );
460 if ( $oldWarning !== null ) {
461 $warnPos = strpos( $oldWarning, $value );
462 // If $value was found in $oldWarning, check if it starts at 0 or after "\n"
463 if ( $warnPos !== false && ( $warnPos === 0 || $oldWarning[$warnPos - 1] === "\n" ) ) {
464 // Check if $value is followed by "\n" or the end of the $oldWarning
465 $warnPos += strlen( $value );
466 if ( strlen( $oldWarning ) <= $warnPos || $oldWarning[$warnPos] === "\n" ) {
467 return;
468 }
469 }
470 // If there is a warning already, append it to the existing one
471 $value = "$oldWarning\n$value";
472 }
473 $this->result->addContentValue( $path, $tag, $value,
475 }
476 }
477}
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Format errors and warnings in the old style, for backwards compatibility.
formatMessageInternal( $msg, $format)
Format a message as an array.
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
formatException( $exception, array $options=[])
Format an exception as an array.
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
getFormat()
Fetch the format for this formatter.
Formats errors and warnings for the API, and add them to the associated ApiResult.
addMessagesFromStatus( $modulePath, StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
Add warnings and errors from a StatusValue object to the result.
__construct(ApiResult $result, Language $lang, $format, $useDB=false)
formatRawMessage(MessageSpecifier $msg)
Format a Message object for raw format.
getFormat()
Fetch the format for this formatter.
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
getMessageFromException( $exception, array $options=[])
Get an ApiMessage from an exception.
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
addWarning( $modulePath, $msg, $code=null, $data=null)
Add a warning to the result.
getDummyTitle()
Fetch a dummy title to set on Messages.
addError( $modulePath, $msg, $code=null, $data=null)
Add an error to the result.
static stripMarkup( $text)
Turn wikitext into something resembling plaintext.
formatMessageInternal( $msg, $format)
Format a message as an array.
formatException( $exception, array $options=[])
Format an exception as an array.
formatMessage( $msg, $format=null)
Format a message as an array.
static Title $dummyTitle
Dummy title to silence warnings from MessageCache::parse()
newWithFormat( $format)
Return a formatter like this one but with a different format.
getLanguage()
Fetch the Language for this formatter.
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
This class represents the result of the API operations.
Definition ApiResult.php:35
const META_TYPE
Key for the 'type' metadata item.
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:58
const META_CONTENT
Key for the 'content' metadata item.
Definition ApiResult.php:90
const OVERRIDE
Override existing value in addValue(), setValue(), and similar functions.
Definition ApiResult.php:41
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
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Internationalisation code.
Definition Language.php:35
Variant of the Message class.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Represents a title within MediaWiki.
Definition Title.php:39
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
const NS_SPECIAL
Definition Defines.php:53
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 since 1.16! 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 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:2042
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 '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:1305
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:2050
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:895
if the prop value should be in the metadata multi language array format
Definition hooks.txt:1690
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:2054
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
Interface for MediaWiki-localized exceptions.
getParams()
Returns the message parameters.
getKey()
Returns the message key.
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))
$params