class AttributeValueBase
Same name in other branches
- 9 core/lib/Drupal/Core/Template/AttributeValueBase.php \Drupal\Core\Template\AttributeValueBase
- 8.9.x core/lib/Drupal/Core/Template/AttributeValueBase.php \Drupal\Core\Template\AttributeValueBase
- 11.x core/lib/Drupal/Core/Template/AttributeValueBase.php \Drupal\Core\Template\AttributeValueBase
Defines the base class for an attribute type.
Hierarchy
- class \Drupal\Core\Template\AttributeValueBase
Expanded class hierarchy of AttributeValueBase
See also
\Drupal\Core\Template\Attribute
File
-
core/
lib/ Drupal/ Core/ Template/ AttributeValueBase.php, line 12
Namespace
Drupal\Core\TemplateView source
abstract class AttributeValueBase {
/**
* Renders '$name=""' if $value is an empty string.
*
* @see \Drupal\Core\Template\AttributeValueBase::render()
*/
const RENDER_EMPTY_ATTRIBUTE = TRUE;
/**
* The value itself.
*
* @var mixed
*/
protected $value;
/**
* The name of the value.
*
* @var mixed
*/
protected $name;
/**
* Constructs a \Drupal\Core\Template\AttributeValueBase object.
*/
public function __construct($name, $value) {
$this->name = $name;
$this->value = $value;
}
/**
* Returns a string representation of the attribute.
*
* While __toString only returns the value in a string form, render()
* contains the name of the attribute as well.
*
* @return string
* The string representation of the attribute.
*/
public function render() {
$value = (string) $this;
if (isset($this->value) && static::RENDER_EMPTY_ATTRIBUTE || !empty($value)) {
return Html::escape($this->name) . '="' . $value . '"';
}
}
/**
* Returns the raw value.
*/
public function value() {
return $this->value;
}
/**
* Implements the magic __toString() method.
*/
public abstract function __toString();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AttributeValueBase::$name | protected | property | The name of the value. | |
AttributeValueBase::$value | protected | property | The value itself. | |
AttributeValueBase::render | public | function | Returns a string representation of the attribute. | 1 |
AttributeValueBase::RENDER_EMPTY_ATTRIBUTE | constant | Renders '$name=""' if $value is an empty string. | 1 | |
AttributeValueBase::value | public | function | Returns the raw value. | |
AttributeValueBase::__construct | public | function | Constructs a \Drupal\Core\Template\AttributeValueBase object. | |
AttributeValueBase::__toString | abstract public | function | Implements the magic __toString() method. | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.