public function ToStringTrait::__toString in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Component/Utility/ToStringTrait.php \Drupal\Component\Utility\ToStringTrait::__toString()
2. 9 core/lib/Drupal/Component/Utility/ToStringTrait.php \Drupal\Component\Utility\ToStringTrait::__toString()

Implements the magic __toString() method.

File

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

Class

ToStringTrait

Wraps __toString in a trait to avoid some fatals.

Namespace

Drupal\Component\Utility

Code

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();
  }
}