trait ToStringTrait

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Component/Utility/ToStringTrait.php \Drupal\Component\Utility\ToStringTrait
  2. 8.9.x core/lib/Drupal/Component/Utility/ToStringTrait.php \Drupal\Component\Utility\ToStringTrait
  3. 11.x core/lib/Drupal/Component/Utility/ToStringTrait.php \Drupal\Component\Utility\ToStringTrait

Wraps __toString in a trait to avoid some fatal errors.

Hierarchy

2 files declare their use of ToStringTrait
DateTimePlus.php in core/lib/Drupal/Component/Datetime/DateTimePlus.php
TranslatableMarkup.php in core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php

File

core/lib/Drupal/Component/Utility/ToStringTrait.php, line 8

Namespace

Drupal\Component\Utility
View on git.drupalcode.org
View source 
trait ToStringTrait {
  
  /**
   * Implements the magic __toString() method.
   */
  public function __toString() {
    try {
      return (string) $this->render();
    } catch (\Exception $e) {
      // User errors in __toString() methods are considered fatal in the Drupal
      // error handler.
      trigger_error(get_class($e) . ' thrown while calling __toString on a ' . static::class . ' object in ' . $e->getFile() . ' on line ' . $e->getLine() . ': ' . $e->getMessage(), E_USER_ERROR);
      // In case we are using another error handler that did not fatal on the
      // E_USER_ERROR, we terminate execution. However, for test purposes allow
      // a return value.
      return $this->_die();
    }
  }
  
  /**
   * For test purposes, wrap die() in an overridable method.
   */
  protected function _die() {
    die;
  }
  
  /**
   * Renders the object as a string.
   *
   * @return string|object
   *   The rendered string or an object implementing __toString().
   */
  public abstract function render();

}

Members

Title Modifiers Object type Summary Overrides
ToStringTrait::render abstract public function Renders the object as a string. 2
ToStringTrait::_die protected function For test purposes, wrap die() in an overridable method.
ToStringTrait::__toString public function Implements the magic __toString() method.

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