Page MenuHomeWickedGov Phorge
Files F1428907

HTMLInfoField.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

HTMLInfoField.php
View Options

<?php
namespace MediaWiki\HTMLForm\Field;
use Closure;
use MediaWiki\HTMLForm\HTMLFormField;
/**
* An information field (text blob), not a proper input.
* @stable to extend
*/
class HTMLInfoField extends HTMLFormField {
/**
* @stable to call
*
* @param array $info
* In addition to the usual HTMLFormField parameters, this can take the following fields:
* - default: the value (text) of the field. Unlike other form field types, HTMLInfoField can
* take a closure as a default value, which will be evaluated with $info as its only parameter.
* - raw: if true, the value won't be escaped.
* - rawrow: if true, the usual wrapping of form fields (e.g. into a table row + cell when
* display mode is table) will not happen and the value must contain it already.
*/
public function __construct( $info ) {
$info['nodata'] = true;
parent::__construct( $info );
}
/**
* @inheritDoc
* @stable to override
*/
public function getDefault() {
$default = parent::getDefault();
if ( $default instanceof Closure ) {
$default = $default( $this->mParams );
}
return $default;
}
/**
* @inheritDoc
* @stable to override
*/
public function getInputHTML( $value ) {
return !empty( $this->mParams['raw'] ) ? $value : htmlspecialchars( $value );
}
/**
* @inheritDoc
* @stable to override
*/
public function getInputOOUI( $value ) {
if ( !empty( $this->mParams['raw'] ) ) {
$value = new \OOUI\HtmlSnippet( $value );
}
return new \OOUI\LabelWidget( [
'label' => $value,
'id' => $this->mID
] );
}
/**
* @inheritDoc
* @stable to override
*/
public function getTableRow( $value ) {
if ( !empty( $this->mParams['rawrow'] ) ) {
return $value;
}
return parent::getTableRow( $value );
}
/**
* @stable to override
* @param string $value
* @return string
* @since 1.20
*/
public function getDiv( $value ) {
if ( !empty( $this->mParams['rawrow'] ) ) {
return $value;
}
return parent::getDiv( $value );
}
/**
* @stable to override
* @param string $value
* @return string
* @since 1.20
*/
public function getRaw( $value ) {
if ( !empty( $this->mParams['rawrow'] ) ) {
return $value;
}
return parent::getRaw( $value );
}
/**
* @stable to override
* @param mixed $value If not FieldLayout or subclass has been deprecated.
* @return \OOUI\FieldLayout
* @since 1.32
*/
public function getOOUI( $value ) {
if ( !empty( $this->mParams['rawrow'] ) ) {
if ( !( $value instanceof \OOUI\FieldLayout ) ) {
wfDeprecatedMsg( __METHOD__ . ": 'default' parameter as a string when using " .
"'rawrow' was deprecated in MediaWiki 1.32 (must be a FieldLayout or subclass)",
'1.32' );
}
return $value;
}
return parent::getOOUI( $value );
}
public function getCodex( $value ) {
if ( !empty( $this->mParams['rawrow'] ) ) {
return $value;
}
return parent::getCodex( $value );
}
/**
* @inheritDoc
* @stable to override
*/
protected function needsLabel() {
return false;
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLInfoField::class, 'HTMLInfoField' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 16:48 (11 h, 4 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
99/e4/4fb108e3c17d380ccea15b674aa5
Default Alt Text
HTMLInfoField.php (3 KB)

Event Timeline