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

Public Member Functions

 __construct ( $imagePage, LinkBatchFactory $linkBatchFactory=null)
 
 doQuery ()
 Do the query, using information from the object context.
 
 formatRow ( $row)
 
 getBody ()
 
 getIndexField ()
 
 getPreventClickjacking ()
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query.
 
 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.
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 
 getDatabase ()
 Get the Database object in use.
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links.
 
 getLimit ()
 Get the current limit.
 
 getModuleStyles ()
 ResourceLoader modules that must be loaded to provide correct styling for this pager.
 
 getNavigationBuilder ()
 
 getNumRows ()
 Get the number of rows in the result set.
 
 getOffsetQuery ()
 Get the current offset for the URL query parameter.
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links.
 
 getResult ()
 
 getResultOffset ()
 
 reallyDoQuery ( $offset, $limit, $order)
 Do a query with specified parameters, rather than using the object context.
 
 setIncludeOffset ( $include)
 Set whether a row matching exactly the offset should be also included in the result or not.
 
 setLimit ( $limit)
 Set the limit from an other source than the request.
 
 setOffset ( $offset)
 Set the offset from an other source than the request.
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage().
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID.
 
 getActionName ()
 Get the action name for the current web request.
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens.
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

Public Attributes

File[] $mHist
 
ImagePage $mImagePage
 
int[] $mRange
 
- Public Attributes inherited from ReverseChronologicalPager
int $mDay
 
bool $mDefaultDirection = IndexPager::DIR_DESCENDING
 
bool $mGroupByDate = false
 Whether to group items by date.
 
int $mMonth
 
int $mYear
 
- Public Attributes inherited from IndexPager
IDatabase $mDb
 
bool $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.
 
int $mDefaultLimit = 50
 The default entry limit choosen for clients.
 
bool $mIsBackwards
 
bool $mIsFirst
 True if the current result set is the first one.
 
bool $mIsLast
 
int $mLimit
 The maximum number of entries to show.
 
int[] $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 List of default entry limit options to be presented to clients.
 
mixed $mOffset
 The starting point to enumerate entries.
 
stdClass bool null $mPastTheEndRow
 Extra row fetched at the end to see if the end was reached.
 
bool $mQueryDone = false
 Whether the listing query completed.
 
WebRequest $mRequest
 
IResultWrapper $mResult
 Result object for the query.
 
const DIR_ASCENDING = false
 Backwards-compatible constant for $mDefaultDirection field (do not change)
 
const DIR_DESCENDING = true
 Backwards-compatible constant for $mDefaultDirection field (do not change)
 
const QUERY_ASCENDING = true
 Backwards-compatible constant for reallyDoQuery() (do not change)
 
const QUERY_DESCENDING = false
 Backwards-compatible constant for reallyDoQuery() (do not change)
 

Protected Member Functions

 preventClickjacking ( $enable=true)
 
 setPreventClickjacking (bool $enable)
 
- Protected Member Functions inherited from ReverseChronologicalPager
 getDateFromTimestamp (string $timestamp)
 Get date from the timestamp.
 
 getEndGroup ()
 End an existing group of page rows.
 
 getFooter ()
 Classes can extend to output a footer at the bottom of the pager list.
Since
1.38
Returns
string

 
 getHeaderRow (string $date)
 
 getRow ( $row)
 Get the HTML of a pager row.
Stability: stable
to override
Since
1.38
Parameters
stdClass$row
Returns
string

 
 getStartGroup ()
 Start a new group of page rows.
 
 isFirstHeaderRow ()
 Determines whether the header row is the first that will be outputted to the page.
 
 isHeaderRowNeeded (string $date)
 Determines if a header row is needed based on the current state of the IndexPager.
 
- 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.
 
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper.
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called.
 
 extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this.
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING.
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows.
 
 getEndBody ()
 Hook into getBody() for the end of the list.
 
 getExtraSortFields ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField().
 
 getLimitLinks ()
 
 getLinkRenderer ()
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links.
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment.
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start.
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar".
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link.
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc.
 

Protected Attributes

File null $mImg
 
Title $mTitle
 
 $preventClickjacking = false
 
- Protected Attributes inherited from IndexPager
array $mDefaultQuery
 
string[] $mExtraSortFields
 An array of secondary columns to order by.
 
array $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query.
 
string string[] $mIndexField
 The index to actually be used for ordering.
 
array $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use.
 
array $mPastTheEndIndex
 

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.
 
- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Definition at line 25 of file ImageHistoryPseudoPager.php.

Constructor & Destructor Documentation

◆ __construct()

ImageHistoryPseudoPager::__construct ( $imagePage,
LinkBatchFactory $linkBatchFactory = null )
Parameters
ImagePage$imagePage
LinkBatchFactory | null$linkBatchFactory

Definition at line 63 of file ImageHistoryPseudoPager.php.

References ContextSource\getUser().

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.

Stability: stable
to override

Reimplemented from IndexPager.

Definition at line 161 of file ImageHistoryPseudoPager.php.

References $mImg.

Referenced by getBody().

◆ formatRow()

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

Reimplemented from IndexPager.

Definition at line 105 of file ImageHistoryPseudoPager.php.

◆ getBody()

ImageHistoryPseudoPager::getBody ( )

◆ getIndexField()

ImageHistoryPseudoPager::getIndexField ( )
Returns
string

Reimplemented from IndexPager.

Definition at line 97 of file ImageHistoryPseudoPager.php.

◆ getPreventClickjacking()

ImageHistoryPseudoPager::getPreventClickjacking ( )
Returns
bool

Definition at line 269 of file ImageHistoryPseudoPager.php.

References $preventClickjacking.

◆ getQueryInfo()

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

◆ getTitle()

ImageHistoryPseudoPager::getTitle ( )
Returns
Title

Reimplemented from ContextSource.

Definition at line 86 of file ImageHistoryPseudoPager.php.

References $mTitle.

Referenced by getBody().

◆ preventClickjacking()

ImageHistoryPseudoPager::preventClickjacking ( $enable = true)
protected
Parameters
bool$enable
Deprecated
since 1.38, use setPreventClickjacking()

Definition at line 254 of file ImageHistoryPseudoPager.php.

References preventClickjacking().

Referenced by preventClickjacking(), and setPreventClickjacking().

◆ setPreventClickjacking()

ImageHistoryPseudoPager::setPreventClickjacking ( bool $enable)
protected
Parameters
bool$enable
Since
1.38

Definition at line 262 of file ImageHistoryPseudoPager.php.

References preventClickjacking().

Referenced by getBody().

Member Data Documentation

◆ $mHist

File [] ImageHistoryPseudoPager::$mHist
Since
1.14

Definition at line 48 of file ImageHistoryPseudoPager.php.

◆ $mImagePage

ImagePage ImageHistoryPseudoPager::$mImagePage
Since
1.14

Definition at line 42 of file ImageHistoryPseudoPager.php.

◆ $mImg

File null ImageHistoryPseudoPager::$mImg
protected

Definition at line 31 of file ImageHistoryPseudoPager.php.

Referenced by doQuery().

◆ $mRange

int [] ImageHistoryPseudoPager::$mRange
Since
1.14

Definition at line 54 of file ImageHistoryPseudoPager.php.

◆ $mTitle

Title ImageHistoryPseudoPager::$mTitle
protected

Definition at line 36 of file ImageHistoryPseudoPager.php.

Referenced by getTitle().

◆ $preventClickjacking

ImageHistoryPseudoPager::$preventClickjacking = false
protected

Definition at line 26 of file ImageHistoryPseudoPager.php.

Referenced by getPreventClickjacking().


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