class AttributeString in Drupal 9

A class that represents most standard HTML attributes.

To use with the Attribute class, set the key to be the attribute name and the value the attribute value.

$attributes = new Attribute(array());
$attributes['id'] = 'socks';
$attributes['style'] = 'background-color:white';
echo '<cat ' . $attributes . '>';

// Produces: <cat id="socks" style="background-color:white">.

Hierarchy

• class \Drupal\Core\Template\AttributeValueBase
  • class \Drupal\Core\Template\AttributeString

See also

\Drupal\Core\Template\Attribute

1 file declares its use of AttributeString

AttributeTest.php in core/tests/Drupal/Tests/Core/Template/AttributeTest.php

File

core/lib/Drupal/Core/Template/AttributeString.php, line 22

Namespace

Drupal\Core\Template

class AttributeString extends AttributeValueBase {

  /**
   * Implements the magic __toString() method.
   */
  public function __toString() {
    return Html::escape($this->value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AttributeString::__toString	public	function	Implements the magic __toString() method. Overrides AttributeValueBase::__toString
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.