class HtmlEscapedText
Same name in other branches
- 9 core/lib/Drupal/Component/Render/HtmlEscapedText.php \Drupal\Component\Render\HtmlEscapedText
- 8.9.x core/lib/Drupal/Component/Render/HtmlEscapedText.php \Drupal\Component\Render\HtmlEscapedText
- 10 core/lib/Drupal/Component/Render/HtmlEscapedText.php \Drupal\Component\Render\HtmlEscapedText
Escapes HTML syntax characters to HTML entities for display in markup.
This class can be used to provide theme engine-like late escaping functionality.
Hierarchy
- class \Drupal\Component\Render\HtmlEscapedText implements \Drupal\Component\Render\MarkupInterface, \Drupal\Component\Render\Countable
Expanded class hierarchy of HtmlEscapedText
2 files declare their use of HtmlEscapedText
- HtmlEscapedTextTest.php in core/
tests/ Drupal/ Tests/ Component/ Render/ HtmlEscapedTextTest.php - Token.php in core/
lib/ Drupal/ Core/ Utility/ Token.php
File
-
core/
lib/ Drupal/ Component/ Render/ HtmlEscapedText.php, line 15
Namespace
Drupal\Component\RenderView source
class HtmlEscapedText implements MarkupInterface, \Countable {
/**
* The string to escape.
*
* @var string
*/
protected $string;
/**
* Constructs an HtmlEscapedText object.
*
* @param $string
* The string to escape. This value will be cast to a string.
*/
public function __construct($string) {
$this->string = (string) $string;
}
/**
* {@inheritdoc}
*/
public function __toString() {
return Html::escape($this->string);
}
/**
* {@inheritdoc}
*/
public function count() : int {
return mb_strlen($this->string);
}
/**
* {@inheritdoc}
*/
public function jsonSerialize() : string {
return $this->__toString();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
HtmlEscapedText::$string | protected | property | The string to escape. | |
HtmlEscapedText::count | public | function | ||
HtmlEscapedText::jsonSerialize | public | function | ||
HtmlEscapedText::__construct | public | function | Constructs an HtmlEscapedText object. | |
HtmlEscapedText::__toString | public | function | Returns markup. | Overrides MarkupInterface::__toString |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.