MediaWiki\SpecialPage\ImageQueryPage Class Reference
Variant of QueryPage which uses a gallery to output results, thus suited for reports generating images. More...
Inherits MediaWiki\SpecialPage\QueryPage.
Inherited by MediaWiki\Specials\SpecialMostImages, MediaWiki\Specials\SpecialUncategorizedImages, and MediaWiki\Specials\SpecialUnusedImages.
Collaboration diagram for MediaWiki\SpecialPage\ImageQueryPage:
Protected Member Functions | |
| formatResult ( $skin, $result) | |
| getCellHtml ( $row) | |
| Get additional HTML to be shown in a results' cell. | |
| outputResults ( $out, $skin, $dbr, $res, $num, $offset) | |
| Format and output report results using the given information plus OutputPage. | |
 Protected Member Functions inherited from MediaWiki\SpecialPage\QueryPage | |
| closeList () | |
| executeLBFromResultWrapper (IResultWrapper $res, $ns=null) | |
| Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and optional the namespace field) and executes the batch. | |
| getCacheOrderFields () | |
| Return the order fields for fetchFromCache. | |
| getDatabaseProvider () | |
| getDBLimit ( $uiLimit, $uiOffset) | |
| What is limit to fetch from DB. | |
| getDBLoadBalancer () | |
| getLimitOffset () | |
| Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser(). | |
| getLinkBatchFactory () | |
| getMaxResults () | |
| Get max number of results we can return in miser mode. | |
| getOrderFields () | |
| Subclasses return an array of fields to order by here. | |
| getPageHeader () | |
| The content returned by this function will be output before any result. | |
| getRecacheDB () | |
| Get a DB connection to be used for slow recache queries. | |
| linkParameters () | |
| If using extra form wheely-dealies, return a set of parameters here as an associative array. | |
| openList ( $offset) | |
| preprocessResults ( $db, $res) | |
| Do any necessary preprocessing of the result object. | |
| setDatabaseProvider (IConnectionProvider $databaseProvider) | |
| setDBLoadBalancer (ILoadBalancer $loadBalancer) | |
| setLinkBatchFactory (LinkBatchFactory $linkBatchFactory) | |
| setListoutput ( $bool) | |
| A mutator for $this->listoutput;. | |
| showEmptyText () | |
| Outputs some kind of an informative message (via OutputPage) to let the user know that the query returned nothing and thus there's nothing to show. | |
| sortDescending () | |
| Override to sort by increasing values. | |
| Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
| addFeedLinks ( $params) | |
| Adds RSS/atom links. | |
| afterExecute ( $subPage) | |
Gets called after execute. | |
| authorizeAction (?string $action=null) | |
| Utility function for authorizing an action to be performed by the special page. | |
| beforeExecute ( $subPage) | |
Gets called before execute. | |
| buildPrevNextNavigation ( $offset, $limit, array $query=[], $atEnd=false, $subpage=false) | |
| Generate (prev x| next x) (20|50|100...) type links for paging. | |
| checkLoginSecurityLevel ( $level=null) | |
| Verifies that the user meets the security level, possibly reauthenticating them in the process. | |
| displayRestrictionError () | |
| Output an error message telling the user what access level they have to have. | |
| getAuthManager () | |
| getCacheTTL () | |
| getGroupName () | |
| Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. | |
| getHookContainer () | |
| getHookRunner () | |
| getLoginSecurityLevel () | |
| Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. | |
| getRobotPolicy () | |
| Return the robot policy. | |
| getSpecialPageFactory () | |
| getSubpagesForPrefixSearch () | |
| Return an array of subpages that this special page will accept for prefix searches. | |
| outputHeader ( $summaryMessageKey='') | |
| Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e. | |
| prefixSearchString ( $search, $limit, $offset, ?SearchEngineFactory $searchEngineFactory=null) | |
| Perform a regular substring search for prefixSearchSubpages. | |
| setAuthManager (AuthManager $authManager) | |
| Set the injected AuthManager from the special page constructor. | |
| setHeaders () | |
| Sets headers - this should be called from the execute() method of all derived classes! | |
| setReauthPostData (array $data) | |
| Record preserved POST data after a reauthentication. | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. | |
Additional Inherited Members | |
| Public Member Functions inherited from MediaWiki\SpecialPage\QueryPage | |
| delete (LinkTarget $title) | |
| Remove a cached result. | |
| deleteAllCachedData () | |
| Remove all cached value This is needed when the page is no longer using the cache. | |
| doQuery ( $offset=false, $limit=false) | |
| Somewhat deprecated, you probably want to be using execute() | |
| execute ( $par) | |
| This is the actual workhorse. | |
| fetchFromCache ( $limit, $offset=false) | |
| Fetch the query results from the query cache. | |
| getCachedTimestamp () | |
| getQueryInfo () | |
| Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions. | |
| isCacheable () | |
| Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode and will not have their results written to the querycache table. | |
| isCached () | |
| Whether or not the output of the page in question is retrieved from the database cache. | |
| isExpensive () | |
| Should this query page only be updated offline on large wikis? | |
| isSyndicated () | |
| Sometimes we don't want to build rss / atom feeds. | |
| reallyDoQuery ( $limit, $offset=false) | |
| Run the query and return the result. | |
| recache ( $limit, $unused=true) | |
| Clear the cache and save new results. | |
| usesExternalSource () | |
| Check if this query page is configured to fetch data from an external source via HTTP. | |
| usesTimestamps () | |
| Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching. | |
| Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
| __construct ( $name='') | |
| Default constructor for special pages Derivative classes should call this from their constructor. | |
| addHelpLink ( $to, $overrideBaseUrl=false) | |
| Adds help link with an icon via page indicators. | |
| checkPermissions () | |
| Checks if userCanExecute, and if not throws a PermissionsError. | |
| checkReadOnly () | |
| If the wiki is currently in readonly mode, throws a ReadOnlyError. | |
| doesWrites () | |
| Indicates whether POST requests to this special page require write access to the wiki. | |
| getAssociatedNavigationLinks () | |
| Return an array of strings representing page titles that are discoverable to end users via UI. | |
| getAuthority () | |
| Shortcut to get the Authority executing this instance. | |
| getConfig () | |
| Shortcut to get main config object. | |
| getContentLanguage () | |
| Shortcut to get content language. | |
| getContext () | |
| Gets the context this SpecialPage is executed in. | |
| getDescription () | |
| Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:SpecialPages. | |
| getFinalGroupName () | |
| Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. | |
| getFullTitle () | |
| Return the full title, including $par. | |
| getLanguage () | |
| Shortcut to get user's language. | |
| getLinkRenderer () | |
| getLocalName () | |
| Get the localised name of the special page. | |
| getName () | |
| Get the canonical, unlocalized name of this special page without namespace. | |
| getOutput () | |
| Get the OutputPage being used for this instance. | |
| getPageTitle ( $subpage=false) | |
| Get a self-referential title object. | |
| getRequest () | |
| Get the WebRequest being used for this instance. | |
| getRestriction () | |
| Get the permission that a user must have to execute this page, e.g. | |
| getShortDescription (string $path='') | |
| Similar to SpecialPage::getDescription, but takes into account subpages and designed for display in tabs. | |
| getSkin () | |
| Shortcut to get the skin being used for this instance. | |
| getUser () | |
| Shortcut to get the User executing this instance. | |
| including ( $x=null) | |
| Whether the special page is being evaluated via transclusion. | |
| isIncludable () | |
| Whether it's allowed to transclude the special page via {{Special:Foo/params}}. | |
| isListed () | |
| Whether this special page is listed in Special:SpecialPages. | |
| isRestricted () | |
| Can be overridden by subclasses with more complicated permissions schemes. | |
| maxIncludeCacheTime () | |
| How long to cache page when it is being included. | |
| msg ( $key,... $params) | |
| Wrapper around wfMessage that sets the current context. | |
| prefixSearchSubpages ( $search, $limit, $offset) | |
| Return an array of subpages beginning with $search that this special page will accept. | |
| requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | |
| If the user is not logged in, throws UserNotLoggedIn error. | |
| requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false) | |
| If the user is not logged in or is a temporary user, throws UserNotLoggedIn. | |
| run ( $subPage) | |
| Entry point. | |
| setContentLanguage (Language $contentLanguage) | |
| Set content language. | |
| setContext ( $context) | |
| Sets the context this SpecialPage is executed in. | |
| setHookContainer (HookContainer $hookContainer) | |
| setLinkRenderer (LinkRenderer $linkRenderer) | |
| setSpecialPageFactory (SpecialPageFactory $specialPageFactory) | |
| userCanExecute (User $user) | |
| Checks if the given user (identified by an object) can execute this special page (as defined by getRestriction). | |
| Static Public Member Functions inherited from MediaWiki\SpecialPage\QueryPage | |
| static | getDisabledQueryPages (Config $config) |
| Get a list of disabled query pages and their run mode. | |
| static | getPages () |
| Get a list of query page classes and their associated special pages, for periodic updates. | |
| Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
| static | getSafeTitleFor ( $name, $subpage=false) |
| Get a localised Title object for a page name with a possibly unvalidated subpage. | |
| static | getTitleFor ( $name, $subpage=false, $fragment='') |
| Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. | |
| static | getTitleValueFor ( $name, $subpage=false, $fragment='') |
| Get a localised TitleValue object for a specified special page name. | |
| static | newSearchPage (User $user) |
| Get the users preferred search page. | |
| Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
| static | prefixSearchArray ( $search, $limit, array $subpages, $offset) |
| Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). | |
| Protected Attributes inherited from MediaWiki\SpecialPage\QueryPage | |
| string null false | $cachedTimestamp = null |
| int | $limit = 0 |
| bool | $listoutput = false |
| Whether or not we want plain listoutput rather than an ordered list. | |
| int | $numRows |
| The number of rows returned by the query. | |
| int | $offset = 0 |
| The offset and limit in use, as passed to the query() function. | |
| bool | $shownavigation = true |
| Whether to show prev/next links. | |
| Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage | |
| IContextSource | $mContext |
| Current request context. | |
| bool | $mIncluding |
| Whether or not this special page is being included from an article. | |
| string | $mName |
| The canonical name of this special page Also used as the message key for the default. | |
Detailed Description
Variant of QueryPage which uses a gallery to output results, thus suited for reports generating images.
- Stability: stable
- to extend
Definition at line 29 of file ImageQueryPage.php.
Member Function Documentation
◆ formatResult()
|
protected |
- Stability: stable
- to override
- Parameters
-
Skin $skin stdClass $result
- Returns
- bool|string
Reimplemented from MediaWiki\SpecialPage\QueryPage.
Definition at line 74 of file ImageQueryPage.php.
◆ getCellHtml()
|
protected |
Get additional HTML to be shown in a results' cell.
- Stability: stable
- to override
- Parameters
-
stdClass $row Result row
- Returns
- string
Reimplemented in MediaWiki\Specials\SpecialMostImages.
Definition at line 86 of file ImageQueryPage.php.
Referenced by MediaWiki\SpecialPage\ImageQueryPage\outputResults().
◆ outputResults()
|
protected |
Format and output report results using the given information plus OutputPage.
- Stability: stable
- to override
- Parameters
-
OutputPage $out OutputPage to print to Skin $skin User skin to use [unused] IReadableDatabase $dbr (read) connection to use IResultWrapper $res Result pointer int $num Number of available result rows int $offset Paging offset
Reimplemented from MediaWiki\SpecialPage\QueryPage.
Definition at line 43 of file ImageQueryPage.php.
References MediaWiki\SpecialPage\ImageQueryPage\getCellHtml(), MediaWiki\SpecialPage\SpecialPage\getContext(), MediaWiki\Title\Title\inNamespace(), and NS_FILE.
The documentation for this class was generated from the following file:
- includes/SpecialPage/ImageQueryPage.php
