mirror of
https://github.com/rectorphp/rector.git
synced 2025-02-22 02:36:52 +01:00
592 lines
18 KiB
PHP
592 lines
18 KiB
PHP
<?php
|
||
|
||
/*
|
||
* This file is part of the Symfony package.
|
||
*
|
||
* (c) Fabien Potencier <fabien@symfony.com>
|
||
*
|
||
* For the full copyright and license information, please view the LICENSE
|
||
* file that was distributed with this source code.
|
||
*/
|
||
namespace RectorPrefix20210629\Symfony\Component\String;
|
||
|
||
use RectorPrefix20210629\Symfony\Component\String\Exception\ExceptionInterface;
|
||
use RectorPrefix20210629\Symfony\Component\String\Exception\InvalidArgumentException;
|
||
use RectorPrefix20210629\Symfony\Component\String\Exception\RuntimeException;
|
||
/**
|
||
* Represents a string of abstract characters.
|
||
*
|
||
* Unicode defines 3 types of "characters" (bytes, code points and grapheme clusters).
|
||
* This class is the abstract type to use as a type-hint when the logic you want to
|
||
* implement doesn't care about the exact variant it deals with.
|
||
*
|
||
* @author Nicolas Grekas <p@tchwork.com>
|
||
* @author Hugo Hamon <hugohamon@neuf.fr>
|
||
*
|
||
* @throws ExceptionInterface
|
||
*/
|
||
abstract class AbstractString implements \JsonSerializable
|
||
{
|
||
public const PREG_PATTERN_ORDER = \PREG_PATTERN_ORDER;
|
||
public const PREG_SET_ORDER = \PREG_SET_ORDER;
|
||
public const PREG_OFFSET_CAPTURE = \PREG_OFFSET_CAPTURE;
|
||
public const PREG_UNMATCHED_AS_NULL = 512;
|
||
public const PREG_SPLIT = 0;
|
||
public const PREG_SPLIT_NO_EMPTY = \PREG_SPLIT_NO_EMPTY;
|
||
public const PREG_SPLIT_DELIM_CAPTURE = \PREG_SPLIT_DELIM_CAPTURE;
|
||
public const PREG_SPLIT_OFFSET_CAPTURE = \PREG_SPLIT_OFFSET_CAPTURE;
|
||
protected $string = '';
|
||
protected $ignoreCase = \false;
|
||
public abstract function __construct(string $string = '');
|
||
/**
|
||
* Unwraps instances of AbstractString back to strings.
|
||
*
|
||
* @return string[]|array
|
||
*/
|
||
public static function unwrap(array $values) : array
|
||
{
|
||
foreach ($values as $k => $v) {
|
||
if ($v instanceof self) {
|
||
$values[$k] = $v->__toString();
|
||
} elseif (\is_array($v) && $values[$k] !== ($v = static::unwrap($v))) {
|
||
$values[$k] = $v;
|
||
}
|
||
}
|
||
return $values;
|
||
}
|
||
/**
|
||
* Wraps (and normalizes) strings in instances of AbstractString.
|
||
*
|
||
* @return static[]|array
|
||
*/
|
||
public static function wrap(array $values) : array
|
||
{
|
||
$i = 0;
|
||
$keys = null;
|
||
foreach ($values as $k => $v) {
|
||
if (\is_string($k) && '' !== $k && $k !== ($j = (string) new static($k))) {
|
||
$keys = $keys ?? \array_keys($values);
|
||
$keys[$i] = $j;
|
||
}
|
||
if (\is_string($v)) {
|
||
$values[$k] = new static($v);
|
||
} elseif (\is_array($v) && $values[$k] !== ($v = static::wrap($v))) {
|
||
$values[$k] = $v;
|
||
}
|
||
++$i;
|
||
}
|
||
return null !== $keys ? \array_combine($keys, $values) : $values;
|
||
}
|
||
/**
|
||
* @param string|string[] $needle
|
||
*
|
||
* @return static
|
||
*/
|
||
public function after($needle, bool $includeNeedle = \false, int $offset = 0)
|
||
{
|
||
$str = clone $this;
|
||
$i = \PHP_INT_MAX;
|
||
foreach ((array) $needle as $n) {
|
||
$n = (string) $n;
|
||
$j = $this->indexOf($n, $offset);
|
||
if (null !== $j && $j < $i) {
|
||
$i = $j;
|
||
$str->string = $n;
|
||
}
|
||
}
|
||
if (\PHP_INT_MAX === $i) {
|
||
return $str;
|
||
}
|
||
if (!$includeNeedle) {
|
||
$i += $str->length();
|
||
}
|
||
return $this->slice($i);
|
||
}
|
||
/**
|
||
* @param string|string[] $needle
|
||
*
|
||
* @return static
|
||
*/
|
||
public function afterLast($needle, bool $includeNeedle = \false, int $offset = 0)
|
||
{
|
||
$str = clone $this;
|
||
$i = null;
|
||
foreach ((array) $needle as $n) {
|
||
$n = (string) $n;
|
||
$j = $this->indexOfLast($n, $offset);
|
||
if (null !== $j && $j >= $i) {
|
||
$i = $offset = $j;
|
||
$str->string = $n;
|
||
}
|
||
}
|
||
if (null === $i) {
|
||
return $str;
|
||
}
|
||
if (!$includeNeedle) {
|
||
$i += $str->length();
|
||
}
|
||
return $this->slice($i);
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function append(string ...$suffix);
|
||
/**
|
||
* @param string|string[] $needle
|
||
*
|
||
* @return static
|
||
*/
|
||
public function before($needle, bool $includeNeedle = \false, int $offset = 0)
|
||
{
|
||
$str = clone $this;
|
||
$i = \PHP_INT_MAX;
|
||
foreach ((array) $needle as $n) {
|
||
$n = (string) $n;
|
||
$j = $this->indexOf($n, $offset);
|
||
if (null !== $j && $j < $i) {
|
||
$i = $j;
|
||
$str->string = $n;
|
||
}
|
||
}
|
||
if (\PHP_INT_MAX === $i) {
|
||
return $str;
|
||
}
|
||
if ($includeNeedle) {
|
||
$i += $str->length();
|
||
}
|
||
return $this->slice(0, $i);
|
||
}
|
||
/**
|
||
* @param string|string[] $needle
|
||
*
|
||
* @return static
|
||
*/
|
||
public function beforeLast($needle, bool $includeNeedle = \false, int $offset = 0)
|
||
{
|
||
$str = clone $this;
|
||
$i = null;
|
||
foreach ((array) $needle as $n) {
|
||
$n = (string) $n;
|
||
$j = $this->indexOfLast($n, $offset);
|
||
if (null !== $j && $j >= $i) {
|
||
$i = $offset = $j;
|
||
$str->string = $n;
|
||
}
|
||
}
|
||
if (null === $i) {
|
||
return $str;
|
||
}
|
||
if ($includeNeedle) {
|
||
$i += $str->length();
|
||
}
|
||
return $this->slice(0, $i);
|
||
}
|
||
/**
|
||
* @return int[]
|
||
*/
|
||
public function bytesAt(int $offset) : array
|
||
{
|
||
$str = $this->slice($offset, 1);
|
||
return '' === $str->string ? [] : \array_values(\unpack('C*', $str->string));
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function camel();
|
||
/**
|
||
* @return static[]
|
||
*/
|
||
public abstract function chunk(int $length = 1) : array;
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function collapseWhitespace()
|
||
{
|
||
$str = clone $this;
|
||
$str->string = \trim(\preg_replace('/(?:\\s{2,}+|[^\\S ])/', ' ', $str->string));
|
||
return $str;
|
||
}
|
||
/**
|
||
* @param string|string[] $needle
|
||
*/
|
||
public function containsAny($needle) : bool
|
||
{
|
||
return null !== $this->indexOf($needle);
|
||
}
|
||
/**
|
||
* @param string|string[] $suffix
|
||
*/
|
||
public function endsWith($suffix) : bool
|
||
{
|
||
if (!\is_array($suffix) && !$suffix instanceof \Traversable) {
|
||
throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class));
|
||
}
|
||
foreach ($suffix as $s) {
|
||
if ($this->endsWith((string) $s)) {
|
||
return \true;
|
||
}
|
||
}
|
||
return \false;
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function ensureEnd(string $suffix)
|
||
{
|
||
if (!$this->endsWith($suffix)) {
|
||
return $this->append($suffix);
|
||
}
|
||
$suffix = \preg_quote($suffix);
|
||
$regex = '{(' . $suffix . ')(?:' . $suffix . ')++$}D';
|
||
return $this->replaceMatches($regex . ($this->ignoreCase ? 'i' : ''), '$1');
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function ensureStart(string $prefix)
|
||
{
|
||
$prefix = new static($prefix);
|
||
if (!$this->startsWith($prefix)) {
|
||
return $this->prepend($prefix);
|
||
}
|
||
$str = clone $this;
|
||
$i = $prefixLen = $prefix->length();
|
||
while ($this->indexOf($prefix, $i) === $i) {
|
||
$str = $str->slice($prefixLen);
|
||
$i += $prefixLen;
|
||
}
|
||
return $str;
|
||
}
|
||
/**
|
||
* @param string|string[] $string
|
||
*/
|
||
public function equalsTo($string) : bool
|
||
{
|
||
if (!\is_array($string) && !$string instanceof \Traversable) {
|
||
throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class));
|
||
}
|
||
foreach ($string as $s) {
|
||
if ($this->equalsTo((string) $s)) {
|
||
return \true;
|
||
}
|
||
}
|
||
return \false;
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function folded();
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function ignoreCase()
|
||
{
|
||
$str = clone $this;
|
||
$str->ignoreCase = \true;
|
||
return $str;
|
||
}
|
||
/**
|
||
* @param string|string[] $needle
|
||
*/
|
||
public function indexOf($needle, int $offset = 0) : ?int
|
||
{
|
||
if (!\is_array($needle) && !$needle instanceof \Traversable) {
|
||
throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class));
|
||
}
|
||
$i = \PHP_INT_MAX;
|
||
foreach ($needle as $n) {
|
||
$j = $this->indexOf((string) $n, $offset);
|
||
if (null !== $j && $j < $i) {
|
||
$i = $j;
|
||
}
|
||
}
|
||
return \PHP_INT_MAX === $i ? null : $i;
|
||
}
|
||
/**
|
||
* @param string|string[] $needle
|
||
*/
|
||
public function indexOfLast($needle, int $offset = 0) : ?int
|
||
{
|
||
if (!\is_array($needle) && !$needle instanceof \Traversable) {
|
||
throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class));
|
||
}
|
||
$i = null;
|
||
foreach ($needle as $n) {
|
||
$j = $this->indexOfLast((string) $n, $offset);
|
||
if (null !== $j && $j >= $i) {
|
||
$i = $offset = $j;
|
||
}
|
||
}
|
||
return $i;
|
||
}
|
||
public function isEmpty() : bool
|
||
{
|
||
return '' === $this->string;
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function join(array $strings, string $lastGlue = null);
|
||
public function jsonSerialize() : string
|
||
{
|
||
return $this->string;
|
||
}
|
||
public abstract function length() : int;
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function lower();
|
||
/**
|
||
* Matches the string using a regular expression.
|
||
*
|
||
* Pass PREG_PATTERN_ORDER or PREG_SET_ORDER as $flags to get all occurrences matching the regular expression.
|
||
*
|
||
* @return array All matches in a multi-dimensional array ordered according to flags
|
||
*/
|
||
public abstract function match(string $regexp, int $flags = 0, int $offset = 0) : array;
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function padBoth(int $length, string $padStr = ' ');
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function padEnd(int $length, string $padStr = ' ');
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function padStart(int $length, string $padStr = ' ');
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function prepend(string ...$prefix);
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function repeat(int $multiplier)
|
||
{
|
||
if (0 > $multiplier) {
|
||
throw new \RectorPrefix20210629\Symfony\Component\String\Exception\InvalidArgumentException(\sprintf('Multiplier must be positive, %d given.', $multiplier));
|
||
}
|
||
$str = clone $this;
|
||
$str->string = \str_repeat($str->string, $multiplier);
|
||
return $str;
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function replace(string $from, string $to);
|
||
/**
|
||
* @param string|callable $to
|
||
*
|
||
* @return static
|
||
*/
|
||
public abstract function replaceMatches(string $fromRegexp, $to);
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function reverse();
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function slice(int $start = 0, int $length = null);
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function snake();
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function splice(string $replacement, int $start = 0, int $length = null);
|
||
/**
|
||
* @return static[]
|
||
*/
|
||
public function split(string $delimiter, int $limit = null, int $flags = null) : array
|
||
{
|
||
if (null === $flags) {
|
||
throw new \TypeError('Split behavior when $flags is null must be implemented by child classes.');
|
||
}
|
||
if ($this->ignoreCase) {
|
||
$delimiter .= 'i';
|
||
}
|
||
\set_error_handler(static function ($t, $m) {
|
||
throw new \RectorPrefix20210629\Symfony\Component\String\Exception\InvalidArgumentException($m);
|
||
});
|
||
try {
|
||
if (\false === ($chunks = \preg_split($delimiter, $this->string, $limit, $flags))) {
|
||
$lastError = \preg_last_error();
|
||
foreach (\get_defined_constants(\true)['pcre'] as $k => $v) {
|
||
if ($lastError === $v && '_ERROR' === \substr($k, -6)) {
|
||
throw new \RectorPrefix20210629\Symfony\Component\String\Exception\RuntimeException('Splitting failed with ' . $k . '.');
|
||
}
|
||
}
|
||
throw new \RectorPrefix20210629\Symfony\Component\String\Exception\RuntimeException('Splitting failed with unknown error code.');
|
||
}
|
||
} finally {
|
||
\restore_error_handler();
|
||
}
|
||
$str = clone $this;
|
||
if (self::PREG_SPLIT_OFFSET_CAPTURE & $flags) {
|
||
foreach ($chunks as &$chunk) {
|
||
$str->string = $chunk[0];
|
||
$chunk[0] = clone $str;
|
||
}
|
||
} else {
|
||
foreach ($chunks as &$chunk) {
|
||
$str->string = $chunk;
|
||
$chunk = clone $str;
|
||
}
|
||
}
|
||
return $chunks;
|
||
}
|
||
/**
|
||
* @param string|string[] $prefix
|
||
*/
|
||
public function startsWith($prefix) : bool
|
||
{
|
||
if (!\is_array($prefix) && !$prefix instanceof \Traversable) {
|
||
throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class));
|
||
}
|
||
foreach ($prefix as $prefix) {
|
||
if ($this->startsWith((string) $prefix)) {
|
||
return \true;
|
||
}
|
||
}
|
||
return \false;
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function title(bool $allWords = \false);
|
||
public function toByteString(string $toEncoding = null) : \RectorPrefix20210629\Symfony\Component\String\ByteString
|
||
{
|
||
$b = new \RectorPrefix20210629\Symfony\Component\String\ByteString();
|
||
$toEncoding = \in_array($toEncoding, ['utf8', 'utf-8', 'UTF8'], \true) ? 'UTF-8' : $toEncoding;
|
||
if (null === $toEncoding || $toEncoding === ($fromEncoding = $this instanceof \RectorPrefix20210629\Symfony\Component\String\AbstractUnicodeString || \preg_match('//u', $b->string) ? 'UTF-8' : 'Windows-1252')) {
|
||
$b->string = $this->string;
|
||
return $b;
|
||
}
|
||
\set_error_handler(static function ($t, $m) {
|
||
throw new \RectorPrefix20210629\Symfony\Component\String\Exception\InvalidArgumentException($m);
|
||
});
|
||
try {
|
||
try {
|
||
$b->string = \mb_convert_encoding($this->string, $toEncoding, 'UTF-8');
|
||
} catch (\RectorPrefix20210629\Symfony\Component\String\Exception\InvalidArgumentException $e) {
|
||
if (!\function_exists('iconv')) {
|
||
throw $e;
|
||
}
|
||
$b->string = \iconv('UTF-8', $toEncoding, $this->string);
|
||
}
|
||
} finally {
|
||
\restore_error_handler();
|
||
}
|
||
return $b;
|
||
}
|
||
public function toCodePointString() : \RectorPrefix20210629\Symfony\Component\String\CodePointString
|
||
{
|
||
return new \RectorPrefix20210629\Symfony\Component\String\CodePointString($this->string);
|
||
}
|
||
public function toString() : string
|
||
{
|
||
return $this->string;
|
||
}
|
||
public function toUnicodeString() : \RectorPrefix20210629\Symfony\Component\String\UnicodeString
|
||
{
|
||
return new \RectorPrefix20210629\Symfony\Component\String\UnicodeString($this->string);
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function trim(string $chars = " \t\n\r\0\v\f ");
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function trimEnd(string $chars = " \t\n\r\0\v\f ");
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function trimStart(string $chars = " \t\n\r\0\v\f ");
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function truncate(int $length, string $ellipsis = '', bool $cut = \true)
|
||
{
|
||
$stringLength = $this->length();
|
||
if ($stringLength <= $length) {
|
||
return clone $this;
|
||
}
|
||
$ellipsisLength = '' !== $ellipsis ? (new static($ellipsis))->length() : 0;
|
||
if ($length < $ellipsisLength) {
|
||
$ellipsisLength = 0;
|
||
}
|
||
if (!$cut) {
|
||
if (null === ($length = $this->indexOf([' ', "\r", "\n", "\t"], ($length ?: 1) - 1))) {
|
||
return clone $this;
|
||
}
|
||
$length += $ellipsisLength;
|
||
}
|
||
$str = $this->slice(0, $length - $ellipsisLength);
|
||
return $ellipsisLength ? $str->trimEnd()->append($ellipsis) : $str;
|
||
}
|
||
/**
|
||
* @return static
|
||
*/
|
||
public abstract function upper();
|
||
/**
|
||
* Returns the printable length on a terminal.
|
||
*/
|
||
public abstract function width(bool $ignoreAnsiDecoration = \true) : int;
|
||
/**
|
||
* @return static
|
||
*/
|
||
public function wordwrap(int $width = 75, string $break = "\n", bool $cut = \false)
|
||
{
|
||
$lines = '' !== $break ? $this->split($break) : [clone $this];
|
||
$chars = [];
|
||
$mask = '';
|
||
if (1 === \count($lines) && '' === $lines[0]->string) {
|
||
return $lines[0];
|
||
}
|
||
foreach ($lines as $i => $line) {
|
||
if ($i) {
|
||
$chars[] = $break;
|
||
$mask .= '#';
|
||
}
|
||
foreach ($line->chunk() as $char) {
|
||
$chars[] = $char->string;
|
||
$mask .= ' ' === $char->string ? ' ' : '?';
|
||
}
|
||
}
|
||
$string = '';
|
||
$j = 0;
|
||
$b = $i = -1;
|
||
$mask = \wordwrap($mask, $width, '#', $cut);
|
||
while (\false !== ($b = \strpos($mask, '#', $b + 1))) {
|
||
for (++$i; $i < $b; ++$i) {
|
||
$string .= $chars[$j];
|
||
unset($chars[$j++]);
|
||
}
|
||
if ($break === $chars[$j] || ' ' === $chars[$j]) {
|
||
unset($chars[$j++]);
|
||
}
|
||
$string .= $break;
|
||
}
|
||
$str = clone $this;
|
||
$str->string = $string . \implode('', $chars);
|
||
return $str;
|
||
}
|
||
public function __sleep() : array
|
||
{
|
||
return ['string'];
|
||
}
|
||
public function __clone()
|
||
{
|
||
$this->ignoreCase = \false;
|
||
}
|
||
public function __toString() : string
|
||
{
|
||
return $this->string;
|
||
}
|
||
}
|