MediaWiki  1.28.1
ProtectedPagesPager Class Reference
Inheritance diagram for ProtectedPagesPager:
Collaboration diagram for ProtectedPagesPager:

Public Member Functions

 __construct ($form, $conds=[], $type, $level, $namespace, $sizetype= '', $size=0, $indefonly=false, $cascadeonly=false, $noredirect=false, LinkRenderer $linkRenderer)
 
 formatValue ($field, $value)
 
 getDefaultSort ()
 
 getFieldNames ()
 
 getIndexField ()
 
 getQueryInfo ()
 
 isFieldSortable ($field)
 
 preprocessResults ($result)
 
- Public Member Functions inherited from TablePager
 __construct (IContextSource $context=null)
 
 formatRow ($row)
 
 formatValue ($name, $value)
 Format a table cell. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getBodyOutput ()
 Get the formatted result list. More...
 
 getCellAttrs ($field, $value)
 Get any extra attributes to be applied to the given cell. More...
 
 getDefaultSort ()
 The database field name used as a default sort order. More...
 
 getEmptyBody ()
 
 getEndBody ()
 
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. More...
 
 getFullOutput ()
 Get the formatted result list, with navigation bars. More...
 
 getHiddenFields ($blacklist=[])
 Get \<input type="hidden"\> elements for use in a method="get" form. More...
 
 getIndexField ()
 
 getLimitDropdown ()
 Gets a limit selection dropdown. More...
 
 getLimitForm ()
 Get a form containing a limit selection dropdown. More...
 
 getLimitSelect ($attribs=[])
 Get a "<select>" element which has options for each of the allowed limits. More...
 
 getLimitSelectList ()
 Get a list of items to show in a "<select>" element of limits. More...
 
 getModuleStyles ()
 ResourceLoader modules that must be loaded to provide correct styling for this pager. More...
 
 getNavigationBar ()
 A navigation bar with images. More...
 
 getRowAttrs ($row)
 Get attributes to be applied to the given row. More...
 
 getRowClass ($row)
 Get a class name to be applied to the given row. More...
 
 getStartBody ()
 
 isFieldSortable ($field)
 Return true if the named field should be sortable by the UI, false otherwise. 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...
 
 formatRow ($row)
 Abstract formatting function. 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...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. 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...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. 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...
 
 getTitle ()
 Get the Title 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

 $cascadeonly
 
 $indefonly
 
 $level
 
 $mConds
 
 $mForm
 
 $namespace
 
 $noredirect
 
 $size
 
 $sizetype
 
- 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
 

Protected Member Functions

 getTableClass ()
 
- Protected Member Functions inherited from TablePager
 getCurrentRow ()
 
 getNavClass ()
 
 getSortHeaderClass ()
 
 getTableClass ()
 
- 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...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 preprocessResults ($result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Private Attributes

LinkRenderer $linkRenderer
 
 $type
 

Additional Inherited Members

- Protected Attributes inherited from TablePager
 $mCurrentRow
 
 $mSort
 
- 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

Todo:
document

Definition at line 281 of file SpecialProtectedpages.php.

Constructor & Destructor Documentation

ProtectedPagesPager::__construct (   $form,
  $conds = [],
  $type,
  $level,
  $namespace,
  $sizetype = '',
  $size = 0,
  $indefonly = false,
  $cascadeonly = false,
  $noredirect = false,
LinkRenderer  $linkRenderer 
)
Parameters
SpecialProtectedpages$form
array$conds
$type
$level
$namespace
string$sizetype
int$size
bool$indefonly
bool$cascadeonly
bool$noredirect
LinkRenderer$linkRenderer

Definition at line 303 of file SpecialProtectedpages.php.

References $level, $linkRenderer, $sizetype, $type, and type.

Member Function Documentation

ProtectedPagesPager::getDefaultSort ( )

Definition at line 581 of file SpecialProtectedpages.php.

ProtectedPagesPager::getFieldNames ( )

Definition at line 350 of file SpecialProtectedpages.php.

References as, and ContextSource\msg().

ProtectedPagesPager::getIndexField ( )

Definition at line 577 of file SpecialProtectedpages.php.

ProtectedPagesPager::getQueryInfo ( )

Definition at line 510 of file SpecialProtectedpages.php.

References $mConds, $size, and type.

ProtectedPagesPager::getTableClass ( )
protected

Definition at line 573 of file SpecialProtectedpages.php.

ProtectedPagesPager::isFieldSortable (   $field)

Definition at line 585 of file SpecialProtectedpages.php.

ProtectedPagesPager::preprocessResults (   $result)

Member Data Documentation

ProtectedPagesPager::$cascadeonly

Definition at line 283 of file SpecialProtectedpages.php.

ProtectedPagesPager::$indefonly

Definition at line 283 of file SpecialProtectedpages.php.

ProtectedPagesPager::$level

Definition at line 283 of file SpecialProtectedpages.php.

Referenced by __construct().

LinkRenderer ProtectedPagesPager::$linkRenderer
private

Definition at line 288 of file SpecialProtectedpages.php.

Referenced by __construct().

ProtectedPagesPager::$mConds

Definition at line 282 of file SpecialProtectedpages.php.

Referenced by getQueryInfo().

ProtectedPagesPager::$mForm

Definition at line 282 of file SpecialProtectedpages.php.

ProtectedPagesPager::$namespace

Definition at line 283 of file SpecialProtectedpages.php.

ProtectedPagesPager::$noredirect

Definition at line 283 of file SpecialProtectedpages.php.

ProtectedPagesPager::$size

Definition at line 283 of file SpecialProtectedpages.php.

Referenced by getQueryInfo().

ProtectedPagesPager::$sizetype

Definition at line 283 of file SpecialProtectedpages.php.

Referenced by __construct().

ProtectedPagesPager::$type
private

Definition at line 283 of file SpecialProtectedpages.php.

Referenced by __construct().


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