Go to the documentation of this file.
36 global $wgCategoryTreeDefaultOptions;
40 foreach ( $wgCategoryTreeDefaultOptions
as $option => $default ) {
42 $this->mOptions[$option] =
$options[$option];
44 $this->mOptions[$option] = $default;
52 $this->mOptions[
'namespaces'] =
false;
59 if ( $this->mOptions[
'namespaces'] ) {
60 # automatically adjust mode to match namespace filter
61 if (
count( $this->mOptions[
'namespaces'] ) === 1
62 && $this->mOptions[
'namespaces'][0] ==
NS_CATEGORY ) {
64 } elseif ( !in_array(
NS_FILE, $this->mOptions[
'namespaces'] ) ) {
77 return $this->mOptions[
$name];
94 if ( $nn ===
false || is_null( $nn ) ) {
98 if ( !is_array( $nn ) ) {
99 $nn = preg_split(
'![\s#:|]+!', $nn );
104 foreach ( $nn
as $n ) {
105 if ( is_int( $n ) ) {
113 $lower = strtolower( $n );
115 if ( is_numeric( $n ) ) {
117 } elseif ( $n ==
'-' || $n ==
'_' || $n ==
'*' || $lower ==
'main' ) {
124 if ( is_int( $ns ) ) {
138 global $wgCategoryTreeDefaultOptions;
140 if ( is_null( $mode ) ) {
141 return $wgCategoryTreeDefaultOptions[
'mode'];
143 if ( is_int( $mode ) ) {
147 $mode = trim( strtolower( $mode ) );
149 if ( is_numeric( $mode ) ) {
153 if ( $mode ==
'all' ) {
155 } elseif ( $mode ==
'pages' ) {
157 } elseif ( $mode ==
'categories' || $mode ==
'sub' ) {
159 } elseif ( $mode ==
'parents' || $mode ==
'super' || $mode ==
'inverse' ) {
161 } elseif ( $mode ==
'default' ) {
162 $mode = $wgCategoryTreeDefaultOptions[
'mode'];
175 if ( is_null(
$value ) ) {
178 if ( is_bool(
$value ) ) {
186 if ( is_numeric(
$value ) ) {
187 return ( (
int)
$value > 0 );
210 global $wgCategoryTreeDefaultOptions;
212 if ( is_null(
$value ) ) {
213 return $wgCategoryTreeDefaultOptions[
'hideprefix'];
235 } elseif (
$value ==
'always' ) {
237 } elseif (
$value ==
'never' ) {
239 } elseif (
$value ==
'auto' ) {
244 return $wgCategoryTreeDefaultOptions[
'hideprefix'];
254 $outputPage->addModuleStyles(
'ext.categoryTree.css' );
255 $outputPage->addModules(
'ext.categoryTree' );
265 if ( $enc ==
'mode' || $enc ==
'' ) {
267 } elseif ( $enc ==
'json' ) {
270 throw new Exception(
'Unknown encoding for CategoryTree options: ' . $enc );
283 foreach ( $this->mOptions
as $k => $v ) {
284 if ( is_array( $v ) ) {
285 $v = implode(
'|', $v );
287 $key .= $k .
':' . $v .
';';
290 if ( !is_null( $depth ) ) {
291 $key .=
";depth=" . $depth;
301 if ( $depth !==
null ) {
303 $opt[
'depth'] = $depth;
316 return http_build_query( $this->mOptions );
330 public function getTag(
$parser, $category, $hideroot =
false, $attr = [], $depth = 1,
331 $allowMissing =
false
333 global $wgCategoryTreeDisableCache;
335 $category = trim( $category );
336 if ( $category ===
'' ) {
341 if ( $wgCategoryTreeDisableCache ===
true ) {
343 } elseif ( is_int( $wgCategoryTreeDisableCache ) ) {
344 $parser->getOutput()->updateCacheExpiry( $wgCategoryTreeDisableCache );
354 if ( isset( $attr[
'class'] ) ) {
355 $attr[
'class'] .=
' CategoryTreeTag';
357 $attr[
'class'] =
' CategoryTreeTag';
360 $attr[
'data-ct-mode'] = $this->mOptions[
'mode'];
366 if ( !$allowMissing && !
$title->getArticleID() ) {
372 $html .=
wfMessage(
'categorytree-not-found', $category )->parse();
396 global $wgCategoryTreeMaxChildren, $wgCategoryTreeUseCategoryTable;
409 $tables = [
'page',
'categorylinks' ];
410 $fields = [
'page_id',
'page_namespace',
'page_title',
411 'page_is_redirect',
'page_len',
'page_latest',
'cl_to',
415 $options = [
'ORDER BY' =>
'cl_type, cl_sortkey',
'LIMIT' => $wgCategoryTreeMaxChildren ];
418 $joins[
'categorylinks'] = [
'RIGHT JOIN', [
419 'cl_to = page_title',
'page_namespace' =>
NS_CATEGORY
421 $where[
'cl_from'] =
$title->getArticleID();
423 $joins[
'categorylinks'] = [
'JOIN',
'cl_from = page_id' ];
424 $where[
'cl_to'] =
$title->getDBkey();
425 $options[
'USE INDEX'][
'categorylinks'] =
'cl_sortkey';
434 $where[
'cl_type'] = [
'page',
'subcat' ];
436 $where[
'cl_type'] =
'subcat';
441 # fetch member count if possible
442 $doCount = !$inverse && $wgCategoryTreeUseCategoryTable;
446 $fields = array_merge( $fields, [
447 'cat_id',
'cat_title',
'cat_subcats',
'cat_pages',
'cat_files'
449 $joins[
'category'] = [
'LEFT JOIN', [
450 'cat_title = page_title',
'page_namespace' =>
NS_CATEGORY ]
456 # collect categories separately from other pages
460 foreach (
$res as $row ) {
461 # NOTE: in inverse mode, the page record may be null, because we use a right join.
462 # happens for categories with no category page (red cat links)
463 if ( $inverse && $row->page_title ===
null ) {
466 # TODO: translation support; ideally added to Title object
472 if ( $doCount && $row->page_namespace ==
NS_CATEGORY ) {
486 return $categories . $other;
495 global $wgCategoryTreeMaxChildren;
503 'page_title' =>
'cl_to',
505 [
'cl_from' =>
$title->getArticleID() ],
508 'LIMIT' => $wgCategoryTreeMaxChildren,
509 'ORDER BY' =>
'cl_to'
517 foreach (
$res as $row ) {
520 $label = htmlspecialchars(
$t->getText() );
522 $wikiLink =
$special->getLocalURL(
'target=' .
$t->getPartialURL() .
530 $s .=
Xml::openElement(
'a', [
'class' =>
'CategoryTreeLabel',
'href' => $wikiLink ] )
547 global $wgCategoryTreeUseCategoryTable;
571 $ns =
$title->getNamespace();
572 $key =
$title->getDBkey();
574 $hideprefix = $this->
getOption(
'hideprefix' );
590 $label = htmlspecialchars(
$title->getText() );
592 $label = htmlspecialchars(
$title->getPrefixedText() );
595 $labelClass =
'CategoryTreeLabel ' .
' CategoryTreeLabelNs' . $ns;
597 if ( !
$title->getArticleID() ) {
598 $labelClass .=
' new';
599 $wikiLink =
$title->getLocalURL(
'action=edit&redlink=1' );
601 $wikiLink =
$title->getLocalURL();
605 $labelClass .=
' CategoryTreeLabelCategory';
607 $labelClass .=
' CategoryTreeLabelPage';
610 if ( ( $ns % 2 ) > 0 ) {
611 $labelClass .=
' CategoryTreeLabelTalk';
617 # NOTE: things in CategoryTree.js rely on the exact order of tags!
618 # Specifically, the CategoryTreeChildren div must be the first
619 # sibling with nodeName = DIV of the grandparent of the expland link.
624 $attr = [
'class' =>
'CategoryTreeBullet' ];
629 $count = intval( $cat->getSubcatCount() );
631 $count = intval( $cat->getPageCount() ) - intval( $cat->getFileCount() );
633 $count = intval( $cat->getPageCount() );
636 if ( $count === 0 ) {
637 $bullet =
wfMessage(
'categorytree-empty-bullet' )->plain() .
' ';
638 $attr[
'class'] =
'CategoryTreeEmptyBullet';
642 $linkattr[
'class' ] =
"CategoryTreeToggle";
643 $linkattr[
'data-ct-title'] = $key;
646 if ( $children == 0 ) {
647 $txt =
wfMessage(
'categorytree-expand-bullet' )->plain();
648 $linkattr[
'data-ct-state' ] =
'collapsed';
650 $txt =
wfMessage(
'categorytree-collapse-bullet' )->plain();
651 $linkattr[
'data-ct-loaded' ] =
true;
652 $linkattr[
'data-ct-state' ] =
'expanded';
658 $bullet =
wfMessage(
'categorytree-page-bullet' )->plain();
665 if ( $count !==
false && $this->
getOption(
'showcount' ) ) {
674 'class' =>
'CategoryTreeChildren',
675 'style' => $children > 0 ?
"display:block" :
"display:none"
681 if ( $children ==
'' ) {
684 $s .=
wfMessage(
'categorytree-no-subcategories' )->text();
686 $s .=
wfMessage(
'categorytree-no-pages' )->text();
688 $s .=
wfMessage(
'categorytree-no-parent-categories' )->text();
690 $s .=
wfMessage(
'categorytree-nothing-found' )->text();
716 # Get counts, with conversion to integer so === works
717 # Note: $allCount is the total number of cat members,
718 # not the count of how many members are normal pages.
719 $allCount = $cat ? intval( $cat->getPageCount() ) : 0;
720 $subcatCount = $cat ? intval( $cat->getSubcatCount() ) : 0;
721 $fileCount = $cat ? intval( $cat->getFileCount() ) : 0;
722 $pages = $allCount - $subcatCount - $fileCount;
725 'title' =>
$context->msg(
'categorytree-member-counts' )
726 ->numParams( $subcatCount, $pages, $fileCount, $allCount, $countMode )->text(),
727 'dir' =>
$context->getLanguage()->getDir() # numbers
and commas
get messed
up in a mixed dir env
732 # Create a list of category members with only non-zero member counts
734 if ( $subcatCount ) {
735 $memberNums[] =
$context->msg(
'categorytree-num-categories' )
736 ->numParams( $subcatCount )->text();
739 $memberNums[] =
$context->msg(
'categorytree-num-pages' )->numParams( $pages )->text();
742 $memberNums[] =
$context->msg(
'categorytree-num-files' )
743 ->numParams( $fileCount )->text();
745 $memberNumsShort = $memberNums
746 ?
$context->getLanguage()->commaList( $memberNums )
747 :
$context->msg(
'categorytree-num-empty' )->text();
749 # Only $5 is actually used in the default message.
750 # Other arguments can be used in a customized message.
754 $context->msg(
'categorytree-member-num' )
756 ->params( $subcatCount, $pages, $fileCount, $allCount, $memberNumsShort )
771 if ( strval(
$title ) ===
'' ) {
775 # The title must be in the category namespace
776 # Ignore a leading Category: if there is one
781 $title =
"Category:$title";
794 global $wgCategoryTreeMaxDepth;
796 if ( is_numeric( $depth ) ) {
797 $depth = intval( $depth );
802 if ( is_array( $wgCategoryTreeMaxDepth ) ) {
803 $max = isset( $wgCategoryTreeMaxDepth[$mode] ) ? $wgCategoryTreeMaxDepth[$mode] : 1;
804 } elseif ( is_numeric( $wgCategoryTreeMaxDepth ) ) {
805 $max = $wgCategoryTreeMaxDepth;
807 wfDebug(
'CategoryTree::capDepth: $wgCategoryTreeMaxDepth is invalid.' );
811 return min( $depth, $max );
getTag( $parser, $category, $hideroot=false, $attr=[], $depth=1, $allowMissing=false)
Custom tag implementation.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
static capDepth( $mode, $depth)
Internal function to cap depth.
static decodeMode( $mode)
renderChildren( $title, $depth=1)
Returns a string with an HTML representation of the children of the given category.
renderNodeInfo( $title, $cat, $children=0)
Returns a string with a HTML represenation of the given page.
namespace and then decline to actually register it & $namespaces
Core functions for the CategoryTree extension, an AJAX based gadget to display the category structure...
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
</source > ! result< div class="mw-highlight mw-content-ltr" dir="ltr">< pre >< span ></span >< span class="kd"> var</span >< span class="nx"> a</span >< span class="p"></span ></pre ></div > ! end ! test Multiline< source/> in lists !input *< source > a b</source > *foo< source > a b</source > ! html< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! html tidy< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! end ! test Custom attributes !input< source lang="javascript" id="foo" class="bar" dir="rtl" style="font-size: larger;"> var a
Allows to change the fields on the form that will be generated $name
static decodeHidePrefix( $value)
static openElement( $element, $attribs=null)
This opens an XML element.
static setHeaders( $outputPage)
Add ResourceLoader modules to the OutputPage object.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
static closeElement( $element)
Returns "</$element>".
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
namespace and then decline to actually register it file or subcat img or subcat $title
static newFromRow( $row)
Make a Title object from a DB row.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
null for the wiki Added in
do that in ParserLimitReportFormat instead $parser
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
when a variable name is used in a it is silently declared as a new masking the global
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static newFromRow( $row, $title=null)
Factory function, for constructing a Category object from a result set.
static newFromTitle( $title)
Factory function.
static decodeBoolean( $value)
Helper function to convert a string to a boolean value.
this hook is for auditing only RecentChangesLinked and Watchlist $special
static getMain()
Get the RequestContext object associated with the main request.
renderParents( $title)
Returns a string with an HTML representation of the parents of the given category.
Interface for objects which can provide a MediaWiki context on request.
getOptionsAsUrlParameters()
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two and(2) offer you this license which gives you legal permission to copy
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set up
static closeElement( $element)
Shortcut to close an XML element.
getOptionsAsCacheKey( $depth=null)
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
static encodeOptions( $options, $enc)
static makeTitle( $title)
Creates a Title object from a user provided (and thus unsafe) string.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<
getOptionsAsJsStructure( $depth=null)
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any order
renderNode( $title, $children=0)
Returns a string with a HTML represenation of the given page.
static decodeNamespaces( $nn)
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
static createCountString(IContextSource $context, $cat, $countMode)
Create a string which format the page, subcat and file counts of a category.