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

Breadcrumb

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

function ValueToStringTrait::toolValueToString

Returns a string representation of the value.

  • null value: `'NULL'`
  • boolean: `'TRUE'`, `'FALSE'`
  • array: `'Array'`
  • scalar: converted-value
  • resource: `'(type resource #number)'`
  • object with `__toString()`: result of `__toString()`
  • object DateTime: ISO 8601 date
  • object: `'(className Object)'`
  • anonymous function: same as object

Parameters

mixed $value the value to return as a string.:

5 calls to ValueToStringTrait::toolValueToString()
AbstractCollection::offsetSet in vendor/ramsey/collection/src/AbstractCollection.php
AbstractTypedMap::offsetSet in vendor/ramsey/collection/src/Map/AbstractTypedMap.php
@inheritDoc @psalm-suppress MoreSpecificImplementedParamType
DoubleEndedQueue::addFirst in vendor/ramsey/collection/src/DoubleEndedQueue.php
NamedParameterMap::offsetSet in vendor/ramsey/collection/src/Map/NamedParameterMap.php
@inheritDoc @psalm-suppress MoreSpecificImplementedParamType,DocblockTypeContradiction
Queue::offsetSet in vendor/ramsey/collection/src/Queue.php
Since arbitrary offsets may not be manipulated in a queue, this method serves only to fulfill the `ArrayAccess` interface requirements. It is invoked by other operations when adding values to the queue.

File

vendor/ramsey/collection/src/Tool/ValueToStringTrait.php, line 48

Class

ValueToStringTrait
Provides functionality to express a value as string

Namespace

Ramsey\Collection\Tool

Code

protected function toolValueToString(mixed $value) : string {
    // null
    if ($value === null) {
        return 'NULL';
    }
    // boolean constants
    if (is_bool($value)) {
        return $value ? 'TRUE' : 'FALSE';
    }
    // array
    if (is_array($value)) {
        return 'Array';
    }
    // scalar types (integer, float, string)
    if (is_scalar($value)) {
        return (string) $value;
    }
    // resource
    if (is_resource($value)) {
        return '(' . get_resource_type($value) . ' resource #' . (int) $value . ')';
    }
    // From here, $value should be an object.
    assert(is_object($value));
    // __toString() is implemented
    if (is_callable([
        $value,
        '__toString',
    ])) {
        return (string) $value->__toString();
    }
    // object of type \DateTime
    if ($value instanceof DateTimeInterface) {
        return $value->format('c');
    }
    // unknown type
    return '(' . $value::class . ' Object)';
}

API Navigation

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