MediaWiki  master
SpecialAllPages Class Reference

Implements Special:Allpages. More...

Inheritance diagram for SpecialAllPages:
Collaboration diagram for SpecialAllPages:

Public Member Functions

 __construct ( $name='Allpages')
 
 execute ( $par)
 Entry point : initialise variables and call subfunctions. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 showChunk ( $namespace=NS_MAIN, $from=false, $to=false, $hideredirects=false)
 
 showToplevel ( $namespace=NS_MAIN, $from='', $to='', $hideredirects=false)
 
- Public Member Functions inherited from IncludableSpecialPage
 __construct ( $name, $restriction='', $listed=true, $function=false, $file='default')
 
 isIncludable ()
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key)
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 getGroupName ()
 
 getNamespaceKeyAndText ( $ns, $text)
 
 outputHTMLForm ( $namespace=NS_MAIN, $from='', $to='', $hideRedirects=false)
 Outputs the HTMLForm used on this page. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $maxPerPage = 345
 Maximum number of pages to show on single subpage. More...
 
 $nsfromMsg = 'allpagesfrom'
 Determines, which message describes the input field 'nsfrom'. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
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, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 

Detailed Description

Implements Special:Allpages.

Todo:
Rewrite using IndexPager

Definition at line 30 of file SpecialAllPages.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialAllPages::__construct (   $name = 'Allpages')
Parameters
string$nameName of the special page, as seen in links and URLs (default: 'Allpages')

Definition at line 49 of file SpecialAllPages.php.

References $name.

Member Function Documentation

◆ execute()

SpecialAllPages::execute (   $par)

Entry point : initialise variables and call subfunctions.

Parameters
string$parBecomes "FOO" when called like Special:Allpages/FOO (default null)

Definition at line 58 of file SpecialAllPages.php.

References $namespaces, $out, $request, SpecialPage\getConfig(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\msg(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showChunk(), and showToplevel().

◆ getGroupName()

SpecialAllPages::getGroupName ( )
protected

Definition at line 384 of file SpecialAllPages.php.

◆ getNamespaceKeyAndText()

SpecialAllPages::getNamespaceKeyAndText (   $ns,
  $text 
)
protected
Parameters
int$nsThe namespace of the article
string$textThe name of the article
Returns
array|null [ int namespace, string dbkey, string pagename ] or null on error

Definition at line 349 of file SpecialAllPages.php.

References $t, and Title\makeTitleSafe().

Referenced by showChunk(), and SpecialPrefixindex\showPrefixChunk().

◆ outputHTMLForm()

SpecialAllPages::outputHTMLForm (   $namespace = NS_MAIN,
  $from = '',
  $to = '',
  $hideRedirects = false 
)
protected

Outputs the HTMLForm used on this page.

Parameters
int$namespaceA namespace constant (default NS_MAIN).
string$fromDbKey we are starting listing at.
string$toDbKey we are ending listing at.
bool$hideRedirectsDon't show redirects (default false)

Definition at line 102 of file SpecialAllPages.php.

References $context, $formDescriptor, HTMLForm\factory(), SpecialPage\getConfig(), SpecialPage\getContext(), and SpecialPage\getPageTitle().

Referenced by showChunk().

◆ prefixSearchSubpages()

SpecialAllPages::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Definition at line 380 of file SpecialAllPages.php.

References SpecialPage\prefixSearchString().

◆ showChunk()

SpecialAllPages::showChunk (   $namespace = NS_MAIN,
  $from = false,
  $to = false,
  $hideredirects = false 
)
Parameters
int$namespaceNamespace (Default NS_MAIN)
string$fromList all pages from this name (default false)
string$toList all pages to this name (default false)
bool$hideredirectsDon't show redirects (default false)

Definition at line 176 of file SpecialAllPages.php.

References $dbr, SpecialPage\$linkRenderer, $namespaces, $out, $output, $query, $res, $s, $self, $t, Html\closeElement(), DB_REPLICA, Html\element(), SpecialPage\getContext(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), getNamespaceKeyAndText(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\including(), list, Title\makeTitle(), SpecialPage\msg(), Title\newFromRow(), NS_MAIN, Html\openElement(), outputHTMLForm(), Html\rawElement(), text, and wfGetDB().

Referenced by execute(), and showToplevel().

◆ showToplevel()

SpecialAllPages::showToplevel (   $namespace = NS_MAIN,
  $from = '',
  $to = '',
  $hideredirects = false 
)
Parameters
int$namespace(default NS_MAIN)
string$fromList all pages from this name
string$toList all pages to this name
bool$hideredirectsDon't show redirects (default false)

Definition at line 161 of file SpecialAllPages.php.

References Title\makeTitleSafe(), and showChunk().

Referenced by execute().

Member Data Documentation

◆ $maxPerPage

int SpecialAllPages::$maxPerPage = 345
protected

Maximum number of pages to show on single subpage.

Definition at line 37 of file SpecialAllPages.php.

◆ $nsfromMsg

string SpecialAllPages::$nsfromMsg = 'allpagesfrom'
protected

Determines, which message describes the input field 'nsfrom'.

Definition at line 44 of file SpecialAllPages.php.


The documentation for this class was generated from the following file: