string/StringObject.php at master · windwalker-io/string · GitHub

History

660 lines (598 loc) · 15.6 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

<?php declare(strict_types=1);

/**

* Part of Windwalker project.

* @license LGPL-2.0-or-later

namespace Windwalker\String;

use Windwalker\Utilities\Classes\ImmutableHelperTrait;

use Windwalker\Utilities\Classes\StringableInterface;

/**

* The StringObject class.

* @method StringObject getChar(int $pos)

* @method StringObject between(string $start, string $end, int $offset = 0)

* @method StringObject collapseWhitespaces()

* @method bool contains(string $search, bool $caseSensitive = true)

* @method bool endsWith(string $search, bool $caseSensitive = true)

* @method bool startsWith(string $target, bool $caseSensitive = true)

* @method StringObject ensureLeft(string $search)

* @method StringObject ensureRight(string $search)

* @method bool hasLowerCase()

* @method bool hasUpperCase()

* @method StringObject match(string $pattern, string $option = 'msr')

* @method StringObject insert(string $insert, int $position)

* @method bool isLowerCase()

* @method bool isUpperCase()

* @method StringObject first(int $length = 1)

* @method StringObject last(int $length = 1)

* @method StringObject intersectLeft(string $string2)

* @method StringObject intersectRight(string $string2)

* @method StringObject intersect(string $string2)

* @method StringObject pad(int $length = 0, string $substring = ' ')

* @method StringObject padLeft(int $length = 0, string $substring = ' ')

* @method StringObject padRight(int $length = 0, string $substring = ' ')

* @method StringObject removeChar(int $offset, int $length = null)

* @method StringObject removeLeft(string $search)

* @method StringObject removeRight(string $search)

* @method StringObject slice(int $start, int $end = null)

* @method StringObject substring(int $start, int $end = null)

* @method StringObject surround($substring = ['"', '"'])

* @method StringObject toggleCase()

* @method StringObject truncate(int $length, string $suffix = '', bool $wordBreak = true)

* @method StringObject map(callable $callback)

* @method StringObject filter(callable $callback)

* @method StringObject reject(callable $callback)

* @since 3.2

class StringObject implements \Countable, \ArrayAccess, \IteratorAggregate, StringableInterface

{

use ImmutableHelperTrait;

/**

* We only provides 3 default encoding constants of PHP.

* @see http://php.net/manual/en/xml.encoding.php

const ENCODING_DEFAULT_ISO = 'ISO-8859-1';

const ENCODING_UTF8 = 'UTF-8';

const ENCODING_US_ASCII = 'US-ASCII';

/**

* Property string.

* @var string

protected $string = '';

/**

* Property encoding.

* @var string

protected $encoding = null;

/**

* create

* @param string $string

* @param null|string $encoding

* @return static

public static function create($string = '', $encoding = self::ENCODING_UTF8)

{

return new static($string, $encoding);

}

/**

* fromArray

* @param array $strings

* @param null|string $encoding

* @return static[]

public static function fromArray(array $strings, $encoding = self::ENCODING_UTF8)

{

foreach ($strings as $k => $string) {

$strings[$k] = static::create($string, $encoding);

}

return $strings;

}

/**

* StringObject constructor.

* @see http://php.net/manual/en/mbstring.supported-encodings.php

* @param string $string

* @param null|string $encoding

public function __construct($string = '', $encoding = self::ENCODING_UTF8)

{

$this->string = $string;

$this->encoding = $encoding === null ? static::ENCODING_UTF8 : $encoding;

}

/**

* __call

* @param string $name

* @param array $args

* @return mixed

* @throws \ReflectionException

public function __call($name, array $args)

{

$class = Str::class;

if (is_callable([$class, $name])) {

return $this->callProxy($class, $name, $args);

}

throw new \BadMethodCallException(sprintf('Call to undefined method: %s::%s()', get_called_class(), $name));

}

/**

* callProxy

* @param string $class

* @param string $method

* @param array $args

* @return static

* @throws \ReflectionException

protected function callProxy($class, $method, array $args)

{

$new = $this->cloneInstance();

$ref = new \ReflectionMethod($class, $method);

$params = $ref->getParameters();

array_shift($params);

/** @var \ReflectionParameter $param */

foreach (array_values($params) as $k => $param) {

if (!array_key_exists($k, $args)) {

if ($param->getName() === 'encoding' && !isset($args[$k])) {

$args[$k] = $this->encoding;

continue;

}

$args[$k] = $param->getDefaultValue();

}

array_unshift($args, $new->string);

$result = call_user_func_array([$class, $method], $args);

if (is_string($result)) {

$new->string = $result;

return $new;

}

return $result;

}

/**

* Retrieve an external iterator

* @link http://php.net/manual/en/iteratoraggregate.getiterator.php

* @return \Traversable An instance of an object implementing Iterator or

* Traversable

* @since 5.0.0

public function getIterator()

{

return new \ArrayIterator($this->chop());

}

/**

* Whether a offset exists

* @link http://php.net/manual/en/arrayaccess.offsetexists.php

* @param mixed $offset

* An offset to check for.

*

* @return boolean true on success or false on failure.

*

*

* The return value will be casted to boolean if non-boolean was returned.

* @since 5.0.0

public function offsetExists($offset)

{

$offset = $offset >= 0 ? $offset : (int) abs($offset) - 1;

return $this->length() > $offset;

}

/**

* Offset to retrieve

* @param int $offset The offset to retrieve.

* @return string Can return all value types.

public function offsetGet($offset)

{

return $this->getChar($offset);

}

/**

* Offset to set

* @link http://php.net/manual/en/arrayaccess.offsetset.php

* @param mixed $offset

* The offset to assign the value to.

*

* @param mixed $string

* The value to set.

*

* @return void

* @since 5.0.0

public function offsetSet($offset, $string)

{

$this->string = Mbstring::substrReplace($this->string, $string, $offset, 1, $this->encoding);

}

/**

* Offset to unset

* @link http://php.net/manual/en/arrayaccess.offsetunset.php

* @param mixed $offset

* The offset to unset.

*

* @return void

* @since 5.0.0

public function offsetUnset($offset)

{

if ($this->length() < abs($offset)) {

return;

}

$this->string = Str::removeChar($this->string, $offset, 1, $this->encoding);

}

/**

* Count elements of an object

* @link http://php.net/manual/en/countable.count.php

* @return int The custom count as an integer.

*

*

* The return value is cast to an integer.

* @since 5.1.0

public function count()

{

return $this->length();

}

/**

* Magic method to convert this object to string.

* @return string

public function __toString()

{

return (string) $this->string;

}

/**

* Method to get property Encoding

* @return string

public function getEncoding()

{

return $this->encoding;

}

/**

* Method to set property encoding

* @param string $encoding

* @return static Return self to support chaining.

public function withEncoding($encoding)

{

return $this->cloneInstance(

function (StringObject $new) use ($encoding) {

$new->encoding = $encoding;

}

);

}

/**

* Method to get property String

* @return string

public function getString()

{

return $this->string;

}

/**

* Method to set property string

* @param string $string

* @return static Return self to support chaining.

public function withString($string)

{

return $this->cloneInstance(

function (StringObject $new) use ($string) {

$new->string = $string;

}

);

}

/**

* toLowerCase

* @return static

public function toLowerCase()

{

$new = $this->cloneInstance();

$new->string = Mbstring::strtolower($new->string, $new->encoding);

return $new;

}

/**

* toUpperCase

* @return static

public function toUpperCase()

{

return $this->cloneInstance(

function (StringObject $new) {

$new->string = Mbstring::strtoupper($new->string, $new->encoding);

}

);

}

/**

* length

* @return int

public function length()

{

return Mbstring::strlen($this->string, $this->encoding);

}

/**

* split

* @param int $length

* @return array|bool

public function chop($length = 1)

{

return Mbstring::strSplit($this->string, $length, $this->encoding);

}

/**

* replace

* @param array|string $search

* @param array|string $replacement

* @param int|null $count

* @return static

public function replace($search, $replacement, &$count = null)

{

return $this->cloneInstance(

function (StringObject $new) use ($search, $replacement, &$count) {

$new->string = str_replace($search, $replacement, $new->string, $count);

}

);

}

/**

* compare

* @param string $compare

* @param bool $caseSensitive

* @return int

public function compare($compare, $caseSensitive = true)

{

if ($caseSensitive) {

return Mbstring::strcmp($this->string, $compare);

}

return Mbstring::strcasecmp($this->string, $compare, $this->encoding);

}

/**

* reverse

* @return static

public function reverse()

{

return $this->cloneInstance(

function (StringObject $new) {

$new->string = Mbstring::strrev($new->string);

}

);

}

/**

* substrReplace

* @param string $replace

* @param int $start

* @param int $offset

* @return static

public function substrReplace($replace, $start, $offset = null)

{

return $this->cloneInstance(

function (StringObject $new) use ($replace, $start, $offset) {

$new->string = Mbstring::substrReplace($new->string, $replace, $start, $offset, $this->encoding);

}

);

}

/**

* ltrim

* @param string|null $charlist

* @return static

public function trimLeft($charlist = null)

{

return $this->cloneInstance(

function (StringObject $new) use ($charlist) {

$new->string = Mbstring::ltrim($new->string, $charlist);

}

);

}

/**

* rtrim

* @param string|null $charlist

* @return static

public function trimRight($charlist = null)

{

return $this->cloneInstance(

function (StringObject $new) use ($charlist) {

$new->string = Mbstring::rtrim($new->string, $charlist);

}

);

}

/**

* trim

* @param string|null $charlist

* @return static

public function trim($charlist = null)

{

return $this->cloneInstance(

function (StringObject $new) use ($charlist) {

$new->string = Mbstring::trim($new->string, $charlist);

}

);

}

/**

* ucfirst

* @return static

public function upperCaseFirst()

{

return $this->cloneInstance(

function (StringObject $new) {

$new->string = Mbstring::ucfirst($new->string, $this->encoding);

}

);

}

/**

* lcfirst

* @return static

public function lowerCaseFirst()

{

return $this->cloneInstance(

function (StringObject $new) {

$new->string = Mbstring::lcfirst($new->string, $this->encoding);

}

);

}

/**

* upperCaseWords

* @return static

public function upperCaseWords()

{

return $this->cloneInstance(

function (StringObject $new) {

$new->string = Mbstring::ucwords($new->string, $this->encoding);

}

);

}

/**

* substrCount

* @param string $search

* @param bool $caseSensitive

* @return int

public function substrCount($search, $caseSensitive = true)

{

return Mbstring::substrCount($this->string, $search, $caseSensitive, $this->encoding);

}

/**

* indexOf

* @param string $search

* @return int|bool

public function indexOf($search)

{

return Mbstring::strpos($this->string, $search, 0, $this->encoding);

}

/**

* indexOf

* @param string $search

* @return int|bool

public function indexOfLast($search)

{

return Mbstring::strrpos($this->string, $search, 0, $this->encoding);

}

/**

* explode

* @param string $delimiter

* @param int|null $limit

* @return array

public function explode($delimiter, $limit = null)

{

if ($limit === null) {

return explode($delimiter, $this->string);

}

return explode($delimiter, $this->string, $limit);

}

/**

* apply

* @param callable $callback

* @return static

public function apply(callable $callback)

{

return $this->cloneInstance(

function ($new) use ($callback) {

$new->string = $callback($new->string);

}

);

}

/**

* pipe

* @param callable $callback

* @return static

* @since 3.5.14

public function pipe(callable $callback): self

{

return $callback($this);

}

/**

* clearHtml

* @param string|null $allowTags

* @return StringObject

* @since 3.5.13

public function stripHtmlTags(?string $allowTags = null)

{

return $this->cloneInstance(function (self $new) use ($allowTags) {

$new->string = strip_tags($new->string, $allowTags);

});

}

string/StringObject.php at master · windwalker-io/string · GitHub

Uh oh!

Expand file tree

Breadcrumbs

StringObject.php

Latest commit

History

Breadcrumbs

StringObject.php

File metadata and controls