Exception
2 years ago
Inflector
8 months ago
Resources
8 months ago
Slugger
2 years ago
AbstractString.php
2 years ago
AbstractUnicodeString.php
8 months ago
ByteString.php
2 years ago
CodePointString.php
2 years ago
LazyString.php
2 years ago
UnicodeString.php
2 years ago
index.php
2 years ago
AbstractString.php
468 lines
| 1 | <?php |
| 2 | namespace MailPoetVendor\Symfony\Component\String; |
| 3 | if (!defined('ABSPATH')) exit; |
| 4 | use MailPoetVendor\Symfony\Component\String\Exception\ExceptionInterface; |
| 5 | use MailPoetVendor\Symfony\Component\String\Exception\InvalidArgumentException; |
| 6 | use MailPoetVendor\Symfony\Component\String\Exception\RuntimeException; |
| 7 | abstract class AbstractString implements \Stringable, \JsonSerializable |
| 8 | { |
| 9 | public const PREG_PATTERN_ORDER = \PREG_PATTERN_ORDER; |
| 10 | public const PREG_SET_ORDER = \PREG_SET_ORDER; |
| 11 | public const PREG_OFFSET_CAPTURE = \PREG_OFFSET_CAPTURE; |
| 12 | public const PREG_UNMATCHED_AS_NULL = \PREG_UNMATCHED_AS_NULL; |
| 13 | public const PREG_SPLIT = 0; |
| 14 | public const PREG_SPLIT_NO_EMPTY = \PREG_SPLIT_NO_EMPTY; |
| 15 | public const PREG_SPLIT_DELIM_CAPTURE = \PREG_SPLIT_DELIM_CAPTURE; |
| 16 | public const PREG_SPLIT_OFFSET_CAPTURE = \PREG_SPLIT_OFFSET_CAPTURE; |
| 17 | protected $string = ''; |
| 18 | protected $ignoreCase = \false; |
| 19 | public abstract function __construct(string $string = ''); |
| 20 | public static function unwrap(array $values) : array |
| 21 | { |
| 22 | foreach ($values as $k => $v) { |
| 23 | if ($v instanceof self) { |
| 24 | $values[$k] = $v->__toString(); |
| 25 | } elseif (\is_array($v) && $values[$k] !== ($v = static::unwrap($v))) { |
| 26 | $values[$k] = $v; |
| 27 | } |
| 28 | } |
| 29 | return $values; |
| 30 | } |
| 31 | public static function wrap(array $values) : array |
| 32 | { |
| 33 | $i = 0; |
| 34 | $keys = null; |
| 35 | foreach ($values as $k => $v) { |
| 36 | if (\is_string($k) && '' !== $k && $k !== ($j = (string) new static($k))) { |
| 37 | $keys = $keys ?? \array_keys($values); |
| 38 | $keys[$i] = $j; |
| 39 | } |
| 40 | if (\is_string($v)) { |
| 41 | $values[$k] = new static($v); |
| 42 | } elseif (\is_array($v) && $values[$k] !== ($v = static::wrap($v))) { |
| 43 | $values[$k] = $v; |
| 44 | } |
| 45 | ++$i; |
| 46 | } |
| 47 | return null !== $keys ? \array_combine($keys, $values) : $values; |
| 48 | } |
| 49 | public function after($needle, bool $includeNeedle = \false, int $offset = 0) : self |
| 50 | { |
| 51 | $str = clone $this; |
| 52 | $i = \PHP_INT_MAX; |
| 53 | foreach ((array) $needle as $n) { |
| 54 | $n = (string) $n; |
| 55 | $j = $this->indexOf($n, $offset); |
| 56 | if (null !== $j && $j < $i) { |
| 57 | $i = $j; |
| 58 | $str->string = $n; |
| 59 | } |
| 60 | } |
| 61 | if (\PHP_INT_MAX === $i) { |
| 62 | return $str; |
| 63 | } |
| 64 | if (!$includeNeedle) { |
| 65 | $i += $str->length(); |
| 66 | } |
| 67 | return $this->slice($i); |
| 68 | } |
| 69 | public function afterLast($needle, bool $includeNeedle = \false, int $offset = 0) : self |
| 70 | { |
| 71 | $str = clone $this; |
| 72 | $i = null; |
| 73 | foreach ((array) $needle as $n) { |
| 74 | $n = (string) $n; |
| 75 | $j = $this->indexOfLast($n, $offset); |
| 76 | if (null !== $j && $j >= $i) { |
| 77 | $i = $offset = $j; |
| 78 | $str->string = $n; |
| 79 | } |
| 80 | } |
| 81 | if (null === $i) { |
| 82 | return $str; |
| 83 | } |
| 84 | if (!$includeNeedle) { |
| 85 | $i += $str->length(); |
| 86 | } |
| 87 | return $this->slice($i); |
| 88 | } |
| 89 | public abstract function append(string ...$suffix) : self; |
| 90 | public function before($needle, bool $includeNeedle = \false, int $offset = 0) : self |
| 91 | { |
| 92 | $str = clone $this; |
| 93 | $i = \PHP_INT_MAX; |
| 94 | foreach ((array) $needle as $n) { |
| 95 | $n = (string) $n; |
| 96 | $j = $this->indexOf($n, $offset); |
| 97 | if (null !== $j && $j < $i) { |
| 98 | $i = $j; |
| 99 | $str->string = $n; |
| 100 | } |
| 101 | } |
| 102 | if (\PHP_INT_MAX === $i) { |
| 103 | return $str; |
| 104 | } |
| 105 | if ($includeNeedle) { |
| 106 | $i += $str->length(); |
| 107 | } |
| 108 | return $this->slice(0, $i); |
| 109 | } |
| 110 | public function beforeLast($needle, bool $includeNeedle = \false, int $offset = 0) : self |
| 111 | { |
| 112 | $str = clone $this; |
| 113 | $i = null; |
| 114 | foreach ((array) $needle as $n) { |
| 115 | $n = (string) $n; |
| 116 | $j = $this->indexOfLast($n, $offset); |
| 117 | if (null !== $j && $j >= $i) { |
| 118 | $i = $offset = $j; |
| 119 | $str->string = $n; |
| 120 | } |
| 121 | } |
| 122 | if (null === $i) { |
| 123 | return $str; |
| 124 | } |
| 125 | if ($includeNeedle) { |
| 126 | $i += $str->length(); |
| 127 | } |
| 128 | return $this->slice(0, $i); |
| 129 | } |
| 130 | public function bytesAt(int $offset) : array |
| 131 | { |
| 132 | $str = $this->slice($offset, 1); |
| 133 | return '' === $str->string ? [] : \array_values(\unpack('C*', $str->string)); |
| 134 | } |
| 135 | public abstract function camel() : self; |
| 136 | public abstract function chunk(int $length = 1) : array; |
| 137 | public function collapseWhitespace() : self |
| 138 | { |
| 139 | $str = clone $this; |
| 140 | $str->string = \trim(\preg_replace("/(?:[ \n\r\t\f]{2,}+|[\n\r\t\f])/", ' ', $str->string), " \n\r\t\f"); |
| 141 | return $str; |
| 142 | } |
| 143 | public function containsAny($needle) : bool |
| 144 | { |
| 145 | return null !== $this->indexOf($needle); |
| 146 | } |
| 147 | public function endsWith($suffix) : bool |
| 148 | { |
| 149 | if (!\is_array($suffix) && !$suffix instanceof \Traversable) { |
| 150 | throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class)); |
| 151 | } |
| 152 | foreach ($suffix as $s) { |
| 153 | if ($this->endsWith((string) $s)) { |
| 154 | return \true; |
| 155 | } |
| 156 | } |
| 157 | return \false; |
| 158 | } |
| 159 | public function ensureEnd(string $suffix) : self |
| 160 | { |
| 161 | if (!$this->endsWith($suffix)) { |
| 162 | return $this->append($suffix); |
| 163 | } |
| 164 | $suffix = \preg_quote($suffix); |
| 165 | $regex = '{(' . $suffix . ')(?:' . $suffix . ')++$}D'; |
| 166 | return $this->replaceMatches($regex . ($this->ignoreCase ? 'i' : ''), '$1'); |
| 167 | } |
| 168 | public function ensureStart(string $prefix) : self |
| 169 | { |
| 170 | $prefix = new static($prefix); |
| 171 | if (!$this->startsWith($prefix)) { |
| 172 | return $this->prepend($prefix); |
| 173 | } |
| 174 | $str = clone $this; |
| 175 | $i = $prefixLen = $prefix->length(); |
| 176 | while ($this->indexOf($prefix, $i) === $i) { |
| 177 | $str = $str->slice($prefixLen); |
| 178 | $i += $prefixLen; |
| 179 | } |
| 180 | return $str; |
| 181 | } |
| 182 | public function equalsTo($string) : bool |
| 183 | { |
| 184 | if (!\is_array($string) && !$string instanceof \Traversable) { |
| 185 | throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class)); |
| 186 | } |
| 187 | foreach ($string as $s) { |
| 188 | if ($this->equalsTo((string) $s)) { |
| 189 | return \true; |
| 190 | } |
| 191 | } |
| 192 | return \false; |
| 193 | } |
| 194 | public abstract function folded() : self; |
| 195 | public function ignoreCase() : self |
| 196 | { |
| 197 | $str = clone $this; |
| 198 | $str->ignoreCase = \true; |
| 199 | return $str; |
| 200 | } |
| 201 | public function indexOf($needle, int $offset = 0) : ?int |
| 202 | { |
| 203 | if (!\is_array($needle) && !$needle instanceof \Traversable) { |
| 204 | throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class)); |
| 205 | } |
| 206 | $i = \PHP_INT_MAX; |
| 207 | foreach ($needle as $n) { |
| 208 | $j = $this->indexOf((string) $n, $offset); |
| 209 | if (null !== $j && $j < $i) { |
| 210 | $i = $j; |
| 211 | } |
| 212 | } |
| 213 | return \PHP_INT_MAX === $i ? null : $i; |
| 214 | } |
| 215 | public function indexOfLast($needle, int $offset = 0) : ?int |
| 216 | { |
| 217 | if (!\is_array($needle) && !$needle instanceof \Traversable) { |
| 218 | throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class)); |
| 219 | } |
| 220 | $i = null; |
| 221 | foreach ($needle as $n) { |
| 222 | $j = $this->indexOfLast((string) $n, $offset); |
| 223 | if (null !== $j && $j >= $i) { |
| 224 | $i = $offset = $j; |
| 225 | } |
| 226 | } |
| 227 | return $i; |
| 228 | } |
| 229 | public function isEmpty() : bool |
| 230 | { |
| 231 | return '' === $this->string; |
| 232 | } |
| 233 | public abstract function join(array $strings, ?string $lastGlue = null) : self; |
| 234 | public function jsonSerialize() : string |
| 235 | { |
| 236 | return $this->string; |
| 237 | } |
| 238 | public abstract function length() : int; |
| 239 | public abstract function lower() : self; |
| 240 | public abstract function match(string $regexp, int $flags = 0, int $offset = 0) : array; |
| 241 | public abstract function padBoth(int $length, string $padStr = ' ') : self; |
| 242 | public abstract function padEnd(int $length, string $padStr = ' ') : self; |
| 243 | public abstract function padStart(int $length, string $padStr = ' ') : self; |
| 244 | public abstract function prepend(string ...$prefix) : self; |
| 245 | public function repeat(int $multiplier) : self |
| 246 | { |
| 247 | if (0 > $multiplier) { |
| 248 | throw new InvalidArgumentException(\sprintf('Multiplier must be positive, %d given.', $multiplier)); |
| 249 | } |
| 250 | $str = clone $this; |
| 251 | $str->string = \str_repeat($str->string, $multiplier); |
| 252 | return $str; |
| 253 | } |
| 254 | public abstract function replace(string $from, string $to) : self; |
| 255 | public abstract function replaceMatches(string $fromRegexp, $to) : self; |
| 256 | public abstract function reverse() : self; |
| 257 | public abstract function slice(int $start = 0, ?int $length = null) : self; |
| 258 | public abstract function snake() : self; |
| 259 | public abstract function splice(string $replacement, int $start = 0, ?int $length = null) : self; |
| 260 | public function split(string $delimiter, ?int $limit = null, ?int $flags = null) : array |
| 261 | { |
| 262 | if (null === $flags) { |
| 263 | throw new \TypeError('Split behavior when $flags is null must be implemented by child classes.'); |
| 264 | } |
| 265 | if ($this->ignoreCase) { |
| 266 | $delimiter .= 'i'; |
| 267 | } |
| 268 | \set_error_handler(static function ($t, $m) { |
| 269 | throw new InvalidArgumentException($m); |
| 270 | }); |
| 271 | try { |
| 272 | if (\false === ($chunks = \preg_split($delimiter, $this->string, $limit, $flags))) { |
| 273 | $lastError = \preg_last_error(); |
| 274 | foreach (\get_defined_constants(\true)['pcre'] as $k => $v) { |
| 275 | if ($lastError === $v && '_ERROR' === \substr($k, -6)) { |
| 276 | throw new RuntimeException('Splitting failed with ' . $k . '.'); |
| 277 | } |
| 278 | } |
| 279 | throw new RuntimeException('Splitting failed with unknown error code.'); |
| 280 | } |
| 281 | } finally { |
| 282 | \restore_error_handler(); |
| 283 | } |
| 284 | $str = clone $this; |
| 285 | if (self::PREG_SPLIT_OFFSET_CAPTURE & $flags) { |
| 286 | foreach ($chunks as &$chunk) { |
| 287 | $str->string = $chunk[0]; |
| 288 | $chunk[0] = clone $str; |
| 289 | } |
| 290 | } else { |
| 291 | foreach ($chunks as &$chunk) { |
| 292 | $str->string = $chunk; |
| 293 | $chunk = clone $str; |
| 294 | } |
| 295 | } |
| 296 | return $chunks; |
| 297 | } |
| 298 | public function startsWith($prefix) : bool |
| 299 | { |
| 300 | if (!\is_array($prefix) && !$prefix instanceof \Traversable) { |
| 301 | throw new \TypeError(\sprintf('Method "%s()" must be overridden by class "%s" to deal with non-iterable values.', __FUNCTION__, static::class)); |
| 302 | } |
| 303 | foreach ($prefix as $prefix) { |
| 304 | if ($this->startsWith((string) $prefix)) { |
| 305 | return \true; |
| 306 | } |
| 307 | } |
| 308 | return \false; |
| 309 | } |
| 310 | public abstract function title(bool $allWords = \false) : self; |
| 311 | public function toByteString(?string $toEncoding = null) : ByteString |
| 312 | { |
| 313 | $b = new ByteString(); |
| 314 | $toEncoding = \in_array($toEncoding, ['utf8', 'utf-8', 'UTF8'], \true) ? 'UTF-8' : $toEncoding; |
| 315 | if (null === $toEncoding || $toEncoding === ($fromEncoding = $this instanceof AbstractUnicodeString || \preg_match('//u', $b->string) ? 'UTF-8' : 'Windows-1252')) { |
| 316 | $b->string = $this->string; |
| 317 | return $b; |
| 318 | } |
| 319 | \set_error_handler(static function ($t, $m) { |
| 320 | throw new InvalidArgumentException($m); |
| 321 | }); |
| 322 | try { |
| 323 | try { |
| 324 | $b->string = \mb_convert_encoding($this->string, $toEncoding, 'UTF-8'); |
| 325 | } catch (InvalidArgumentException|\ValueError $e) { |
| 326 | if (!\function_exists('iconv')) { |
| 327 | if ($e instanceof \ValueError) { |
| 328 | throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e); |
| 329 | } |
| 330 | throw $e; |
| 331 | } |
| 332 | $b->string = \iconv('UTF-8', $toEncoding, $this->string); |
| 333 | } |
| 334 | } finally { |
| 335 | \restore_error_handler(); |
| 336 | } |
| 337 | return $b; |
| 338 | } |
| 339 | public function toCodePointString() : CodePointString |
| 340 | { |
| 341 | return new CodePointString($this->string); |
| 342 | } |
| 343 | public function toString() : string |
| 344 | { |
| 345 | return $this->string; |
| 346 | } |
| 347 | public function toUnicodeString() : UnicodeString |
| 348 | { |
| 349 | return new UnicodeString($this->string); |
| 350 | } |
| 351 | public abstract function trim(string $chars = " \t\n\r\x00\v\f ") : self; |
| 352 | public abstract function trimEnd(string $chars = " \t\n\r\x00\v\f ") : self; |
| 353 | public function trimPrefix($prefix) : self |
| 354 | { |
| 355 | if (\is_array($prefix) || $prefix instanceof \Traversable) { |
| 356 | foreach ($prefix as $s) { |
| 357 | $t = $this->trimPrefix($s); |
| 358 | if ($t->string !== $this->string) { |
| 359 | return $t; |
| 360 | } |
| 361 | } |
| 362 | return clone $this; |
| 363 | } |
| 364 | $str = clone $this; |
| 365 | if ($prefix instanceof self) { |
| 366 | $prefix = $prefix->string; |
| 367 | } else { |
| 368 | $prefix = (string) $prefix; |
| 369 | } |
| 370 | if ('' !== $prefix && \strlen($this->string) >= \strlen($prefix) && 0 === \substr_compare($this->string, $prefix, 0, \strlen($prefix), $this->ignoreCase)) { |
| 371 | $str->string = \substr($this->string, \strlen($prefix)); |
| 372 | } |
| 373 | return $str; |
| 374 | } |
| 375 | public abstract function trimStart(string $chars = " \t\n\r\x00\v\f ") : self; |
| 376 | public function trimSuffix($suffix) : self |
| 377 | { |
| 378 | if (\is_array($suffix) || $suffix instanceof \Traversable) { |
| 379 | foreach ($suffix as $s) { |
| 380 | $t = $this->trimSuffix($s); |
| 381 | if ($t->string !== $this->string) { |
| 382 | return $t; |
| 383 | } |
| 384 | } |
| 385 | return clone $this; |
| 386 | } |
| 387 | $str = clone $this; |
| 388 | if ($suffix instanceof self) { |
| 389 | $suffix = $suffix->string; |
| 390 | } else { |
| 391 | $suffix = (string) $suffix; |
| 392 | } |
| 393 | if ('' !== $suffix && \strlen($this->string) >= \strlen($suffix) && 0 === \substr_compare($this->string, $suffix, -\strlen($suffix), null, $this->ignoreCase)) { |
| 394 | $str->string = \substr($this->string, 0, -\strlen($suffix)); |
| 395 | } |
| 396 | return $str; |
| 397 | } |
| 398 | public function truncate(int $length, string $ellipsis = '', bool $cut = \true) : self |
| 399 | { |
| 400 | $stringLength = $this->length(); |
| 401 | if ($stringLength <= $length) { |
| 402 | return clone $this; |
| 403 | } |
| 404 | $ellipsisLength = '' !== $ellipsis ? (new static($ellipsis))->length() : 0; |
| 405 | if ($length < $ellipsisLength) { |
| 406 | $ellipsisLength = 0; |
| 407 | } |
| 408 | if (!$cut) { |
| 409 | if (null === ($length = $this->indexOf([' ', "\r", "\n", "\t"], ($length ?: 1) - 1))) { |
| 410 | return clone $this; |
| 411 | } |
| 412 | $length += $ellipsisLength; |
| 413 | } |
| 414 | $str = $this->slice(0, $length - $ellipsisLength); |
| 415 | return $ellipsisLength ? $str->trimEnd()->append($ellipsis) : $str; |
| 416 | } |
| 417 | public abstract function upper() : self; |
| 418 | public abstract function width(bool $ignoreAnsiDecoration = \true) : int; |
| 419 | public function wordwrap(int $width = 75, string $break = "\n", bool $cut = \false) : self |
| 420 | { |
| 421 | $lines = '' !== $break ? $this->split($break) : [clone $this]; |
| 422 | $chars = []; |
| 423 | $mask = ''; |
| 424 | if (1 === \count($lines) && '' === $lines[0]->string) { |
| 425 | return $lines[0]; |
| 426 | } |
| 427 | foreach ($lines as $i => $line) { |
| 428 | if ($i) { |
| 429 | $chars[] = $break; |
| 430 | $mask .= '#'; |
| 431 | } |
| 432 | foreach ($line->chunk() as $char) { |
| 433 | $chars[] = $char->string; |
| 434 | $mask .= ' ' === $char->string ? ' ' : '?'; |
| 435 | } |
| 436 | } |
| 437 | $string = ''; |
| 438 | $j = 0; |
| 439 | $b = $i = -1; |
| 440 | $mask = \wordwrap($mask, $width, '#', $cut); |
| 441 | while (\false !== ($b = \strpos($mask, '#', $b + 1))) { |
| 442 | for (++$i; $i < $b; ++$i) { |
| 443 | $string .= $chars[$j]; |
| 444 | unset($chars[$j++]); |
| 445 | } |
| 446 | if ($break === $chars[$j] || ' ' === $chars[$j]) { |
| 447 | unset($chars[$j++]); |
| 448 | } |
| 449 | $string .= $break; |
| 450 | } |
| 451 | $str = clone $this; |
| 452 | $str->string = $string . \implode('', $chars); |
| 453 | return $str; |
| 454 | } |
| 455 | public function __sleep() : array |
| 456 | { |
| 457 | return ['string']; |
| 458 | } |
| 459 | public function __clone() |
| 460 | { |
| 461 | $this->ignoreCase = \false; |
| 462 | } |
| 463 | public function __toString() : string |
| 464 | { |
| 465 | return $this->string; |
| 466 | } |
| 467 | } |
| 468 |