Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. LazyString.php

class LazyString

A string whose value is computed lazily by a callback.

@author Nicolas Grekas <p@tchwork.com>

Hierarchy

  • class \Symfony\Component\String\LazyString implements \Symfony\Component\String\Stringable, \Symfony\Component\String\JsonSerializable

Expanded class hierarchy of LazyString

File

vendor/symfony/string/LazyString.php, line 19

Namespace

Symfony\Component\String
View source
class LazyString implements \Stringable, \JsonSerializable {
    private \Closure|string $value;
    
    /**
     * @param callable|array $callback A callable or a [Closure, method] lazy-callable
     */
    public static function fromCallable(callable|array $callback, mixed ...$arguments) : static {
        if (\is_array($callback) && !\is_callable($callback) && !(($callback[0] ?? null) instanceof \Closure || 2 < \count($callback))) {
            throw new \TypeError(\sprintf('Argument 1 passed to "%s()" must be a callable or a [Closure, method] lazy-callable, "%s" given.', __METHOD__, '[' . implode(', ', array_map('get_debug_type', $callback)) . ']'));
        }
        $lazyString = new static();
        $lazyString->value = static function () use (&$callback, &$arguments) : string {
            static $value;
            if (null !== $arguments) {
                if (!\is_callable($callback)) {
                    $callback[0] = $callback[0]();
                    $callback[1] ??= '__invoke';
                }
                $value = $callback(...$arguments);
                $callback = !\is_scalar($value) && !$value instanceof \Stringable ? self::getPrettyName($callback) : 'callable';
                $arguments = null;
            }
            return $value ?? '';
        };
        return $lazyString;
    }
    public static function fromStringable(string|int|float|bool|\Stringable $value) : static {
        if (\is_object($value)) {
            return static::fromCallable($value->__toString(...));
        }
        $lazyString = new static();
        $lazyString->value = (string) $value;
        return $lazyString;
    }
    
    /**
     * Tells whether the provided value can be cast to string.
     */
    public static final function isStringable(mixed $value) : bool {
        return \is_string($value) || $value instanceof \Stringable || \is_scalar($value);
    }
    
    /**
     * Casts scalars and stringable objects to strings.
     *
     * @throws \TypeError When the provided value is not stringable
     */
    public static final function resolve(\Stringable|string|int|float|bool $value) : string {
        return $value;
    }
    public function __toString() : string {
        if (\is_string($this->value)) {
            return $this->value;
        }
        try {
            return $this->value = ($this->value)();
        } catch (\Throwable $e) {
            if (\TypeError::class === $e::class && __FILE__ === $e->getFile()) {
                $type = explode(', ', $e->getMessage());
                $type = substr(array_pop($type), 0, -\strlen(' returned'));
                $r = new \ReflectionFunction($this->value);
                $callback = $r->getStaticVariables()['callback'];
                $e = new \TypeError(\sprintf('Return value of %s() passed to %s::fromCallable() must be of the type string, %s returned.', $callback, static::class, $type));
            }
            throw $e;
        }
    }
    public function __sleep() : array {
        $this->__toString();
        return [
            'value',
        ];
    }
    public function jsonSerialize() : string {
        return $this->__toString();
    }
    private function __construct() {
    }
    private static function getPrettyName(callable $callback) : string {
        if (\is_string($callback)) {
            return $callback;
        }
        if (\is_array($callback)) {
            $class = \is_object($callback[0]) ? get_debug_type($callback[0]) : $callback[0];
            $method = $callback[1];
        }
        elseif ($callback instanceof \Closure) {
            $r = new \ReflectionFunction($callback);
            if ($r->isAnonymous() || !($class = $r->getClosureCalledClass())) {
                return $r->name;
            }
            $class = $class->name;
            $method = $r->name;
        }
        else {
            $class = get_debug_type($callback);
            $method = '__invoke';
        }
        return $class . '::' . $method;
    }

}

Members

Title Sort descending Modifiers Object type Summary
LazyString::$value private property
LazyString::fromCallable public static function
LazyString::fromStringable public static function
LazyString::getPrettyName private static function
LazyString::isStringable final public static function Tells whether the provided value can be cast to string.
LazyString::jsonSerialize public function
LazyString::resolve final public static function Casts scalars and stringable objects to strings.
LazyString::__construct private function
LazyString::__sleep public function
LazyString::__toString public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal