BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
CategoryViewer Class Reference
Inheritance diagram for CategoryViewer:
Collaboration diagram for CategoryViewer:

Public Member Functions

 __construct ($title, IContextSource $context, $from=[], $until=[], $query=[])
 
 getHTML ()
 
 clearCategoryState ()
 
 addSubcategoryObject (Category $cat, $sortkey, $pageLength)
 
 generateLink ($type, Title $title, $isRedirect, $html=null)
 
 getSubcategorySortChar ($title, $sortkey)
 
 addImage (Title $title, $sortkey, $pageLength, $isRedirect=false)
 
 addPage ($title, $sortkey, $pageLength, $isRedirect=false)
 
 finaliseCategoryState ()
 
 doCategoryQuery ()
 
 getCategoryTop ()
 
 getSubcategorySection ()
 
 getPagesSection ()
 
 getImageSection ()
 
 getCategoryBottom ()
 
- Public Member Functions inherited from ContextSource
 getContext ()
 
 setContext (IContextSource $context)
 
 getConfig ()
 
 getRequest ()
 
 getTitle ()
 
 canUseWikiPage ()
 
 getWikiPage ()
 
 getOutput ()
 
 getUser ()
 
 getLanguage ()
 
 getSkin ()
 
 getTiming ()
 
 getStats ()
 
 msg ()
 
 exportSession ()
 

Public Attributes

 $limit
 
 $from
 
 $until
 
 $articles
 
 $articles_start_char
 
 $children
 
 $children_start_char
 
 $showGallery
 
 $imgsNoGallery_start_char
 
 $imgsNoGallery
 
 $nextPage
 
 $flip
 
 $title
 
 $collation
 
 $gallery
 

Protected Attributes

 $prevPage
 

Constructor & Destructor Documentation

CategoryViewer::__construct (   $title,
IContextSource  $context,
  $from = [],
  $until = [],
  $query = [] 
)
Since
1.19 $context is a second, required parameter
Parameters
Title$title
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

Member Function Documentation

CategoryViewer::addImage ( Title  $title,
  $sortkey,
  $pageLength,
  $isRedirect = false 
)

Add a page in the image namespace

Parameters
Title$title
string$sortkey
int$pageLength
bool$isRedirect
CategoryViewer::addPage (   $title,
  $sortkey,
  $pageLength,
  $isRedirect = false 
)

Add a miscellaneous page

Parameters
Title$title
string$sortkey
int$pageLength
bool$isRedirect
CategoryViewer::addSubcategoryObject ( Category  $cat,
  $sortkey,
  $pageLength 
)

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

Parameters
Category$cat
string$sortkey
int$pageLength
CategoryViewer::getCategoryBottom ( )
Returns
string
CategoryViewer::getCategoryTop ( )
Returns
string
CategoryViewer::getHTML ( )

Format the category data list.

Returns
string HTML output
CategoryViewer::getImageSection ( )
Returns
string
CategoryViewer::getPagesSection ( )
Returns
string
CategoryViewer::getSubcategorySection ( )
Returns
string
CategoryViewer::getSubcategorySortChar (   $title,
  $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
Title$title
string$sortkeyThe human-readable sortkey (before transforming to icu or whatever).
Returns
string

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