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

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 ()
 
 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...
 
 getRelevantUser ()
 Get the user relevant to the ImageList. More...
 
 getTitle ()
 
 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)
 
 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...
 
 getEmptyBody ()
 
 getEndBody ()
 
 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...
 
 getStartBody ()
 
- Public Member Functions inherited from IndexPager
 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...
 
 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=[])
 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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 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...
 
 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 ()
 
- 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: DIR_ASCENDING or DIR_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...
 

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
 $mCurrentRow
 
 $mSort
 
- 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...
 

Additional Inherited Members

- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Constants for the $mDefaultDirection field. More...
 
const DIR_DESCENDING = true
 

Detailed Description

Definition at line 29 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 132 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 372 of file ImageListPager.php.

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

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

References $link, $linkRenderer, $name, $opt, $value, Xml\element(), Linker\formatComment(), CommentStore\getStore(), Title\makeTitle(), Title\makeTitleSafe(), NS_FILE, NS_USER, RepoGroup\singleton(), wfLocalFile(), wfMessage(), 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 616 of file ImageListPager.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 411 of file ImageListPager.php.

◆ getFieldNames()

ImageListPager::getFieldNames ( )
Returns
array

Reimplemented from TablePager.

Definition at line 171 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 $query, and getContext().

◆ getNavClass()

ImageListPager::getNavClass ( )
protected
Returns
string

Reimplemented from TablePager.

Definition at line 594 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 602 of file ImageListPager.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 231 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 250 of file ImageListPager.php.

References $options, $tables, as, buildQueryConds(), getFieldNames(), CommentStore\getStore(), and ActorMigration\newMigration().

Referenced by getQueryInfo().

◆ getRelevantUser()

ImageListPager::getRelevantUser ( )

Get the user relevant to the ImageList.

Returns
User|null

Definition at line 106 of file ImageListPager.php.

References $mUser.

◆ getSortHeaderClass()

ImageListPager::getSortHeaderClass ( )
protected
Returns
string

Reimplemented from TablePager.

Definition at line 598 of file ImageListPager.php.

◆ getTableClass()

ImageListPager::getTableClass ( )
protected
Returns
string

Reimplemented from TablePager.

Definition at line 590 of file ImageListPager.php.

◆ getTitle()

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

Reimplemented from ContextSource.

Definition at line 625 of file ImageListPager.php.

References SpecialPage\getTitleFor().

◆ isFieldSortable()

ImageListPager::isFieldSortable (   $field)

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

Parameters
string$field

Reimplemented from TablePager.

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

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

Referenced by __construct().

◆ 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.
Parameters
int$offset
int$limit
bool$asc
Returns
array
Exceptions
MWException

Reimplemented from IndexPager.

Definition at line 330 of file ImageListPager.php.

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

Member Data Documentation

◆ $mFieldNames

ImageListPager::$mFieldNames = null
protected

Definition at line 31 of file ImageListPager.php.

Referenced by getFieldNames().

◆ $mIncluding

ImageListPager::$mIncluding = false
protected

Definition at line 47 of file ImageListPager.php.

◆ $mQueryConds

ImageListPager::$mQueryConds = []
protected

Definition at line 34 of file ImageListPager.php.

Referenced by buildQueryConds().

◆ $mSearch

ImageListPager::$mSearch = ''
protected

Definition at line 45 of file ImageListPager.php.

◆ $mShowAll

ImageListPager::$mShowAll = false
protected

Definition at line 49 of file ImageListPager.php.

◆ $mTableName

ImageListPager::$mTableName = 'image'
protected

Definition at line 51 of file ImageListPager.php.

Referenced by reallyDoQuery().

◆ $mUser

User null ImageListPager::$mUser = null
protected

The relevant user.

Definition at line 43 of file ImageListPager.php.

Referenced by getRelevantUser().

◆ $mUserName

ImageListPager::$mUserName = null
protected

Definition at line 36 of file ImageListPager.php.


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