CategoryPage Class Reference
Special handling for category description pages, showing pages, subcategories and file that belong to the category. More...
Inheritance diagram for CategoryPage:
Collaboration diagram for CategoryPage:
Public Member Functions | |
| closeShowCategory () | |
| getCategoryViewerClass () | |
| openShowCategory () | |
| setCategoryViewerClass ( $class) | |
| 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) | |
| __get ( $fname) | |
| __set ( $fname, $fvalue) | |
| 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. | |
| checkFlags ( $flags) | |
| Call to WikiPage function for backwards compatibility. | |
| checkTouched () | |
| clear () | |
| Clear the object. | |
| clearPreparedEdit () | |
| Call to WikiPage function for backwards compatibility. | |
| commitRollback ( $fromP, $summary, $bot, &$resultDetails, User $guser=null) | |
| confirmDelete ( $reason) | |
| Output deletion confirmation dialog. | |
| delete () | |
| UI entry point for page deletion. | |
| doDelete ( $reason, $suppress=false, $immediate=false) | |
| Perform a deletion and output success or failure messages. | |
| doDeleteArticle ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', $immediate=false) | |
| doDeleteArticleReal ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $user=null, $tags=[], $immediate=false) | |
| Call to WikiPage function for backwards compatibility. | |
| doDeleteUpdates ( $id, Content $content=null, $revision=null, User $user=null) | |
| doEditUpdates (Revision $revision, User $user, array $options=[]) | |
| Call to WikiPage function for backwards compatibility. | |
| doPurge () | |
| doRollback ( $fromP, $summary, $token, $bot, &$resultDetails, User $user=null) | |
| doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user) | |
| doViewUpdates (User $user, $oldid=0) | |
| exists () | |
| fetchRevisionRecord () | |
| Fetches the revision to work on. | |
| followRedirect () | |
| generateReason (&$hasHistory) | |
| getActionOverrides () | |
| Call to WikiPage function for backwards compatibility. | |
| getAutoDeleteReason (&$hasHistory) | |
| getCategories () | |
| getComment ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null) | |
| Call to WikiPage function for backwards compatibility. | |
| getContentHandler () | |
| getContentModel () | |
| getContext () | |
| Gets the context this Article is executed in. | |
| getContributors () | |
| getCreator ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null) | |
| Call to WikiPage function for backwards compatibility. | |
| getDeletionUpdates (Content $content=null) | |
| getHiddenCategories () | |
| getId () | |
| getLatest () | |
| getLinksTimestamp () | |
| getMinorEdit () | |
| getOldestRevision () | |
| 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, User $user=null) | |
| #- | |
| getRedirectedFrom () | |
| Get the page this view was redirected from. | |
| getRedirectTarget () | |
| getRedirectURL ( $rt) | |
| getRevIdFetched () | |
| Use this to fetch the rev ID used on page views. | |
| getRevision () | |
| Call to WikiPage function for backwards compatibility. | |
| getRevisionFetched () | |
| Get the fetched Revision object depending on request parameters or null on failure. | |
| getRobotPolicy ( $action, ParserOutput $pOutput=null) | |
| Get the robot policy to be used for the current view. | |
| getTimestamp () | |
| getTitle () | |
| Get the title object of the article. | |
| getTouched () | |
| getUndoContent (Revision $undo, Revision $undoafter=null) | |
| Call to WikiPage function for backwards compatibility. | |
| getUser ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null) | |
| getUserText ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null) | |
| hasViewableContent () | |
| insertOn ( $dbw, $pageId=null) | |
| insertProtectNullRevision ( $revCommentMsg, array $limit, array $expiry, $cascade, $reason, $user=null) | |
| insertRedirect () | |
| insertRedirectEntry (Title $rt, $oldLatest=null) | |
| isCountable ( $editInfo=false) | |
| 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. | |
| isRedirect () | |
| loadFromRow ( $data, $from) | |
| loadPageData ( $from='fromdb') | |
| lockAndGetLatest () | |
| makeParserOptions ( $context) | |
| pageDataFromId ( $dbr, $id, $options=[]) | |
| pageDataFromTitle ( $dbr, $title, $options=[]) | |
| prepareContentForEdit (Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true) | |
| Call to WikiPage function for backwards compatibility. | |
| protect () | |
| action=protect handler | |
| protectDescription (array $limit, array $expiry) | |
| protectDescriptionLog (array $limit, array $expiry) | |
| render () | |
| Handle action=render. | |
| replaceSectionAtRev ( $sectionId, Content $sectionContent, $sectionTitle='', $baseRevId=null) | |
| replaceSectionContent ( $sectionId, Content $sectionContent, $sectionTitle='', $edittime=null) | |
| Call to WikiPage function for backwards compatibility. | |
| 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 -\> | |
| setParserOptions (ParserOptions $options) | |
| Override the ParserOptions used to render the primary article wikitext. | |
| setRedirectedFrom (Title $from) | |
| Tell the page view functions that this view was redirected from another page on the wiki. | |
| setTimestamp ( $ts) | |
| shouldCheckParserCache (ParserOptions $parserOptions, $oldId) | |
| 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. | |
| 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. | |
| supportsSections () | |
| triggerOpportunisticLinksUpdate (ParserOutput $parserOutput) | |
| unprotect () | |
| action=unprotect handler (alias) | |
| updateCategoryCounts (array $added, array $deleted, $id=0) | |
| updateIfNewerOn ( $dbw, $revision) | |
| Call to WikiPage function for backwards compatibility. | |
| updateRedirectOn ( $dbw, $redirectTitle, $lastRevIsRedirect=null) | |
| updateRestrictions ( $limit=[], $reason='', &$cascade=0, $expiry=[]) | |
| updateRevisionOn ( $dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null) | |
| viewRedirect ( $target, $appendSubtitle=true, $forceKnown=false) | |
| Return the HTML for the top of a redirect page. | |
Protected Member Functions | |
| newPage (Title $title) | |
| Protected Member Functions inherited from Article | |
| fetchContentObject () | |
| Get text content object Does NOT follow redirects. | |
| getContentObject () | |
| Returns a Content object representing the pages effective display content, not necessarily the revision's content! | |
| getEmptyPageParserOutput (ParserOptions $options) | |
| Returns ParserOutput to use when a page does not exist. | |
| 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 | |
| $mCategoryViewerClass = CategoryViewer::class | |
| Protected Attributes inherited from Article | |
| LinkRenderer | $linkRenderer |
| IContextSource null | $mContext |
| The context this Article is executed in. | |
| WikiPage | $mPage |
| The WikiPage object of this instance. | |
| 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, $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 | |
| bool | $mContentLoaded = false |
| Is the target revision loaded? Set by fetchRevisionRecord(). | |
| Content null | $mContentObject |
| Content of the main slot of $this->mRevisionRecord. | |
| int null | $mOldId |
| The oldid of the article that was requested to be shown, 0 for the current revision. | |
| ParserOptions null | $mParserOptions |
| ParserOptions object for $wgUser articles. | |
| 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 bool | $mRedirectUrl = false |
| URL to redirect to or false if none. | |
| int | $mRevIdFetched = 0 |
| Revision ID of revision that was loaded. | |
Detailed Description
Special handling for category description pages, showing pages, subcategories and file that belong to the category.
@method WikiCategoryPage getPage() Set by overwritten newPage() in this class
Definition at line 30 of file CategoryPage.php.
Member Function Documentation
◆ closeShowCategory()
| CategoryPage::closeShowCategory | ( | ) |
Definition at line 81 of file CategoryPage.php.
References $type, Article\addHelpLink(), getContext(), and getTitle().
Referenced by view().
◆ getCategoryViewerClass()
| CategoryPage::getCategoryViewerClass | ( | ) |
◆ newPage()
|
protected |
- Parameters
-
Title $title
- Returns
- WikiCategoryPage
Reimplemented from Article.
Definition at line 38 of file CategoryPage.php.
References $title.
◆ openShowCategory()
| CategoryPage::openShowCategory | ( | ) |
Definition at line 77 of file CategoryPage.php.
Referenced by view().
◆ setCategoryViewerClass()
| CategoryPage::setCategoryViewerClass | ( | $class | ) |
◆ 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 43 of file CategoryPage.php.
References $title, closeShowCategory(), getContext(), Article\getPage(), getTitle(), Article\getTouched(), getUser(), NS_CATEGORY, and openShowCategory().
Member Data Documentation
◆ $mCategoryViewerClass
|
protected |
Definition at line 32 of file CategoryPage.php.
The documentation for this class was generated from the following file:
- includes/page/CategoryPage.php
