annotate core/lib/Drupal/Component/Render/HtmlEscapedText.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Component\Render;
Chris@0 4
Chris@0 5 use Drupal\Component\Utility\Html;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Escapes HTML syntax characters to HTML entities for display in markup.
Chris@0 9 *
Chris@0 10 * This class can be used to provide theme engine-like late escaping
Chris@0 11 * functionality.
Chris@0 12 *
Chris@0 13 * @ingroup sanitization
Chris@0 14 */
Chris@0 15 class HtmlEscapedText implements MarkupInterface, \Countable {
Chris@0 16
Chris@0 17 /**
Chris@0 18 * The string to escape.
Chris@0 19 *
Chris@0 20 * @var string
Chris@0 21 */
Chris@0 22 protected $string;
Chris@0 23
Chris@0 24 /**
Chris@0 25 * Constructs an HtmlEscapedText object.
Chris@0 26 *
Chris@0 27 * @param $string
Chris@0 28 * The string to escape. This value will be cast to a string.
Chris@0 29 */
Chris@0 30 public function __construct($string) {
Chris@0 31 $this->string = (string) $string;
Chris@0 32 }
Chris@0 33
Chris@0 34 /**
Chris@0 35 * {@inheritdoc}
Chris@0 36 */
Chris@0 37 public function __toString() {
Chris@0 38 return Html::escape($this->string);
Chris@0 39 }
Chris@0 40
Chris@0 41 /**
Chris@0 42 * {@inheritdoc}
Chris@0 43 */
Chris@0 44 public function count() {
Chris@17 45 return mb_strlen($this->string);
Chris@0 46 }
Chris@0 47
Chris@0 48 /**
Chris@0 49 * {@inheritdoc}
Chris@0 50 */
Chris@0 51 public function jsonSerialize() {
Chris@0 52 return $this->__toString();
Chris@0 53 }
Chris@0 54
Chris@0 55 }