MediaWiki  1.23.2
BlockListPager Class Reference
Inheritance diagram for BlockListPager:
Collaboration diagram for BlockListPager:

Public Member Functions

 __construct ( $page, $conds)
 
 formatValue ( $name, $value)
 Format a table cell. More...
 
 getDefaultSort ()
 The database field name used as a default sort order. More...
 
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. More...
 
 getIndexField ()
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getTableClass ()
 
 isFieldSortable ( $name)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
 preprocessResults ( $result)
 Do a LinkBatch query to minimise database load when generating all these links. More...
 
- Public Member Functions inherited from TablePager
 __construct (IContextSource $context=null)
 
 formatRow ( $row)
 
 getCellAttrs ( $field, $value)
 Get any extra attributes to be applied to the given cell. More...
 
 getEmptyBody ()
 
 getEndBody ()
 
 getHiddenFields ( $blacklist=array())
 Get <input type="hidden"> elements for use in a method="get" form. More...
 
 getLimitDropdown ()
 Gets a limit selection dropdown. More...
 
 getLimitForm ()
 Get a form containing a limit selection dropdown. More...
 
 getLimitSelect ( $attribs=array())
 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...
 
 getNavClass ()
 
 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...
 
 getSortHeaderClass ()
 
 getStartBody ()
 
- Public Member Functions inherited from IndexPager
 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=array())
 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 RequestContext object. More...
 
 getLang ()
 Get the Language 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...
 
 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...
 

Protected Attributes

 $conds
 
 $page
 
- 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...
 

Additional Inherited Members

- Public Attributes inherited from TablePager
 $mCurrentRow
 
 $mSort
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = array( 20, 50, 100, 250, 500 )
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
ResultWrapper $mResult
 Result object for the query. 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: false for ascending, true for descending. 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...
 

Detailed Description

Definition at line 215 of file SpecialBlockList.php.

Constructor & Destructor Documentation

◆ __construct()

BlockListPager::__construct (   $page,
  $conds 
)
Parameters
$pageSpecialPage
$condsArray

Definition at line 223 of file SpecialBlockList.php.

References $conds, $page, and page.

Member Function Documentation

◆ formatValue()

BlockListPager::formatValue (   $name,
  $value 
)

Format a table cell.

The return value should be HTML, but use an empty string not &#160; for empty cells. Do not include the

and .

The current result row is available as $this->mCurrentRow, in case you need more context.

Access:\n protected
Parameters
string$namethe database field name
string$valuethe value retrieved from the database

Reimplemented from TablePager.

Definition at line 250 of file SpecialBlockList.php.

References TablePager\$mCurrentRow, $name, $type, $value, array(), Linker\formatComment(), ContextSource\getLanguage(), SpecialPage\getTitleFor(), ContextSource\getUser(), Linker\linkKnown(), list, ContextSource\msg(), Block\parseTarget(), Html\rawElement(), Linker\TOOL_LINKS_NOBLOCK, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, Linker\userLink(), and Linker\userToolLinks().

◆ getDefaultSort()

BlockListPager::getDefaultSort ( )

The database field name used as a default sort order.

Access:\n protected
Returns
string

Reimplemented from TablePager.

Definition at line 414 of file SpecialBlockList.php.

◆ getFieldNames()

BlockListPager::getFieldNames ( )

An array mapping database field names to a textual description of the field name, for use in the table header.

The description should be plain text, it will be HTML-escaped later.

Returns
Array

Reimplemented from TablePager.

Definition at line 230 of file SpecialBlockList.php.

References array(), as, and ContextSource\msg().

◆ getIndexField()

BlockListPager::getIndexField ( )
Access:\n protected
Returns
string

Reimplemented from TablePager.

Definition at line 410 of file SpecialBlockList.php.

◆ getQueryInfo()

BlockListPager::getQueryInfo ( )

This function should be overridden to provide all parameters needed for the main paged query.

It returns an associative array with the following elements: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => option array join_conds => JOIN conditions

Returns
Array

Reimplemented from IndexPager.

Definition at line 371 of file SpecialBlockList.php.

References array(), and ContextSource\getUser().

◆ getTableClass()

BlockListPager::getTableClass ( )
Access:\n protected
Returns
string

Reimplemented from TablePager.

Definition at line 406 of file SpecialBlockList.php.

◆ isFieldSortable()

BlockListPager::isFieldSortable (   $field)

Return true if the named field should be sortable by the UI, false otherwise.

Parameters
$fieldString

Reimplemented from TablePager.

Definition at line 418 of file SpecialBlockList.php.

◆ preprocessResults()

BlockListPager::preprocessResults (   $result)

Do a LinkBatch query to minimise database load when generating all these links.

Parameters
ResultWrapper$result

Reimplemented from IndexPager.

Definition at line 426 of file SpecialBlockList.php.

References $lb, $name, $user, array(), as, UserArray\newFromIDs(), NS_USER, NS_USER_TALK, wfProfileIn(), and wfProfileOut().

Member Data Documentation

◆ $conds

BlockListPager::$conds
protected

Definition at line 216 of file SpecialBlockList.php.

Referenced by __construct().

◆ $page

BlockListPager::$page
protected

Definition at line 217 of file SpecialBlockList.php.

Referenced by __construct().


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