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 ()
 
 getDefaultSort ()
 
 getFieldNames ()
 The array keys (but not the array values) are used in sql. More...
 
 getForm ()
 
 getPagingQueries ()
 
 getQueryInfo ()
 
 getRelevantUser ()
 Get the user relevant to the ImageList. More...
 
 getTitle ()
 
 isFieldSortable ( $field)
 
 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)
 
 formatValue ( $name, $value)
 Format a table cell. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getBodyOutput ()
 Get the formatted result list. More...
 
 getCellAttrs ( $field, $value)
 Get any extra attributes to be applied to the given cell. More...
 
 getDefaultSort ()
 The database field name used as a default sort order. More...
 
 getEmptyBody ()
 
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. 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 ()
 
 getLimitDropdown ()
 Gets a limit selection dropdown. 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...
 
 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...
 
 isFieldSortable ( $field)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 
 doQuery ()
 Do the query, using information from the object context. 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...
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 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...
 
 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...
 
 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 ()
 
 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 ()
 
 getNavClass ()
 
 getQueryInfoReal ( $table)
 Actually get the query info. More...
 
 getSortHeaderClass ()
 
 getTableClass ()
 
 outputUserDoesNotExist ( $userName)
 Add a message to the output stating that the user doesn't exist. More...
 
- Protected Member Functions inherited from TablePager
 getCurrentRow ()
 
 getEndBody ()
 
 getNavClass ()
 
 getSortHeaderClass ()
 
 getStartBody ()
 
 getTableClass ()
 TablePager relies on mw-datatable for styling, see T214208. 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...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More...
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows. More...
 
 getEndBody ()
 Hook into getBody() for the end of the list. 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...
 
 getLinkRenderer ()
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. 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...
 
mixed $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string $mIndexField
 The index to actually be used for ordering. More...
 
mixed $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
mixed $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

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

Definition at line 440 of file ImageListPager.php.

References $file, IndexPager\$linkRenderer, Xml\element(), Linker\formatComment(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), CommentStore\getStore(), ContextSource\getUser(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), Title\makeTitle(), Title\makeTitleSafe(), ContextSource\msg(), NS_FILE, NS_USER, RepoGroup\singleton(), wfTimestamp(), and User\whoIs().

◆ getDefaultQuery()

ImageListPager::getDefaultQuery ( )

Definition at line 613 of file ImageListPager.php.

References $mUserName, and $queries.

◆ getDefaultSort()

ImageListPager::getDefaultSort ( )

Definition at line 407 of file ImageListPager.php.

References ContextSource\getConfig().

◆ getFieldNames()

ImageListPager::getFieldNames ( )

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

Definition at line 178 of file ImageListPager.php.

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

Referenced by getQueryInfoReal().

◆ getForm()

◆ getNavClass()

ImageListPager::getNavClass ( )
protected

Definition at line 591 of file ImageListPager.php.

◆ getPagingQueries()

ImageListPager::getPagingQueries ( )

Definition at line 599 of file ImageListPager.php.

References $mUserName, and $queries.

◆ getQueryInfo()

ImageListPager::getQueryInfo ( )

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

Definition at line 595 of file ImageListPager.php.

◆ getTableClass()

ImageListPager::getTableClass ( )
protected

Definition at line 587 of file ImageListPager.php.

◆ getTitle()

ImageListPager::getTitle ( )
Returns
Title|null

Implements IContextSource.

Definition at line 622 of file ImageListPager.php.

References SpecialPage\getTitleFor().

Referenced by getForm().

◆ isFieldSortable()

ImageListPager::isFieldSortable (   $field)

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

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.

Referenced by getForm().

◆ $mShowAll

ImageListPager::$mShowAll = false
protected

Definition at line 50 of file ImageListPager.php.

Referenced by getForm().

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

Referenced by getDefaultQuery(), getForm(), and getPagingQueries().


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