MediaWiki  1.33.0
CategoryTreeCategoryViewer Class Reference
Inheritance diagram for CategoryTreeCategoryViewer:
Collaboration diagram for CategoryTreeCategoryViewer:

Public Member Functions

 addSubcategoryObject (Category $cat, $sortkey, $pageLength)
 Add a subcategory to the internal lists. More...
 
 clearCategoryState ()
 @inheritDoc More...
 
 finaliseCategoryState ()
 @inheritDoc More...
 
- Public Member Functions inherited from CategoryViewer
 __construct ( $title, IContextSource $context, $from=[], $until=[], $query=[])
 
 addImage (Title $title, $sortkey, $pageLength, $isRedirect=false)
 Add a page in the image namespace. More...
 
 addPage ( $title, $sortkey, $pageLength, $isRedirect=false)
 Add a miscellaneous page. More...
 
 doCategoryQuery ()
 
 formatList ( $articles, $articles_start_char, $cutoff=6)
 Format a list of articles chunked by letter, either as a bullet list or a columnar format, depending on the length. More...
 
 generateLink ( $type, Title $title, $isRedirect, $html=null)
 
 getCategoryBottom ()
 
 getCategoryTop ()
 
 getHTML ()
 Format the category data list. More...
 
 getImageSection ()
 
 getPagesSection ()
 
 getSubcategorySection ()
 
 getSubcategorySortChar ( $title, $sortkey)
 Get the character to be used for sorting subcategories. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

CategoryTree $categorytree
 
 $child_cats
 
- Public Attributes inherited from CategoryViewer
string[] $articles
 
array $articles_start_char
 
array $children
 
array $children_start_char
 
Collation $collation
 
array $flip
 
array $from
 
ImageGalleryBase $gallery
 
array $imgsNoGallery
 
array $imgsNoGallery_start_char
 
int $limit
 
array $nextPage
 
bool $showGallery
 
Title $title
 
array $until
 

Private Member Functions

 getCategoryTree ()
 

Additional Inherited Members

- Static Public Member Functions inherited from CategoryViewer
static columnList ( $articles, $articles_start_char)
 Format a list of articles chunked by letter in a three-column list, ordered vertically. More...
 
static shortList ( $articles, $articles_start_char)
 Format a list of articles chunked by letter in a bullet list. More...
 
- Protected Attributes inherited from CategoryViewer
array $prevPage
 

Detailed Description

Definition at line 21 of file CategoryTreeCategoryViewer.php.

Member Function Documentation

◆ addSubcategoryObject()

CategoryTreeCategoryViewer::addSubcategoryObject ( Category  $cat,
  $sortkey,
  $pageLength 
)

Add a subcategory to the internal lists.

Parameters
Category$cat
string$sortkey
int$pageLength

Reimplemented from CategoryViewer.

Definition at line 52 of file CategoryTreeCategoryViewer.php.

References CategoryViewer\$cat, CategoryViewer\$title, getCategoryTree(), ContextSource\getRequest(), CategoryViewer\getSubcategorySortChar(), and Category\getTitle().

◆ clearCategoryState()

CategoryTreeCategoryViewer::clearCategoryState ( )

@inheritDoc

Reimplemented from CategoryViewer.

Definition at line 70 of file CategoryTreeCategoryViewer.php.

◆ finaliseCategoryState()

CategoryTreeCategoryViewer::finaliseCategoryState ( )

@inheritDoc

Reimplemented from CategoryViewer.

Definition at line 78 of file CategoryTreeCategoryViewer.php.

◆ getCategoryTree()

CategoryTreeCategoryViewer::getCategoryTree ( )
private

Member Data Documentation

◆ $categorytree

CategoryTree CategoryTreeCategoryViewer::$categorytree

Definition at line 27 of file CategoryTreeCategoryViewer.php.

Referenced by getCategoryTree().

◆ $child_cats

CategoryTreeCategoryViewer::$child_cats

Definition at line 22 of file CategoryTreeCategoryViewer.php.


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