AttributeString.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Template/AttributeString.php
  2. 8.9.x core/lib/Drupal/Core/Template/AttributeString.php
  3. 11.x core/lib/Drupal/Core/Template/AttributeString.php

Namespace

Drupal\Core\Template

File

core/lib/Drupal/Core/Template/AttributeString.php

View source
<?php

namespace Drupal\Core\Template;

use Drupal\Component\Utility\Html;

/**
 * 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.
 * @code
 *  $attributes = new Attribute([]);
 *  $attributes['id'] = 'socks';
 *  $attributes['style'] = 'background-color:white';
 *  echo '<cat ' . $attributes . '>';
 *  // Produces: <cat id="socks" style="background-color:white">.
 * @endcode
 *
 * @see \Drupal\Core\Template\Attribute
 */
class AttributeString extends AttributeValueBase {
    
    /**
     * Implements the magic __toString() method.
     */
    public function __toString() {
        return Html::escape((string) $this->value);
    }

}

Classes

Title Deprecated Summary
AttributeString A class that represents most standard HTML attributes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.