MediaWiki  1.23.8
NewPagesPager Class Reference
Inheritance diagram for NewPagesPager:
Collaboration diagram for NewPagesPager:

Public Member Functions

 __construct ( $form, FormOptions $opts)
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getEndBody ()
 Hook into getBody() for the end of the list. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
- Public Member Functions inherited from ReverseChronologicalPager
 getDateCond ( $year, $month)
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. 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...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=array())
 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 ()
 Get the Config object. More...
 
 getContext ()
 Get the RequestContext object. More...
 
 getLang ()
 Get the Language object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Protected Attributes

HtmlForm $mForm
 
 $opts
 
- 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 ReverseChronologicalPager
 $mDefaultDirection = true
 
 $mMonth
 
 $mYear
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = array( 20, 50, 100, 250, 500 )
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
ResultWrapper $mResult
 Result object for the query. More...
 
- 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: false for ascending, true for descending. More...
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows. 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...
 

Detailed Description

Definition at line 500 of file SpecialNewpages.php.

Constructor & Destructor Documentation

◆ __construct()

NewPagesPager::__construct (   $form,
FormOptions  $opts 
)

Definition at line 508 of file SpecialNewpages.php.

References $form, and $opts.

Member Function Documentation

◆ formatRow()

NewPagesPager::formatRow (   $row)

Abstract formatting function.

This should return an HTML string representing the result row $row. Rows will be concatenated and returned by getBody()

Parameters
array | stdClass$rowDatabase row
Returns
string

Reimplemented from IndexPager.

Definition at line 603 of file SpecialNewpages.php.

◆ getEndBody()

NewPagesPager::getEndBody ( )

Hook into getBody() for the end of the list.

Returns
String

Reimplemented from IndexPager.

Definition at line 620 of file SpecialNewpages.php.

◆ getIndexField()

NewPagesPager::getIndexField ( )

This function should be overridden to return the name of the index fi- eld.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=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.

Returns
string|Array

Reimplemented from IndexPager.

Definition at line 599 of file SpecialNewpages.php.

◆ getQueryInfo()

NewPagesPager::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 514 of file SpecialNewpages.php.

References $options, $tables, $user, array(), ContextSource\getUser(), global, User\groupHasPermission(), Title\makeTitleSafe(), ChangeTags\modifyDisplayQuery(), NS_USER, and wfRunHooks().

◆ getStartBody()

NewPagesPager::getStartBody ( )

Hook into getBody(), allows text to be inserted at the start.

This will be called even if there are no rows in the result set.

Returns
String

Reimplemented from IndexPager.

Definition at line 607 of file SpecialNewpages.php.

References as, NS_USER, and NS_USER_TALK.

Member Data Documentation

◆ $mForm

HtmlForm NewPagesPager::$mForm
protected

Definition at line 506 of file SpecialNewpages.php.

◆ $opts

NewPagesPager::$opts
protected

Definition at line 502 of file SpecialNewpages.php.

Referenced by __construct().


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