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

Public Member Functions

 __construct ( $imagePage)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 formatRow ( $row)
 
 getBody ()
 
 getIndexField ()
 
 getPreventClickjacking ()
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getTitle ()
 
- Public Member Functions inherited from ReverseChronologicalPager
 getDateCond ( $year, $month, $day=-1)
 Set and return the mOffset timestamp such that we can get all revisions with a timestamp up to the specified parameters. More...
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 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...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. 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...
 
 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, $descending)
 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 ()
 
 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)
 

Public Attributes

File[] $mHist
 
ImagePage $mImagePage
 
int[] $mRange
 
- Public Attributes inherited from ReverseChronologicalPager
 $mDay
 
 $mDefaultDirection = IndexPager::DIR_DESCENDING
 
 $mMonth
 
 $mYear
 
- 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
 

Protected Member Functions

 preventClickjacking ( $enable=true)
 
- Protected Member Functions inherited from IndexPager
 buildQueryInfo ( $offset, $limit, $descending)
 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...
 
 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

File $mImg
 
Title $mTitle
 
 $preventClickjacking = false
 
- 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

- Static Public Member Functions inherited from ReverseChronologicalPager
static getOffsetDate ( $year, $month, $day=-1)
 Core logic of determining the mOffset timestamp such that we can get all items with a timestamp up to the specified parameters. More...
 

Detailed Description

Definition at line 21 of file ImageHistoryPseudoPager.php.

Constructor & Destructor Documentation

◆ __construct()

ImageHistoryPseudoPager::__construct (   $imagePage)
Parameters
ImagePage$imagePage

Definition at line 55 of file ImageHistoryPseudoPager.php.

References list.

Member Function Documentation

◆ doQuery()

ImageHistoryPseudoPager::doQuery ( )

Do the query, using information from the object context.

This function has been kept minimal to make it overridable if necessary, to allow for result sets formed from multiple DB queries.

Reimplemented from IndexPager.

Definition at line 133 of file ImageHistoryPseudoPager.php.

References $mImg.

Referenced by getBody().

◆ formatRow()

ImageHistoryPseudoPager::formatRow (   $row)
Parameters
object$row
Returns
string

Reimplemented from IndexPager.

Definition at line 92 of file ImageHistoryPseudoPager.php.

◆ getBody()

ImageHistoryPseudoPager::getBody ( )
Returns
string

Reimplemented from IndexPager.

Definition at line 99 of file ImageHistoryPseudoPager.php.

References $s, $user, doQuery(), ReverseChronologicalPager\getNavigationBar(), NS_USER, NS_USER_TALK, and preventClickjacking().

◆ getIndexField()

ImageHistoryPseudoPager::getIndexField ( )
Returns
string

Reimplemented from IndexPager.

Definition at line 84 of file ImageHistoryPseudoPager.php.

◆ getPreventClickjacking()

ImageHistoryPseudoPager::getPreventClickjacking ( )
Returns
bool

Definition at line 224 of file ImageHistoryPseudoPager.php.

References $preventClickjacking.

◆ getQueryInfo()

ImageHistoryPseudoPager::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 77 of file ImageHistoryPseudoPager.php.

◆ getTitle()

ImageHistoryPseudoPager::getTitle ( )
Returns
Title

Reimplemented from ContextSource.

Definition at line 73 of file ImageHistoryPseudoPager.php.

References $mTitle.

◆ preventClickjacking()

ImageHistoryPseudoPager::preventClickjacking (   $enable = true)
protected
Parameters
bool$enable

Definition at line 217 of file ImageHistoryPseudoPager.php.

Referenced by getBody().

Member Data Documentation

◆ $mHist

File [] ImageHistoryPseudoPager::$mHist
Since
1.14

Definition at line 44 of file ImageHistoryPseudoPager.php.

◆ $mImagePage

ImagePage ImageHistoryPseudoPager::$mImagePage
Since
1.14

Definition at line 38 of file ImageHistoryPseudoPager.php.

◆ $mImg

File ImageHistoryPseudoPager::$mImg
protected

Definition at line 27 of file ImageHistoryPseudoPager.php.

Referenced by doQuery().

◆ $mRange

int [] ImageHistoryPseudoPager::$mRange
Since
1.14

Definition at line 50 of file ImageHistoryPseudoPager.php.

◆ $mTitle

Title ImageHistoryPseudoPager::$mTitle
protected

Definition at line 32 of file ImageHistoryPseudoPager.php.

Referenced by getTitle().

◆ $preventClickjacking

ImageHistoryPseudoPager::$preventClickjacking = false
protected

Definition at line 22 of file ImageHistoryPseudoPager.php.

Referenced by getPreventClickjacking().


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