MediaWiki  1.29.1
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)
 Abstract formatting function. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getQueryInfo ()
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 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)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. 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...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 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...
 
 reallyDoQuery ( $offset, $limit, $descending)
 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 ()
 Get the Config object. More...
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getStats ()
 Get the Stats object. More...
 
 getTiming ()
 Get the Timing object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Public Attributes

 $mConds
 
 $mForm
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
ResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Constants for the $mDefaultDirection field. More...
 
const DIR_DESCENDING = true
 

Additional Inherited Members

- 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
 buildQueryInfo ( $offset, $limit, $descending)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. 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 ()
 This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 
- Protected Attributes inherited from IndexPager
 $mExtraSortFields
 An array of secondary columns to order by. More...
 
 $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
 $mIndexField
 The index to actually be used for ordering. More...
 
 $mLastShown
 
 $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 

Detailed Description

Definition at line 25 of file ProtectedTitlesPager.php.

Constructor & Destructor Documentation

◆ __construct()

ProtectedTitlesPager::__construct (   $form,
  $conds = [],
  $type,
  $level,
  $namespace,
  $sizetype = '',
  $size = 0 
)

Definition at line 29 of file ProtectedTitlesPager.php.

Member Function Documentation

◆ formatRow()

ProtectedTitlesPager::formatRow (   $row)

Abstract formatting function.

This should return 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 61 of file ProtectedTitlesPager.php.

◆ getIndexField()

ProtectedTitlesPager::getIndexField ( )

This function should be overridden to return the name of the index fi- eld.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=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.

Returns
string|array

Reimplemented from IndexPager.

Definition at line 88 of file ProtectedTitlesPager.php.

◆ getQueryInfo()

ProtectedTitlesPager::getQueryInfo ( )
Returns
array

Reimplemented from IndexPager.

Definition at line 68 of file ProtectedTitlesPager.php.

References $mConds.

◆ getStartBody()

ProtectedTitlesPager::getStartBody ( )

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 40 of file ProtectedTitlesPager.php.

References LinkBatch\add(), and as.

◆ getTitle()

ProtectedTitlesPager::getTitle ( )
Returns
Title

Reimplemented from ContextSource.

Definition at line 57 of file ProtectedTitlesPager.php.

Member Data Documentation

◆ $mConds

ProtectedTitlesPager::$mConds

Definition at line 27 of file ProtectedTitlesPager.php.

Referenced by getQueryInfo().

◆ $mForm

ProtectedTitlesPager::$mForm

Definition at line 27 of file ProtectedTitlesPager.php.


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