CategoryPage Class Reference
Special handling for category description pages. More...
Inherits Article.
Collaboration diagram for CategoryPage:
Public Member Functions | |
| closeShowCategory () | |
| openShowCategory () | |
| view () | |
| This is the default action of the index.php entry point: just view the page of the given title. | |
 Public Member Functions inherited from Article | |
| __construct (Title $title, $oldId=null) | |
| addHelpLink ( $to, $overrideBaseUrl=false) | |
| Adds help link with an icon via page indicators. | |
| adjustDisplayTitle (ParserOutput $pOutput) | |
| Adjust title for pages with displaytitle, -{T|}- or language conversion. | |
| clear () | |
| fetchRevisionRecord () | |
| Fetches the revision to work on. | |
| getActionOverrides () | |
| Call to WikiPage function for backwards compatibility. | |
| getContext () | |
| Gets the context this Article is executed in. | |
| getOldID () | |
| getOldIDFromRequest () | |
| Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect. | |
| getPage () | |
| Get the WikiPage object of this instance. | |
| getParserOptions () | |
| Get parser options suitable for rendering the primary article wikitext. | |
| getParserOutput ( $oldid=null, ?UserIdentity $user=null) | |
| Lightweight method to get the parser output for a page, checking the parser cache and so on. | |
| getRedirectedFrom () | |
| Get the page this view was redirected from. | |
| getRevIdFetched () | |
| Use this to fetch the rev ID used on page views. | |
| getRobotPolicy ( $action, ?ParserOutput $pOutput=null) | |
| Get the robot policy to be used for the current view. | |
| getTitle () | |
| Get the title object of the article. | |
| isCurrent () | |
| Returns true if the currently-referenced revision is the current edit to this page (and it exists). | |
| isFileCacheable ( $mode=HTMLFileCache::MODE_NORMAL) | |
| Check if the page can be cached. | |
| protect () | |
| action=protect handler | |
| render () | |
| Handle action=render. | |
| setContext ( $context) | |
| Sets the context this Article is executed in. | |
| setOldSubtitle ( $oldid=0) | |
| Generate the navigation links when browsing through an article revisions It shows the information as: Revision as of \<date\>; view current revision \<- Previous version | Next Version -\> | |
| setRedirectedFrom (Title $from) | |
| Tell the page view functions that this view was redirected from another page on the wiki. | |
| showDeletedRevisionHeader () | |
| If the revision requested for view is deleted, check permissions. | |
| showMissingArticle () | |
| Show the error text for a missing article. | |
| showNamespaceHeader () | |
| Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]]. | |
| showPatrolFooter () | |
| If patrol is possible, output a patrol UI box. | |
| showProtectionIndicator () | |
| Show a lock icon above the article body if the page is protected. | |
| showRedirectedFromHeader () | |
| If this request is a redirect view, send "redirected from" subtitle to the output. | |
| showViewFooter () | |
| Show the footer section of an ordinary page view. | |
| unprotect () | |
| action=unprotect handler (alias) | |
Protected Member Functions | |
| newPage (Title $title) | |
| Protected Member Functions inherited from Article | |
| isDiffOnlyView () | |
| showDiffPage () | |
| Show a diff page according to current request variables. | |
| tryFileCache () | |
| checkLastModified returns true if it has taken care of all output to the client that is necessary for this request. | |
Protected Attributes | |
| string | $mCategoryViewerClass = CategoryViewer::class |
| Subclasses can change this to override the viewer class. | |
| Protected Attributes inherited from Article | |
| DatabaseBlockStore | $blockStore |
| IConnectionProvider | $dbProvider |
| LinkRenderer | $linkRenderer |
| IContextSource null | $mContext |
| The context this Article is executed in. | |
| WikiPage | $mPage |
| The WikiPage object of this instance. | |
| RestrictionStore | $restrictionStore |
| bool | $viewIsRenderAction = false |
| Whether render() was called. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Article | |
| static | formatRobotPolicy ( $policy) |
| Converts a String robot policy into an associative array, to allow merging of several policies using array_merge(). | |
| static | getRedirectHeaderHtml (Language $lang, Title $target, $forceKnown=false) |
| Return the HTML for the top of a redirect page. | |
| static | newFromID ( $id) |
| Constructor from a page id. | |
| static | newFromTitle ( $title, IContextSource $context) |
| Create an Article object of the appropriate class for the given page. | |
| static | newFromWikiPage (WikiPage $page, IContextSource $context) |
| Create an Article object of the appropriate class for the given page. | |
| static | purgePatrolFooterCache ( $articleID) |
| Purge the cache used to check if it is worth showing the patrol footer For example, it is done during re-uploads when file patrol is used. | |
| Public Attributes inherited from Article | |
| int null | $mOldId |
| The oldid of the article that was requested to be shown, 0 for the current revision. | |
| ParserOutput null false | $mParserOutput = null |
| The ParserOutput generated for viewing the page, initialized by view(). | |
| Title null | $mRedirectedFrom = null |
| Title from which we were redirected here, if any. | |
| string false | $mRedirectUrl = false |
| URL to redirect to or false if none. | |
Detailed Description
Special handling for category description pages.
This displays category members: subcategories, pages, and files categorised here.
@method WikiCategoryPage getPage() Set by overwritten newPage() in this class
Definition at line 32 of file CategoryPage.php.
Member Function Documentation
◆ closeShowCategory()
| CategoryPage::closeShowCategory | ( | ) |
Definition at line 81 of file CategoryPage.php.
References Article\addHelpLink(), Article\getContext(), and Article\getPage().
Referenced by view().
◆ newPage()
|
protected |
- Parameters
-
Title $title
- Returns
- WikiCategoryPage
Reimplemented from Article.
Definition at line 40 of file CategoryPage.php.
◆ openShowCategory()
| CategoryPage::openShowCategory | ( | ) |
Definition at line 77 of file CategoryPage.php.
Referenced by view().
◆ view()
| CategoryPage::view | ( | ) |
This is the default action of the index.php entry point: just view the page of the given title.
Reimplemented from Article.
Definition at line 45 of file CategoryPage.php.
References closeShowCategory(), Article\getContext(), Article\getPage(), getTitle(), Article\isDiffOnlyView(), NS_CATEGORY, and openShowCategory().
Member Data Documentation
◆ $mCategoryViewerClass
|
protected |
Subclasses can change this to override the viewer class.
Definition at line 34 of file CategoryPage.php.
The documentation for this class was generated from the following file:
- includes/page/CategoryPage.php
