MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
28 class UsageException extends MWException {
30  private $mCodestr;
35  private $mExtraData;
43  public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
44  parent::__construct( $message, $code );
45  $this->mCodestr = $codestr;
46  $this->mExtraData = $extradata;
48  // This should never happen, so throw an exception about it that will
49  // hopefully get logged with a backtrace (T138585)
50  if ( !is_string( $codestr ) || $codestr === '' ) {
51  throw new InvalidArgumentException( 'Invalid $codestr, was ' .
52  ( $codestr === '' ? 'empty string' : gettype( $codestr ) )
53  );
54  }
55  }
60  public function getCodeString() {
61  return $this->mCodestr;
62  }
67  public function getMessageArray() {
68  $result = [
69  'code' => $this->mCodestr,
70  'info' => $this->getMessage()
71  ];
72  if ( is_array( $this->mExtraData ) ) {
73  $result = array_merge( $result, $this->mExtraData );
74  }
76  return $result;
77  }
82  public function __toString() {
83  return "{$this->getCodeString()}: {$this->getMessage()}";
84  }
85 }
100  protected $modulePath;
101  protected $status;
108  public function __construct(
109  ApiBase $module = null, StatusValue $status, $httpCode = 0
110  ) {
111  if ( $status->isOK() ) {
112  throw new InvalidArgumentException( __METHOD__ . ' requires a fatal Status' );
113  }
115  $this->modulePath = $module ? $module->getModulePath() : null;
116  $this->status = $status;
118  // Bug T46111: Messages in the log files should be in English and not
119  // customized by the local wiki.
120  $enMsg = clone $this->getApiMessage();
121  $enMsg->inLanguage( 'en' )->useDatabase( false );
122  parent::__construct(
123  ApiErrorFormatter::stripMarkup( $enMsg->text() ),
124  $enMsg->getApiCode(),
125  $httpCode,
126  $enMsg->getApiData()
127  );
128  }
138  public static function newWithMessage(
139  ApiBase $module = null, $msg, $code = null, $data = null, $httpCode = 0
140  ) {
141  return new static(
142  $module,
144  $httpCode
145  );
146  }
151  private function getApiMessage() {
152  $errors = $this->status->getErrorsByType( 'error' );
153  if ( !$errors ) {
154  $errors = $this->status->getErrors();
155  }
156  if ( !$errors ) {
157  $msg = new ApiMessage( 'apierror-unknownerror-nocode', 'unknownerror' );
158  } else {
159  $msg = ApiMessage::create( $errors[0] );
160  }
161  return $msg;
162  }
168  public function getModulePath() {
169  return $this->modulePath;
170  }
176  public function getStatusValue() {
177  return $this->status;
178  }
185  public function getCodeString() {
186  return $this->getApiMessage()->getApiCode();
187  }
194  public function getMessageArray() {
195  $enMsg = clone $this->getApiMessage();
196  $enMsg->inLanguage( 'en' )->useDatabase( false );
198  return [
199  'code' => $enMsg->getApiCode(),
200  'info' => ApiErrorFormatter::stripMarkup( $enMsg->text() ),
201  ] + $enMsg->getApiData();
202  }
207  public function getMessageObject() {
208  return $this->status->getMessage();
209  }
214  public function __toString() {
215  $enMsg = clone $this->getApiMessage();
216  $enMsg->inLanguage( 'en' )->useDatabase( false );
217  $text = ApiErrorFormatter::stripMarkup( $enMsg->text() );
219  return get_class( $this ) . ": {$enMsg->getApiCode()}: {$text} "
220  . "in {$this->getFile()}:{$this->getLine()}\n"
221  . "Stack trace:\n{$this->getTraceAsString()}";
222  }
224 }
Fetch the error status.
Definition: ApiUsageException.php:176
Exception used to abort API execution with an error.
Definition: ApiUsageException.php:98
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
__construct(ApiBase $module=null, StatusValue $status, $httpCode=0)
Definition: ApiUsageException.php:108
Fetch the responsible module name.
Definition: ApiUsageException.php:168
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: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:1954
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:63
Definition: ApiUsageException.php:67
null array $mExtraData
Definition: ApiUsageException.php:35
static newWithMessage(ApiBase $module=null, $msg, $code=null, $data=null, $httpCode=0)
Definition: ApiUsageException.php:138
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
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:41
Extension of Message implementing IApiMessage.
Definition: ApiMessage.php:198
Definition: ApiUsageException.php:100
MediaWiki exception.
Definition: MWException.php:26
static stripMarkup( $text)
Turn wikitext into something resembling plaintext.
Definition: ApiErrorFormatter.php:252
This exception will be thrown when dieUsage is called to stop module execution.
Definition: ApiUsageException.php:28
Definition: ApiUsageException.php:82
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:212
Interface for MediaWiki-localized exceptions.
Definition: LocalizedException.php:27
Return a Message object for this exception.Message
Definition: ApiUsageException.php:207
Definition: ApiUsageException.php:30
Definition: ApiUsageException.php:214
Definition: ApiUsageException.php:185
Definition: ApiUsageException.php:151
Definition: ApiUsageException.php:60
Definition: ApiUsageException.php:101
__construct( $message, $codestr, $code=0, $extradata=null)
Definition: ApiUsageException.php:43
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:783
Definition: ApiUsageException.php:194
the array() calling protocol came about after MediaWiki 1.4rc1.