Inheritance diagram for ImageListPager:

[legend]

Collaboration diagram for ImageListPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, $userName, $search, $including, $showAll, LinkRenderer $linkRenderer, RepoGroup $repoGroup, ILoadBalancer $loadBalancer, CommentStore $commentStore, ActorMigration $actorMigration, UserCache $userCache)

	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 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.

	getNavigationBar ()
	A navigation bar with images.

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

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

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

	getResult ()

	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 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.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	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 ()
	The array keys (but not the array values) are used in sql.

	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 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 IndexPager
	buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	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().

	getLimitLinks ()

	getLinkRenderer ()

	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.

	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
	$mFieldNames = null

	$mIncluding = false

	$mQueryConds = []

	$mSearch = ''

	$mShowAll = false

	$mTableName = 'image'

User null	$mUser = null
	The relevant user.

	$mUserName = null

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.

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

Private Attributes
ActorMigration	$actorMigration

CommentStore	$commentStore

LocalRepo	$localRepo

UserCache	$userCache

const	INDEX_FIELDS
	The unique sort fields for the sort options for unique pagniate.

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.

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 IndexPager
static	oppositeOrder ( $order)

Detailed Description

Definition at line 30 of file ImageListPager.php.

Constructor & Destructor Documentation

◆ __construct()

ImageListPager::__construct	(	IContextSource	$context,
			$userName,
			$search,
			$including,
			$showAll,
		LinkRenderer	$linkRenderer,
		RepoGroup	$repoGroup,
		ILoadBalancer	$loadBalancer,
		CommentStore	$commentStore,
		ActorMigration	$actorMigration,
		UserCache	$userCache
	)

Parameters

IContextSource	$context
string	$userName
string	$search
bool	$including
bool	$showAll
LinkRenderer	$linkRenderer
RepoGroup	$repoGroup
ILoadBalancer	$loadBalancer
CommentStore	$commentStore
ActorMigration	$actorMigration
UserCache	$userCache

Definition at line 88 of file ImageListPager.php.

References $actorMigration, $commentStore, ContextSource\$context, $dbr, IndexPager\$linkRenderer, $userCache, IndexPager\DIR_ASCENDING, IndexPager\DIR_DESCENDING, ContextSource\getConfig(), Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), RepoGroup\getLocalRepo(), ContextSource\getRequest(), User\isIP(), User\newFromName(), NS_USER, outputUserDoesNotExist(), and ContextSource\setContext().

Member Function Documentation

◆ buildQueryConds()

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 184 of file ImageListPager.php.

References $dbr, $mQueryConds, IndexPager\getDatabase(), and User\newFromName().

Referenced by getQueryInfoReal().

◆ combineResult()

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 420 of file ImageListPager.php.

Referenced by reallyDoQuery().

◆ doBatchLookups()

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 IndexPager.

Definition at line 470 of file ImageListPager.php.

◆ formatValue()

ImageListPager::formatValue	(	$field,
		$value
	)

Parameters

string	$field
string	$value

Returns

Message|string|int The return type depends on the value of $field:

thumb: string
img_timestamp: string
img_name: string
img_user_text: string
img_size: string
img_description: string
count: int
top: Message

Exceptions

MWException

Reimplemented from TablePager.

Definition at line 494 of file ImageListPager.php.

References $file, Linker\formatComment(), getAuthority(), NS_FILE, NS_USER, and wfTimestamp().

◆ getDefaultQuery()

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 IndexPager.

Definition at line 663 of file ImageListPager.php.

◆ getDefaultSort()

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 TablePager.

Definition at line 461 of file ImageListPager.php.

◆ getFieldNames()

ImageListPager::getFieldNames ( )

protected

The array keys (but not the array values) are used in sql.

Phan gets confused by this, so mark this method as being ok for sql in general.

Returns: -taint onlysafefor_sql; array

Reimplemented from TablePager.

Definition at line 228 of file ImageListPager.php.

References $mFieldNames, ContextSource\getConfig(), and ContextSource\msg().

Referenced by getQueryInfoReal().

◆ getForm()

ImageListPager::getForm ( )

Definition at line 579 of file ImageListPager.php.

References getContext(), and getTitle().

◆ getIndexField()

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 TablePager.

Definition at line 457 of file ImageListPager.php.

◆ getNavClass()

ImageListPager::getNavClass ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from TablePager.

Definition at line 641 of file ImageListPager.php.

◆ getPagingQueries()

ImageListPager::getPagingQueries ( )

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

Stability: stable: to override

Returns: array

Reimplemented from IndexPager.

Definition at line 649 of file ImageListPager.php.

◆ getQueryInfo()

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 IndexPager.

Definition at line 288 of file ImageListPager.php.

References getQueryInfoReal().

◆ getQueryInfoReal()

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 307 of file ImageListPager.php.

References $dbr, buildQueryConds(), IndexPager\getDatabase(), and getFieldNames().

Referenced by getQueryInfo().

◆ getRelevantUser()

ImageListPager::getRelevantUser ( )

Get the user relevant to the ImageList.

Returns: User|null

Definition at line 158 of file ImageListPager.php.

References $mUser.

◆ getSortHeaderClass()

ImageListPager::getSortHeaderClass ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from TablePager.

Definition at line 645 of file ImageListPager.php.

◆ getTableClass()

ImageListPager::getTableClass ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from TablePager.

Definition at line 637 of file ImageListPager.php.

◆ getTitle()

ImageListPager::getTitle ( )

Since: 1.18

Stability: stable: to override

Returns: Title|null

Reimplemented from ContextSource.

Definition at line 672 of file ImageListPager.php.

References SpecialPage\getTitleFor().

◆ isFieldSortable()

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 TablePager.

Definition at line 254 of file ImageListPager.php.

References ContextSource\getConfig().

◆ outputUserDoesNotExist()

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 167 of file ImageListPager.php.

References ContextSource\getOutput(), and wfEscapeWikiText().

Referenced by __construct().

◆ reallyDoQuery()

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

Exceptions

MWException

Reimplemented from IndexPager.

Definition at line 375 of file ImageListPager.php.

References $dbr, IndexPager\$mIndexField, $mTableName, IndexPager\buildQueryInfo(), combineResult(), and IndexPager\getDatabase().

Member Data Documentation

◆ $actorMigration

ActorMigration ImageListPager::$actorMigration

private

Definition at line 61 of file ImageListPager.php.

Referenced by __construct().

◆ $commentStore

CommentStore ImageListPager::$commentStore

private

Definition at line 58 of file ImageListPager.php.

Referenced by __construct().

◆ $localRepo

LocalRepo ImageListPager::$localRepo

private

Definition at line 55 of file ImageListPager.php.

◆ $mFieldNames

ImageListPager::$mFieldNames = null

protected

Definition at line 32 of file ImageListPager.php.

Referenced by getFieldNames().

◆ $mIncluding

ImageListPager::$mIncluding = false

protected

Definition at line 48 of file ImageListPager.php.

◆ $mQueryConds

ImageListPager::$mQueryConds = []

protected

Definition at line 35 of file ImageListPager.php.

Referenced by buildQueryConds().

◆ $mSearch

ImageListPager::$mSearch = ''

protected

Definition at line 46 of file ImageListPager.php.

◆ $mShowAll

ImageListPager::$mShowAll = false

protected

Definition at line 50 of file ImageListPager.php.

◆ $mTableName

ImageListPager::$mTableName = 'image'

protected

Definition at line 52 of file ImageListPager.php.

Referenced by reallyDoQuery().

◆ $mUser

User null ImageListPager::$mUser = null

protected

The relevant user.

Definition at line 44 of file ImageListPager.php.

Referenced by getRelevantUser().

◆ $mUserName

ImageListPager::$mUserName = null

protected

Definition at line 37 of file ImageListPager.php.

◆ $userCache

UserCache ImageListPager::$userCache

private

Definition at line 64 of file ImageListPager.php.

Referenced by __construct().

◆ INDEX_FIELDS

const ImageListPager::INDEX_FIELDS

private

Initial value:

= [
        'img_timestamp' => [ 'img_timestamp', 'img_name' ],
        'img_name' => [ 'img_name' ],
        'img_size' => [ 'img_size', 'img_name' ],
    ]

The unique sort fields for the sort options for unique pagniate.

Definition at line 69 of file ImageListPager.php.

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

includes/specials/pagers/ImageListPager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private 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

◆ $actorMigration

◆ $commentStore

◆ $localRepo

◆ $mFieldNames

◆ $mIncluding

◆ $mQueryConds

◆ $mSearch

◆ $mShowAll

◆ $mTableName

◆ $mUser

◆ $mUserName

◆ $userCache

◆ INDEX_FIELDS