MediaWiki  REL1_31
SpecialPage.php
Go to the documentation of this file.
1 <?php
27 
36 class SpecialPage implements MessageLocalizer {
37  // The canonical name of this special page
38  // Also used for the default <h1> heading, @see getDescription()
39  protected $mName;
40 
41  // The local name of this special page
42  private $mLocalName;
43 
44  // Minimum user level required to access this page, or "" for anyone.
45  // Also used to categorise the pages in Special:Specialpages
46  protected $mRestriction;
47 
48  // Listed in Special:Specialpages?
49  private $mListed;
50 
51  // Whether or not this special page is being included from an article
52  protected $mIncluding;
53 
54  // Whether the special page can be included in an article
55  protected $mIncludable;
56 
61  protected $mContext;
62 
66  private $linkRenderer;
67 
82  public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
84  self::getTitleValueFor( $name, $subpage, $fragment )
85  );
86  }
87 
97  public static function getTitleValueFor( $name, $subpage = false, $fragment = '' ) {
99 
100  return new TitleValue( NS_SPECIAL, $name, $fragment );
101  }
102 
110  public static function getSafeTitleFor( $name, $subpage = false ) {
112  if ( $name ) {
114  } else {
115  return null;
116  }
117  }
118 
136  public function __construct(
137  $name = '', $restriction = '', $listed = true,
138  $function = false, $file = '', $includable = false
139  ) {
140  $this->mName = $name;
141  $this->mRestriction = $restriction;
142  $this->mListed = $listed;
143  $this->mIncludable = $includable;
144  }
145 
150  function getName() {
151  return $this->mName;
152  }
153 
158  function getRestriction() {
159  return $this->mRestriction;
160  }
161 
162  // @todo FIXME: Decide which syntax to use for this, and stick to it
168  function isListed() {
169  return $this->mListed;
170  }
171 
178  function setListed( $listed ) {
179  return wfSetVar( $this->mListed, $listed );
180  }
181 
188  function listed( $x = null ) {
189  return wfSetVar( $this->mListed, $x );
190  }
191 
196  public function isIncludable() {
197  return $this->mIncludable;
198  }
199 
210  public function maxIncludeCacheTime() {
211  return $this->getConfig()->get( 'MiserMode' ) ? $this->getCacheTTL() : 0;
212  }
213 
217  protected function getCacheTTL() {
218  return 60 * 60;
219  }
220 
226  function including( $x = null ) {
227  return wfSetVar( $this->mIncluding, $x );
228  }
229 
234  function getLocalName() {
235  if ( !isset( $this->mLocalName ) ) {
236  $this->mLocalName = SpecialPageFactory::getLocalNameFor( $this->mName );
237  }
238 
239  return $this->mLocalName;
240  }
241 
250  public function isExpensive() {
251  return false;
252  }
253 
263  public function isCached() {
264  return false;
265  }
266 
274  public function isRestricted() {
275  // DWIM: If anons can do something, then it is not restricted
276  return $this->mRestriction != '' && !User::groupHasPermission( '*', $this->mRestriction );
277  }
278 
287  public function userCanExecute( User $user ) {
288  return $user->isAllowed( $this->mRestriction );
289  }
290 
296  throw new PermissionsError( $this->mRestriction );
297  }
298 
306  public function checkPermissions() {
307  if ( !$this->userCanExecute( $this->getUser() ) ) {
308  $this->displayRestrictionError();
309  }
310  }
311 
319  public function checkReadOnly() {
320  if ( wfReadOnly() ) {
321  throw new ReadOnlyError;
322  }
323  }
324 
336  public function requireLogin(
337  $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
338  ) {
339  if ( $this->getUser()->isAnon() ) {
340  throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
341  }
342  }
343 
351  protected function getLoginSecurityLevel() {
352  return false;
353  }
354 
369  protected function setReauthPostData( array $data ) {
370  }
371 
396  protected function checkLoginSecurityLevel( $level = null ) {
397  $level = $level ?: $this->getName();
398  $key = 'SpecialPage:reauth:' . $this->getName();
399  $request = $this->getRequest();
400 
401  $securityStatus = AuthManager::singleton()->securitySensitiveOperationStatus( $level );
402  if ( $securityStatus === AuthManager::SEC_OK ) {
403  $uniqueId = $request->getVal( 'postUniqueId' );
404  if ( $uniqueId ) {
405  $key = $key . ':' . $uniqueId;
406  $session = $request->getSession();
407  $data = $session->getSecret( $key );
408  if ( $data ) {
409  $session->remove( $key );
410  $this->setReauthPostData( $data );
411  }
412  }
413  return true;
414  } elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
415  $title = self::getTitleFor( 'Userlogin' );
416  $queryParams = $request->getQueryValues();
417 
418  if ( $request->wasPosted() ) {
419  $data = array_diff_assoc( $request->getValues(), $request->getQueryValues() );
420  if ( $data ) {
421  // unique ID in case the same special page is open in multiple browser tabs
422  $uniqueId = MWCryptRand::generateHex( 6 );
423  $key = $key . ':' . $uniqueId;
424  $queryParams['postUniqueId'] = $uniqueId;
425  $session = $request->getSession();
426  $session->persist(); // Just in case
427  $session->setSecret( $key, $data );
428  }
429  }
430 
431  $query = [
432  'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
433  'returntoquery' => wfArrayToCgi( array_diff_key( $queryParams, [ 'title' => true ] ) ),
434  'force' => $level,
435  ];
436  $url = $title->getFullURL( $query, false, PROTO_HTTPS );
437 
438  $this->getOutput()->redirect( $url );
439  return false;
440  }
441 
442  $titleMessage = wfMessage( 'specialpage-securitylevel-not-allowed-title' );
443  $errorMessage = wfMessage( 'specialpage-securitylevel-not-allowed' );
444  throw new ErrorPageError( $titleMessage, $errorMessage );
445  }
446 
463  public function prefixSearchSubpages( $search, $limit, $offset ) {
464  $subpages = $this->getSubpagesForPrefixSearch();
465  if ( !$subpages ) {
466  return [];
467  }
468 
469  return self::prefixSearchArray( $search, $limit, $subpages, $offset );
470  }
471 
480  protected function getSubpagesForPrefixSearch() {
481  return [];
482  }
483 
491  protected function prefixSearchString( $search, $limit, $offset ) {
492  $title = Title::newFromText( $search );
493  if ( !$title || !$title->canExist() ) {
494  // No prefix suggestion in special and media namespace
495  return [];
496  }
497 
498  $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
499  $searchEngine->setLimitOffset( $limit, $offset );
500  $searchEngine->setNamespaces( [] );
501  $result = $searchEngine->defaultPrefixSearch( $search );
502  return array_map( function ( Title $t ) {
503  return $t->getPrefixedText();
504  }, $result );
505  }
506 
518  protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
519  $escaped = preg_quote( $search, '/' );
520  return array_slice( preg_grep( "/^$escaped/i",
521  array_slice( $subpages, $offset ) ), 0, $limit );
522  }
523 
527  function setHeaders() {
528  $out = $this->getOutput();
529  $out->setArticleRelated( false );
530  $out->setRobotPolicy( $this->getRobotPolicy() );
531  $out->setPageTitle( $this->getDescription() );
532  if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
533  $out->addModuleStyles( [
534  'mediawiki.ui.input',
535  'mediawiki.ui.radio',
536  'mediawiki.ui.checkbox',
537  ] );
538  }
539  }
540 
548  final public function run( $subPage ) {
558  if ( !Hooks::run( 'SpecialPageBeforeExecute', [ $this, $subPage ] ) ) {
559  return;
560  }
561 
562  if ( $this->beforeExecute( $subPage ) === false ) {
563  return;
564  }
565  $this->execute( $subPage );
566  $this->afterExecute( $subPage );
567 
576  Hooks::run( 'SpecialPageAfterExecute', [ $this, $subPage ] );
577  }
578 
588  protected function beforeExecute( $subPage ) {
589  // No-op
590  }
591 
599  protected function afterExecute( $subPage ) {
600  // No-op
601  }
602 
611  public function execute( $subPage ) {
612  $this->setHeaders();
613  $this->checkPermissions();
614  $securityLevel = $this->getLoginSecurityLevel();
615  if ( $securityLevel !== false && !$this->checkLoginSecurityLevel( $securityLevel ) ) {
616  return;
617  }
618  $this->outputHeader();
619  }
620 
629  function outputHeader( $summaryMessageKey = '' ) {
631 
632  if ( $summaryMessageKey == '' ) {
633  $msg = $wgContLang->lc( $this->getName() ) . '-summary';
634  } else {
635  $msg = $summaryMessageKey;
636  }
637  if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
638  $this->getOutput()->wrapWikiMsg(
639  "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
640  }
641  }
642 
652  function getDescription() {
653  return $this->msg( strtolower( $this->mName ) )->text();
654  }
655 
663  function getTitle( $subpage = false ) {
664  wfDeprecated( __METHOD__, '1.23' );
665  return $this->getPageTitle( $subpage );
666  }
667 
675  function getPageTitle( $subpage = false ) {
676  return self::getTitleFor( $this->mName, $subpage );
677  }
678 
685  public function setContext( $context ) {
686  $this->mContext = $context;
687  }
688 
695  public function getContext() {
696  if ( $this->mContext instanceof IContextSource ) {
697  return $this->mContext;
698  } else {
699  wfDebug( __METHOD__ . " called and \$mContext is null. " .
700  "Return RequestContext::getMain(); for sanity\n" );
701 
702  return RequestContext::getMain();
703  }
704  }
705 
712  public function getRequest() {
713  return $this->getContext()->getRequest();
714  }
715 
722  public function getOutput() {
723  return $this->getContext()->getOutput();
724  }
725 
732  public function getUser() {
733  return $this->getContext()->getUser();
734  }
735 
742  public function getSkin() {
743  return $this->getContext()->getSkin();
744  }
745 
752  public function getLanguage() {
753  return $this->getContext()->getLanguage();
754  }
755 
761  public function getConfig() {
762  return $this->getContext()->getConfig();
763  }
764 
771  public function getFullTitle() {
772  return $this->getContext()->getTitle();
773  }
774 
782  protected function getRobotPolicy() {
783  return 'noindex,nofollow';
784  }
785 
793  public function msg( $key /* $args */ ) {
794  $message = call_user_func_array(
795  [ $this->getContext(), 'msg' ],
796  func_get_args()
797  );
798  // RequestContext passes context to wfMessage, and the language is set from
799  // the context, but setting the language for Message class removes the
800  // interface message status, which breaks for example usernameless gender
801  // invocations. Restore the flag when not including special page in content.
802  if ( $this->including() ) {
803  $message->setInterfaceMessageFlag( false );
804  }
805 
806  return $message;
807  }
808 
814  protected function addFeedLinks( $params ) {
815  $feedTemplate = wfScript( 'api' );
816 
817  foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
818  $theseParams = $params + [ 'feedformat' => $format ];
819  $url = wfAppendQuery( $feedTemplate, $theseParams );
820  $this->getOutput()->addFeedLink( $format, $url );
821  }
822  }
823 
832  public function addHelpLink( $to, $overrideBaseUrl = false ) {
833  if ( $this->including() ) {
834  return;
835  }
836 
838  $msg = $this->msg( $wgContLang->lc( $this->getName() ) . '-helppage' );
839 
840  if ( !$msg->isDisabled() ) {
841  $helpUrl = Skin::makeUrl( $msg->plain() );
842  $this->getOutput()->addHelpLink( $helpUrl, true );
843  } else {
844  $this->getOutput()->addHelpLink( $to, $overrideBaseUrl );
845  }
846  }
847 
856  public function getFinalGroupName() {
857  $name = $this->getName();
858 
859  // Allow overriding the group from the wiki side
860  $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
861  if ( !$msg->isBlank() ) {
862  $group = $msg->text();
863  } else {
864  // Than use the group from this object
865  $group = $this->getGroupName();
866  }
867 
868  return $group;
869  }
870 
877  public function doesWrites() {
878  return false;
879  }
880 
889  protected function getGroupName() {
890  return 'other';
891  }
892 
897  protected function useTransactionalTimeLimit() {
898  if ( $this->getRequest()->wasPosted() ) {
900  }
901  }
902 
907  public function getLinkRenderer() {
908  if ( $this->linkRenderer ) {
909  return $this->linkRenderer;
910  } else {
911  return MediaWikiServices::getInstance()->getLinkRenderer();
912  }
913  }
914 
920  $this->linkRenderer = $linkRenderer;
921  }
922 }
ReadOnlyError
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Definition: ReadOnlyError.php:28
SpecialPage\$mIncluding
$mIncluding
Definition: SpecialPage.php:52
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
SpecialPage\getFinalGroupName
getFinalGroupName()
Get the group that the special page belongs in on Special:SpecialPage Use this method,...
Definition: SpecialPage.php:856
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
Linker
Some internal bits split of from Skin.php.
Definition: Linker.php:34
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
SpecialPage\isExpensive
isExpensive()
Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in ...
Definition: SpecialPage.php:250
SpecialPage\getTitle
getTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:663
SpecialPage\maxIncludeCacheTime
maxIncludeCacheTime()
How long to cache page when it is being included.
Definition: SpecialPage.php:210
SpecialPage\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialPage.php:889
wfSetVar
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
Definition: GlobalFunctions.php:1699
MediaWiki\Linker\LinkRenderer
Class that generates HTML links for pages.
Definition: LinkRenderer.php:41
UserNotLoggedIn
Redirect a user to the login page.
Definition: UserNotLoggedIn.php:53
SpecialPage\$mIncludable
$mIncludable
Definition: SpecialPage.php:55
$out
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 $out
Definition: hooks.txt:864
SpecialPage\checkPermissions
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
Definition: SpecialPage.php:306
SpecialPage\setReauthPostData
setReauthPostData(array $data)
Record preserved POST data after a reauthentication.
Definition: SpecialPage.php:369
SpecialPage\__construct
__construct( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
Default constructor for special pages Derivative classes should call this from their constructor Note...
Definition: SpecialPage.php:136
SpecialPage\displayRestrictionError
displayRestrictionError()
Output an error message telling the user what access level they have to have.
Definition: SpecialPage.php:295
SpecialPage\setListed
setListed( $listed)
Set whether this page is listed in Special:Specialpages, at run-time.
Definition: SpecialPage.php:178
$params
$params
Definition: styleTest.css.php:40
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1262
SpecialPage\getLocalName
getLocalName()
Get the localised name of the special page.
Definition: SpecialPage.php:234
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialPage\$mContext
IContextSource $mContext
Current request context.
Definition: SpecialPage.php:61
SpecialPage\getSkin
getSkin()
Shortcut to get the skin being used for this instance.
Definition: SpecialPage.php:742
SpecialPage\useTransactionalTimeLimit
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: SpecialPage.php:897
MWCryptRand\generateHex
static generateHex( $chars, $forceStrong=false)
Generate a run of (ideally) cryptographically random data and return it in hexadecimal string format.
Definition: MWCryptRand.php:76
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:752
User\groupHasPermission
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
Definition: User.php:4991
$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
SpecialPage\getName
getName()
Get the name of this Special Page.
Definition: SpecialPage.php:150
SpecialPage\isListed
isListed()
Whether this special page is listed in Special:SpecialPages.
Definition: SpecialPage.php:168
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
MessageLocalizer
Interface for localizing messages in MediaWiki.
Definition: MessageLocalizer.php:28
SpecialPage\getRestriction
getRestriction()
Get the permission that a user must have to execute this page.
Definition: SpecialPage.php:158
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:469
SpecialPage\getSafeTitleFor
static getSafeTitleFor( $name, $subpage=false)
Get a localised Title object for a page name with a possibly unvalidated subpage.
Definition: SpecialPage.php:110
SpecialPage\$mRestriction
$mRestriction
Definition: SpecialPage.php:46
SpecialPage\getDescription
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
Definition: SpecialPage.php:652
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:63
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:832
SpecialPage\prefixSearchString
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
Definition: SpecialPage.php:491
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
SpecialPage\addFeedLinks
addFeedLinks( $params)
Adds RSS/atom links.
Definition: SpecialPage.php:814
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
SpecialPage\getCacheTTL
getCacheTTL()
Definition: SpecialPage.php:217
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
SpecialPage\checkLoginSecurityLevel
checkLoginSecurityLevel( $level=null)
Verifies that the user meets the security level, possibly reauthenticating them in the process.
Definition: SpecialPage.php:396
SpecialPage\$mLocalName
$mLocalName
Definition: SpecialPage.php:42
SpecialPage\getTitleValueFor
static getTitleValueFor( $name, $subpage=false, $fragment='')
Get a localised TitleValue object for a specified special page name.
Definition: SpecialPage.php:97
wfTransactionalTimeLimit
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
Definition: GlobalFunctions.php:3073
SpecialPage\getFullTitle
getFullTitle()
Return the full title, including $par.
Definition: SpecialPage.php:771
SpecialPage\isRestricted
isRestricted()
Can be overridden by subclasses with more complicated permissions schemes.
Definition: SpecialPage.php:274
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
SpecialPage\isIncludable
isIncludable()
Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
Definition: SpecialPage.php:196
SpecialPage\afterExecute
afterExecute( $subPage)
Gets called after.
Definition: SpecialPage.php:599
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
SpecialPage\beforeExecute
beforeExecute( $subPage)
Gets called before.
Definition: SpecialPage.php:588
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:230
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
SpecialPage\requireLogin
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
Definition: SpecialPage.php:336
SpecialPage\setLinkRenderer
setLinkRenderer(LinkRenderer $linkRenderer)
Definition: SpecialPage.php:919
Title\newFromTitleValue
static newFromTitleValue(TitleValue $titleValue)
Create a new Title from a TitleValue.
Definition: Title.php:233
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
SpecialPage\userCanExecute
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
Definition: SpecialPage.php:287
SpecialPage\getRobotPolicy
getRobotPolicy()
Return the robot policy.
Definition: SpecialPage.php:782
SpecialPage\prefixSearchArray
static prefixSearchArray( $search, $limit, array $subpages, $offset)
Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as op...
Definition: SpecialPage.php:518
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
SpecialPage\listed
listed( $x=null)
Get or set whether this special page is listed in Special:SpecialPages.
Definition: SpecialPage.php:188
SpecialPage\isCached
isCached()
Is this page cached? Expensive pages are cached or disabled in miser mode.
Definition: SpecialPage.php:263
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialPage\getLoginSecurityLevel
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
Definition: SpecialPage.php:351
SpecialPageFactory\getLocalNameFor
static getLocalNameFor( $name, $subpage=false)
Get the local name for a specified canonical name.
Definition: SpecialPageFactory.php:647
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
SpecialPage\run
run( $subPage)
Entry point.
Definition: SpecialPage.php:548
SpecialPage\execute
execute( $subPage)
Default execute method Checks user permissions.
Definition: SpecialPage.php:611
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:83
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
SpecialPage\$mName
$mName
Definition: SpecialPage.php:39
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Skin\makeUrl
static makeUrl( $name, $urlaction='')
Definition: Skin.php:1153
SpecialPage\getSubpagesForPrefixSearch
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept for prefix searches.
Definition: SpecialPage.php:480
SpecialPage\$mListed
$mListed
Definition: SpecialPage.php:49
SpecialPage\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialPage.php:463
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
SpecialPage\setContext
setContext( $context)
Sets the context this SpecialPage is executed in.
Definition: SpecialPage.php:685
SpecialPage\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialPage.php:877
SpecialPage\checkReadOnly
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
Definition: SpecialPage.php:319
$t
$t
Definition: testCompression.php:69
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:25
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1620
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:629
SpecialPage\including
including( $x=null)
Whether the special page is being evaluated via transclusion.
Definition: SpecialPage.php:226
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:35
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:377
MediaWiki
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:34