Inheritance diagram for ImageListPager:

[legend]

Collaboration diagram for ImageListPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, $userName=null, $search='', $including=false, $showAll=false)

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

	formatValue ( $field, $value)

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

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

	getFieldNames ()

	getForm ()

	getNavClass ()

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

	getSortHeaderClass ()

	getTableClass ()

	getTitle ()
	Get the Title object. More...

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

	reallyDoQuery ( $offset, $limit, $asc)
	Override reallyDoQuery to mix together two queries. 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...

	getIndexField ()

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

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

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

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

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

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

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

	$mIncluding = false

	$mQueryConds = array()

	$mSearch = ''

	$mShowAll = false

	$mTableName = 'image'

	$mUserName = null

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
	buildQueryConds ( $table)
	Build the where clause of the query. More...

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

	getQueryInfoReal ( $table)
	Actually get the query info. More...

Protected Member Functions inherited from IndexPager
	buildQueryInfo ( $offset, $limit, $descending)
	Build variables to use by the database wrapper. 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...

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

Additional Inherited Members
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

Definition at line 70 of file SpecialListfiles.php.

Constructor & Destructor Documentation

◆ __construct()

ImageListPager::__construct	(	IContextSource	$context,
			$userName = `null`,
			$search = `''`,
			$including = `false`,
			$showAll = `false`
	)

Definition at line 80 of file SpecialListfiles.php.

References ContextSource\$context, $dbr, DB_SLAVE, IContextSource\getRequest(), global, Title\newFromText(), Title\newFromURL(), NS_USER, and wfGetDB().

Member Function Documentation

◆ buildQueryConds()

ImageListPager::buildQueryConds ( $table )

protected

Build the where clause of the query.

Replaces the older mQueryConds member variable.

Parameters

$table String Either "image" or "oldimage"

Returns: array The query conditions.

Definition at line 127 of file SpecialListfiles.php.

References $dbr, $mQueryConds, $mUserName, array(), DB_SLAVE, Title\newFromURL(), and wfGetDB().

Referenced by getQueryInfoReal().

◆ combineResult()

ImageListPager::combineResult	(	$res1,
		$res2,
		$limit,
		$ascending
	)

protected

Combine results from 2 tables.

Note: This will throw away some results

Parameters

$res1	ResultWrapper
$res2	ResultWrapper
$limit	int
$ascending	boolean See note about $asc in $this->reallyDoQuery

Returns: FakeResultWrapper $res1 and $res2 combined

Definition at line 335 of file SpecialListfiles.php.

References $limit, and array().

Referenced by reallyDoQuery().

◆ doBatchLookups()

ImageListPager::doBatchLookups ( )

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.

Returns: void

Reimplemented from IndexPager.

Definition at line 382 of file SpecialListfiles.php.

References array(), as, and UserCache\singleton().

◆ 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 406 of file SpecialListfiles.php.

References $file, $link, $name, $value, array(), Xml\element(), Linker\formatComment(), Linker\link(), Linker\linkKnown(), Title\makeTitle(), Title\makeTitleSafe(), NS_FILE, NS_USER, RepoGroup\singleton(), wfLocalFile(), and User\whoIs().

◆ 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, except for a short blacklist.

Returns: array Associative array

Reimplemented from IndexPager.

Definition at line 535 of file SpecialListfiles.php.

References $queries.

◆ getDefaultSort()

ImageListPager::getDefaultSort ( )

The database field name used as a default sort order.

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 372 of file SpecialListfiles.php.

References global.

◆ getFieldNames()

ImageListPager::getFieldNames ( )

Returns: Array

Reimplemented from TablePager.

Definition at line 159 of file SpecialListfiles.php.

References $mFieldNames, array(), global, ContextSource\msg(), and text.

Referenced by getQueryInfoReal().

◆ getForm()

ImageListPager::getForm ( )

Definition at line 471 of file SpecialListfiles.php.

References array(), Xml\buildForm(), Html\closeElement(), Xml\fieldset(), global, Html\hidden(), Html\input(), Html\openElement(), and text.

◆ getNavClass()

ImageListPager::getNavClass ( )

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 515 of file SpecialListfiles.php.

◆ getPagingQueries()

ImageListPager::getPagingQueries ( )

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

Returns: Array

Reimplemented from IndexPager.

Definition at line 523 of file SpecialListfiles.php.

References $queries, $query, and as.

◆ getQueryInfo()

ImageListPager::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 213 of file SpecialListfiles.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

$table String Either 'image' or 'oldimage'

Returns: array Query info

Definition at line 232 of file SpecialListfiles.php.

References $dbr, $options, $tables, array(), as, buildQueryConds(), DB_SLAVE, getFieldNames(), and wfGetDB().

Referenced by getQueryInfo().

◆ getSortHeaderClass()

ImageListPager::getSortHeaderClass ( )

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 519 of file SpecialListfiles.php.

◆ getTableClass()

ImageListPager::getTableClass ( )

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 511 of file SpecialListfiles.php.

◆ getTitle()

ImageListPager::getTitle ( )

Get the Title object.

Since: 1.18

Returns: Title

Reimplemented from ContextSource.

Definition at line 544 of file SpecialListfiles.php.

References SpecialPage\getTitleFor().

◆ isFieldSortable()

ImageListPager::isFieldSortable ( $field )

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

Parameters

$field String

Reimplemented from TablePager.

Definition at line 181 of file SpecialListfiles.php.

References array(), and global.

◆ reallyDoQuery()

ImageListPager::reallyDoQuery	(	$offset,
		$limit,
		$asc
	)

Override reallyDoQuery to mix together two queries.

Note: $asc is named $descending in IndexPager base class. However it is true when the order is ascending, and false when the order is descending, so I renamed it to $asc here.

Reimplemented from IndexPager.

Definition at line 295 of file SpecialListfiles.php.

References $fname, $limit, IndexPager\$mIndexField, $mTableName, $options, $tables, IndexPager\buildQueryInfo(), combineResult(), and list.

Member Data Documentation

◆ $mFieldNames

ImageListPager::$mFieldNames = null

Definition at line 71 of file SpecialListfiles.php.

Referenced by getFieldNames().

◆ $mIncluding

ImageListPager::$mIncluding = false

Definition at line 76 of file SpecialListfiles.php.

◆ $mQueryConds

ImageListPager::$mQueryConds = array()

Definition at line 73 of file SpecialListfiles.php.

Referenced by buildQueryConds().

◆ $mSearch

ImageListPager::$mSearch = ''

Definition at line 75 of file SpecialListfiles.php.

◆ $mShowAll

ImageListPager::$mShowAll = false

Definition at line 77 of file SpecialListfiles.php.

◆ $mTableName

ImageListPager::$mTableName = 'image'

Definition at line 78 of file SpecialListfiles.php.

Referenced by reallyDoQuery().

◆ $mUserName

ImageListPager::$mUserName = null

Definition at line 74 of file SpecialListfiles.php.

Referenced by buildQueryConds().

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

includes/specials/SpecialListfiles.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildQueryConds()

◆ combineResult()

◆ doBatchLookups()

◆ formatValue()

◆ getDefaultQuery()

◆ getDefaultSort()

◆ getFieldNames()

◆ getForm()

◆ getNavClass()

◆ getPagingQueries()

◆ getQueryInfo()

◆ getQueryInfoReal()

◆ getSortHeaderClass()

◆ getTableClass()

◆ getTitle()

◆ isFieldSortable()

◆ reallyDoQuery()

Member Data Documentation

◆ $mFieldNames

◆ $mIncluding

◆ $mQueryConds

◆ $mSearch

◆ $mShowAll

◆ $mTableName

◆ $mUserName