1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
<?php
namespace OOUI;
/**
* Notice widget.
*/
class MessageWidget extends Widget {
use IconElement;
use LabelElement;
use TitledElement;
use FlaggedElement;
/**
* Defines whether the widget is inline
*
* @var bool
*/
protected $inline;
/**
* Defines the displayed message type
*
* @var string
*/
protected $type;
/**
* @var ButtonWidget|null
*/
protected $closeButton = null;
/**
* Map legal types to their OOUI icon
*
* @var array
*/
protected $iconMap = [
'notice' => 'infoFilled',
'error' => 'error',
'warning' => 'alert',
'success' => 'check',
];
/**
* Default type for the widget
*
* @var string
*/
protected $defaultType = 'notice';
/**
* @param array $config Configuration options
*/
public function __construct( array $config = [] ) {
// Parent constructor
parent::__construct( $config );
// Traits
$this->initializeLabelElement( $config );
$this->initializeIconElement( $config );
$this->initializeTitledElement( $config );
$this->initializeFlaggedElement( $config );
$this->setType( $config['type'] ?? $this->defaultType );
$this->setInline( $config['inline'] ?? false );
// If an icon is passed in, set it again as setType will
// have overridden the setIcon call in the IconElement constructor
if ( isset( $config['icon'] ) ) {
$this->setIcon( $config['icon'] );
}
if ( !$this->inline && !empty( $config['showClose'] ) ) {
$this->closeButton = new ButtonWidget( [
'classes' => [ 'oo-ui-messageWidget-close' ],
'framed' => false,
'icon' => 'close',
// TODO We have no way to use localisation messages in PHP
// (and to use different languages when used from MediaWiki)
// 'label' => msg( 'ooui-popup-widget-close-button-aria-label' ),
// 'invisibleLabel' => true
] );
$this->addClasses( [ 'oo-ui-messageWidget-showClose' ] );
}
$this->addClasses( [ 'oo-ui-messageWidget' ] );
$this->appendContent( [ $this->icon, $this->label, $this->closeButton ] );
}
/** @inheritDoc */
public function getConfig( &$config ) {
$config['type'] = $this->type;
$config['inline'] = $this->inline;
$config['showClose'] = $this->closeButton !== null;
return parent::getConfig( $config );
}
/**
* Set the inline state of the widget
*
* @param bool $inline Widget is inline
*/
public function setInline( $inline ) {
$this->inline = (bool)$inline;
$this->toggleClasses( [ 'oo-ui-messageWidget-block' ], !$this->inline );
}
/**
* Set the widget type. The given type must belong to the list of
* legal types set by $this->iconMap
*
* @param string $type Given type
*/
public function setType( $type ) {
if ( !array_key_exists( $type, $this->iconMap ) ) {
$type = $this->defaultType;
}
// Set flag
$this->clearFlags();
$this->setFlags( [ $type ] );
// Set icon
$this->setIcon( $this->iconMap[ $type ] );
$this->icon->removeClasses( [ 'oo-ui-image-' . $this->type ] );
$this->icon->addClasses( [ 'oo-ui-image-' . $type ] );
// Initialization
if ( $type === 'error' ) {
$this->setAttributes( [ 'role' => 'alert' ] );
$this->removeAttributes( [ 'aria-live' ] );
} else {
$this->setAttributes( [ 'aria-live' => 'polite' ] );
$this->removeAttributes( [ 'role' ] );
}
$this->type = $type;
}
}
|
