MediaWiki  master
Revision\MainSlotRoleHandler Class Reference

A SlotRoleHandler for the main slot. More...

Inheritance diagram for Revision\MainSlotRoleHandler:
Collaboration diagram for Revision\MainSlotRoleHandler:

Public Member Functions

 __construct (array $namespaceContentModels, IContentHandlerFactory $contentHandlerFactory)
 
 getDefaultModel (LinkTarget $page)
 
 isAllowedModel ( $model, LinkTarget $page)
 
 supportsArticleCount ()
 Whether this slot should be considered when determining whether a page should be counted as an "article" in the site statistics. More...
 
- Public Member Functions inherited from Revision\SlotRoleHandler
 __construct ( $role, $contentModel, $layout=[])
 
 getNameMessageKey ()
 The message key for the translation of the slot name. More...
 
 getOutputLayoutHints ()
 Layout hints for use while laying out the combined output of all slots, typically by RevisionRenderer. More...
 
 getRole ()
 

Private Attributes

IContentHandlerFactory $contentHandlerFactory
 
string[] $namespaceContentModels
 A mapping of namespaces to content models. More...
 

Detailed Description

A SlotRoleHandler for the main slot.

While most slot roles serve a specific purpose and thus typically exhibit the same behaviour on all pages, the main slot is used for different things in different pages, typically depending on the namespace, a "file extension" in the page name, or the content model of the slot's content.

MainSlotRoleHandler implements some of the per-namespace and per-model behavior that was supported prior to MediaWiki Version 1.33.

Since
1.33

Definition at line 42 of file MainSlotRoleHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Revision\MainSlotRoleHandler::__construct ( array  $namespaceContentModels,
IContentHandlerFactory  $contentHandlerFactory 
)
Parameters
string[]$namespaceContentModelsA mapping of namespaces to content models, typically from $wgNamespaceContentModels.
IContentHandlerFactory$contentHandlerFactory

Definition at line 60 of file MainSlotRoleHandler.php.

References Revision\MainSlotRoleHandler\$contentHandlerFactory, Revision\MainSlotRoleHandler\$namespaceContentModels, and CONTENT_MODEL_WIKITEXT.

Member Function Documentation

◆ getDefaultModel()

Revision\MainSlotRoleHandler::getDefaultModel ( LinkTarget  $page)

◆ isAllowedModel()

Revision\MainSlotRoleHandler::isAllowedModel (   $model,
LinkTarget  $page 
)
Parameters
string$model
LinkTarget$page
Returns
bool
Exceptions
MWUnknownContentModelException

Reimplemented from Revision\SlotRoleHandler.

Definition at line 80 of file MainSlotRoleHandler.php.

References $title, and Title\newFromLinkTarget().

◆ supportsArticleCount()

Revision\MainSlotRoleHandler::supportsArticleCount ( )

Whether this slot should be considered when determining whether a page should be counted as an "article" in the site statistics.

For a page to be considered countable, one of the page's slots must return true from this method, and Content::isCountable() must return true for the content of that slot.

The default implementation always returns false.

Returns
bool

Reimplemented from Revision\SlotRoleHandler.

Definition at line 69 of file MainSlotRoleHandler.php.

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory Revision\MainSlotRoleHandler::$contentHandlerFactory
private

Definition at line 53 of file MainSlotRoleHandler.php.

Referenced by Revision\MainSlotRoleHandler\__construct().

◆ $namespaceContentModels

string [] Revision\MainSlotRoleHandler::$namespaceContentModels
private

A mapping of namespaces to content models.

See also
$wgNamespaceContentModels

Definition at line 48 of file MainSlotRoleHandler.php.

Referenced by Revision\MainSlotRoleHandler\__construct().


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