aed646001c
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I1f306a3925d6768209a06e70082598b2f70cd319
85 lines
1.7 KiB
PHP
85 lines
1.7 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\HTMLForm\Field;
|
|
|
|
use MediaWiki\HTMLForm\HTMLFormField;
|
|
|
|
/*
|
|
* @stable to extend
|
|
*/
|
|
class HTMLHiddenField extends HTMLFormField {
|
|
/** @var bool */
|
|
protected $outputAsDefault = true;
|
|
|
|
/**
|
|
* @stable to call
|
|
* @inheritDoc
|
|
*/
|
|
public function __construct( $params ) {
|
|
parent::__construct( $params );
|
|
|
|
if ( isset( $this->mParams['output-as-default'] ) ) {
|
|
$this->outputAsDefault = (bool)$this->mParams['output-as-default'];
|
|
}
|
|
|
|
# Per HTML5 spec, hidden fields cannot be 'required'
|
|
# https://www.w3.org/TR/html5/forms.html#hidden-state-%28type=hidden%29
|
|
unset( $this->mParams['required'] );
|
|
}
|
|
|
|
public function getHiddenFieldData( $value ) {
|
|
$params = [];
|
|
if ( $this->mID ) {
|
|
$params['id'] = $this->mID;
|
|
}
|
|
|
|
if ( $this->outputAsDefault ) {
|
|
$value = $this->mDefault;
|
|
}
|
|
|
|
return [ $this->mName, $value, $params ];
|
|
}
|
|
|
|
public function getTableRow( $value ) {
|
|
[ $name, $value, $params ] = $this->getHiddenFieldData( $value );
|
|
$this->mParent->addHiddenField( $name, $value, $params );
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
* @return string
|
|
* @since 1.20
|
|
*/
|
|
public function getDiv( $value ) {
|
|
return $this->getTableRow( $value );
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
* @return string
|
|
* @since 1.20
|
|
*/
|
|
public function getRaw( $value ) {
|
|
return $this->getTableRow( $value );
|
|
}
|
|
|
|
public function getCodex( $value ) {
|
|
return $this->getTableRow( $value );
|
|
}
|
|
|
|
public function getInputHTML( $value ) {
|
|
return '';
|
|
}
|
|
|
|
public function canDisplayErrors() {
|
|
return false;
|
|
}
|
|
|
|
public function hasVisibleOutput() {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/** @deprecated class alias since 1.42 */
|
|
class_alias( HTMLHiddenField::class, 'HTMLHiddenField' );
|