MediaWiki  master
SpecialPagesWithProp Class Reference

Special:PagesWithProp to search the page_props table. More...

Inheritance diagram for SpecialPagesWithProp:
Collaboration diagram for SpecialPagesWithProp:

Public Member Functions

 __construct ( $name='PagesWithProp')
 
 execute ( $par)
 This is the actual workhorse. More...
 
 formatResult ( $skin, $result)
 
 getExistingPropNames ()
 
 getQueryInfo ()
 Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions. More...
 
 isCacheable ()
 Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode and will not have their results written to the querycache table. More...
 
 isSyndicated ()
 Disable RSS/Atom feeds. More...
 
 onSubmit ( $data, $form)
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 sortDescending ()
 
- Public Member Functions inherited from QueryPage
 delete (LinkTarget $title)
 Remove a cached result. More...
 
 doQuery ( $offset=false, $limit=false)
 Somewhat deprecated, you probably want to be using execute() More...
 
 fetchFromCache ( $limit, $offset=false)
 Fetch the query results from the query cache. More...
 
 getCachedTimestamp ()
 
 isCached ()
 Whether or not the output of the page in question is retrieved from the database cache. More...
 
 isExpensive ()
 Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode. More...
 
 reallyDoQuery ( $limit, $offset=false)
 Run the query and return the result. More...
 
 recache ( $limit, $ignoreErrors=true)
 Clear the cache and save new results. More...
 
 usesTimestamps ()
 Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching. 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...
 
 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...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. 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,... $params)
 Wrapper around wfMessage that sets the current context. 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...
 
 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 ()
 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...
 
 getOrderFields ()
 Subclasses return an array of fields to order by here. More...
 
 queryExistingProps ( $limit=null, $offset=0)
 
- Protected Member Functions inherited from QueryPage
 closeList ()
 
 executeLBFromResultWrapper (IResultWrapper $res, $ns=null)
 Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and optional the namespace field) and executes the batch. More...
 
 getCacheOrderFields ()
 Return the order fields for fetchFromCache. More...
 
 getDBLimit ( $uiLimit, $uiOffset)
 What is limit to fetch from DB. More...
 
 getLimitOffset ()
 Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser(). More...
 
 getMaxResults ()
 Get max number of results we can return in miser mode. More...
 
 getPageHeader ()
 The content returned by this function will be output before any result. More...
 
 getRecacheDB ()
 Get a DB connection to be used for slow recache queries. More...
 
 getSQL ()
 For back-compat, subclasses may return a raw SQL query here, as a string. More...
 
 linkParameters ()
 If using extra form wheely-dealies, return a set of parameters here as an associative array. More...
 
 openList ( $offset)
 
 outputResults ( $out, $skin, $dbr, $res, $num, $offset)
 Format and output report results using the given information plus OutputPage. More...
 
 preprocessResults ( $db, $res)
 Do any necessary preprocessing of the result object. More...
 
 setListoutput ( $bool)
 A mutator for $this->listoutput;. More...
 
 showEmptyText ()
 Outputs some kind of an informative message (via OutputPage) to let the user know that the query returned nothing and thus there's nothing to show. 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...
 
 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...
 
 getCacheTTL ()
 
 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...
 
 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)
 Perform a regular substring search for prefixSearchSubpages. 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...
 

Private Attributes

string[] null $existingPropNames = null
 
int null $ns
 
string null $propName = null
 
bool $reverse = false
 
bool $sortByValue = false
 

Additional Inherited Members

- Static Public Member Functions inherited from QueryPage
static getDisabledQueryPages (Config $config)
 Get a list of query pages disabled and with it's run mode. More...
 
static getPages ()
 Get a list of query page classes and their associated special pages, for periodic updates. More...
 
- 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...
 
- Protected Attributes inherited from QueryPage
string null $cachedTimestamp = null
 
int $limit = 0
 
bool $listoutput = false
 Whether or not we want plain listoutput rather than an ordered list. More...
 
int $numRows
 The number of rows returned by the query. More...
 
int $offset = 0
 The offset and limit in use, as passed to the query() function. More...
 
bool $shownavigation = true
 Whether to show prev/next links. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

Special:PagesWithProp to search the page_props table.

Since
1.21

Definition at line 30 of file SpecialPagesWithProp.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPagesWithProp::__construct (   $name = 'PagesWithProp')

Definition at line 57 of file SpecialPagesWithProp.php.

Member Function Documentation

◆ execute()

SpecialPagesWithProp::execute (   $par)

This is the actual workhorse.

It does everything needed to make a real, honest-to-gosh query page.

Parameters
string | null$par

Reimplemented from QueryPage.

Definition at line 65 of file SpecialPagesWithProp.php.

References $context, $ns, $reverse, $sortByValue, HTMLForm\factory(), SpecialPage\getContext(), getExistingPropNames(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\msg(), SpecialPage\outputHeader(), and SpecialPage\setHeaders().

◆ formatResult()

SpecialPagesWithProp::formatResult (   $skin,
  $result 
)
Parameters
Skin$skin
object$resultResult row
Returns
string

Reimplemented from QueryPage.

Definition at line 202 of file SpecialPagesWithProp.php.

References $title, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\msg(), and Title\newFromRow().

◆ getExistingPropNames()

SpecialPagesWithProp::getExistingPropNames ( )

Definition at line 227 of file SpecialPagesWithProp.php.

References $existingPropNames, and queryExistingProps().

Referenced by execute().

◆ getGroupName()

SpecialPagesWithProp::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.

Definition at line 261 of file SpecialPagesWithProp.php.

◆ getOrderFields()

SpecialPagesWithProp::getOrderFields ( )
protected

Subclasses return an array of fields to order by here.

Don't append DESC to the field names, that'll be done automatically if sortDescending() returns true.

Returns
string[]
Since
1.18

Reimplemented from QueryPage.

Definition at line 182 of file SpecialPagesWithProp.php.

◆ getQueryInfo()

SpecialPagesWithProp::getQueryInfo ( )

Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions.

Note that the query itself should return the following three columns: 'namespace', 'title', and 'value'. 'value' is used for sorting.

These may be stored in the querycache table for expensive queries, and that cached data will be returned sometimes, so the presence of extra fields can't be relied upon. The cached 'value' column will be an integer; non-numeric values are useful only for sorting the initial query (except if they're timestamps, see usesTimestamps()).

Don't include an ORDER or LIMIT clause, they will be added.

If this function is not overridden or returns something other than an array, getSQL() will be used instead. This is for backwards compatibility only and is strongly deprecated.

Returns
array
Since
1.18

Reimplemented from QueryPage.

Definition at line 154 of file SpecialPagesWithProp.php.

References $ns, and $propName.

◆ isCacheable()

SpecialPagesWithProp::isCacheable ( )

Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode and will not have their results written to the querycache table.

Returns
bool
Since
1.18

Reimplemented from QueryPage.

Definition at line 61 of file SpecialPagesWithProp.php.

◆ isSyndicated()

SpecialPagesWithProp::isSyndicated ( )

Disable RSS/Atom feeds.

Returns
bool

Reimplemented from QueryPage.

Definition at line 150 of file SpecialPagesWithProp.php.

◆ onSubmit()

SpecialPagesWithProp::onSubmit (   $data,
  $form 
)

Definition at line 127 of file SpecialPagesWithProp.php.

◆ prefixSearchSubpages()

SpecialPagesWithProp::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
int$offsetNumber of pages to skip
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 140 of file SpecialPagesWithProp.php.

References QueryPage\$limit, QueryPage\$offset, SpecialPage\prefixSearchArray(), and queryExistingProps().

◆ queryExistingProps()

SpecialPagesWithProp::queryExistingProps (   $limit = null,
  $offset = 0 
)
protected

◆ sortDescending()

SpecialPagesWithProp::sortDescending ( )
Returns
bool

Reimplemented from QueryPage.

Definition at line 193 of file SpecialPagesWithProp.php.

References $reverse.

Member Data Documentation

◆ $existingPropNames

string [] null SpecialPagesWithProp::$existingPropNames = null
private

Definition at line 40 of file SpecialPagesWithProp.php.

Referenced by getExistingPropNames().

◆ $ns

int null SpecialPagesWithProp::$ns
private

Definition at line 45 of file SpecialPagesWithProp.php.

Referenced by execute(), and getQueryInfo().

◆ $propName

string null SpecialPagesWithProp::$propName = null
private

Definition at line 35 of file SpecialPagesWithProp.php.

Referenced by getQueryInfo().

◆ $reverse

bool SpecialPagesWithProp::$reverse = false
private

Definition at line 50 of file SpecialPagesWithProp.php.

Referenced by execute(), and sortDescending().

◆ $sortByValue

bool SpecialPagesWithProp::$sortByValue = false
private

Definition at line 55 of file SpecialPagesWithProp.php.

Referenced by execute().


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