MediaWiki  master
CategoryViewer Class Reference
Inheritance diagram for CategoryViewer:
Collaboration diagram for CategoryViewer:

Public Member Functions

 __construct (PageIdentity $page, IContextSource $context, array $from=[], array $until=[], array $query=[])
 
 addImage (PageReference $page, string $sortkey, int $pageLength, bool $isRedirect=false)
 Add a page in the image namespace. More...
 
 addPage (PageReference $page, string $sortkey, int $pageLength, bool $isRedirect=false)
 Add a miscellaneous page. More...
 
 addSubcategoryObject (Category $cat, $sortkey, $pageLength)
 Add a subcategory to the internal lists, using a Category object. More...
 
 getHTML ()
 Format the category data list. More...
 
 getSubcategorySortChar (PageIdentity $page, string $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...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Static Public Member Functions

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...
 

Public Attributes

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
 
array $until
 

Protected Member Functions

 clearCategoryState ()
 
 doCategoryQuery ()
 
 finaliseCategoryState ()
 
 getCategoryBottom ()
 
 getCategoryTop ()
 
 getImageSection ()
 
 getPagesSection ()
 
 getSubcategorySection ()
 

Protected Attributes

PageIdentity $page
 
array $prevPage
 

Private Member Functions

 addFragmentToTitle (PageReference $page, string $section)
 Takes a title, and adds the fragment identifier that corresponds to the correct segment of the category. More...
 
 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 (string $type, PageReference $page, bool $isRedirect, ?string $html=null)
 
 getCountMessage ( $rescnt, $dbcnt, $type)
 What to do if the category table conflicts with the number of results returned? This function says what. More...
 
 getSectionPagingLinks ( $type)
 Get the paging links for a section (subcats/pages/files), to go at the top and bottom of the output. More...
 
 pagingLinks ( $first, $last, $type='')
 Create paging links, as a helper method to getSectionPagingLinks(). More...
 

Private Attributes

Category $cat
 Category object for this page. More...
 
ILanguageConverter $languageConverter
 
array $query
 The original query array, to be used in generating paging links. More...
 

Detailed Description

Definition at line 29 of file CategoryViewer.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryViewer::__construct ( PageIdentity  $page,
IContextSource  $context,
array  $from = [],
array  $until = [],
array  $query = [] 
)
Since
1.19 $context is a second, required parameter
Parameters
PageIdentity$page
IContextSource$context
array$fromAn array with keys page, subcat, and file for offset of results of each section (since 1.17)
array$untilAn array with 3 keys for until of each section (since 1.17)
array$query

Definition at line 99 of file CategoryViewer.php.

References ContextSource\$context, $from, $page, $query, $until, Title\castFromPageIdentity(), deprecatePublicPropertyFallback(), IContextSource\getConfig(), ContextSource\getOutput(), Category\newFromTitle(), and ContextSource\setContext().

Member Function Documentation

◆ addFragmentToTitle()

CategoryViewer::addFragmentToTitle ( PageReference  $page,
string  $section 
)
private

Takes a title, and adds the fragment identifier that corresponds to the correct segment of the category.

Parameters
PageReference$pageThe title (usually $this->title)
string$sectionWhich section
Exceptions
MWException
Returns
LinkTarget

Definition at line 732 of file CategoryViewer.php.

References $page, Page\PageReference\getDBkey(), and Page\PageReference\getNamespace().

Referenced by pagingLinks().

◆ addImage()

CategoryViewer::addImage ( PageReference  $page,
string  $sortkey,
int  $pageLength,
bool  $isRedirect = false 
)

Add a page in the image namespace.

Parameters
PageReference$page
string$sortkey
int$pageLength
bool$isRedirect

Definition at line 289 of file CategoryViewer.php.

References $flip, $page, $title, and generateLink().

Referenced by doCategoryQuery().

◆ addPage()

CategoryViewer::addPage ( PageReference  $page,
string  $sortkey,
int  $pageLength,
bool  $isRedirect = false 
)

Add a miscellaneous page.

Parameters
PageReference$page
string$sortkey
int$pageLength
bool$isRedirect

Definition at line 316 of file CategoryViewer.php.

References generateLink().

Referenced by doCategoryQuery().

◆ addSubcategoryObject()

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

Add a subcategory to the internal lists, using a Category object.

Parameters
Category$cat
string$sortkey
int$pageLength

Definition at line 205 of file CategoryViewer.php.

References $cat, generateLink(), Category\getPage(), and getSubcategorySortChar().

Referenced by doCategoryQuery().

◆ clearCategoryState()

CategoryViewer::clearCategoryState ( )
protected

◆ columnList()

static CategoryViewer::columnList (   $articles,
  $articles_start_char 
)
static

Format a list of articles chunked by letter in a three-column list, ordered vertically.

This is used for categories with a significant number of pages.

TODO: Take the headers into account when creating columns, so they're more visually equal.

TODO: shortList and columnList are similar, need merging

Parameters
string[]$articlesHTML links to each article
string[]$articles_start_charThe header characters for each article
Returns
string HTML to output
Access: internal

Definition at line 618 of file CategoryViewer.php.

References $articles, $articles_start_char, Html\closeElement(), Html\openElement(), and Html\rawElement().

Referenced by formatList().

◆ doCategoryQuery()

CategoryViewer::doCategoryQuery ( )
protected

◆ finaliseCategoryState()

CategoryViewer::finaliseCategoryState ( )
protected

Definition at line 325 of file CategoryViewer.php.

Referenced by getHTML().

◆ formatList()

CategoryViewer::formatList (   $articles,
  $articles_start_char,
  $cutoff = 6 
)
private

Format a list of articles chunked by letter, either as a bullet list or a columnar format, depending on the length.

Parameters
array$articles
array$articles_start_char
int$cutoff
Returns
string
Access: internal

Definition at line 585 of file CategoryViewer.php.

References $articles, $articles_start_char, columnList(), Html\rawElement(), and shortList().

Referenced by getImageSection(), getPagesSection(), and getSubcategorySection().

◆ generateLink()

CategoryViewer::generateLink ( string  $type,
PageReference  $page,
bool  $isRedirect,
?string  $html = null 
)
private
Parameters
string$type
PageReference$page
bool$isRedirect
string | null$html
Returns
string Annotations needed to tell taint about HtmlArmor, due to the use of the hook it is not possible to avoid raw html handling here
Parameters
-taint$htmltainted
Returns
-taint escaped

Definition at line 232 of file CategoryViewer.php.

References $page, $type, and Html\rawElement().

Referenced by addImage(), addPage(), and addSubcategoryObject().

◆ getCategoryBottom()

CategoryViewer::getCategoryBottom ( )
protected
Returns
string

Definition at line 571 of file CategoryViewer.php.

Referenced by getCategoryTop(), and getHTML().

◆ getCategoryTop()

CategoryViewer::getCategoryTop ( )
protected
Returns
string

Definition at line 445 of file CategoryViewer.php.

References getCategoryBottom().

Referenced by getHTML().

◆ getCountMessage()

CategoryViewer::getCountMessage (   $rescnt,
  $dbcnt,
  $type 
)
private

What to do if the category table conflicts with the number of results returned? This function says what.

Each type is considered independently of the other types.

Parameters
int$rescntThe number of items returned by our database query.
int$dbcntThe number of items according to the category table.
string$type'subcat', 'article', or 'file'
Returns
string A message giving the number of items, to output to HTML.

Definition at line 762 of file CategoryViewer.php.

References $type, and ContextSource\msg().

Referenced by getImageSection(), getPagesSection(), and getSubcategorySection().

◆ getHTML()

◆ getImageSection()

CategoryViewer::getImageSection ( )
protected

◆ getPagesSection()

CategoryViewer::getPagesSection ( )
protected

◆ getSectionPagingLinks()

CategoryViewer::getSectionPagingLinks (   $type)
private

Get the paging links for a section (subcats/pages/files), to go at the top and bottom of the output.

Parameters
string$type'page', 'subcat', or 'file'
Returns
string HTML output, possibly empty if there are no other pages

Definition at line 548 of file CategoryViewer.php.

References $type, and pagingLinks().

Referenced by getImageSection(), getPagesSection(), and getSubcategorySection().

◆ getSubcategorySection()

CategoryViewer::getSubcategorySection ( )
protected

◆ getSubcategorySortChar()

CategoryViewer::getSubcategorySortChar ( PageIdentity  $page,
string  $sortkey 
)

Get the character to be used for sorting subcategories.

If there's a link from Category:A to Category:B, the sortkey of the resulting entry in the categorylinks table is Category:A, not A, which it SHOULD be. Workaround: If sortkey == "Category:".$title, than use $title for sorting, else use sortkey...

Parameters
PageIdentity$page
string$sortkeyThe human-readable sortkey (before transforming to icu or whatever).
Returns
string

Definition at line 268 of file CategoryViewer.php.

References $page, and Page\PageReference\getDBkey().

Referenced by addSubcategoryObject().

◆ pagingLinks()

CategoryViewer::pagingLinks (   $first,
  $last,
  $type = '' 
)
private

Create paging links, as a helper method to getSectionPagingLinks().

Parameters
string$firstThe 'until' parameter for the generated URL
string$lastThe 'from' parameter for the generated URL
string$typeA prefix for parameters, 'page' or 'subcat' or 'file'
Returns
string HTML

Definition at line 690 of file CategoryViewer.php.

References $query, $type, addFragmentToTitle(), and ContextSource\msg().

Referenced by getSectionPagingLinks().

◆ shortList()

static CategoryViewer::shortList (   $articles,
  $articles_start_char 
)
static

Format a list of articles chunked by letter in a bullet list.

This is used for categories with a small number of pages (when columns aren't needed).

Parameters
string[]$articlesHTML links to each article
string[]$articles_start_charThe header characters for each article
Returns
string HTML to output
Access: internal

Definition at line 666 of file CategoryViewer.php.

References $articles, and $articles_start_char.

Referenced by formatList().

Member Data Documentation

◆ $articles

string [] CategoryViewer::$articles

Definition at line 43 of file CategoryViewer.php.

Referenced by columnList(), formatList(), and shortList().

◆ $articles_start_char

array CategoryViewer::$articles_start_char

Definition at line 46 of file CategoryViewer.php.

Referenced by columnList(), formatList(), and shortList().

◆ $cat

Category CategoryViewer::$cat
private

Category object for this page.

Definition at line 82 of file CategoryViewer.php.

Referenced by addSubcategoryObject(), and doCategoryQuery().

◆ $children

array CategoryViewer::$children

Definition at line 49 of file CategoryViewer.php.

◆ $children_start_char

array CategoryViewer::$children_start_char

Definition at line 52 of file CategoryViewer.php.

◆ $collation

Collation CategoryViewer::$collation

Definition at line 76 of file CategoryViewer.php.

◆ $flip

array CategoryViewer::$flip

Definition at line 70 of file CategoryViewer.php.

Referenced by addImage().

◆ $from

array CategoryViewer::$from

Definition at line 37 of file CategoryViewer.php.

Referenced by __construct().

◆ $gallery

ImageGalleryBase CategoryViewer::$gallery

Definition at line 79 of file CategoryViewer.php.

◆ $imgsNoGallery

array CategoryViewer::$imgsNoGallery

Definition at line 61 of file CategoryViewer.php.

◆ $imgsNoGallery_start_char

array CategoryViewer::$imgsNoGallery_start_char

Definition at line 58 of file CategoryViewer.php.

◆ $languageConverter

ILanguageConverter CategoryViewer::$languageConverter
private

Definition at line 88 of file CategoryViewer.php.

◆ $limit

int CategoryViewer::$limit

Definition at line 34 of file CategoryViewer.php.

◆ $nextPage

array CategoryViewer::$nextPage

Definition at line 64 of file CategoryViewer.php.

◆ $page

PageIdentity CategoryViewer::$page
protected

◆ $prevPage

array CategoryViewer::$prevPage
protected

Definition at line 67 of file CategoryViewer.php.

◆ $query

array CategoryViewer::$query
private

The original query array, to be used in generating paging links.

Definition at line 85 of file CategoryViewer.php.

Referenced by __construct(), and pagingLinks().

◆ $showGallery

bool CategoryViewer::$showGallery

Definition at line 55 of file CategoryViewer.php.

◆ $until

array CategoryViewer::$until

Definition at line 40 of file CategoryViewer.php.

Referenced by __construct().


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