MediaWiki  REL1_24
SpecialCategories Class Reference
Inheritance diagram for SpecialCategories:
Collaboration diagram for SpecialCategories:

List of all members.

Public Member Functions

 __construct ()
 execute ($par)
 Default execute method Checks user permissions.
 setPageLinkRenderer (PageLinkRenderer $linkRenderer)
 Initialize or override the PageLinkRenderer SpecialCategories collaborates with.

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

Protected Attributes

PageLinkRenderer $linkRenderer = null

Private Member Functions

 initServices ()
 Initialize any services we'll need (unless it has already been provided via a setter).

Detailed Description

Definition at line 27 of file SpecialCategories.php.


Constructor & Destructor Documentation

Definition at line 33 of file SpecialCategories.php.


Member Function Documentation

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters:
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 67 of file SpecialCategories.php.

References $from, array(), Html\closeElement(), SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getRequest(), initServices(), SpecialPage\msg(), Html\openElement(), SpecialPage\outputHeader(), and SpecialPage\setHeaders().

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.

Definition at line 90 of file SpecialCategories.php.

Initialize any services we'll need (unless it has already been provided via a setter).

This allows for dependency injection even though we don't control object creation.

Definition at line 59 of file SpecialCategories.php.

Referenced by execute().

Initialize or override the PageLinkRenderer SpecialCategories collaborates with.

Useful mainly for testing.

Todo:
the pager should also be injected, and de-coupled from the rendering logic.
Parameters:
PageLinkRenderer$linkRenderer

Definition at line 49 of file SpecialCategories.php.


Member Data Documentation

PageLinkRenderer SpecialCategories::$linkRenderer = null [protected]

Definition at line 31 of file SpecialCategories.php.


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