Page MenuHomeWickedGov Phorge
Files F4125391

MessageWidget.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

MessageWidget.php
View Options

<?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' => 'success',
];
/**
* 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;
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 07:27 (2 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
52/99/346af566d3c520ab1bf336518976
Default Alt Text
MessageWidget.php (3 KB)

Event Timeline