MediaWiki  master
SpecialNewpages Class Reference

A special page that list newly created pages. More...

Inheritance diagram for SpecialNewpages:
Collaboration diagram for SpecialNewpages:

Public Member Functions

 __construct (LinkBatchFactory $linkBatchFactory, CommentStore $commentStore, IContentHandlerFactory $contentHandlerFactory, GroupPermissionsLookup $groupPermissionsLookup, ILoadBalancer $loadBalancer, RevisionLookup $revisionLookup, NamespaceInfo $namespaceInfo, UserOptionsLookup $userOptionsLookup)
 
 execute ( $par)
 Show a form for filtering namespace and username. More...
 
 formatRow ( $result)
 Format a row, providing the timestamp, links to the page/history, size, user links, and a comment. More...
 
- 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='', $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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 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...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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

 feed ( $type)
 Output a subscription feed listing recent edits to this page. More...
 
 feedItem ( $row)
 
 feedItemAuthor ( $row)
 
 feedItemDesc ( $row)
 
 feedTitle ()
 
 filterLinks ()
 
 form ()
 
 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...
 
 parseParams ( $par)
 
 patrollable ( $result)
 Should a specific result row provide "patrollable" links? More...
 
 setup ( $par)
 
- 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...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getAuthManager ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. 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...
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. 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...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

array[] $customFilters
 
FormOptions $opts
 
 $showNavigation = false
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Private Member Functions

 canAnonymousUsersCreatePages ()
 
 revisionFromRcResult (stdClass $result, Title $title)
 

Private Attributes

CommentStore $commentStore
 
IContentHandlerFactory $contentHandlerFactory
 
GroupPermissionsLookup $groupPermissionsLookup
 
LinkBatchFactory $linkBatchFactory
 
ILoadBalancer $loadBalancer
 
NamespaceInfo $namespaceInfo
 
RevisionLookup $revisionLookup
 
UserOptionsLookup $userOptionsLookup
 

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

A special page that list newly created pages.

Definition at line 40 of file SpecialNewpages.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialNewpages::__construct ( LinkBatchFactory  $linkBatchFactory,
CommentStore  $commentStore,
IContentHandlerFactory  $contentHandlerFactory,
GroupPermissionsLookup  $groupPermissionsLookup,
ILoadBalancer  $loadBalancer,
RevisionLookup  $revisionLookup,
NamespaceInfo  $namespaceInfo,
UserOptionsLookup  $userOptionsLookup 
)
Parameters
LinkBatchFactory$linkBatchFactory
CommentStore$commentStore
IContentHandlerFactory$contentHandlerFactory
GroupPermissionsLookup$groupPermissionsLookup
ILoadBalancer$loadBalancer
RevisionLookup$revisionLookup
NamespaceInfo$namespaceInfo
UserOptionsLookup$userOptionsLookup

Definition at line 84 of file SpecialNewpages.php.

References $commentStore, $contentHandlerFactory, $groupPermissionsLookup, $linkBatchFactory, $loadBalancer, $namespaceInfo, $revisionLookup, and $userOptionsLookup.

Member Function Documentation

◆ canAnonymousUsersCreatePages()

SpecialNewpages::canAnonymousUsersCreatePages ( )
private

Definition at line 643 of file SpecialNewpages.php.

Referenced by filterLinks().

◆ execute()

SpecialNewpages::execute (   $par)

Show a form for filtering namespace and username.

Parameters
string | null$par

Reimplemented from SpecialPage.

Definition at line 197 of file SpecialNewpages.php.

References SpecialPage\addHelpLink(), feed(), form(), SpecialPage\getHookContainer(), SpecialPage\getOutput(), SpecialPage\including(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), setup(), and wfArrayToCgi().

◆ feed()

SpecialNewpages::feed (   $type)
protected

Output a subscription feed listing recent edits to this page.

Parameters
string$type

Definition at line 548 of file SpecialNewpages.php.

References $type, feedItem(), feedTitle(), SpecialPage\getConfig(), SpecialPage\getHookContainer(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), and SpecialPage\msg().

Referenced by execute().

◆ feedItem()

SpecialNewpages::feedItem (   $row)
protected

Definition at line 597 of file SpecialNewpages.php.

References $title, and Title\makeTitle().

Referenced by feed().

◆ feedItemAuthor()

SpecialNewpages::feedItemAuthor (   $row)
protected

Definition at line 616 of file SpecialNewpages.php.

◆ feedItemDesc()

SpecialNewpages::feedItemDesc (   $row)
protected

Definition at line 620 of file SpecialNewpages.php.

References $content, SpecialPage\msg(), and FeedItem\stripComment().

◆ feedTitle()

SpecialNewpages::feedTitle ( )
protected

Definition at line 589 of file SpecialNewpages.php.

References SpecialPage\getConfig(), and SpecialPage\getDescription().

Referenced by feed().

◆ filterLinks()

◆ form()

SpecialNewpages::form ( )
protected

◆ formatRow()

SpecialNewpages::formatRow (   $result)

Format a row, providing the timestamp, links to the page/history, size, user links, and a comment.

Parameters
stdClass$resultResult row
Returns
string

Definition at line 418 of file SpecialNewpages.php.

References $lang, SpecialPage\$linkRenderer, $title, Html\element(), ChangeTags\formatSummaryRow(), SpecialPage\getHookRunner(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), Title\makeTitle(), SpecialPage\msg(), Title\newFromRow(), patrollable(), Html\rawElement(), Linker\revComment(), revisionFromRcResult(), and Linker\revUserTools().

◆ getCacheTTL()

SpecialNewpages::getCacheTTL ( )
protected
Stability: stable
to override
Returns
int Seconds that this page can be cached

Reimplemented from SpecialPage.

Definition at line 652 of file SpecialNewpages.php.

◆ getGroupName()

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

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 648 of file SpecialNewpages.php.

◆ parseParams()

SpecialNewpages::parseParams (   $par)
protected
Parameters
string$par

Definition at line 150 of file SpecialNewpages.php.

References SpecialPage\getLanguage().

Referenced by setup().

◆ patrollable()

SpecialNewpages::patrollable (   $result)
protected

Should a specific result row provide "patrollable" links?

Parameters
stdClass$resultResult row
Returns
bool

Definition at line 539 of file SpecialNewpages.php.

References SpecialPage\getUser().

Referenced by formatRow().

◆ revisionFromRcResult()

SpecialNewpages::revisionFromRcResult ( stdClass  $result,
Title  $title 
)
private
Parameters
stdClass$resultResult row from recent changes
Title$title
Returns
RevisionRecord

Definition at line 395 of file SpecialNewpages.php.

References $title.

Referenced by formatRow().

◆ setup()

SpecialNewpages::setup (   $par)
protected

Member Data Documentation

◆ $commentStore

CommentStore SpecialNewpages::$commentStore
private

Definition at line 54 of file SpecialNewpages.php.

Referenced by __construct().

◆ $contentHandlerFactory

IContentHandlerFactory SpecialNewpages::$contentHandlerFactory
private

Definition at line 57 of file SpecialNewpages.php.

Referenced by __construct().

◆ $customFilters

array [] SpecialNewpages::$customFilters
protected

Definition at line 46 of file SpecialNewpages.php.

◆ $groupPermissionsLookup

GroupPermissionsLookup SpecialNewpages::$groupPermissionsLookup
private

Definition at line 60 of file SpecialNewpages.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory SpecialNewpages::$linkBatchFactory
private

Definition at line 51 of file SpecialNewpages.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer SpecialNewpages::$loadBalancer
private

Definition at line 63 of file SpecialNewpages.php.

Referenced by __construct().

◆ $namespaceInfo

NamespaceInfo SpecialNewpages::$namespaceInfo
private

Definition at line 69 of file SpecialNewpages.php.

Referenced by __construct().

◆ $opts

FormOptions SpecialNewpages::$opts
protected

Definition at line 44 of file SpecialNewpages.php.

Referenced by setup().

◆ $revisionLookup

RevisionLookup SpecialNewpages::$revisionLookup
private

Definition at line 66 of file SpecialNewpages.php.

Referenced by __construct().

◆ $showNavigation

SpecialNewpages::$showNavigation = false
protected

Definition at line 48 of file SpecialNewpages.php.

◆ $userOptionsLookup

UserOptionsLookup SpecialNewpages::$userOptionsLookup
private

Definition at line 72 of file SpecialNewpages.php.

Referenced by __construct().


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