MediaWiki
REL1_34
SlotRoleHandler.php
Go to the documentation of this file.
1
<?php
23
namespace
MediaWiki\Revision
;
24
25
use
MediaWiki\Linker\LinkTarget
;
26
34
class
SlotRoleHandler
{
35
39
private
$role
;
40
45
private
$layout
= [
46
'display'
=>
'section'
,
// use 'none' to suppress
47
'region'
=>
'center'
,
48
'placement'
=>
'append'
49
];
50
54
private
$contentModel
;
55
64
public
function
__construct
(
$role
,
$contentModel
,
$layout
= [] ) {
65
$this->role =
$role
;
66
$this->contentModel =
$contentModel
;
67
$this->layout = array_merge( $this->layout,
$layout
);
68
}
69
73
public
function
getRole
() {
74
return
$this->role
;
75
}
76
97
public
function
getOutputLayoutHints
() {
98
return
$this->layout
;
99
}
100
106
public
function
getNameMessageKey
() {
107
return
'slot-name-'
.
$this->role
;
108
}
109
121
public
function
getDefaultModel
(
LinkTarget
$page ) {
122
return
$this->contentModel
;
123
}
124
140
public
function
isAllowedModel
( $model,
LinkTarget
$page ) {
141
return
( $model === $this->contentModel );
142
}
143
155
public
function
supportsArticleCount
() {
156
return
false
;
157
}
158
159
}
MediaWiki\Revision\SlotRoleHandler
SlotRoleHandler instances are used to declare the existence and behavior of slot roles.
Definition
SlotRoleHandler.php:34
MediaWiki\Revision\SlotRoleHandler\$role
string $role
Definition
SlotRoleHandler.php:39
MediaWiki\Revision\SlotRoleHandler\$contentModel
string $contentModel
Definition
SlotRoleHandler.php:54
MediaWiki\Revision\SlotRoleHandler\getOutputLayoutHints
getOutputLayoutHints()
Layout hints for use while laying out the combined output of all slots, typically by RevisionRenderer...
Definition
SlotRoleHandler.php:97
MediaWiki\Revision\SlotRoleHandler\getRole
getRole()
Definition
SlotRoleHandler.php:73
MediaWiki\Revision\SlotRoleHandler\getNameMessageKey
getNameMessageKey()
The message key for the translation of the slot name.
Definition
SlotRoleHandler.php:106
MediaWiki\Revision\SlotRoleHandler\$layout
array $layout
Definition
SlotRoleHandler.php:45
MediaWiki\Revision\SlotRoleHandler\getDefaultModel
getDefaultModel(LinkTarget $page)
Determines the content model to use per default for this slot on the given page.
Definition
SlotRoleHandler.php:121
MediaWiki\Revision\SlotRoleHandler\__construct
__construct( $role, $contentModel, $layout=[])
Definition
SlotRoleHandler.php:64
MediaWiki\Revision\SlotRoleHandler\supportsArticleCount
supportsArticleCount()
Whether this slot should be considered when determining whether a page should be counted as an "artic...
Definition
SlotRoleHandler.php:155
MediaWiki\Revision\SlotRoleHandler\isAllowedModel
isAllowedModel( $model, LinkTarget $page)
Determines whether the given model can be used on this slot on the given page.
Definition
SlotRoleHandler.php:140
MediaWiki\Linker\LinkTarget
Definition
LinkTarget.php:26
MediaWiki\Revision
Created by PhpStorm.
Definition
FallbackSlotRoleHandler.php:23
includes
Revision
SlotRoleHandler.php
Generated on Mon Nov 25 2024 16:05:42 for MediaWiki by
1.10.0