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

Public Member Functions

 __construct ( $page, $conds, LinkBatchFactory $linkBatchFactory, BlockRestrictionStore $blockRestrictionStore, PermissionManager $permissionManager, ILoadBalancer $loadBalancer, SpecialPageFactory $specialPageFactory, ActorMigration $actorMigration, CommentStore $commentStore)
 
 formatValue ( $name, $value)
 
 getDefaultSort ()
 The database field name used as a default sort order. More...
 
 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[]
Stable to override Stable to override More...
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query. More...
 
 getTotalAutoblocks ()
 Get total number of autoblocks at any given time. 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, LinkRenderer $linkRenderer=null)
 Stable to call. More...
 
 formatRow ( $row)
 Stable to override. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getBodyOutput ()
 Get the formatted result list. 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...
 
 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...
 
- Public Member Functions inherited from IndexPager
 doQuery ()
 Do the query, using information from the object context. 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 ()
 
 getTitle ()
 
 getUser ()
 Stable to override. More...
 
 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)
 

Protected Member Functions

 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. More...
 
 getTableClass ()
 TablePager relies on mw-datatable for styling, see T214208. More...
 
 isFieldSortable ( $name)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
- Protected Member Functions inherited from TablePager
 getCellAttrs ( $field, $value)
 Get any extra attributes to be applied to the given cell. More...
 
 getCurrentRow ()
 
 getEmptyBody ()
 
 getEndBody ()
 Stable to override. More...
 
 getNavClass ()
 Stable to override. 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 ()
 Stable to override. More...
 
 getStartBody ()
 Stable to override. 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...
 
 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" @stable to override. More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 

Protected Attributes

 $conds
 
Restriction[] $restrictions = []
 Array of restrictions. More...
 
- Protected Attributes inherited from TablePager
stdClass $mCurrentRow
 
string $mSort
 
- 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
 

Private Member Functions

 getRestrictionListHTML (stdClass $row)
 Get Restriction List HTML. More...
 

Private Attributes

ActorMigration $actorMigration
 
BlockRestrictionStore $blockRestrictionStore
 
CommentStore $commentStore
 
LinkBatchFactory $linkBatchFactory
 
PermissionManager $permissionManager
 
SpecialPageFactory $specialPageFactory
 

Additional Inherited Members

- 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...
 
- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Definition at line 38 of file BlockListPager.php.

Constructor & Destructor Documentation

◆ __construct()

BlockListPager::__construct (   $page,
  $conds,
LinkBatchFactory  $linkBatchFactory,
BlockRestrictionStore  $blockRestrictionStore,
PermissionManager  $permissionManager,
ILoadBalancer  $loadBalancer,
SpecialPageFactory  $specialPageFactory,
ActorMigration  $actorMigration,
CommentStore  $commentStore 
)
Parameters
SpecialPage$page
array$conds
LinkBatchFactory$linkBatchFactory
BlockRestrictionStore$blockRestrictionStore
PermissionManager$permissionManager
ILoadBalancer$loadBalancer
SpecialPageFactory$specialPageFactory
ActorMigration$actorMigration
CommentStore$commentStore

Definition at line 78 of file BlockListPager.php.

References $actorMigration, $blockRestrictionStore, $commentStore, $conds, $linkBatchFactory, $permissionManager, $specialPageFactory, DB_REPLICA, IndexPager\DIR_DESCENDING, and Wikimedia\Rdbms\ILoadBalancer\getConnectionRef().

Member Function Documentation

◆ formatValue()

BlockListPager::formatValue (   $name,
  $value 
)

◆ getDefaultSort()

BlockListPager::getDefaultSort ( )

The database field name used as a default sort order.

Note that this field will only be sorted on if isFieldSortable returns true for this field. If not (e.g. paginating on multiple columns), this should return empty string, and getIndexField should be overridden.

Returns
string

Reimplemented from TablePager.

Definition at line 450 of file BlockListPager.php.

◆ getFieldNames()

BlockListPager::getFieldNames ( )
protected

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 101 of file BlockListPager.php.

References ContextSource\msg().

◆ getIndexField()

BlockListPager::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[]
Stable to override Stable to override

Reimplemented from TablePager.

Definition at line 446 of file BlockListPager.php.

◆ getQueryInfo()

BlockListPager::getQueryInfo ( )

Provides 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 377 of file BlockListPager.php.

References $conds, and IndexPager\getDatabase().

◆ getRestrictionListHTML()

BlockListPager::getRestrictionListHTML ( stdClass  $row)
private

Get Restriction List HTML.

Parameters
stdClass$row
Returns
string

Definition at line 311 of file BlockListPager.php.

References IndexPager\$linkRenderer, ContextSource\getLanguage(), IndexPager\getLinkRenderer(), ContextSource\msg(), NS_MAIN, and Html\rawElement().

Referenced by formatValue().

◆ getTableClass()

BlockListPager::getTableClass ( )
protected

TablePager relies on mw-datatable for styling, see T214208.

Stable to override

Returns
string

Reimplemented from TablePager.

Definition at line 442 of file BlockListPager.php.

◆ getTotalAutoblocks()

BlockListPager::getTotalAutoblocks ( )

Get total number of autoblocks at any given time.

Returns
int Total number of unexpired active autoblocks

Definition at line 426 of file BlockListPager.php.

References $dbr, $res, and IndexPager\getDatabase().

Referenced by SpecialAutoblockList\showTotal().

◆ isFieldSortable()

BlockListPager::isFieldSortable (   $field)
protected

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

Parameters
string$field

Reimplemented from TablePager.

Definition at line 454 of file BlockListPager.php.

◆ preprocessResults()

BlockListPager::preprocessResults (   $result)

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

Parameters
IResultWrapper$result

Reimplemented from IndexPager.

Definition at line 462 of file BlockListPager.php.

References $title, NS_USER, and NS_USER_TALK.

Member Data Documentation

◆ $actorMigration

ActorMigration BlockListPager::$actorMigration
private

Definition at line 62 of file BlockListPager.php.

Referenced by __construct().

◆ $blockRestrictionStore

BlockRestrictionStore BlockListPager::$blockRestrictionStore
private

Definition at line 53 of file BlockListPager.php.

Referenced by __construct().

◆ $commentStore

CommentStore BlockListPager::$commentStore
private

Definition at line 65 of file BlockListPager.php.

Referenced by __construct().

◆ $conds

BlockListPager::$conds
protected

Definition at line 40 of file BlockListPager.php.

Referenced by __construct(), and getQueryInfo().

◆ $linkBatchFactory

LinkBatchFactory BlockListPager::$linkBatchFactory
private

Definition at line 50 of file BlockListPager.php.

Referenced by __construct().

◆ $permissionManager

PermissionManager BlockListPager::$permissionManager
private

Definition at line 56 of file BlockListPager.php.

Referenced by __construct().

◆ $restrictions

Restriction [] BlockListPager::$restrictions = []
protected

Array of restrictions.

Definition at line 47 of file BlockListPager.php.

◆ $specialPageFactory

SpecialPageFactory BlockListPager::$specialPageFactory
private

Definition at line 59 of file BlockListPager.php.

Referenced by __construct().


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