MediaWiki  1.23.14
SpecialAllpages Class Reference

Implements Special:Allpages. More...

Inheritance diagram for SpecialAllpages:
Collaboration diagram for SpecialAllpages:

Public Member Functions

 __construct ( $name='Allpages')
 Constructor. More...
 
 execute ( $par)
 Entry point : initialise variables and call subfunctions. More...
 
 namespaceForm ( $namespace=NS_MAIN, $from='', $to='', $hideredirects=false)
 HTML for the top form. More...
 
 showChunk ( $namespace=NS_MAIN, $from=false, $to=false, $hideredirects=false)
 
 showline ( $inpoint, $outpoint, $namespace=NS_MAIN, $hideRedirects=false)
 Show a line of "ABC to DEF" ranges of articles. More...
 
 showToplevel ( $namespace=NS_MAIN, $from='', $to='', $hideredirects=false)
 
- Public Member Functions inherited from IncludableSpecialPage
 __construct ( $name, $restriction='', $listed=true, $function=false, $file='default')
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $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...
 
 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...
 
 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...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 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...
 
 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...
 
 msg ()
 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...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 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...
 
 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 ()
 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...
 
 getNamespaceKeyAndText ( $ns, $text)
 
- 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...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Protected Attributes

int $maxLineCount = 100
 Maximum number of pages to show on single index subpage. More...
 
int $maxPageLength = 70
 Maximum number of chars to show for an entry. More...
 
int $maxPerPage = 345
 Maximum number of pages to show on single subpage. More...
 
 $maxTopLevelPages = 50000
 Maximum number of pages in a hierarchical ("top level") list. More...
 
string $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
 

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. More...
 

Detailed Description

Implements Special:Allpages.

Definition at line 29 of file SpecialAllpages.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialAllpages::__construct (   $name = 'Allpages')

Constructor.

Parameters
string$namename of the special page, as seen in links and URLs (default: 'Allpages')

Definition at line 70 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)

Reimplemented from SpecialPage.

Reimplemented in SpecialPrefixindex.

Definition at line 79 of file SpecialAllpages.php.

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

◆ getGroupName()

SpecialAllpages::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Reimplemented in SpecialPrefixindex.

Definition at line 585 of file SpecialAllpages.php.

◆ getNamespaceKeyAndText()

SpecialAllpages::getNamespaceKeyAndText (   $ns,
  $text 
)
protected
Parameters
$nsInteger: the namespace of the article
string$textthe name of the article
Returns
array( int namespace, string dbkey, string pagename ) or NULL on error

Definition at line 562 of file SpecialAllpages.php.

References $t, array(), and Title\makeTitleSafe().

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

◆ namespaceForm()

SpecialAllpages::namespaceForm (   $namespace = NS_MAIN,
  $from = '',
  $to = '',
  $hideredirects = false 
)

HTML for the top form.

Parameters
$namespaceInteger: a namespace constant (default NS_MAIN).
string$fromdbKey we are starting listing at.
string$todbKey we are ending listing at.
bool$hideredirectsdont show redirects (default FALSE)
Returns
string

Definition at line 120 of file SpecialAllpages.php.

References $from, $out, $t, array(), Xml\checkLabel(), Xml\closeElement(), Xml\element(), SpecialPage\getPageTitle(), global, Html\hidden(), Xml\input(), Xml\label(), SpecialPage\msg(), Html\namespaceSelector(), Xml\openElement(), Xml\submitButton(), and text.

Referenced by showChunk(), and showToplevel().

◆ 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$hideredirectsdont show redirects (default FALSE)

Definition at line 364 of file SpecialAllpages.php.

References $dbr, $from, $link, $maxPerPage, $n, $namespaces, $options, $out, $output, $query, $res, $s, $self, $t, array(), Xml\closeElement(), DB_SLAVE, Html\element(), SpecialPage\getContext(), SpecialPage\getLanguage(), getNamespaceKeyAndText(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\including(), Linker\link(), Linker\linkKnown(), list, Title\makeTitle(), SpecialPage\msg(), namespaceForm(), Title\newFromRow(), NS_MAIN, Xml\openElement(), Html\rawElement(), and wfGetDB().

Referenced by execute(), and showToplevel().

◆ showline()

SpecialAllpages::showline (   $inpoint,
  $outpoint,
  $namespace = NS_MAIN,
  $hideRedirects = false 
)

Show a line of "ABC to DEF" ranges of articles.

Parameters
string$inpointlower limit of pagenames
string$outpointupper limit of pagenames
$namespaceInteger (Default NS_MAIN)
bool$hideRedirectsdon't show redirects. Default: false
Returns
string

Definition at line 323 of file SpecialAllpages.php.

References $out, $wgContLang, array(), Html\element(), SpecialPage\getPageTitle(), global, and SpecialPage\msg().

Referenced by showToplevel().

◆ showToplevel()

SpecialAllpages::showToplevel (   $namespace = NS_MAIN,
  $from = '',
  $to = '',
  $hideredirects = false 
)
Parameters
$namespaceInteger (default NS_MAIN)
string$fromlist all pages from this name
string$tolist all pages to this name
bool$hideredirectsdont show redirects (default FALSE)

Definition at line 178 of file SpecialAllpages.php.

References $count, $dbr, $from, $lines, $options, $out, $output, $res, $s, $wgMemc, array(), Xml\closeElement(), DB_SLAVE, false, SpecialPage\getOutput(), SpecialPage\getPageTitle(), global, SpecialPage\including(), Linker\link(), Title\makeTitleSafe(), SpecialPage\msg(), namespaceForm(), Xml\openElement(), showChunk(), showline(), wfGetDB(), and wfMemcKey().

Referenced by execute().

Member Data Documentation

◆ $maxLineCount

int SpecialAllpages::$maxLineCount = 100
protected

Maximum number of pages to show on single index subpage.

$maxLineCount

Definition at line 41 of file SpecialAllpages.php.

◆ $maxPageLength

int SpecialAllpages::$maxPageLength = 70
protected

Maximum number of chars to show for an entry.

$maxPageLength

Definition at line 47 of file SpecialAllpages.php.

◆ $maxPerPage

int SpecialAllpages::$maxPerPage = 345
protected

Maximum number of pages to show on single subpage.

$maxPerPage

Definition at line 35 of file SpecialAllpages.php.

Referenced by showChunk().

◆ $maxTopLevelPages

SpecialAllpages::$maxTopLevelPages = 50000
protected

Maximum number of pages in a hierarchical ("top level") list.

Traversal of the entire page list by spidering the top levels is thought to require O(N^3) DB CPU time where N is the number of pages on the wiki. See bug 56840. If this limit is exceeded, the behaviour becomes like a simple alphabetic pager.

Definition at line 57 of file SpecialAllpages.php.

◆ $nsfromMsg

string SpecialAllpages::$nsfromMsg = 'allpagesfrom'
protected

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

$nsfromMsg

Definition at line 63 of file SpecialAllpages.php.


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