class AttributeBoolean in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Template/AttributeBoolean.php \Drupal\Core\Template\AttributeBoolean
A class that defines a type of boolean HTML attribute.
Boolean HTML attributes are not attributes with values of TRUE/FALSE. They are attributes that if they exist in the tag, they are TRUE. Examples include selected, disabled, checked, readonly.
To set a boolean attribute on the Attribute class, set it to TRUE.
$attributes = new Attribute();
$attributes['disabled'] = TRUE;
echo '<select' . $attributes . '/>';
// produces <select disabled>;
$attributes['disabled'] = FALSE;
echo '<select' . $attributes . '/>';
// produces <select>;
Hierarchy
- class \Drupal\Core\Template\AttributeValueBase
- class \Drupal\Core\Template\AttributeBoolean
Expanded class hierarchy of AttributeBoolean
See also
\Drupal\Core\Template\Attribute
File
- core/
lib/ Drupal/ Core/ Template/ AttributeBoolean.php, line 32 - Contains \Drupal\Core\Template\AttributeBoolean.
Namespace
Drupal\Core\TemplateView source
class AttributeBoolean extends AttributeValueBase {
/**
* {@inheritdoc}
*/
public function render() {
return $this
->__toString();
}
/**
* Implements the magic __toString() method.
*/
public function __toString() {
return $this->value === FALSE ? '' : Html::escape($this->name);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AttributeBoolean:: |
public | function |
Returns a string representation of the attribute. Overrides AttributeValueBase:: |
|
AttributeBoolean:: |
public | function |
Implements the magic __toString() method. Overrides AttributeValueBase:: |
|
AttributeValueBase:: |
protected | property | The name of the value. | |
AttributeValueBase:: |
protected | property | The value itself. | |
AttributeValueBase:: |
constant | Renders '$name=""' if $value is an empty string. | 1 | |
AttributeValueBase:: |
public | function | Returns the raw value. | |
AttributeValueBase:: |
public | function | Constructs a \Drupal\Core\Template\AttributeValueBase object. |