string/AbstractString.php at 8.2 · symfony/string · GitHub

History

726 lines (565 loc) · 19.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

<?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 Symfony\Component\String;

use Symfony\Component\String\Exception\ExceptionInterface;

use Symfony\Component\String\Exception\InvalidArgumentException;

use 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 \Stringable, \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 = \PREG_UNMATCHED_AS_NULL;

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 $string = '';

protected ?bool $ignoreCase = false;

abstract public 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 ??= 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

public function after(string|iterable $needle, bool $includeNeedle = false, int $offset = 0): static

{

$str = clone $this;

$i = \PHP_INT_MAX;

if (\is_string($needle)) {

$needle = [$needle];

}

foreach ($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

public function afterLast(string|iterable $needle, bool $includeNeedle = false, int $offset = 0): static

{

$str = clone $this;

$i = null;

if (\is_string($needle)) {

$needle = [$needle];

}

foreach ($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);

}

abstract public function append(string ...$suffix): static;

/**

* @param string|string[] $needle

public function before(string|iterable $needle, bool $includeNeedle = false, int $offset = 0): static

{

$str = clone $this;

$i = \PHP_INT_MAX;

if (\is_string($needle)) {

$needle = [$needle];

}

foreach ($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

public function beforeLast(string|iterable $needle, bool $includeNeedle = false, int $offset = 0): static

{

$str = clone $this;

$i = null;

if (\is_string($needle)) {

$needle = [$needle];

}

foreach ($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));

}

abstract public function camel(): static;

/**

* @return static[]

abstract public function chunk(int $length = 1): array;

public function collapseWhitespace(): static

{

$str = clone $this;

$str->string = trim(preg_replace("/(?:[ \n\r\t\x0C]{2,}+|[\n\r\t\x0C])/", ' ', $str->string), " \n\r\t\x0C");

return $str;

}

/**

* @param string|string[] $needle

public function containsAny(string|iterable $needle): bool

{

return null !== $this->indexOf($needle);

}

/**

* @param string|string[] $suffix

public function endsWith(string|iterable $suffix): bool

{

if (\is_string($suffix)) {

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;

}

public function ensureEnd(string $suffix): static

{

if (!$this->endsWith($suffix)) {

return $this->append($suffix);

}

$suffix = preg_quote($suffix);

$regex = '{('.$suffix.')(?:'.$suffix.')++$}D';

return $this->replaceMatches($regex.($this->ignoreCase ? 'i' : ''), '$1');

}

public function ensureStart(string $prefix): static

{

$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|iterable $string): bool

{

if (\is_string($string)) {

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;

}

abstract public function folded(): static;

public function ignoreCase(): static

{

$str = clone $this;

$str->ignoreCase = true;

return $str;

}

/**

* @param string|string[] $needle

public function indexOf(string|iterable $needle, int $offset = 0): ?int

{

if (\is_string($needle)) {

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(string|iterable $needle, int $offset = 0): ?int

{

if (\is_string($needle)) {

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;

}

abstract public function join(array $strings, ?string $lastGlue = null): static;

public function jsonSerialize(): string

{

return $this->string;

}

abstract public function length(): int;

abstract public function lower(): static;

/**

* 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

abstract public function match(string $regexp, int $flags = 0, int $offset = 0): array;

abstract public function padBoth(int $length, string $padStr = ' '): static;

abstract public function padEnd(int $length, string $padStr = ' '): static;

abstract public function padStart(int $length, string $padStr = ' '): static;

abstract public function prepend(string ...$prefix): static;

public function repeat(int $multiplier): static

{

if (0 > $multiplier) {

throw new InvalidArgumentException(\sprintf('Multiplier must be positive, %d given.', $multiplier));

}

$str = clone $this;

$str->string = str_repeat($str->string, $multiplier);

return $str;

}

abstract public function replace(string $from, string $to): static;

/**

* @param-immediately-invoked-callable $to

abstract public function replaceMatches(string $fromRegexp, string|callable $to): static;

abstract public function reverse(): static;

abstract public function slice(int $start = 0, ?int $length = null): static;

abstract public function snake(): static;

public function kebab(): static

{

return $this->snake()->replace('_', '-');

}

public function pascal(): static

{

return $this->camel()->title();

}

abstract public function splice(string $replacement, int $start = 0, ?int $length = null): static;

/**

* @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 fn ($t, $m) => throw new InvalidArgumentException($m));

try {

if (false === $chunks = preg_split($delimiter, $this->string, $limit, $flags)) {

throw new RuntimeException('Splitting failed with error: '.preg_last_error_msg());

}

} 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(string|iterable $prefix): bool

{

if (\is_string($prefix)) {

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;

}

abstract public function title(bool $allWords = false): static;

public function toByteString(?string $toEncoding = null): ByteString

{

$b = new ByteString();

$toEncoding = \in_array($toEncoding, ['utf8', 'utf-8', 'UTF8'], true) ? 'UTF-8' : $toEncoding;

if (null === $toEncoding || $toEncoding === $fromEncoding = $this instanceof AbstractUnicodeString || preg_match('//u', $b->string) ? 'UTF-8' : 'Windows-1252') {

$b->string = $this->string;

return $b;

}

try {

$b->string = mb_convert_encoding($this->string, $toEncoding, 'UTF-8');

} catch (\ValueError $e) {

if (!\function_exists('iconv')) {

throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);

}

$b->string = iconv('UTF-8', $toEncoding, $this->string);

}

return $b;

}

public function toCodePointString(): CodePointString

{

return new CodePointString($this->string);

}

public function toString(): string

{

return $this->string;

}

public function toUnicodeString(): UnicodeString

{

return new UnicodeString($this->string);

}

abstract public function trim(string $chars = " \t\n\r\0\x0B\x0C\u{A0}\u{FEFF}"): static;

abstract public function trimEnd(string $chars = " \t\n\r\0\x0B\x0C\u{A0}\u{FEFF}"): static;

/**

* @param string|string[] $prefix

public function trimPrefix($prefix): static

{

if (\is_array($prefix) || $prefix instanceof \Traversable) { // don't use is_iterable(), it's slow

foreach ($prefix as $s) {

$t = $this->trimPrefix($s);

if ($t->string !== $this->string) {

return $t;

}

return clone $this;

}

$str = clone $this;

if ($prefix instanceof self) {

$prefix = $prefix->string;

} else {

$prefix = (string) $prefix;

}

if ('' !== $prefix && \strlen($this->string) >= \strlen($prefix) && 0 === substr_compare($this->string, $prefix, 0, \strlen($prefix), $this->ignoreCase)) {

$str->string = substr($this->string, \strlen($prefix));

}

return $str;

}

abstract public function trimStart(string $chars = " \t\n\r\0\x0B\x0C\u{A0}\u{FEFF}"): static;

/**

* @param string|string[] $suffix

public function trimSuffix($suffix): static

{

if (\is_array($suffix) || $suffix instanceof \Traversable) { // don't use is_iterable(), it's slow

foreach ($suffix as $s) {

$t = $this->trimSuffix($s);

if ($t->string !== $this->string) {

return $t;

}

return clone $this;

}

$str = clone $this;

if ($suffix instanceof self) {

$suffix = $suffix->string;

} else {

$suffix = (string) $suffix;

}

if ('' !== $suffix && \strlen($this->string) >= \strlen($suffix) && 0 === substr_compare($this->string, $suffix, -\strlen($suffix), null, $this->ignoreCase)) {

$str->string = substr($this->string, 0, -\strlen($suffix));

}

return $str;

}

public function truncate(int $length, string $ellipsis = '', bool|TruncateMode $cut = TruncateMode::Char): static

{

$stringLength = $this->length();

if ($stringLength <= $length) {

return clone $this;

}

$ellipsisLength = '' !== $ellipsis ? (new static($ellipsis))->length() : 0;

if ($length < $ellipsisLength) {

$ellipsisLength = 0;

}

$desiredLength = $length;

if (TruncateMode::WordAfter === $cut || !$cut) {

if (null === $length = $this->indexOf([' ', "\r", "\n", "\t"], ($length ?: 1) - 1)) {

return clone $this;

}

$length += $ellipsisLength;

} elseif (TruncateMode::WordBefore === $cut && null !== $this->indexOf([' ', "\r", "\n", "\t"], ($length ?: 1) - 1)) {

$length += $ellipsisLength;

}

$str = $this->slice(0, $length - $ellipsisLength);

if (TruncateMode::WordBefore === $cut) {

if (0 === $ellipsisLength && $desiredLength === $this->indexOf([' ', "\r", "\n", "\t"], $length)) {

return $str;

}

$str = $str->beforeLast([' ', "\r", "\n", "\t"]);

}

return $ellipsisLength ? $str->trimEnd()->append($ellipsis) : $str;

}

abstract public function upper(): static;

/**

* Returns the printable length on a terminal.

abstract public function width(bool $ignoreAnsiDecoration = true): int;

public function wordwrap(int $width = 75, string $break = "\n", bool $cut = false): static

{

$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 __serialize(): array

{

return ['string' => $this->string];

}

public function __clone()

{

$this->ignoreCase = false;

}

public function __toString(): string

{

return $this->string;

}

string/AbstractString.php at 8.2 · symfony/string · GitHub

Uh oh!

Expand file tree

Breadcrumbs

AbstractString.php

Latest commit

History

Breadcrumbs

AbstractString.php

File metadata and controls