MediaWiki  master
ProtectedTitlesPager Class Reference
Inheritance diagram for ProtectedTitlesPager:
Collaboration diagram for ProtectedTitlesPager:

Public Member Functions

 __construct ( $form, $conds, $type, $level, $namespace, $sizetype='', $size=0)
 
 formatRow ( $row)
 Returns an HTML string representing the result row $row. More...
 
 getIndexField ()
 Returns the name of the index field. More...
 
 getQueryInfo ()
 
 getTitle ()
 
- Public Member Functions inherited from AlphabeticPager
 getNavigationBar ()
 Shamelessly stolen bits from ReverseChronologicalPager, didn't want to do class magic as may be still revamped. More...
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getLimit ()
 Get the current limit. More...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 reallyDoQuery ( $offset, $limit, $order)
 Do a query with specified parameters, rather than using the object context. More...
 
 setIncludeOffset ( $include)
 Set whether a row matching exactly the offset should be also included in the result or not. More...
 
 setLimit ( $limit)
 Set the limit from an other source than the request. More...
 
 setOffset ( $offset)
 Set the offset from an other source than the request. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

array $mConds
 
SpecialProtectedtitles $mForm
 
- Public Attributes inherited from IndexPager
IDatabase $mDb
 
bool $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
int $mDefaultLimit = 50
 The default entry limit choosen for clients. More...
 
bool $mIsBackwards
 
bool $mIsFirst
 True if the current result set is the first one. More...
 
bool $mIsLast
 
int $mLimit
 The maximum number of entries to show. More...
 
int[] $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 List of default entry limit options to be presented to clients. More...
 
mixed $mOffset
 The starting point to enumerate entries. More...
 
stdClass bool null $mPastTheEndRow
 Extra row fetched at the end to see if the end was reached. More...
 
bool $mQueryDone = false
 Whether the listing query completed. More...
 
WebRequest $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const DIR_DESCENDING = true
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const QUERY_ASCENDING = true
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 
const QUERY_DESCENDING = false
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 

Protected Member Functions

 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
- Protected Member Functions inherited from AlphabeticPager
 getOrderTypeMessages ()
 If this supports multiple order type messages, give the message key for enabling each one in getNavigationBar. More...
 
- Protected Member Functions inherited from IndexPager
 buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. More...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More...
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows. More...
 
 getEndBody ()
 Hook into getBody() for the end of the list. More...
 
 getExtraSortFields ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 getLimitLinks ()
 
 getLinkRenderer ()
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment. More...
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Private Attributes

string null $level
 
int null $namespace
 

Additional Inherited Members

- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 
- Protected Attributes inherited from IndexPager
array $mDefaultQuery
 
string[] $mExtraSortFields
 An array of secondary columns to order by. More...
 
array $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string string[] $mIndexField
 The index to actually be used for ordering. More...
 
array $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
array $mPastTheEndIndex
 

Detailed Description

Definition at line 25 of file ProtectedTitlesPager.php.

Constructor & Destructor Documentation

◆ __construct()

ProtectedTitlesPager::__construct (   $form,
  $conds,
  $type,
  $level,
  $namespace,
  $sizetype = '',
  $size = 0 
)
Parameters
SpecialProtectedtitles$form
array$conds
string | null$type
string | null$level
int | null$namespace
string | null$sizetype
int | null$size

Definition at line 52 of file ProtectedTitlesPager.php.

References $level, and $namespace.

Member Function Documentation

◆ formatRow()

ProtectedTitlesPager::formatRow (   $row)

Returns an HTML string representing the result row $row.

Rows will be concatenated and returned by getBody()

Parameters
array | stdClass$rowDatabase row
Returns
string

Reimplemented from IndexPager.

Definition at line 83 of file ProtectedTitlesPager.php.

◆ getIndexField()

ProtectedTitlesPager::getIndexField ( )

Returns the name of the index field.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=querykey will use indexfield to sort. In this case, the first returned key is the default.

Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.

The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).

Examples:

  • Always paginate on the user field: 'user'
  • Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ]
  • Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ]
  • Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ]
Returns
string|string[]|array[]

Reimplemented from IndexPager.

Definition at line 110 of file ProtectedTitlesPager.php.

◆ getQueryInfo()

ProtectedTitlesPager::getQueryInfo ( )
Returns
array

Reimplemented from IndexPager.

Definition at line 90 of file ProtectedTitlesPager.php.

References $level, and $mConds.

◆ getStartBody()

ProtectedTitlesPager::getStartBody ( )
protected

Hook into getBody(), allows text to be inserted at the start.

This will be called even if there are no rows in the result set.

Returns
string

Reimplemented from IndexPager.

Definition at line 62 of file ProtectedTitlesPager.php.

References LinkBatch\add().

◆ getTitle()

ProtectedTitlesPager::getTitle ( )
Returns
Title

Reimplemented from ContextSource.

Definition at line 79 of file ProtectedTitlesPager.php.

Member Data Documentation

◆ $level

string null ProtectedTitlesPager::$level
private

Definition at line 38 of file ProtectedTitlesPager.php.

Referenced by __construct(), and getQueryInfo().

◆ $mConds

array ProtectedTitlesPager::$mConds

Definition at line 35 of file ProtectedTitlesPager.php.

Referenced by getQueryInfo().

◆ $mForm

SpecialProtectedtitles ProtectedTitlesPager::$mForm

Definition at line 30 of file ProtectedTitlesPager.php.

◆ $namespace

int null ProtectedTitlesPager::$namespace
private

Definition at line 41 of file ProtectedTitlesPager.php.

Referenced by __construct().


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