MediaWiki REL1_32
|
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. | |
formatValue ( $field, $value) | |
getDefaultQuery () | |
Get an array of query parameters that should be put into self-links. | |
getDefaultSort () | |
The database field name used as a default sort order. | |
getFieldNames () | |
The array keys (but not the array values) are used in sql. | |
getForm () | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. | |
getQueryInfo () | |
This function should be overridden to provide all parameters needed for the main paged query. | |
getRelevantUser () | |
Get the user relevant to the ImageList. | |
getTitle () | |
isFieldSortable ( $field) | |
Return true if the named field should be sortable by the UI, false otherwise. | |
reallyDoQuery ( $offset, $limit, $asc) | |
Override reallyDoQuery to mix together two queries. | |
Public Member Functions inherited from TablePager | |
__construct (IContextSource $context=null) | |
formatRow ( $row) | |
getBody () | |
Get the formatted result list. | |
getBodyOutput () | |
Get the formatted result list. | |
getCellAttrs ( $field, $value) | |
Get any extra attributes to be applied to the given cell. | |
getEmptyBody () | |
getEndBody () | |
getFullOutput () | |
Get the formatted result list, with navigation bars. | |
getHiddenFields ( $blacklist=[]) | |
Get \<input type="hidden"\> elements for use in a method="get" form. | |
getIndexField () | |
getLimitDropdown () | |
Gets a limit selection dropdown. | |
getLimitForm () | |
Get a form containing a limit selection dropdown. | |
getLimitSelect ( $attribs=[]) | |
Get a "<select>" element which has options for each of the allowed limits. | |
getLimitSelectList () | |
Get a list of items to show in a "<select>" element of limits. | |
getModuleStyles () | |
ResourceLoader modules that must be loaded to provide correct styling for this pager. | |
getNavigationBar () | |
A navigation bar with images. | |
getRowAttrs ( $row) | |
Get attributes to be applied to the given row. | |
getRowClass ( $row) | |
Get a class name to be applied to the given row. | |
getStartBody () | |
Public Member Functions inherited from IndexPager | |
doQuery () | |
Do the query, using information from the object context. | |
extractResultInfo ( $isFirst, $limit, IResultWrapper $res) | |
Extract some useful data from the result object for use by the navigation bar, put it into $this. | |
getDatabase () | |
Get the Database object in use. | |
getLimit () | |
Get the current limit. | |
getLimitLinks () | |
getNumRows () | |
Get the number of rows in the result set. | |
getPagingLinks ( $linkTexts, $disabledTexts=[]) | |
Get paging links. | |
getResult () | |
getSqlComment () | |
Get some text to go in brackets in the "function name" part of the SQL comment. | |
isNavigationBarShown () | |
Returns whether to show the "navigation bar". | |
makeLink ( $text, array $query=null, $type=null) | |
Make a self-link. | |
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. | |
getConfig () | |
getContext () | |
Get the base IContextSource object. | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. | |
msg ( $key) | |
Get a Message object with context set Parameters are the same as wfMessage() | |
setContext (IContextSource $context) | |
Protected Member Functions | |
buildQueryConds ( $table) | |
Build the where clause of the query. | |
combineResult ( $res1, $res2, $limit, $ascending) | |
Combine results from 2 tables. | |
getNavClass () | |
getQueryInfoReal ( $table) | |
Actually get the query info. | |
getSortHeaderClass () | |
getTableClass () | |
outputUserDoesNotExist ( $userName) | |
Add a message to the output stating that the user doesn't exist. | |
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. | |
getDefaultDirections () | |
Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. | |
getExtraSortFields () | |
This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). | |
preprocessResults ( $result) | |
Pre-process results; useful for performing batch existence checks, etc. | |
Protected Attributes | |
$mFieldNames = null | |
$mIncluding = false | |
$mQueryConds = [] | |
$mSearch = '' | |
$mShowAll = false | |
$mTableName = 'image' | |
User null | $mUser = null |
The relevant user. | |
$mUserName = null | |
Protected Attributes inherited from TablePager | |
$mCurrentRow | |
$mSort | |
Protected Attributes inherited from IndexPager | |
$mDefaultQuery | |
$mExtraSortFields | |
An array of secondary columns to order by. | |
$mFirstShown | |
$mIncludeOffset = false | |
Whether to include the offset in the query. | |
$mIndexField | |
The index to actually be used for ordering. | |
$mLastShown | |
$mNavigationBar | |
$mOrderType | |
For pages that support multiple types of ordering, which one to use. | |
$mPastTheEndIndex | |
Additional Inherited Members | |
Public Attributes inherited from IndexPager | |
IDatabase | $mDb |
$mDefaultDirection | |
$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. | |
$mDefaultLimit = 50 | |
$mIsBackwards | |
$mIsFirst | |
True if the current result set is the first one. | |
$mIsLast | |
$mLimit | |
$mLimitsShown = [ 20, 50, 100, 250, 500 ] | |
$mOffset | |
$mPastTheEndRow | |
$mQueryDone = false | |
$mRequest | |
IResultWrapper | $mResult |
Result object for the query. | |
const | DIR_ASCENDING = false |
Constants for the $mDefaultDirection field. | |
const | DIR_DESCENDING = true |
Definition at line 29 of file ImageListPager.php.
ImageListPager::__construct | ( | IContextSource | $context, |
$userName = null, | |||
$search = '', | |||
$including = false, | |||
$showAll = false ) |
Definition at line 53 of file ImageListPager.php.
References ContextSource\$context, $dbr, $user, DB_REPLICA, IndexPager\DIR_ASCENDING, IndexPager\DIR_DESCENDING, ContextSource\getConfig(), ContextSource\getRequest(), User\isIP(), User\newFromName(), outputUserDoesNotExist(), ContextSource\setContext(), and wfGetDB().
|
protected |
Build the where clause of the query.
Replaces the older mQueryConds member variable.
string | $table | Either "image" or "oldimage" |
Definition at line 132 of file ImageListPager.php.
References $dbr, $mQueryConds, DB_REPLICA, User\newFromName(), and wfGetDB().
Referenced by getQueryInfoReal().
|
protected |
Combine results from 2 tables.
Note: This will throw away some results
IResultWrapper | $res1 | |
IResultWrapper | $res2 | |
int | $limit | |
bool | $ascending | See note about $asc in $this->reallyDoQuery |
Definition at line 375 of file ImageListPager.php.
Referenced by reallyDoQuery().
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.
Reimplemented from IndexPager.
Definition at line 423 of file ImageListPager.php.
References UserCache\singleton().
ImageListPager::formatValue | ( | $field, | |
$value ) |
string | $field | |
string | $value |
MWException |
Reimplemented from TablePager.
Definition at line 447 of file ImageListPager.php.
References $link, $linkRenderer, $opt, $value, Linker\formatComment(), NS_FILE, RepoGroup\singleton(), wfLocalFile(), wfTimestamp(), and User\whoIs().
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.
Reimplemented from IndexPager.
Definition at line 616 of file ImageListPager.php.
References $queries.
ImageListPager::getDefaultSort | ( | ) |
The database field name used as a default sort order.
Reimplemented from TablePager.
Definition at line 414 of file ImageListPager.php.
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.
Reimplemented from TablePager.
Definition at line 174 of file ImageListPager.php.
References $mFieldNames, ContextSource\getConfig(), and ContextSource\msg().
Referenced by getQueryInfoReal().
ImageListPager::getForm | ( | ) |
Definition at line 531 of file ImageListPager.php.
References $formDescriptor, $query, and getContext().
|
protected |
ImageListPager::getPagingQueries | ( | ) |
Get a URL query array for the prev, next, first and last links.
Reimplemented from IndexPager.
Definition at line 602 of file ImageListPager.php.
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
Reimplemented from IndexPager.
Definition at line 234 of file ImageListPager.php.
References getQueryInfoReal().
|
protected |
Actually get the query info.
This is to allow displaying both stuff from image and oldimage table.
This is a bit hacky.
string | $table | Either 'image' or 'oldimage' |
Definition at line 253 of file ImageListPager.php.
References $options, $tables, buildQueryConds(), and getFieldNames().
Referenced by getQueryInfo().
ImageListPager::getRelevantUser | ( | ) |
Get the user relevant to the ImageList.
Definition at line 106 of file ImageListPager.php.
References $mUser.
|
protected |
|
protected |
ImageListPager::getTitle | ( | ) |
Reimplemented from ContextSource.
Definition at line 625 of file ImageListPager.php.
ImageListPager::isFieldSortable | ( | $field | ) |
Return true if the named field should be sortable by the UI, false otherwise.
string | $field |
Reimplemented from TablePager.
Definition at line 200 of file ImageListPager.php.
References ContextSource\getConfig().
|
protected |
Add a message to the output stating that the user doesn't exist.
string | $userName | Unescaped user name |
Definition at line 115 of file ImageListPager.php.
References ContextSource\getOutput(), and wfEscapeWikiText().
Referenced by __construct().
ImageListPager::reallyDoQuery | ( | $offset, | |
$limit, | |||
$asc ) |
Override reallyDoQuery to mix together two queries.
int | $offset | |
int | $limit | |
bool | $asc |
MWException |
Reimplemented from IndexPager.
Definition at line 333 of file ImageListPager.php.
References $fname, IndexPager\$mIndexField, $mTableName, $options, $tables, IndexPager\buildQueryInfo(), combineResult(), and list.
|
protected |
Definition at line 31 of file ImageListPager.php.
Referenced by getFieldNames().
|
protected |
Definition at line 47 of file ImageListPager.php.
|
protected |
Definition at line 34 of file ImageListPager.php.
Referenced by buildQueryConds().
|
protected |
Definition at line 45 of file ImageListPager.php.
|
protected |
Definition at line 49 of file ImageListPager.php.
|
protected |
Definition at line 51 of file ImageListPager.php.
Referenced by reallyDoQuery().
|
protected |
The relevant user.
Definition at line 43 of file ImageListPager.php.
Referenced by getRelevantUser().
|
protected |
Definition at line 36 of file ImageListPager.php.