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

Breadcrumb

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

class UnicodeString

Represents a string of Unicode grapheme clusters encoded as UTF-8.

A letter followed by combining characters (accents typically) form what Unicode defines as a grapheme cluster: a character as humans mean it in written texts. This class knows about the concept and won't split a letter apart from its combining accents. It also ensures all string comparisons happen on their canonically-composed representation, ignoring e.g. the order in which accents are listed when a letter has many of them.

@author Nicolas Grekas <p@tchwork.com> @author Hugo Hamon <hugohamon@neuf.fr>

Hierarchy

  • class \Symfony\Component\String\AbstractString implements \Symfony\Component\String\Stringable, \Symfony\Component\String\JsonSerializable
    • class \Symfony\Component\String\AbstractUnicodeString extends \Symfony\Component\String\AbstractString
      • class \Symfony\Component\String\UnicodeString extends \Symfony\Component\String\AbstractUnicodeString

Expanded class hierarchy of UnicodeString

See also

https://unicode.org/reports/tr15/

3 files declare their use of UnicodeString
AsciiSlugger.php in vendor/symfony/string/Slugger/AsciiSlugger.php
Helper.php in vendor/symfony/console/Helper/Helper.php
ReStructuredTextDescriptor.php in vendor/symfony/console/Descriptor/ReStructuredTextDescriptor.php

File

vendor/symfony/string/UnicodeString.php, line 33

Namespace

Symfony\Component\String
View source
class UnicodeString extends AbstractUnicodeString {
    public function __construct(string $string = '') {
        if ('' === $string || normalizer_is_normalized($this->string = $string)) {
            return;
        }
        if (false === ($string = normalizer_normalize($string))) {
            throw new InvalidArgumentException('Invalid UTF-8 string.');
        }
        $this->string = $string;
    }
    public function append(string ...$suffix) : static {
        $str = clone $this;
        $str->string = $this->string . (1 >= \count($suffix) ? $suffix[0] ?? '' : implode('', $suffix));
        if (normalizer_is_normalized($str->string)) {
            return $str;
        }
        if (false === ($string = normalizer_normalize($str->string))) {
            throw new InvalidArgumentException('Invalid UTF-8 string.');
        }
        $str->string = $string;
        return $str;
    }
    public function chunk(int $length = 1) : array {
        if (1 > $length) {
            throw new InvalidArgumentException('The chunk length must be greater than zero.');
        }
        if ('' === $this->string) {
            return [];
        }
        $rx = '/(';
        while (65535 < $length) {
            $rx .= '\\X{65535}';
            $length -= 65535;
        }
        $rx .= '\\X{' . $length . '})/u';
        $str = clone $this;
        $chunks = [];
        foreach (preg_split($rx, $this->string, -1, \PREG_SPLIT_DELIM_CAPTURE | \PREG_SPLIT_NO_EMPTY) as $chunk) {
            $str->string = $chunk;
            $chunks[] = clone $str;
        }
        return $chunks;
    }
    public function endsWith(string|iterable|AbstractString $suffix) : bool {
        if ($suffix instanceof AbstractString) {
            $suffix = $suffix->string;
        }
        elseif (!\is_string($suffix)) {
            return parent::endsWith($suffix);
        }
        $form = null === $this->ignoreCase ? \Normalizer::NFD : \Normalizer::NFC;
        normalizer_is_normalized($suffix, $form) ?: ($suffix = normalizer_normalize($suffix, $form));
        if ('' === $suffix || false === $suffix) {
            return false;
        }
        if ($this->ignoreCase) {
            return 0 === mb_stripos(grapheme_extract($this->string, \strlen($suffix), \GRAPHEME_EXTR_MAXBYTES, \strlen($this->string) - \strlen($suffix)), $suffix, 0, 'UTF-8');
        }
        return $suffix === grapheme_extract($this->string, \strlen($suffix), \GRAPHEME_EXTR_MAXBYTES, \strlen($this->string) - \strlen($suffix));
    }
    public function equalsTo(string|iterable|AbstractString $string) : bool {
        if ($string instanceof AbstractString) {
            $string = $string->string;
        }
        elseif (!\is_string($string)) {
            return parent::equalsTo($string);
        }
        $form = null === $this->ignoreCase ? \Normalizer::NFD : \Normalizer::NFC;
        normalizer_is_normalized($string, $form) ?: ($string = normalizer_normalize($string, $form));
        if ('' !== $string && false !== $string && $this->ignoreCase) {
            return \strlen($string) === \strlen($this->string) && 0 === mb_stripos($this->string, $string, 0, 'UTF-8');
        }
        return $string === $this->string;
    }
    public function indexOf(string|iterable|AbstractString $needle, int $offset = 0) : ?int {
        if ($needle instanceof AbstractString) {
            $needle = $needle->string;
        }
        elseif (!\is_string($needle)) {
            return parent::indexOf($needle, $offset);
        }
        $form = null === $this->ignoreCase ? \Normalizer::NFD : \Normalizer::NFC;
        normalizer_is_normalized($needle, $form) ?: ($needle = normalizer_normalize($needle, $form));
        if ('' === $needle || false === $needle) {
            return null;
        }
        try {
            $i = $this->ignoreCase ? grapheme_stripos($this->string, $needle, $offset) : grapheme_strpos($this->string, $needle, $offset);
        } catch (\ValueError) {
            return null;
        }
        return false === $i ? null : $i;
    }
    public function indexOfLast(string|iterable|AbstractString $needle, int $offset = 0) : ?int {
        if ($needle instanceof AbstractString) {
            $needle = $needle->string;
        }
        elseif (!\is_string($needle)) {
            return parent::indexOfLast($needle, $offset);
        }
        $form = null === $this->ignoreCase ? \Normalizer::NFD : \Normalizer::NFC;
        normalizer_is_normalized($needle, $form) ?: ($needle = normalizer_normalize($needle, $form));
        if ('' === $needle || false === $needle) {
            return null;
        }
        $string = $this->string;
        if (0 > $offset) {
            // workaround https://bugs.php.net/74264
            if (0 > ($offset += grapheme_strlen($needle))) {
                $string = grapheme_substr($string, 0, $offset);
            }
            $offset = 0;
        }
        $i = $this->ignoreCase ? grapheme_strripos($string, $needle, $offset) : grapheme_strrpos($string, $needle, $offset);
        return false === $i ? null : $i;
    }
    public function join(array $strings, ?string $lastGlue = null) : static {
        $str = parent::join($strings, $lastGlue);
        normalizer_is_normalized($str->string) ?: ($str->string = normalizer_normalize($str->string));
        return $str;
    }
    public function length() : int {
        return grapheme_strlen($this->string);
    }
    public function normalize(int $form = self::NFC) : static {
        $str = clone $this;
        if (\in_array($form, [
            self::NFC,
            self::NFKC,
        ], true)) {
            normalizer_is_normalized($str->string, $form) ?: ($str->string = normalizer_normalize($str->string, $form));
        }
        elseif (!\in_array($form, [
            self::NFD,
            self::NFKD,
        ], true)) {
            throw new InvalidArgumentException('Unsupported normalization form.');
        }
        elseif (!normalizer_is_normalized($str->string, $form)) {
            $str->string = normalizer_normalize($str->string, $form);
            $str->ignoreCase = null;
        }
        return $str;
    }
    public function prepend(string ...$prefix) : static {
        $str = clone $this;
        $str->string = (1 >= \count($prefix) ? $prefix[0] ?? '' : implode('', $prefix)) . $this->string;
        if (normalizer_is_normalized($str->string)) {
            return $str;
        }
        if (false === ($string = normalizer_normalize($str->string))) {
            throw new InvalidArgumentException('Invalid UTF-8 string.');
        }
        $str->string = $string;
        return $str;
    }
    public function replace(string $from, string $to) : static {
        $str = clone $this;
        normalizer_is_normalized($from) ?: ($from = normalizer_normalize($from));
        if ('' !== $from && false !== $from) {
            $tail = $str->string;
            $result = '';
            $indexOf = $this->ignoreCase ? 'grapheme_stripos' : 'grapheme_strpos';
            while ('' !== $tail && false !== ($i = $indexOf($tail, $from))) {
                $slice = grapheme_substr($tail, 0, $i);
                $result .= $slice . $to;
                $tail = substr($tail, \strlen($slice) + \strlen($from));
            }
            $str->string = $result . $tail;
            if (normalizer_is_normalized($str->string)) {
                return $str;
            }
            if (false === ($string = normalizer_normalize($str->string))) {
                throw new InvalidArgumentException('Invalid UTF-8 string.');
            }
            $str->string = $string;
        }
        return $str;
    }
    public function replaceMatches(string $fromRegexp, string|callable $to) : static {
        $str = parent::replaceMatches($fromRegexp, $to);
        normalizer_is_normalized($str->string) ?: ($str->string = normalizer_normalize($str->string));
        return $str;
    }
    public function slice(int $start = 0, ?int $length = null) : static {
        $str = clone $this;
        $str->string = (string) grapheme_substr($this->string, $start, $length ?? 2147483647);
        return $str;
    }
    public function splice(string $replacement, int $start = 0, ?int $length = null) : static {
        $str = clone $this;
        $start = $start ? \strlen(grapheme_substr($this->string, 0, $start)) : 0;
        $length = $length ? \strlen(grapheme_substr($this->string, $start, $length)) : $length;
        $str->string = substr_replace($this->string, $replacement, $start, $length ?? 2147483647);
        if (normalizer_is_normalized($str->string)) {
            return $str;
        }
        if (false === ($string = normalizer_normalize($str->string))) {
            throw new InvalidArgumentException('Invalid UTF-8 string.');
        }
        $str->string = $string;
        return $str;
    }
    public function split(string $delimiter, ?int $limit = null, ?int $flags = null) : array {
        if (1 > ($limit ??= 2147483647)) {
            throw new InvalidArgumentException('Split limit must be a positive integer.');
        }
        if ('' === $delimiter) {
            throw new InvalidArgumentException('Split delimiter is empty.');
        }
        if (null !== $flags) {
            return parent::split($delimiter . 'u', $limit, $flags);
        }
        normalizer_is_normalized($delimiter) ?: ($delimiter = normalizer_normalize($delimiter));
        if (false === $delimiter) {
            throw new InvalidArgumentException('Split delimiter is not a valid UTF-8 string.');
        }
        $str = clone $this;
        $tail = $this->string;
        $chunks = [];
        $indexOf = $this->ignoreCase ? 'grapheme_stripos' : 'grapheme_strpos';
        while (1 < $limit && false !== ($i = $indexOf($tail, $delimiter))) {
            $str->string = grapheme_substr($tail, 0, $i);
            $chunks[] = clone $str;
            $tail = substr($tail, \strlen($str->string) + \strlen($delimiter));
            --$limit;
        }
        $str->string = $tail;
        $chunks[] = clone $str;
        return $chunks;
    }
    public function startsWith(string|iterable|AbstractString $prefix) : bool {
        if ($prefix instanceof AbstractString) {
            $prefix = $prefix->string;
        }
        elseif (!\is_string($prefix)) {
            return parent::startsWith($prefix);
        }
        $form = null === $this->ignoreCase ? \Normalizer::NFD : \Normalizer::NFC;
        normalizer_is_normalized($prefix, $form) ?: ($prefix = normalizer_normalize($prefix, $form));
        if ('' === $prefix || false === $prefix) {
            return false;
        }
        if ($this->ignoreCase) {
            return 0 === mb_stripos(grapheme_extract($this->string, \strlen($prefix), \GRAPHEME_EXTR_MAXBYTES), $prefix, 0, 'UTF-8');
        }
        return $prefix === grapheme_extract($this->string, \strlen($prefix), \GRAPHEME_EXTR_MAXBYTES);
    }
    public function __wakeup() : void {
        if (!\is_string($this->string)) {
            throw new \BadMethodCallException('Cannot unserialize ' . __CLASS__);
        }
        normalizer_is_normalized($this->string) ?: ($this->string = normalizer_normalize($this->string));
    }
    public function __clone() {
        if (null === $this->ignoreCase) {
            normalizer_is_normalized($this->string) ?: ($this->string = normalizer_normalize($this->string));
        }
        $this->ignoreCase = false;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractString::$ignoreCase protected property
AbstractString::$string protected property
AbstractString::after public function
AbstractString::afterLast public function
AbstractString::before public function
AbstractString::beforeLast public function
AbstractString::bytesAt public function 1
AbstractString::collapseWhitespace public function
AbstractString::containsAny public function
AbstractString::ensureEnd public function
AbstractString::ensureStart public function
AbstractString::ignoreCase public function
AbstractString::isEmpty public function
AbstractString::jsonSerialize public function
AbstractString::kebab public function
AbstractString::PREG_OFFSET_CAPTURE public constant
AbstractString::PREG_PATTERN_ORDER public constant
AbstractString::PREG_SET_ORDER public constant
AbstractString::PREG_SPLIT public constant
AbstractString::PREG_SPLIT_DELIM_CAPTURE public constant
AbstractString::PREG_SPLIT_NO_EMPTY public constant
AbstractString::PREG_SPLIT_OFFSET_CAPTURE public constant
AbstractString::PREG_UNMATCHED_AS_NULL public constant
AbstractString::repeat public function
AbstractString::toByteString public function
AbstractString::toCodePointString public function 1
AbstractString::toString public function
AbstractString::toUnicodeString public function 1
AbstractString::truncate public function
AbstractString::unwrap public static function Unwraps instances of AbstractString back to strings.
AbstractString::wordwrap public function
AbstractString::wrap public static function Wraps (and normalizes) strings in instances of AbstractString.
AbstractString::__sleep public function
AbstractString::__toString public function
AbstractUnicodeString::$tableWide private static property
AbstractUnicodeString::$tableZero private static property
AbstractUnicodeString::$transliterators private static property
AbstractUnicodeString::ascii public function Generic UTF-8 to ASCII transliteration.
AbstractUnicodeString::ASCII private constant
AbstractUnicodeString::camel public function Overrides AbstractString::camel
AbstractUnicodeString::codePointsAt public function 1
AbstractUnicodeString::folded public function Overrides AbstractString::folded
AbstractUnicodeString::FOLD_FROM private constant
AbstractUnicodeString::FOLD_TO private constant
AbstractUnicodeString::fromCodePoints public static function
AbstractUnicodeString::getLocaleTransliterator private function
AbstractUnicodeString::localeLower public function
AbstractUnicodeString::localeTitle public function
AbstractUnicodeString::localeUpper public function
AbstractUnicodeString::lower public function Overrides AbstractString::lower
AbstractUnicodeString::match public function Matches the string using a regular expression. Overrides AbstractString::match
AbstractUnicodeString::NFC public constant
AbstractUnicodeString::NFD public constant
AbstractUnicodeString::NFKC public constant
AbstractUnicodeString::NFKD public constant
AbstractUnicodeString::pad private function
AbstractUnicodeString::padBoth public function Overrides AbstractString::padBoth
AbstractUnicodeString::padEnd public function Overrides AbstractString::padEnd
AbstractUnicodeString::padStart public function Overrides AbstractString::padStart
AbstractUnicodeString::reverse public function Overrides AbstractString::reverse
AbstractUnicodeString::snake public function Overrides AbstractString::snake
AbstractUnicodeString::title public function Overrides AbstractString::title
AbstractUnicodeString::TRANSLIT_FROM private constant
AbstractUnicodeString::TRANSLIT_TO private constant
AbstractUnicodeString::trim public function Overrides AbstractString::trim
AbstractUnicodeString::trimEnd public function Overrides AbstractString::trimEnd
AbstractUnicodeString::trimPrefix public function Overrides AbstractString::trimPrefix
AbstractUnicodeString::trimStart public function Overrides AbstractString::trimStart
AbstractUnicodeString::trimSuffix public function Overrides AbstractString::trimSuffix
AbstractUnicodeString::upper public function Overrides AbstractString::upper
AbstractUnicodeString::wcswidth private function Based on https://github.com/jquast/wcwidth, a Python implementation of https://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c.
AbstractUnicodeString::width public function Returns the printable length on a terminal. Overrides AbstractString::width
UnicodeString::append public function Overrides AbstractString::append
UnicodeString::chunk public function Overrides AbstractString::chunk
UnicodeString::endsWith public function Overrides AbstractString::endsWith
UnicodeString::equalsTo public function Overrides AbstractString::equalsTo
UnicodeString::indexOf public function Overrides AbstractString::indexOf
UnicodeString::indexOfLast public function Overrides AbstractString::indexOfLast
UnicodeString::join public function Overrides AbstractUnicodeString::join
UnicodeString::length public function Overrides AbstractString::length
UnicodeString::normalize public function Overrides AbstractUnicodeString::normalize
UnicodeString::prepend public function Overrides AbstractString::prepend
UnicodeString::replace public function Overrides AbstractString::replace
UnicodeString::replaceMatches public function Overrides AbstractUnicodeString::replaceMatches
UnicodeString::slice public function Overrides AbstractString::slice
UnicodeString::splice public function Overrides AbstractString::splice
UnicodeString::split public function Overrides AbstractString::split
UnicodeString::startsWith public function Overrides AbstractString::startsWith
UnicodeString::__clone public function Overrides AbstractString::__clone
UnicodeString::__construct public function Overrides AbstractString::__construct
UnicodeString::__wakeup public function

API Navigation

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