Special:PagesWithProp to search the page_props table. More...
Public Member Functions | |
| __construct ($name= 'PagesWithProp') | |
| execute ($par) | |
| This is the actual workhorse. | |
| formatResult ($skin, $result) | |
| getExistingPropNames () | |
| getOrderFields () | |
| Subclasses return an array of fields to order by here. | |
| 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. | |
| 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. | |
| isSyndicated () | |
| Disable RSS/Atom feeds. | |
| onSubmit ($data, $form) | |
| prefixSearchSubpages ($search, $limit=10) | |
| Return an array of subpages beginning with $search that this special page will accept. | |
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'. | |
Private Attributes | |
| $existingPropNames = null | |
| $propName = null | |
Detailed Description
Special:PagesWithProp to search the page_props table.
- Since:
- 1.21
Definition at line 31 of file SpecialPagesWithProp.php.
Constructor & Destructor Documentation
| SpecialPagesWithProp::__construct | ( | $ | name = 'PagesWithProp' | ) |
Definition at line 35 of file SpecialPagesWithProp.php.
References $name.
Member Function Documentation
| SpecialPagesWithProp::execute | ( | $ | par | ) |
This is the actual workhorse.
It does everything needed to make a real, honest-to-gosh query page.
- Parameters:
-
string $par
Reimplemented from QueryPage.
Definition at line 43 of file SpecialPagesWithProp.php.
References $form, array(), SpecialPage\getContext(), getExistingPropNames(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\msg(), SpecialPage\outputHeader(), and SpecialPage\setHeaders().
Referenced by onSubmit().
| SpecialPagesWithProp::formatResult | ( | $ | skin, |
| $ | result | ||
| ) |
- Parameters:
-
Skin $skin object $result Result row
- Returns:
- string
Reimplemented from QueryPage.
Definition at line 130 of file SpecialPagesWithProp.php.
References $result, $ret, $title, array(), Html\element(), SpecialPage\getLanguage(), Linker\link(), SpecialPage\msg(), and Title\newFromRow().
Definition at line 155 of file SpecialPagesWithProp.php.
References $dbr, $res, array(), as, and wfGetDB().
Referenced by execute(), and prefixSearchSubpages().
| 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 174 of file SpecialPagesWithProp.php.
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:
- array
- Since:
- 1.18
Reimplemented from QueryPage.
Definition at line 121 of file SpecialPagesWithProp.php.
References array().
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 101 of file SpecialPagesWithProp.php.
References array().
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 39 of file SpecialPagesWithProp.php.
Disable RSS/Atom feeds.
- Returns:
- bool
Reimplemented from QueryPage.
Definition at line 97 of file SpecialPagesWithProp.php.
| SpecialPagesWithProp::onSubmit | ( | $ | data, |
| $ | form | ||
| ) |
Definition at line 76 of file SpecialPagesWithProp.php.
References execute().
| SpecialPagesWithProp::prefixSearchSubpages | ( | $ | search, |
| $ | limit = 10 |
||
| ) |
Return an array of subpages beginning with $search that this special page will accept.
- Parameters:
-
string $search Prefix to search for int $limit Maximum number of results to return
- Returns:
- string[] Matching subpages
Reimplemented from SpecialPage.
Definition at line 88 of file SpecialPagesWithProp.php.
References QueryPage\$limit, getExistingPropNames(), and SpecialPage\prefixSearchArray().
Member Data Documentation
SpecialPagesWithProp::$existingPropNames = null [private] |
Definition at line 33 of file SpecialPagesWithProp.php.
SpecialPagesWithProp::$propName = null [private] |
Definition at line 32 of file SpecialPagesWithProp.php.
The documentation for this class was generated from the following file:
- includes/specials/SpecialPagesWithProp.php
