MediaWiki  1.30.0
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. More...
 
- Public Member Functions inherited from Article
 __construct (Title $title, $oldId=null)
 Constructor and clear the article. More...
 
 __get ( $fname)
 Use PHP's magic __get handler to handle accessing of raw WikiPage fields for backwards compatibility. More...
 
 __set ( $fname, $fvalue)
 Use PHP's magic __set handler to handle setting of raw WikiPage fields for backwards compatibility. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 adjustDisplayTitle (ParserOutput $pOutput)
 Adjust title for pages with displaytitle, -{T|}- or language conversion. More...
 
 checkFlags ( $flags)
 Call to WikiPage function for backwards compatibility. More...
 
 checkTouched ()
 Call to WikiPage function for backwards compatibility. More...
 
 clear ()
 Clear the object. More...
 
 clearPreparedEdit ()
 Call to WikiPage function for backwards compatibility. More...
 
 commitRollback ( $fromP, $summary, $bot, &$resultDetails, User $guser=null)
 
 confirmDelete ( $reason)
 Output deletion confirmation dialog. More...
 
 delete ()
 UI entry point for page deletion. More...
 
 doDelete ( $reason, $suppress=false)
 Perform a deletion and output success or failure messages. More...
 
 doDeleteArticle ( $reason, $suppress=false, $u1=null, $u2=null, &$error='')
 
 doDeleteArticleReal ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $user=null, $tags=[])
 Call to WikiPage function for backwards compatibility. More...
 
 doDeleteUpdates ( $id, Content $content=null)
 Call to WikiPage function for backwards compatibility. More...
 
 doEditContent (Content $content, $summary, $flags=0, $baseRevId=false, User $user=null, $serialFormat=null)
 Call to WikiPage function for backwards compatibility. More...
 
 doEditUpdates (Revision $revision, User $user, array $options=[])
 Call to WikiPage function for backwards compatibility. More...
 
 doPurge ()
 Call to WikiPage function for backwards compatibility. More...
 
 doRollback ( $fromP, $summary, $token, $bot, &$resultDetails, User $user=null)
 
 doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user)
 
 doViewUpdates (User $user, $oldid=0)
 Call to WikiPage function for backwards compatibility. More...
 
 exists ()
 Call to WikiPage function for backwards compatibility. More...
 
 followRedirect ()
 Call to WikiPage function for backwards compatibility. More...
 
 generateReason (&$hasHistory)
 
 getActionOverrides ()
 Call to WikiPage function for backwards compatibility. More...
 
 getAutoDeleteReason (&$hasHistory)
 Call to WikiPage function for backwards compatibility. More...
 
 getCategories ()
 Call to WikiPage function for backwards compatibility. More...
 
 getComment ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getContentHandler ()
 Call to WikiPage function for backwards compatibility. More...
 
 getContentModel ()
 Call to WikiPage function for backwards compatibility. More...
 
 getContext ()
 Gets the context this Article is executed in. More...
 
 getContributors ()
 Call to WikiPage function for backwards compatibility. More...
 
 getCreator ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getDeletionUpdates (Content $content=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getHiddenCategories ()
 Call to WikiPage function for backwards compatibility. More...
 
 getId ()
 Call to WikiPage function for backwards compatibility. More...
 
 getLastPurgeTimestamp ()
 Call to WikiPage function for backwards compatibility. More...
 
 getLatest ()
 Call to WikiPage function for backwards compatibility. More...
 
 getLinksTimestamp ()
 Call to WikiPage function for backwards compatibility. More...
 
 getMinorEdit ()
 Call to WikiPage function for backwards compatibility. More...
 
 getOldestRevision ()
 Call to WikiPage function for backwards compatibility. More...
 
 getOldID ()
 
 getOldIDFromRequest ()
 Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect. More...
 
 getPage ()
 Get the WikiPage object of this instance. More...
 
 getParserOptions ()
 Get parser options suitable for rendering the primary article wikitext. More...
 
 getParserOutput ( $oldid=null, User $user=null)
 #- More...
 
 getRedirectedFrom ()
 Get the page this view was redirected from. More...
 
 getRedirectTarget ()
 Call to WikiPage function for backwards compatibility. More...
 
 getRedirectURL ( $rt)
 Call to WikiPage function for backwards compatibility. More...
 
 getRevIdFetched ()
 Use this to fetch the rev ID used on page views. More...
 
 getRevision ()
 Call to WikiPage function for backwards compatibility. More...
 
 getRevisionFetched ()
 Get the fetched Revision object depending on request parameters or null on failure. More...
 
 getRobotPolicy ( $action, $pOutput=null)
 Get the robot policy to be used for the current view. More...
 
 getTimestamp ()
 Call to WikiPage function for backwards compatibility. More...
 
 getTitle ()
 Get the title object of the article. More...
 
 getTouched ()
 Call to WikiPage function for backwards compatibility. More...
 
 getUndoContent (Revision $undo, Revision $undoafter=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getUser ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getUserText ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 hasViewableContent ()
 Call to WikiPage function for backwards compatibility. More...
 
 insertOn ( $dbw, $pageId=null)
 Call to WikiPage function for backwards compatibility. More...
 
 insertProtectNullRevision ( $revCommentMsg, array $limit, array $expiry, $cascade, $reason, $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 insertRedirect ()
 Call to WikiPage function for backwards compatibility. More...
 
 insertRedirectEntry (Title $rt, $oldLatest=null)
 Call to WikiPage function for backwards compatibility. More...
 
 isCountable ( $editInfo=false)
 Call to WikiPage function for backwards compatibility. More...
 
 isCurrent ()
 Returns true if the currently-referenced revision is the current edit to this page (and it exists). More...
 
 isFileCacheable ( $mode=HTMLFileCache::MODE_NORMAL)
 Check if the page can be cached. More...
 
 isRedirect ()
 Call to WikiPage function for backwards compatibility. More...
 
 loadFromRow ( $data, $from)
 Call to WikiPage function for backwards compatibility. More...
 
 loadPageData ( $from='fromdb')
 Call to WikiPage function for backwards compatibility. More...
 
 lockAndGetLatest ()
 Call to WikiPage function for backwards compatibility. More...
 
 makeParserOptions ( $context)
 Call to WikiPage function for backwards compatibility. More...
 
 pageDataFromId ( $dbr, $id, $options=[])
 Call to WikiPage function for backwards compatibility. More...
 
 pageDataFromTitle ( $dbr, $title, $options=[])
 Call to WikiPage function for backwards compatibility. More...
 
 prepareContentForEdit (Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true)
 Call to WikiPage function for backwards compatibility. More...
 
 protect ()
 action=protect handler More...
 
 protectDescription (array $limit, array $expiry)
 Call to WikiPage function for backwards compatibility. More...
 
 protectDescriptionLog (array $limit, array $expiry)
 Call to WikiPage function for backwards compatibility. More...
 
 render ()
 Handle action=render. More...
 
 replaceSectionAtRev ( $sectionId, Content $sectionContent, $sectionTitle='', $baseRevId=null)
 Call to WikiPage function for backwards compatibility. More...
 
 replaceSectionContent ( $sectionId, Content $sectionContent, $sectionTitle='', $edittime=null)
 Call to WikiPage function for backwards compatibility. More...
 
 setContext ( $context)
 Sets the context this Article is executed in. More...
 
 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 -\> More...
 
 setParserOptions (ParserOptions $options)
 Override the ParserOptions used to render the primary article wikitext. More...
 
 setRedirectedFrom (Title $from)
 Tell the page view functions that this view was redirected from another page on the wiki. More...
 
 setTimestamp ( $ts)
 Call to WikiPage function for backwards compatibility. More...
 
 shouldCheckParserCache (ParserOptions $parserOptions, $oldId)
 Call to WikiPage function for backwards compatibility. More...
 
 showDeletedRevisionHeader ()
 If the revision requested for view is deleted, check permissions. More...
 
 showMissingArticle ()
 Show the error text for a missing article. More...
 
 showNamespaceHeader ()
 Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]]. More...
 
 showPatrolFooter ()
 If patrol is possible, output a patrol UI box. More...
 
 showRedirectedFromHeader ()
 If this request is a redirect view, send "redirected from" subtitle to the output. More...
 
 showViewFooter ()
 Show the footer section of an ordinary page view. More...
 
 supportsSections ()
 Call to WikiPage function for backwards compatibility. More...
 
 triggerOpportunisticLinksUpdate (ParserOutput $parserOutput)
 Call to WikiPage function for backwards compatibility. More...
 
 unprotect ()
 action=unprotect handler (alias) More...
 
 updateCategoryCounts (array $added, array $deleted, $id=0)
 Call to WikiPage function for backwards compatibility. More...
 
 updateIfNewerOn ( $dbw, $revision)
 Call to WikiPage function for backwards compatibility. More...
 
 updateRedirectOn ( $dbw, $redirectTitle, $lastRevIsRedirect=null)
 Call to WikiPage function for backwards compatibility. More...
 
 updateRestrictions ( $limit=[], $reason='', &$cascade=0, $expiry=[])
 
 updateRevisionOn ( $dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)
 Call to WikiPage function for backwards compatibility. More...
 
 viewRedirect ( $target, $appendSubtitle=true, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 

Protected Member Functions

 newPage (Title $title)
 
- Protected Member Functions inherited from Article
 fetchContentObject ()
 Get text content object Does NOT follow redirects. More...
 
 getContentObject ()
 Returns a Content object representing the pages effective display content, not necessarily the revision's content! More...
 
 showDiffPage ()
 Show a diff page according to current request variables. More...
 
 tryFileCache ()
 checkLastModified returns true if it has taken care of all output to the client that is necessary for this request. More...
 

Protected Attributes

 $mCategoryViewerClass = 'CategoryViewer'
 
WikiCategoryPage $mPage
 
- Protected Attributes inherited from Article
IContextSource $mContext
 The context this Article is executed in. More...
 
WikiPage $mPage
 The WikiPage object of this instance. More...
 

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(). More...
 
static getRedirectHeaderHtml (Language $lang, $target, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 
static newFromID ( $id)
 Constructor from a page id. More...
 
static newFromTitle ( $title, IContextSource $context)
 Create an Article object of the appropriate class for the given page. More...
 
static newFromWikiPage (WikiPage $page, IContextSource $context)
 Create an Article object of the appropriate class for the given page. More...
 
static onArticleCreate ( $title)
 
static onArticleDelete ( $title)
 
static onArticleEdit ( $title)
 
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. More...
 
static selectFields ()
 
- Public Attributes inherited from Article
string $mContent
 Text of the revision we are working on. More...
 
bool $mContentLoaded = false
 Is the content ($mContent) already loaded? More...
 
Content $mContentObject
 Content of the revision we are working on. More...
 
int null $mOldId
 The oldid of the article that is to be shown, 0 for the current revision. More...
 
ParserOptions $mParserOptions
 ParserOptions object for $wgUser articles. More...
 
ParserOutput $mParserOutput
 
Title $mRedirectedFrom = null
 Title from which we were redirected here. More...
 
string bool $mRedirectUrl = false
 URL to redirect to or false if none. More...
 
int $mRevIdFetched = 0
 Revision ID of revision we are working on. More...
 
Revision $mRevision = null
 Revision we are working on. More...
 

Detailed Description

Special handling for category description pages, showing pages, subcategories and file that belong to the category.

Definition at line 28 of file CategoryPage.php.

Member Function Documentation

◆ closeShowCategory()

CategoryPage::closeShowCategory ( )

Definition at line 84 of file CategoryPage.php.

References $out, $request, $type, Article\addHelpLink(), as, Article\getContext(), and Article\getTitle().

Referenced by view().

◆ getCategoryViewerClass()

CategoryPage::getCategoryViewerClass ( )

Definition at line 121 of file CategoryPage.php.

References $mCategoryViewerClass.

◆ newPage()

CategoryPage::newPage ( Title  $title)
protected
Parameters
Title$title
Returns
WikiCategoryPage

Reimplemented from Article.

Definition at line 41 of file CategoryPage.php.

References $title.

◆ openShowCategory()

CategoryPage::openShowCategory ( )

Definition at line 80 of file CategoryPage.php.

Referenced by view().

◆ setCategoryViewerClass()

CategoryPage::setCategoryViewerClass (   $class)

Definition at line 125 of file CategoryPage.php.

◆ 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 46 of file CategoryPage.php.

References $request, $title, closeShowCategory(), Article\getContext(), Article\getTitle(), Article\getUser(), NS_CATEGORY, openShowCategory(), Hooks\run(), IExpiringStore\TTL_MINUTE, and view().

Member Data Documentation

◆ $mCategoryViewerClass

CategoryPage::$mCategoryViewerClass = 'CategoryViewer'
protected

Definition at line 30 of file CategoryPage.php.

Referenced by getCategoryViewerClass().

◆ $mPage

WikiCategoryPage CategoryPage::$mPage
protected

Definition at line 35 of file CategoryPage.php.


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