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

Public Member Functions

 __construct (IContextSource $context, $userName, $search, $including, $showAll, LinkRenderer $linkRenderer)
 
 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...
 
 getForm ()
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query. More...
 
 getRelevantUser ()
 Get the user relevant to the ImageList. More...
 
 getTitle ()
 
 reallyDoQuery ( $offset, $limit, $order)
 Override reallyDoQuery to mix together two queries. More...
 
- Public Member Functions inherited from TablePager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 
 formatRow ( $row)
 
 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...
 
 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[]
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...
 
 getLimit ()
 Get the current limit. More...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getResult ()
 
 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 ()
 
 getUser ()
 
 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

 buildQueryConds ( $table)
 Build the where clause of the query. More...
 
 combineResult ( $res1, $res2, $limit, $ascending)
 Combine results from 2 tables. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 getFieldNames ()
 The array keys (but not the array values) are used in sql. More...
 
 getNavClass ()
 
 getQueryInfoReal ( $table)
 Actually get the query info. More...
 
 getSortHeaderClass ()
 
 getTableClass ()
 TablePager relies on mw-datatable for styling, see T214208. More...
 
 isFieldSortable ( $field)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
 outputUserDoesNotExist ( $userName)
 Add a message to the output stating that the user doesn't exist. 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 ()
 
 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 ()
 
- 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...
 
 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". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Protected Attributes

 $mFieldNames = null
 
 $mIncluding = false
 
 $mQueryConds = []
 
 $mSearch = ''
 
 $mShowAll = false
 
 $mTableName = 'image'
 
User null $mUser = null
 The relevant user. More...
 
 $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. 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
 

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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildQueryConds()

ImageListPager::buildQueryConds (   $table)
protected

Build the where clause of the query.

Replaces the older mQueryConds member variable.

Parameters
string$tableEither "image" or "oldimage"
Returns
array The query conditions.

Definition at line 134 of file ImageListPager.php.

References $dbr, $mQueryConds, DB_REPLICA, User\newFromName(), Title\newFromText(), ActorMigration\newMigration(), 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
IResultWrapper$res1
IResultWrapper$res2
int$limit
bool$ascendingSee note about $asc in $this->reallyDoQuery
Returns
FakeResultWrapper $res1 and $res2 combined

Definition at line 370 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.

Returns
void

Reimplemented from IndexPager.

Definition at line 416 of file ImageListPager.php.

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

References $file, Xml\element(), Linker\formatComment(), CommentStore\getStore(), getUser(), Title\makeTitle(), Title\makeTitleSafe(), NS_FILE, NS_USER, wfTimestamp(), 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 613 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.

Access:\n protected
Returns
string

Reimplemented from TablePager.

Definition at line 407 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 178 of file ImageListPager.php.

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

Referenced by getQueryInfoReal().

◆ getForm()

ImageListPager::getForm ( )

Definition at line 528 of file ImageListPager.php.

References HTMLForm\factory(), getContext(), and getTitle().

◆ getNavClass()

ImageListPager::getNavClass ( )
protected
Returns
string

Reimplemented from TablePager.

Definition at line 591 of file ImageListPager.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 599 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 238 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$tableEither 'image' or 'oldimage'
Returns
array Query info

Definition at line 257 of file ImageListPager.php.

References $dbr, buildQueryConds(), DB_REPLICA, getFieldNames(), CommentStore\getStore(), ActorMigration\newMigration(), and wfGetDB().

Referenced by getQueryInfo().

◆ getRelevantUser()

ImageListPager::getRelevantUser ( )

Get the user relevant to the ImageList.

Returns
User|null

Definition at line 108 of file ImageListPager.php.

References $mUser.

◆ getSortHeaderClass()

ImageListPager::getSortHeaderClass ( )
protected
Returns
string

Reimplemented from TablePager.

Definition at line 595 of file ImageListPager.php.

◆ getTableClass()

ImageListPager::getTableClass ( )
protected

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

Returns
string

Reimplemented from TablePager.

Definition at line 587 of file ImageListPager.php.

◆ getTitle()

ImageListPager::getTitle ( )
Since
1.18
Returns
Title|null

Reimplemented from ContextSource.

Definition at line 622 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

Reimplemented from TablePager.

Definition at line 204 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$userNameUnescaped user name

Definition at line 117 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.

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.
Parameters
int$offset
int$limit
bool$orderIndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING
Returns
FakeResultWrapper
Exceptions
MWException

Reimplemented from IndexPager.

Definition at line 328 of file ImageListPager.php.

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

Member Data Documentation

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


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