MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
32  private static $dummyTitle = null;
35  protected $result;
38  protected $lang;
39  protected $useDB = false;
40  protected $format = 'none';
52  public function __construct( ApiResult $result, Language $lang, $format, $useDB = false ) {
53  $this->result = $result;
54  $this->lang = $lang;
55  $this->useDB = $useDB;
56  $this->format = $format;
57  }
63  protected function getDummyTitle() {
64  if ( self::$dummyTitle === null ) {
65  self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
66  }
67  return self::$dummyTitle;
68  }
79  public function addWarning( $moduleName, $msg, $code = null, $data = null ) {
80  $msg = ApiMessage::create( $msg, $code, $data )
81  ->inLanguage( $this->lang )
82  ->title( $this->getDummyTitle() )
83  ->useDatabase( $this->useDB );
84  $this->addWarningOrError( 'warning', $moduleName, $msg );
85  }
96  public function addError( $moduleName, $msg, $code = null, $data = null ) {
97  $msg = ApiMessage::create( $msg, $code, $data )
98  ->inLanguage( $this->lang )
99  ->title( $this->getDummyTitle() )
100  ->useDatabase( $this->useDB );
101  $this->addWarningOrError( 'error', $moduleName, $msg );
102  }
110  public function addMessagesFromStatus(
111  $moduleName, Status $status, $types = [ 'warning', 'error' ]
112  ) {
113  if ( $status->isGood() || !$status->errors ) {
114  return;
115  }
117  $types = (array)$types;
118  foreach ( $status->errors as $error ) {
119  if ( !in_array( $error['type'], $types, true ) ) {
120  continue;
121  }
123  if ( $error['type'] === 'error' ) {
124  $tag = 'error';
125  } else {
126  // Assume any unknown type is a warning
127  $tag = 'warning';
128  }
130  if ( is_array( $error ) && isset( $error['message'] ) ) {
131  // Normal case
132  if ( $error['message'] instanceof Message ) {
133  $msg = ApiMessage::create( $error['message'], null, [] );
134  } else {
135  $args = isset( $error['params'] ) ? $error['params'] : [];
136  array_unshift( $args, $error['message'] );
137  $error += [ 'params' => [] ];
138  $msg = ApiMessage::create( $args, null, [] );
139  }
140  } elseif ( is_array( $error ) ) {
141  // Weird case handled by Message::getErrorMessage
142  $msg = ApiMessage::create( $error, null, [] );
143  } else {
144  // Another weird case handled by Message::getErrorMessage
145  $msg = ApiMessage::create( $error, null, [] );
146  }
148  $msg->inLanguage( $this->lang )
149  ->title( $this->getDummyTitle() )
150  ->useDatabase( $this->useDB );
151  $this->addWarningOrError( $tag, $moduleName, $msg );
152  }
153  }
162  public function arrayFromStatus( Status $status, $type = 'error', $format = null ) {
163  if ( $status->isGood() || !$status->errors ) {
164  return [];
165  }
167  $result = new ApiResult( 1e6 );
168  $formatter = new ApiErrorFormatter(
169  $result, $this->lang, $format ?: $this->format, $this->useDB
170  );
171  $formatter->addMessagesFromStatus( 'dummy', $status, [ $type ] );
172  switch ( $type ) {
173  case 'error':
174  return (array)$result->getResultData( [ 'errors', 'dummy' ] );
175  case 'warning':
176  return (array)$result->getResultData( [ 'warnings', 'dummy' ] );
177  }
178  }
186  protected function addWarningOrError( $tag, $moduleName, $msg ) {
187  $value = [ 'code' => $msg->getApiCode() ];
188  switch ( $this->format ) {
189  case 'wikitext':
190  $value += [
191  'text' => $msg->text(),
192  ApiResult::META_CONTENT => 'text',
193  ];
194  break;
196  case 'html':
197  $value += [
198  'html' => $msg->parse(),
199  ApiResult::META_CONTENT => 'html',
200  ];
201  break;
203  case 'raw':
204  $value += [
205  'key' => $msg->getKey(),
206  'params' => $msg->getParams(),
207  ];
208  ApiResult::setIndexedTagName( $value['params'], 'param' );
209  break;
211  case 'none':
212  break;
213  }
214  $value += $msg->getApiData();
216  $path = [ $tag . 's', $moduleName ];
217  $existing = $this->result->getResultData( $path );
218  if ( $existing === null || !in_array( $value, $existing ) ) {
220  if ( $existing === null ) {
222  }
223  $this->result->addValue( $path, null, $value, $flags );
224  $this->result->addIndexedTagName( $path, $tag );
225  }
226  }
227 }
235 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
237  // @codingStandardsIgnoreEnd
242  public function __construct( ApiResult $result ) {
243  parent::__construct( $result, Language::factory( 'en' ), 'none', false );
244  }
246  public function arrayFromStatus( Status $status, $type = 'error', $format = null ) {
247  if ( $status->isGood() || !$status->errors ) {
248  return [];
249  }
251  $result = [];
252  foreach ( $status->getErrorsByType( $type ) as $error ) {
253  if ( $error['message'] instanceof Message ) {
254  $error = [
255  'message' => $error['message']->getKey(),
256  'params' => $error['message']->getParams(),
257  ] + $error;
258  }
259  ApiResult::setIndexedTagName( $error['params'], 'param' );
260  $result[] = $error;
261  }
264  return $result;
265  }
267  protected function addWarningOrError( $tag, $moduleName, $msg ) {
268  $value = $msg->plain();
270  if ( $tag === 'error' ) {
271  // In BC mode, only one error
272  $code = $msg->getApiCode();
273  if ( isset( ApiBase::$messageMap[$code] ) ) {
274  // Backwards compatibility
275  $code = ApiBase::$messageMap[$code]['code'];
276  }
278  $value = [
279  'code' => $code,
280  'info' => $value,
281  ] + $msg->getApiData();
282  $this->result->addValue( null, 'error', $value,
284  } else {
285  // Don't add duplicate warnings
286  $tag .= 's';
287  $path = [ $tag, $moduleName ];
288  $oldWarning = $this->result->getResultData( [ $tag, $moduleName, $tag ] );
289  if ( $oldWarning !== null ) {
290  $warnPos = strpos( $oldWarning, $value );
291  // If $value was found in $oldWarning, check if it starts at 0 or after "\n"
292  if ( $warnPos !== false && ( $warnPos === 0 || $oldWarning[$warnPos - 1] === "\n" ) ) {
293  // Check if $value is followed by "\n" or the end of the $oldWarning
294  $warnPos += strlen( $value );
295  if ( strlen( $oldWarning ) <= $warnPos || $oldWarning[$warnPos] === "\n" ) {
296  return;
297  }
298  }
299  // If there is a warning already, append it to the existing one
300  $value = "$oldWarning\n$value";
301  }
302  $this->result->addContentValue( $path, $tag, $value,
304  }
305  }
306 }
the array() calling protocol came about after MediaWiki 1.4rc1.
static $messageMap
Array that maps message keys to error messages.
Definition: ApiBase.php:1684
Formats errors and warnings for the API, and add them to the associated ApiResult.
addMessagesFromStatus($moduleName, Status $status, $types=[ 'warning', 'error'])
Add warnings and errors from a Status object to the result.
Definition: Defines.php:45
Returns whether the operation completed and didn't have any error or warnings.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
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
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
if($line===false) $args
Definition: cdb.php:64
arrayFromStatus(Status $status, $type= 'error', $format=null)
Format messages from a Status as an array.
addWarning($moduleName, $msg, $code=null, $data=null)
Add a warning to the result.
static create($msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:129
Format errors and warnings in the old style, for backwards compatibility.
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition: ApiResult.php:56
This class represents the result of the API operations.
Definition: ApiResult.php:33
__construct(ApiResult $result, Language $lang, $format, $useDB=false)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books $tag
Definition: hooks.txt:1007
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
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:802
addError($moduleName, $msg, $code=null, $data=null)
Add an error to the result.
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
Fetch a dummy title to set on Messages.
Returns a list of status messages of the given type.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
Key for the 'content' metadata item.
Definition: ApiResult.php:88
static factory($code)
Get a cached or new language object for a given language code.
Definition: Language.php:181
arrayFromStatus(Status $status, $type= 'error', $format=null)
Override existing value in addValue(), setValue(), and similar functions.
Definition: ApiResult.php:39
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
addWarningOrError($tag, $moduleName, $msg)
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1610
addWarningOrError($tag, $moduleName, $msg)
Actually add the warning or error to the result.
static Title $dummyTitle
Dummy title to silence warnings from MessageCache::parse()