Collaboration diagram for MediaWiki\Pager\ImageListPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, CommentStore $commentStore, LinkRenderer $linkRenderer, IConnectionProvider $dbProvider, RepoGroup $repoGroup, UserCache $userCache, UserNameUtils $userNameUtils, CommentFormatter $commentFormatter, $userName, $search, $including, $showAll)

	formatValue ( $field, $value)

	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.

	getDefaultSort ()
	The database field name used as a default sort order.

	getForm ()

	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[] Stability: stable to override

	getPagingQueries ()
	Get a URL query array for the prev, next, first and last links.

	getQueryInfo ()
	Provides all parameters needed for the main paged query.

	getRelevantUser ()
	Get the user relevant to the ImageList.

	getTitle ()

	reallyDoQuery ( $offset, $limit, $order)
	Override reallyDoQuery to mix together two queries.

Public Member Functions inherited from MediaWiki\Pager\TablePager
	__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)

	formatRow ( $row)

	getBody ()
	Get the formatted result list.

	getBodyOutput ()
	Get the formatted result list.

	getFullOutput ()
	Get the formatted result list, with navigation bars.

	getHiddenFields ( $noResubmit=[])
	Get \<input type="hidden"\> elements for use in a method="get" form.

	getLimitForm ()
	Get a form containing a limit selection dropdown.

	getLimitSelect ( $attribs=[])
	Get a "<select>" element which has options for each of the allowed limits.

	getLimitSelectList ()
	Get a list of items to show in a "<select>" element of limits.

	getModuleStyles ()
	ResourceLoader modules that must be loaded to provide correct styling for this pager. Stability: stable to override Since 1.38 Returns string[]

	getNavigationBar ()
	A navigation bar with images.

Public Member Functions inherited from MediaWiki\Pager\IndexPager
	doQuery ()
	Do the query, using information from the object context.

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

	getNavigationBuilder ()

	getNumRows ()
	Get the number of rows in the result set.

	getOffsetQuery ()
	Get the current offset for the URL query parameter.

	getResult ()

	getResultOffset ()

	setIncludeOffset ( $include)
	Set whether a row matching exactly the offset should be also included in the result or not.

	setLimit ( $limit)
	Set the limit from an other source than the request.

	setOffset ( $offset)
	Set the offset from an other source than the request.

Public Member Functions inherited from MediaWiki\Context\ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getLanguageCode ()

	getOutput ()

	getRequest ()

	getSkin ()

	getTiming ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Protected Member Functions
	buildQueryConds ( $table)
	Build the where clause of the query.

	combineResult ( $res1, $res2, $limit, $order)
	Combine results from 2 tables.

	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.

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

	getNavClass ()

	getQueryInfoReal ( $table)
	Actually get the query info.

	getSortHeaderClass ()

	getTableClass ()
	TablePager relies on `mw-datatable` for styling, see T214208.

	isFieldSortable ( $field)
	Return true if the named field should be sortable by the UI, false otherwise.

	outputUserDoesNotExist ( $userName)
	Add a message to the output stating that the user doesn't exist.

Protected Member Functions inherited from MediaWiki\Pager\TablePager
	getCellAttrs ( $field, $value)
	Get any extra attributes to be applied to the given cell.

	getCurrentRow ()

	getEmptyBody ()

	getEndBody ()

	getRowAttrs ( $row)
	Get attributes to be applied to the given row.

	getRowClass ( $row)
	Get a class name to be applied to the given row.

	getStartBody ()

Protected Member Functions inherited from MediaWiki\Pager\IndexPager
	buildQueryInfo ( $offset, $limit, $order)
	Build variables to use by the database wrapper.

	extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
	Extract some useful data from the result object for use by the navigation bar, put it into $this.

	getDefaultDirections ()
	Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING.

	getExtraSortFields ()
	Returns the names of secondary columns to order by in addition to the column in getIndexField().

	getFooter ()
	Classes can extend to output a footer at the bottom of the pager list.

	getLinkRenderer ()

	getRow ( $row)
	Get the HTML of a pager row.

	getSqlComment ()
	Get some text to go in brackets in the "function name" part of the SQL comment.

	isNavigationBarShown ()
	Returns whether to show the "navigation bar".

	makeLink ( $text, array $query=null, $type=null)
	Make a self-link.

	preprocessResults ( $result)
	Pre-process results; useful for performing batch existence checks, etc.

Protected Attributes
string[] null	$mFieldNames = null

bool	$mIncluding = false

array	$mQueryConds = []

bool	$mShowAll = false

string	$mTableName = 'image'

User null	$mUser = null
	The relevant user.

string null	$mUserName = null

Protected Attributes inherited from MediaWiki\Pager\TablePager
stdClass	$mCurrentRow

string	$mSort

Protected Attributes inherited from MediaWiki\Pager\IndexPager
array	$mDefaultQuery

string[]	$mExtraSortFields
	An array of secondary columns to order by.

array	$mFirstShown

bool	$mIncludeOffset = false
	Whether to include the offset in the query.

string string[]	$mIndexField
	The index to actually be used for ordering.

array	$mLastShown

string	$mNavigationBar

string null	$mOrderType
	For pages that support multiple types of ordering, which one to use.

array	$mPastTheEndIndex

Additional Inherited Members
Public Attributes inherited from MediaWiki\Pager\IndexPager
IReadableDatabase	$mDb

bool	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

int	$mDefaultLimit = 50
	The default entry limit choosen for clients.

bool	$mIsBackwards

bool	$mIsFirst
	True if the current result set is the first one.

bool	$mIsLast

int	$mLimit
	The maximum number of entries to show.

int[]	$mLimitsShown = [ 20, 50, 100, 250, 500 ]
	List of default entry limit options to be presented to clients.

mixed	$mOffset
	The starting point to enumerate entries.

stdClass bool null	$mPastTheEndRow
	Extra row fetched at the end to see if the end was reached.

bool	$mQueryDone = false
	Whether the listing query completed.

WebRequest	$mRequest

IResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Backwards-compatible constant for $mDefaultDirection field (do not change)

const	DIR_DESCENDING = true
	Backwards-compatible constant for $mDefaultDirection field (do not change)

const	QUERY_ASCENDING = true
	Backwards-compatible constant for reallyDoQuery() (do not change)

const	QUERY_DESCENDING = false
	Backwards-compatible constant for reallyDoQuery() (do not change)

Static Protected Member Functions inherited from MediaWiki\Pager\IndexPager
static	oppositeOrder ( $order)

Detailed Description

Definition at line 47 of file ImageListPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\ImageListPager::__construct	(	IContextSource	$context,
		CommentStore	$commentStore,
		LinkRenderer	$linkRenderer,
		IConnectionProvider	$dbProvider,
		RepoGroup	$repoGroup,
		UserCache	$userCache,
		UserNameUtils	$userNameUtils,
		CommentFormatter	$commentFormatter,
			$userName,
			$search,
			$including,
			$showAll )

Parameters

IContextSource	$context
CommentStore	$commentStore
LinkRenderer	$linkRenderer
IConnectionProvider	$dbProvider
RepoGroup	$repoGroup
UserCache	$userCache
UserNameUtils	$userNameUtils
CommentFormatter	$commentFormatter
string	$userName
string	$search
bool	$including
bool	$showAll

Definition at line 95 of file ImageListPager.php.

References MediaWiki\Pager\IndexPager\DIR_ASCENDING, MediaWiki\Pager\IndexPager\DIR_DESCENDING, RepoGroup\getLocalRepo(), Wikimedia\Rdbms\IConnectionProvider\getReplicaDatabase(), MediaWiki\Context\ContextSource\getRequest(), MediaWiki\User\UserNameUtils\isIP(), NS_USER, MediaWiki\Pager\ImageListPager\outputUserDoesNotExist(), and MediaWiki\Context\ContextSource\setContext().

Member Function Documentation

◆ buildQueryConds()

MediaWiki\Pager\ImageListPager::buildQueryConds ( $table )

protected

Build the where clause of the query.

Replaces the older mQueryConds member variable.

Parameters

string $table Either "image" or "oldimage"

Returns: array The query conditions.

Definition at line 175 of file ImageListPager.php.

References MediaWiki\Pager\ImageListPager\$mQueryConds, and MediaWiki\Pager\ImageListPager\$mUserName.

Referenced by MediaWiki\Pager\ImageListPager\getQueryInfoReal().

◆ combineResult()

MediaWiki\Pager\ImageListPager::combineResult	(	$res1,
		$res2,
		$limit,
		$order )

protected

Combine results from 2 tables.

Note: This will throw away some results

Parameters

IResultWrapper	$res1
IResultWrapper	$res2
int	$limit
bool	$order	IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING

Returns: IResultWrapper $res1 and $res2 combined

Definition at line 370 of file ImageListPager.php.

Referenced by MediaWiki\Pager\ImageListPager\reallyDoQuery().

◆ doBatchLookups()

MediaWiki\Pager\ImageListPager::doBatchLookups ( )

protected

Called from getBody(), before getStartBody() is called and after doQuery() was called.

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

Stability: stable: to override

Returns: void

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 423 of file ImageListPager.php.

◆ formatValue()

MediaWiki\Pager\ImageListPager::formatValue	(		$field,
			$value )

Parameters

string	$field
string \| null	$value

Returns: string

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 440 of file ImageListPager.php.

References getAuthority(), getUser(), NS_FILE, NS_USER, and wfTimestamp().

◆ getDefaultQuery()

MediaWiki\Pager\ImageListPager::getDefaultQuery ( )

Get an array of query parameters that should be put into self-links.

By default, all parameters passed in the URL are used, apart from a few exceptions.

Stability: stable: to override

Returns: array Associative array

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 612 of file ImageListPager.php.

◆ getDefaultSort()

MediaWiki\Pager\ImageListPager::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 MediaWiki\Pager\TablePager.

Definition at line 411 of file ImageListPager.php.

◆ getFieldNames()

MediaWiki\Pager\ImageListPager::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: string[]

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 194 of file ImageListPager.php.

References MediaWiki\Pager\ImageListPager\$mFieldNames, MediaWiki\Context\ContextSource\getConfig(), MediaWiki\MainConfigNames\MiserMode, and MediaWiki\Context\ContextSource\msg().

Referenced by MediaWiki\Pager\ImageListPager\getQueryInfoReal().

◆ getForm()

MediaWiki\Pager\ImageListPager::getForm ( )

Definition at line 539 of file ImageListPager.php.

References getContext(), getRequest(), and getTitle().

◆ getIndexField()

MediaWiki\Pager\ImageListPager::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[]

Stability: stable: to override

Stability: stable: to override

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 407 of file ImageListPager.php.

◆ getNavClass()

MediaWiki\Pager\ImageListPager::getNavClass ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 590 of file ImageListPager.php.

◆ getPagingQueries()

MediaWiki\Pager\ImageListPager::getPagingQueries ( )

Get a URL query array for the prev, next, first and last links.

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 598 of file ImageListPager.php.

◆ getQueryInfo()

MediaWiki\Pager\ImageListPager::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 MediaWiki\Pager\IndexPager.

Definition at line 243 of file ImageListPager.php.

References MediaWiki\Pager\ImageListPager\getQueryInfoReal().

◆ getQueryInfoReal()

MediaWiki\Pager\ImageListPager::getQueryInfoReal ( $table )

protected

Actually get the query info.

This is to allow displaying both stuff from image and oldimage table.

This is a bit hacky.

Parameters

string $table Either 'image' or 'oldimage'

Returns: array Query info

Definition at line 260 of file ImageListPager.php.

References MediaWiki\Pager\ImageListPager\buildQueryConds(), MediaWiki\Pager\IndexPager\getDatabase(), and MediaWiki\Pager\ImageListPager\getFieldNames().

Referenced by MediaWiki\Pager\ImageListPager\getQueryInfo().

◆ getRelevantUser()

MediaWiki\Pager\ImageListPager::getRelevantUser ( )

Get the user relevant to the ImageList.

Returns: User|null

Definition at line 152 of file ImageListPager.php.

References MediaWiki\Pager\ImageListPager\$mUser.

◆ getSortHeaderClass()

MediaWiki\Pager\ImageListPager::getSortHeaderClass ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 594 of file ImageListPager.php.

◆ getTableClass()

MediaWiki\Pager\ImageListPager::getTableClass ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 586 of file ImageListPager.php.

◆ getTitle()

MediaWiki\Pager\ImageListPager::getTitle ( )

Since: 1.18

Stability: stable: to override

Returns: Title|null

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 621 of file ImageListPager.php.

◆ isFieldSortable()

MediaWiki\Pager\ImageListPager::isFieldSortable ( $field )

protected

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

Parameters

string $field

Returns: bool

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 219 of file ImageListPager.php.

References MediaWiki\Context\ContextSource\getConfig(), and MediaWiki\MainConfigNames\MiserMode.

◆ outputUserDoesNotExist()

MediaWiki\Pager\ImageListPager::outputUserDoesNotExist ( $userName )

protected

Add a message to the output stating that the user doesn't exist.

Parameters

string $userName Unescaped user name

Definition at line 161 of file ImageListPager.php.

References MediaWiki\Context\ContextSource\getOutput(), MediaWiki\Context\ContextSource\msg(), and wfEscapeWikiText().

Referenced by MediaWiki\Pager\ImageListPager\__construct().

◆ reallyDoQuery()

MediaWiki\Pager\ImageListPager::reallyDoQuery	(	$offset,
		$limit,
		$order )

Override reallyDoQuery to mix together two queries.

Parameters

string	$offset
int	$limit
bool	$order	IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING

Returns: IResultWrapper

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 324 of file ImageListPager.php.

References MediaWiki\Pager\IndexPager\$mIndexField, MediaWiki\Pager\ImageListPager\$mTableName, MediaWiki\Pager\IndexPager\buildQueryInfo(), MediaWiki\Pager\ImageListPager\combineResult(), and MediaWiki\Pager\IndexPager\getDatabase().

Member Data Documentation

◆ $mFieldNames

string [] null MediaWiki\Pager\ImageListPager::$mFieldNames = null

protected

Definition at line 50 of file ImageListPager.php.

Referenced by MediaWiki\Pager\ImageListPager\getFieldNames().

◆ $mIncluding

bool MediaWiki\Pager\ImageListPager::$mIncluding = false

protected

Definition at line 61 of file ImageListPager.php.

◆ $mQueryConds

array MediaWiki\Pager\ImageListPager::$mQueryConds = []

protected

Deprecated: Subclasses should override {

See also: buildQueryConds} instead

Definition at line 55 of file ImageListPager.php.

Referenced by MediaWiki\Pager\ImageListPager\buildQueryConds().

◆ $mShowAll

bool MediaWiki\Pager\ImageListPager::$mShowAll = false

protected

Definition at line 63 of file ImageListPager.php.

◆ $mTableName

string MediaWiki\Pager\ImageListPager::$mTableName = 'image'

protected

Definition at line 65 of file ImageListPager.php.

Referenced by MediaWiki\Pager\ImageListPager\reallyDoQuery().

◆ $mUser

User null MediaWiki\Pager\ImageListPager::$mUser = null

protected

The relevant user.

Definition at line 59 of file ImageListPager.php.

Referenced by MediaWiki\Pager\ImageListPager\getRelevantUser().

◆ $mUserName

string null MediaWiki\Pager\ImageListPager::$mUserName = null

protected

Definition at line 57 of file ImageListPager.php.

Referenced by MediaWiki\Pager\ImageListPager\buildQueryConds().

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

includes/specials/pagers/ImageListPager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildQueryConds()

◆ combineResult()

◆ doBatchLookups()

◆ formatValue()

◆ getDefaultQuery()

◆ getDefaultSort()

◆ getFieldNames()

◆ getForm()

◆ getIndexField()

◆ getNavClass()

◆ getPagingQueries()

◆ getQueryInfo()

◆ getQueryInfoReal()

◆ getRelevantUser()

◆ getSortHeaderClass()

◆ getTableClass()

◆ getTitle()

◆ isFieldSortable()

◆ outputUserDoesNotExist()

◆ reallyDoQuery()

Member Data Documentation

◆ $mFieldNames

◆ $mIncluding

◆ $mQueryConds

◆ $mShowAll

◆ $mTableName

◆ $mUser

◆ $mUserName