Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Stringy often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Stringy, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess |
||
| 15 | { |
||
| 16 | /** |
||
| 17 | * An instance's string. |
||
| 18 | * |
||
| 19 | * @var string |
||
| 20 | */ |
||
| 21 | protected $str; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * The string's encoding, which should be one of the mbstring module's |
||
| 25 | * supported encodings. |
||
| 26 | * |
||
| 27 | * @var string |
||
| 28 | */ |
||
| 29 | protected $encoding; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Initializes a Stringy object and assigns both str and encoding properties |
||
| 33 | * the supplied values. $str is cast to a string prior to assignment, and if |
||
| 34 | * $encoding is not specified, it defaults to mb_internal_encoding(). Throws |
||
| 35 | * an InvalidArgumentException if the first argument is an array or object |
||
| 36 | * without a __toString method. |
||
| 37 | * |
||
| 38 | * @param mixed $str Value to modify, after being cast to string |
||
| 39 | * @param string $encoding The character encoding |
||
| 40 | * |
||
| 41 | * @throws \InvalidArgumentException if an array or object without a |
||
| 42 | * __toString method is passed as the first argument |
||
| 43 | */ |
||
| 44 | 1020 | public function __construct($str = '', $encoding = null) |
|
| 78 | |||
| 79 | /** |
||
| 80 | * Returns the value in $str. |
||
| 81 | * |
||
| 82 | * @return string The current value of the $str property |
||
| 83 | */ |
||
| 84 | 111 | public function __toString() |
|
| 88 | |||
| 89 | /** |
||
| 90 | * Returns a new string with $string appended. |
||
| 91 | * |
||
| 92 | * @param string $string The string to append |
||
| 93 | * |
||
| 94 | * @return Stringy Object with appended $string |
||
| 95 | */ |
||
| 96 | 5 | public function append($string) |
|
| 100 | |||
| 101 | /** |
||
| 102 | * Append an password (limited to chars that are good readable). |
||
| 103 | * |
||
| 104 | * @param int $length length of the random string |
||
| 105 | * |
||
| 106 | * @return Stringy Object with appended password |
||
| 107 | */ |
||
| 108 | 1 | public function appendPassword($length) |
|
| 114 | |||
| 115 | /** |
||
| 116 | * Append an unique identifier. |
||
| 117 | * |
||
| 118 | * @param string|int $extraPrefix |
||
| 119 | * |
||
| 120 | * @return Stringy Object with appended unique identifier as md5-hash |
||
| 121 | */ |
||
| 122 | 1 | public function appendUniqueIdentifier($extraPrefix = '') |
|
| 132 | |||
| 133 | /** |
||
| 134 | * Append an random string. |
||
| 135 | * |
||
| 136 | * @param int $length length of the random string |
||
| 137 | * @param string $possibleChars characters string for the random selection |
||
| 138 | * |
||
| 139 | * @return Stringy Object with appended random string |
||
| 140 | */ |
||
| 141 | 2 | public function appendRandomString($length, $possibleChars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789') |
|
| 162 | |||
| 163 | /** |
||
| 164 | * Creates a Stringy object and assigns both str and encoding properties |
||
| 165 | * the supplied values. $str is cast to a string prior to assignment, and if |
||
| 166 | * $encoding is not specified, it defaults to mb_internal_encoding(). It |
||
| 167 | * then returns the initialized object. Throws an InvalidArgumentException |
||
| 168 | * if the first argument is an array or object without a __toString method. |
||
| 169 | * |
||
| 170 | * @param mixed $str Value to modify, after being cast to string |
||
| 171 | * @param string $encoding The character encoding |
||
| 172 | * |
||
| 173 | * @return Stringy A Stringy object |
||
| 174 | * @throws \InvalidArgumentException if an array or object without a |
||
| 175 | * __toString method is passed as the first argument |
||
| 176 | */ |
||
| 177 | 1010 | public static function create($str = '', $encoding = null) |
|
| 181 | |||
| 182 | /** |
||
| 183 | * Returns the substring between $start and $end, if found, or an empty |
||
| 184 | * string. An optional offset may be supplied from which to begin the |
||
| 185 | * search for the start string. |
||
| 186 | * |
||
| 187 | * @param string $start Delimiter marking the start of the substring |
||
| 188 | * @param string $end Delimiter marking the end of the substring |
||
| 189 | * @param int $offset Index from which to begin the search |
||
| 190 | * |
||
| 191 | * @return Stringy Object whose $str is a substring between $start and $end |
||
| 192 | */ |
||
| 193 | 16 | public function between($start, $end, $offset = 0) |
|
| 208 | |||
| 209 | /** |
||
| 210 | * Returns the index of the first occurrence of $needle in the string, |
||
| 211 | * and false if not found. Accepts an optional offset from which to begin |
||
| 212 | * the search. |
||
| 213 | * |
||
| 214 | * @param string $needle Substring to look for |
||
| 215 | * @param int $offset Offset from which to search |
||
| 216 | * |
||
| 217 | * @return int|bool The occurrence's index if found, otherwise false |
||
| 218 | */ |
||
| 219 | 28 | public function indexOf($needle, $offset = 0) |
|
| 223 | |||
| 224 | /** |
||
| 225 | * Returns the substring beginning at $start with the specified $length. |
||
| 226 | * It differs from the UTF8::substr() function in that providing a $length of |
||
| 227 | * null will return the rest of the string, rather than an empty string. |
||
| 228 | * |
||
| 229 | * @param int $start Position of the first character to use |
||
| 230 | * @param int $length Maximum number of characters used |
||
| 231 | * |
||
| 232 | * @return Stringy Object with its $str being the substring |
||
| 233 | */ |
||
| 234 | 66 | public function substr($start, $length = null) |
|
| 244 | |||
| 245 | /** |
||
| 246 | * Returns the length of the string. |
||
| 247 | * |
||
| 248 | * @return int The number of characters in $str given the encoding |
||
| 249 | */ |
||
| 250 | 249 | public function length() |
|
| 254 | |||
| 255 | /** |
||
| 256 | * Trims the string and replaces consecutive whitespace characters with a |
||
| 257 | * single space. This includes tabs and newline characters, as well as |
||
| 258 | * multibyte whitespace such as the thin space and ideographic space. |
||
| 259 | * |
||
| 260 | * @return Stringy Object with a trimmed $str and condensed whitespace |
||
| 261 | */ |
||
| 262 | 13 | public function collapseWhitespace() |
|
| 266 | |||
| 267 | /** |
||
| 268 | * Returns a string with whitespace removed from the start and end of the |
||
| 269 | * string. Supports the removal of unicode whitespace. Accepts an optional |
||
| 270 | * string of characters to strip instead of the defaults. |
||
| 271 | * |
||
| 272 | * @param string $chars Optional string of characters to strip |
||
| 273 | * |
||
| 274 | * @return Stringy Object with a trimmed $str |
||
| 275 | */ |
||
| 276 | 114 | View Code Duplication | public function trim($chars = null) |
| 286 | |||
| 287 | /** |
||
| 288 | * Replaces all occurrences of $pattern in $str by $replacement. |
||
| 289 | * |
||
| 290 | * @param string $pattern The regular expression pattern |
||
| 291 | * @param string $replacement The string to replace with |
||
| 292 | * @param string $options Matching conditions to be used |
||
| 293 | * |
||
| 294 | * @return Stringy Object with the result2ing $str after the replacements |
||
| 295 | */ |
||
| 296 | 184 | public function regexReplace($pattern, $replacement, $options = '') |
|
| 310 | |||
| 311 | /** |
||
| 312 | * Returns true if the string contains all $needles, false otherwise. By |
||
| 313 | * default the comparison is case-sensitive, but can be made insensitive by |
||
| 314 | * setting $caseSensitive to false. |
||
| 315 | * |
||
| 316 | * @param array $needles SubStrings to look for |
||
| 317 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 318 | * |
||
| 319 | * @return bool Whether or not $str contains $needle |
||
| 320 | */ |
||
| 321 | 43 | View Code Duplication | public function containsAll($needles, $caseSensitive = true) |
| 336 | |||
| 337 | /** |
||
| 338 | * Returns true if the string contains $needle, false otherwise. By default |
||
| 339 | * the comparison is case-sensitive, but can be made insensitive by setting |
||
| 340 | * $caseSensitive to false. |
||
| 341 | * |
||
| 342 | * @param string $needle Substring to look for |
||
| 343 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 344 | * |
||
| 345 | * @return bool Whether or not $str contains $needle |
||
| 346 | */ |
||
| 347 | 105 | public function contains($needle, $caseSensitive = true) |
|
| 357 | |||
| 358 | /** |
||
| 359 | * Returns true if the string contains any $needles, false otherwise. By |
||
| 360 | * default the comparison is case-sensitive, but can be made insensitive by |
||
| 361 | * setting $caseSensitive to false. |
||
| 362 | * |
||
| 363 | * @param array $needles SubStrings to look for |
||
| 364 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 365 | * |
||
| 366 | * @return bool Whether or not $str contains $needle |
||
| 367 | */ |
||
| 368 | 43 | View Code Duplication | public function containsAny($needles, $caseSensitive = true) |
| 383 | |||
| 384 | /** |
||
| 385 | * Returns the length of the string, implementing the countable interface. |
||
| 386 | * |
||
| 387 | * @return int The number of characters in the string, given the encoding |
||
| 388 | */ |
||
| 389 | 1 | public function count() |
|
| 393 | |||
| 394 | /** |
||
| 395 | * Returns the number of occurrences of $substring in the given string. |
||
| 396 | * By default, the comparison is case-sensitive, but can be made insensitive |
||
| 397 | * by setting $caseSensitive to false. |
||
| 398 | * |
||
| 399 | * @param string $substring The substring to search for |
||
| 400 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 401 | * |
||
| 402 | * @return int The number of $substring occurrences |
||
| 403 | */ |
||
| 404 | 15 | public function countSubstr($substring, $caseSensitive = true) |
|
| 415 | |||
| 416 | /** |
||
| 417 | * Returns a lowercase and trimmed string separated by dashes. Dashes are |
||
| 418 | * inserted before uppercase characters (with the exception of the first |
||
| 419 | * character of the string), and in place of spaces as well as underscores. |
||
| 420 | * |
||
| 421 | * @return Stringy Object with a dasherized $str |
||
| 422 | */ |
||
| 423 | 19 | public function dasherize() |
|
| 427 | |||
| 428 | /** |
||
| 429 | * Returns a lowercase and trimmed string separated by the given delimiter. |
||
| 430 | * Delimiters are inserted before uppercase characters (with the exception |
||
| 431 | * of the first character of the string), and in place of spaces, dashes, |
||
| 432 | * and underscores. Alpha delimiters are not converted to lowercase. |
||
| 433 | * |
||
| 434 | * @param string $delimiter Sequence used to separate parts of the string |
||
| 435 | * |
||
| 436 | * @return Stringy Object with a delimited $str |
||
| 437 | */ |
||
| 438 | 49 | public function delimit($delimiter) |
|
| 450 | |||
| 451 | /** |
||
| 452 | * Ensures that the string begins with $substring. If it doesn't, it's |
||
| 453 | * prepended. |
||
| 454 | * |
||
| 455 | * @param string $substring The substring to add if not present |
||
| 456 | * |
||
| 457 | * @return Stringy Object with its $str prefixed by the $substring |
||
| 458 | */ |
||
| 459 | 10 | View Code Duplication | public function ensureLeft($substring) |
| 469 | |||
| 470 | /** |
||
| 471 | * Returns true if the string begins with $substring, false otherwise. By |
||
| 472 | * default, the comparison is case-sensitive, but can be made insensitive |
||
| 473 | * by setting $caseSensitive to false. |
||
| 474 | * |
||
| 475 | * @param string $substring The substring to look for |
||
| 476 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 477 | * |
||
| 478 | * @return bool Whether or not $str starts with $substring |
||
| 479 | */ |
||
| 480 | 33 | public function startsWith($substring, $caseSensitive = true) |
|
| 492 | |||
| 493 | /** |
||
| 494 | * Ensures that the string ends with $substring. If it doesn't, it's |
||
| 495 | * appended. |
||
| 496 | * |
||
| 497 | * @param string $substring The substring to add if not present |
||
| 498 | * |
||
| 499 | * @return Stringy Object with its $str suffixed by the $substring |
||
| 500 | */ |
||
| 501 | 10 | View Code Duplication | public function ensureRight($substring) |
| 511 | |||
| 512 | /** |
||
| 513 | * Returns true if the string ends with $substring, false otherwise. By |
||
| 514 | * default, the comparison is case-sensitive, but can be made insensitive |
||
| 515 | * by setting $caseSensitive to false. |
||
| 516 | * |
||
| 517 | * @param string $substring The substring to look for |
||
| 518 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 519 | * |
||
| 520 | * @return bool Whether or not $str ends with $substring |
||
| 521 | */ |
||
| 522 | 33 | public function endsWith($substring, $caseSensitive = true) |
|
| 541 | |||
| 542 | /** |
||
| 543 | * Returns the first $n characters of the string. |
||
| 544 | * |
||
| 545 | * @param int $n Number of characters to retrieve from the start |
||
| 546 | * |
||
| 547 | * @return Stringy Object with its $str being the first $n chars |
||
| 548 | */ |
||
| 549 | 12 | View Code Duplication | public function first($n) |
| 561 | |||
| 562 | /** |
||
| 563 | * Returns the encoding used by the Stringy object. |
||
| 564 | * |
||
| 565 | * @return string The current value of the $encoding property |
||
| 566 | */ |
||
| 567 | 3 | public function getEncoding() |
|
| 571 | |||
| 572 | /** |
||
| 573 | * Returns a new ArrayIterator, thus implementing the IteratorAggregate |
||
| 574 | * interface. The ArrayIterator's constructor is passed an array of chars |
||
| 575 | * in the multibyte string. This enables the use of foreach with instances |
||
| 576 | * of Stringy\Stringy. |
||
| 577 | * |
||
| 578 | * @return \ArrayIterator An iterator for the characters in the string |
||
| 579 | */ |
||
| 580 | 1 | public function getIterator() |
|
| 584 | |||
| 585 | /** |
||
| 586 | * Returns an array consisting of the characters in the string. |
||
| 587 | * |
||
| 588 | * @return array An array of string chars |
||
| 589 | */ |
||
| 590 | 4 | public function chars() |
|
| 602 | |||
| 603 | /** |
||
| 604 | * Returns the character at $index, with indexes starting at 0. |
||
| 605 | * |
||
| 606 | * @param int $index Position of the character |
||
| 607 | * |
||
| 608 | * @return Stringy The character at $index |
||
| 609 | */ |
||
| 610 | 11 | public function at($index) |
|
| 614 | |||
| 615 | /** |
||
| 616 | * Returns true if the string contains a lower case char, false |
||
| 617 | * otherwise. |
||
| 618 | * |
||
| 619 | * @return bool Whether or not the string contains a lower case character. |
||
| 620 | */ |
||
| 621 | 12 | public function hasLowerCase() |
|
| 625 | |||
| 626 | /** |
||
| 627 | * Returns true if $str matches the supplied pattern, false otherwise. |
||
| 628 | * |
||
| 629 | * @param string $pattern Regex pattern to match against |
||
| 630 | * |
||
| 631 | * @return bool Whether or not $str matches the pattern |
||
| 632 | */ |
||
| 633 | 91 | private function matchesPattern($pattern) |
|
| 641 | |||
| 642 | /** |
||
| 643 | * Returns true if the string contains an upper case char, false |
||
| 644 | * otherwise. |
||
| 645 | * |
||
| 646 | * @return bool Whether or not the string contains an upper case character. |
||
| 647 | */ |
||
| 648 | 12 | public function hasUpperCase() |
|
| 652 | |||
| 653 | /** |
||
| 654 | * Convert all HTML entities to their applicable characters. |
||
| 655 | * |
||
| 656 | * @param int|null $flags Optional flags |
||
| 657 | * |
||
| 658 | * @return Stringy Object with the resulting $str after being html decoded. |
||
| 659 | */ |
||
| 660 | 5 | public function htmlDecode($flags = ENT_COMPAT) |
|
| 666 | |||
| 667 | /** |
||
| 668 | * Convert all applicable characters to HTML entities. |
||
| 669 | * |
||
| 670 | * @param int|null $flags Optional flags |
||
| 671 | * |
||
| 672 | * @return Stringy Object with the resulting $str after being html encoded. |
||
| 673 | */ |
||
| 674 | 5 | public function htmlEncode($flags = ENT_COMPAT) |
|
| 680 | |||
| 681 | /** |
||
| 682 | * Capitalizes the first word of the string, replaces underscores with |
||
| 683 | * spaces, and strips '_id'. |
||
| 684 | * |
||
| 685 | * @return Stringy Object with a humanized $str |
||
| 686 | */ |
||
| 687 | 3 | public function humanize() |
|
| 693 | |||
| 694 | /** |
||
| 695 | * Converts the first character of the supplied string to upper case. |
||
| 696 | * |
||
| 697 | * @return Stringy Object with the first character of $str being upper case |
||
| 698 | */ |
||
| 699 | 27 | View Code Duplication | public function upperCaseFirst() |
| 713 | |||
| 714 | /** |
||
| 715 | * Returns the index of the last occurrence of $needle in the string, |
||
| 716 | * and false if not found. Accepts an optional offset from which to begin |
||
| 717 | * the search. Offsets may be negative to count from the last character |
||
| 718 | * in the string. |
||
| 719 | * |
||
| 720 | * @param string $needle Substring to look for |
||
| 721 | * @param int $offset Offset from which to search |
||
| 722 | * |
||
| 723 | * @return int|bool The last occurrence's index if found, otherwise false |
||
| 724 | */ |
||
| 725 | 12 | public function indexOfLast($needle, $offset = 0) |
|
| 729 | |||
| 730 | /** |
||
| 731 | * Inserts $substring into the string at the $index provided. |
||
| 732 | * |
||
| 733 | * @param string $substring String to be inserted |
||
| 734 | * @param int $index The index at which to insert the substring |
||
| 735 | * |
||
| 736 | * @return Stringy Object with the resulting $str after the insertion |
||
| 737 | */ |
||
| 738 | 8 | View Code Duplication | public function insert($substring, $index) |
| 752 | |||
| 753 | /** |
||
| 754 | * Returns true if the string contains only alphabetic chars, false |
||
| 755 | * otherwise. |
||
| 756 | * |
||
| 757 | * @return bool Whether or not $str contains only alphabetic chars |
||
| 758 | */ |
||
| 759 | 10 | public function isAlpha() |
|
| 763 | |||
| 764 | /** |
||
| 765 | * Determine whether the string is considered to be empty. |
||
| 766 | * |
||
| 767 | * A variable is considered empty if it does not exist or if its value equals FALSE. |
||
| 768 | * empty() does not generate a warning if the variable does not exist. |
||
| 769 | * |
||
| 770 | * @return bool |
||
| 771 | */ |
||
| 772 | public function isEmpty() |
||
| 776 | |||
| 777 | /** |
||
| 778 | * Returns true if the string contains only alphabetic and numeric chars, |
||
| 779 | * false otherwise. |
||
| 780 | * |
||
| 781 | * @return bool Whether or not $str contains only alphanumeric chars |
||
| 782 | */ |
||
| 783 | 13 | public function isAlphanumeric() |
|
| 787 | |||
| 788 | /** |
||
| 789 | * Returns true if the string contains only whitespace chars, false |
||
| 790 | * otherwise. |
||
| 791 | * |
||
| 792 | * @return bool Whether or not $str contains only whitespace characters |
||
| 793 | */ |
||
| 794 | 15 | public function isBlank() |
|
| 798 | |||
| 799 | /** |
||
| 800 | * Returns true if the string contains only hexadecimal chars, false |
||
| 801 | * otherwise. |
||
| 802 | * |
||
| 803 | * @return bool Whether or not $str contains only hexadecimal chars |
||
| 804 | */ |
||
| 805 | 13 | public function isHexadecimal() |
|
| 809 | |||
| 810 | /** |
||
| 811 | * Returns true if the string contains HTML-Tags, false otherwise. |
||
| 812 | * |
||
| 813 | * @return bool Whether or not $str contains HTML-Tags |
||
| 814 | */ |
||
| 815 | 1 | public function isHtml() |
|
| 819 | |||
| 820 | /** |
||
| 821 | * Returns true if the string is JSON, false otherwise. Unlike json_decode |
||
| 822 | * in PHP 5.x, this method is consistent with PHP 7 and other JSON parsers, |
||
| 823 | * in that an empty string is not considered valid JSON. |
||
| 824 | * |
||
| 825 | * @return bool Whether or not $str is JSON |
||
| 826 | */ |
||
| 827 | 20 | public function isJson() |
|
| 841 | |||
| 842 | /** |
||
| 843 | * Returns true if the string contains only lower case chars, false |
||
| 844 | * otherwise. |
||
| 845 | * |
||
| 846 | * @return bool Whether or not $str contains only lower case characters |
||
| 847 | */ |
||
| 848 | 8 | public function isLowerCase() |
|
| 856 | |||
| 857 | /** |
||
| 858 | * Returns true if the string is serialized, false otherwise. |
||
| 859 | * |
||
| 860 | * @return bool Whether or not $str is serialized |
||
| 861 | */ |
||
| 862 | 7 | public function isSerialized() |
|
| 879 | |||
| 880 | /** |
||
| 881 | * Returns true if the string contains only lower case chars, false |
||
| 882 | * otherwise. |
||
| 883 | * |
||
| 884 | * @return bool Whether or not $str contains only lower case characters |
||
| 885 | */ |
||
| 886 | 8 | public function isUpperCase() |
|
| 890 | |||
| 891 | /** |
||
| 892 | * Returns the last $n characters of the string. |
||
| 893 | * |
||
| 894 | * @param int $n Number of characters to retrieve from the end |
||
| 895 | * |
||
| 896 | * @return Stringy Object with its $str being the last $n chars |
||
| 897 | */ |
||
| 898 | 12 | View Code Duplication | public function last($n) |
| 910 | |||
| 911 | /** |
||
| 912 | * Splits on newlines and carriage returns, returning an array of Stringy |
||
| 913 | * objects corresponding to the lines in the string. |
||
| 914 | * |
||
| 915 | * @return Stringy[] An array of Stringy objects |
||
| 916 | */ |
||
| 917 | 15 | public function lines() |
|
| 928 | |||
| 929 | /** |
||
| 930 | * Returns the longest common prefix between the string and $otherStr. |
||
| 931 | * |
||
| 932 | * @param string $otherStr Second string for comparison |
||
| 933 | * |
||
| 934 | * @return Stringy Object with its $str being the longest common prefix |
||
| 935 | */ |
||
| 936 | 10 | public function longestCommonPrefix($otherStr) |
|
| 954 | |||
| 955 | /** |
||
| 956 | * Returns the longest common suffix between the string and $otherStr. |
||
| 957 | * |
||
| 958 | * @param string $otherStr Second string for comparison |
||
| 959 | * |
||
| 960 | * @return Stringy Object with its $str being the longest common suffix |
||
| 961 | */ |
||
| 962 | 10 | public function longestCommonSuffix($otherStr) |
|
| 980 | |||
| 981 | /** |
||
| 982 | * Returns the longest common substring between the string and $otherStr. |
||
| 983 | * In the case of ties, it returns that which occurs first. |
||
| 984 | * |
||
| 985 | * @param string $otherStr Second string for comparison |
||
| 986 | * |
||
| 987 | * @return Stringy Object with its $str being the longest common substring |
||
| 988 | */ |
||
| 989 | 10 | public function longestCommonSubstring($otherStr) |
|
| 1033 | |||
| 1034 | /** |
||
| 1035 | * Returns whether or not a character exists at an index. Offsets may be |
||
| 1036 | * negative to count from the last character in the string. Implements |
||
| 1037 | * part of the ArrayAccess interface. |
||
| 1038 | * |
||
| 1039 | * @param mixed $offset The index to check |
||
| 1040 | * |
||
| 1041 | * @return boolean Whether or not the index exists |
||
| 1042 | */ |
||
| 1043 | 6 | public function offsetExists($offset) |
|
| 1055 | |||
| 1056 | /** |
||
| 1057 | * Returns the character at the given index. Offsets may be negative to |
||
| 1058 | * count from the last character in the string. Implements part of the |
||
| 1059 | * ArrayAccess interface, and throws an OutOfBoundsException if the index |
||
| 1060 | * does not exist. |
||
| 1061 | * |
||
| 1062 | * @param mixed $offset The index from which to retrieve the char |
||
| 1063 | * |
||
| 1064 | * @return string The character at the specified index |
||
| 1065 | * @throws \OutOfBoundsException If the positive or negative offset does |
||
| 1066 | * not exist |
||
| 1067 | */ |
||
| 1068 | 2 | public function offsetGet($offset) |
|
| 1084 | |||
| 1085 | /** |
||
| 1086 | * Implements part of the ArrayAccess interface, but throws an exception |
||
| 1087 | * when called. This maintains the immutability of Stringy objects. |
||
| 1088 | * |
||
| 1089 | * @param mixed $offset The index of the character |
||
| 1090 | * @param mixed $value Value to set |
||
| 1091 | * |
||
| 1092 | * @throws \Exception When called |
||
| 1093 | */ |
||
| 1094 | 1 | public function offsetSet($offset, $value) |
|
| 1099 | |||
| 1100 | /** |
||
| 1101 | * Implements part of the ArrayAccess interface, but throws an exception |
||
| 1102 | * when called. This maintains the immutability of Stringy objects. |
||
| 1103 | * |
||
| 1104 | * @param mixed $offset The index of the character |
||
| 1105 | * |
||
| 1106 | * @throws \Exception When called |
||
| 1107 | */ |
||
| 1108 | 1 | public function offsetUnset($offset) |
|
| 1113 | |||
| 1114 | /** |
||
| 1115 | * Pads the string to a given length with $padStr. If length is less than |
||
| 1116 | * or equal to the length of the string, no padding takes places. The |
||
| 1117 | * default string used for padding is a space, and the default type (one of |
||
| 1118 | * 'left', 'right', 'both') is 'right'. Throws an InvalidArgumentException |
||
| 1119 | * if $padType isn't one of those 3 values. |
||
| 1120 | * |
||
| 1121 | * @param int $length Desired string length after padding |
||
| 1122 | * @param string $padStr String used to pad, defaults to space |
||
| 1123 | * @param string $padType One of 'left', 'right', 'both' |
||
| 1124 | * |
||
| 1125 | * @return Stringy Object with a padded $str |
||
| 1126 | * @throws \InvalidArgumentException If $padType isn't one of 'right', 'left' or 'both' |
||
| 1127 | */ |
||
| 1128 | 13 | public function pad($length, $padStr = ' ', $padType = 'right') |
|
| 1145 | |||
| 1146 | /** |
||
| 1147 | * Returns a new string of a given length such that the beginning of the |
||
| 1148 | * string is padded. Alias for pad() with a $padType of 'left'. |
||
| 1149 | * |
||
| 1150 | * @param int $length Desired string length after padding |
||
| 1151 | * @param string $padStr String used to pad, defaults to space |
||
| 1152 | * |
||
| 1153 | * @return Stringy String with left padding |
||
| 1154 | */ |
||
| 1155 | 10 | public function padLeft($length, $padStr = ' ') |
|
| 1159 | |||
| 1160 | /** |
||
| 1161 | * Adds the specified amount of left and right padding to the given string. |
||
| 1162 | * The default character used is a space. |
||
| 1163 | * |
||
| 1164 | * @param int $left Length of left padding |
||
| 1165 | * @param int $right Length of right padding |
||
| 1166 | * @param string $padStr String used to pad |
||
| 1167 | * |
||
| 1168 | * @return Stringy String with padding applied |
||
| 1169 | */ |
||
| 1170 | 37 | private function applyPadding($left = 0, $right = 0, $padStr = ' ') |
|
| 1207 | |||
| 1208 | /** |
||
| 1209 | * Returns a new string of a given length such that the end of the string |
||
| 1210 | * is padded. Alias for pad() with a $padType of 'right'. |
||
| 1211 | * |
||
| 1212 | * @param int $length Desired string length after padding |
||
| 1213 | * @param string $padStr String used to pad, defaults to space |
||
| 1214 | * |
||
| 1215 | * @return Stringy String with right padding |
||
| 1216 | */ |
||
| 1217 | 13 | public function padRight($length, $padStr = ' ') |
|
| 1221 | |||
| 1222 | /** |
||
| 1223 | * Returns a new string of a given length such that both sides of the |
||
| 1224 | * string are padded. Alias for pad() with a $padType of 'both'. |
||
| 1225 | * |
||
| 1226 | * @param int $length Desired string length after padding |
||
| 1227 | * @param string $padStr String used to pad, defaults to space |
||
| 1228 | * |
||
| 1229 | * @return Stringy String with padding applied |
||
| 1230 | */ |
||
| 1231 | 14 | public function padBoth($length, $padStr = ' ') |
|
| 1237 | |||
| 1238 | /** |
||
| 1239 | * Returns a new string starting with $string. |
||
| 1240 | * |
||
| 1241 | * @param string $string The string to append |
||
| 1242 | * |
||
| 1243 | * @return Stringy Object with appended $string |
||
| 1244 | */ |
||
| 1245 | 2 | public function prepend($string) |
|
| 1249 | |||
| 1250 | /** |
||
| 1251 | * Returns a new string with the prefix $substring removed, if present. |
||
| 1252 | * |
||
| 1253 | * @param string $substring The prefix to remove |
||
| 1254 | * |
||
| 1255 | * @return Stringy Object having a $str without the prefix $substring |
||
| 1256 | */ |
||
| 1257 | 12 | View Code Duplication | public function removeLeft($substring) |
| 1269 | |||
| 1270 | /** |
||
| 1271 | * Returns a new string with the suffix $substring removed, if present. |
||
| 1272 | * |
||
| 1273 | * @param string $substring The suffix to remove |
||
| 1274 | * |
||
| 1275 | * @return Stringy Object having a $str without the suffix $substring |
||
| 1276 | */ |
||
| 1277 | 12 | View Code Duplication | public function removeRight($substring) |
| 1289 | |||
| 1290 | /** |
||
| 1291 | * Returns a repeated string given a multiplier. |
||
| 1292 | * |
||
| 1293 | * @param int $multiplier The number of times to repeat the string |
||
| 1294 | * |
||
| 1295 | * @return Stringy Object with a repeated str |
||
| 1296 | */ |
||
| 1297 | 7 | public function repeat($multiplier) |
|
| 1303 | |||
| 1304 | /** |
||
| 1305 | * Replaces all occurrences of $search in $str by $replacement. |
||
| 1306 | * |
||
| 1307 | * @param string $search The needle to search for |
||
| 1308 | * @param string $replacement The string to replace with |
||
| 1309 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 1310 | * |
||
| 1311 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1312 | */ |
||
| 1313 | 28 | View Code Duplication | public function replace($search, $replacement, $caseSensitive = true) |
| 1323 | |||
| 1324 | /** |
||
| 1325 | * Replaces all occurrences of $search in $str by $replacement. |
||
| 1326 | * |
||
| 1327 | * @param array $search The elements to search for |
||
| 1328 | * @param string|array $replacement The string to replace with |
||
| 1329 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 1330 | * |
||
| 1331 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1332 | */ |
||
| 1333 | 30 | View Code Duplication | public function replaceAll(array $search, $replacement, $caseSensitive = true) |
| 1343 | |||
| 1344 | /** |
||
| 1345 | * Replaces all occurrences of $search from the beginning of string with $replacement |
||
| 1346 | * |
||
| 1347 | * @param string $search |
||
| 1348 | * @param string $replacement |
||
| 1349 | * |
||
| 1350 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1351 | */ |
||
| 1352 | 16 | public function replaceBeginning($search, $replacement) |
|
| 1358 | |||
| 1359 | /** |
||
| 1360 | * Replaces all occurrences of $search from the ending of string with $replacement |
||
| 1361 | * |
||
| 1362 | * @param string $search |
||
| 1363 | * @param string $replacement |
||
| 1364 | * |
||
| 1365 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1366 | */ |
||
| 1367 | 16 | public function replaceEnding($search, $replacement) |
|
| 1373 | |||
| 1374 | /** |
||
| 1375 | * Returns a reversed string. A multibyte version of strrev(). |
||
| 1376 | * |
||
| 1377 | * @return Stringy Object with a reversed $str |
||
| 1378 | */ |
||
| 1379 | 5 | public function reverse() |
|
| 1385 | |||
| 1386 | /** |
||
| 1387 | * Truncates the string to a given length, while ensuring that it does not |
||
| 1388 | * split words. If $substring is provided, and truncating occurs, the |
||
| 1389 | * string is further truncated so that the substring may be appended without |
||
| 1390 | * exceeding the desired length. |
||
| 1391 | * |
||
| 1392 | * @param int $length Desired length of the truncated string |
||
| 1393 | * @param string $substring The substring to append if it can fit |
||
| 1394 | * |
||
| 1395 | * @return Stringy Object with the resulting $str after truncating |
||
| 1396 | */ |
||
| 1397 | 22 | public function safeTruncate($length, $substring = '') |
|
| 1422 | |||
| 1423 | /** |
||
| 1424 | * A multibyte string shuffle function. It returns a string with its |
||
| 1425 | * characters in random order. |
||
| 1426 | * |
||
| 1427 | * @return Stringy Object with a shuffled $str |
||
| 1428 | */ |
||
| 1429 | 3 | public function shuffle() |
|
| 1435 | |||
| 1436 | /** |
||
| 1437 | * Converts the string into an URL slug. This includes replacing non-ASCII |
||
| 1438 | * characters with their closest ASCII equivalents, removing remaining |
||
| 1439 | * non-ASCII and non-alphanumeric characters, and replacing whitespace with |
||
| 1440 | * $replacement. The replacement defaults to a single dash, and the string |
||
| 1441 | * is also converted to lowercase. |
||
| 1442 | * |
||
| 1443 | * @param string $replacement The string used to replace whitespace |
||
| 1444 | * @param string $language The language for the url |
||
| 1445 | * @param bool $strToLower string to lower |
||
| 1446 | * |
||
| 1447 | * @return Stringy Object whose $str has been converted to an URL slug |
||
| 1448 | */ |
||
| 1449 | 15 | public function slugify($replacement = '-', $language = 'de', $strToLower = true) |
|
| 1455 | |||
| 1456 | /** |
||
| 1457 | * Remove css media-queries. |
||
| 1458 | * |
||
| 1459 | * @return Stringy |
||
| 1460 | */ |
||
| 1461 | 1 | public function stripeCssMediaQueries() |
|
| 1467 | |||
| 1468 | /** |
||
| 1469 | * Remove empty html-tag. |
||
| 1470 | * |
||
| 1471 | * e.g.: <tag></tag> |
||
| 1472 | * |
||
| 1473 | * @return Stringy |
||
| 1474 | */ |
||
| 1475 | 1 | public function stripeEmptyHtmlTags() |
|
| 1481 | |||
| 1482 | /** |
||
| 1483 | * Converts the string into an valid UTF-8 string. |
||
| 1484 | * |
||
| 1485 | * @return Stringy |
||
| 1486 | */ |
||
| 1487 | 1 | public function utf8ify() |
|
| 1491 | |||
| 1492 | /** |
||
| 1493 | * escape html |
||
| 1494 | * |
||
| 1495 | * @return Stringy |
||
| 1496 | */ |
||
| 1497 | 6 | public function escape() |
|
| 1507 | |||
| 1508 | /** |
||
| 1509 | * Create an extract from a text, so if the search-string was found, it will be centered in the output. |
||
| 1510 | * |
||
| 1511 | * @param string $search |
||
| 1512 | * @param int|null $length |
||
| 1513 | * @param string $ellipsis |
||
| 1514 | * |
||
| 1515 | * @return Stringy |
||
| 1516 | */ |
||
| 1517 | 1 | public function extractText($search = '', $length = null, $ellipsis = '...') |
|
| 1634 | |||
| 1635 | |||
| 1636 | /** |
||
| 1637 | * remove xss from html |
||
| 1638 | * |
||
| 1639 | * @return Stringy |
||
| 1640 | */ |
||
| 1641 | 6 | public function removeXss() |
|
| 1653 | |||
| 1654 | /** |
||
| 1655 | * remove html-break [br | \r\n | \r | \n | ...] |
||
| 1656 | * |
||
| 1657 | * @param string $replacement |
||
| 1658 | * |
||
| 1659 | * @return Stringy |
||
| 1660 | */ |
||
| 1661 | 6 | public function removeHtmlBreak($replacement = '') |
|
| 1667 | |||
| 1668 | /** |
||
| 1669 | * remove html |
||
| 1670 | * |
||
| 1671 | * @param $allowableTags |
||
| 1672 | * |
||
| 1673 | * @return Stringy |
||
| 1674 | */ |
||
| 1675 | 6 | public function removeHtml($allowableTags = null) |
|
| 1681 | |||
| 1682 | /** |
||
| 1683 | * Returns the substring beginning at $start, and up to, but not including |
||
| 1684 | * the index specified by $end. If $end is omitted, the function extracts |
||
| 1685 | * the remaining string. If $end is negative, it is computed from the end |
||
| 1686 | * of the string. |
||
| 1687 | * |
||
| 1688 | * @param int $start Initial index from which to begin extraction |
||
| 1689 | * @param int $end Optional index at which to end extraction |
||
| 1690 | * |
||
| 1691 | * @return Stringy Object with its $str being the extracted substring |
||
| 1692 | */ |
||
| 1693 | 18 | public function slice($start, $end = null) |
|
| 1709 | |||
| 1710 | /** |
||
| 1711 | * Splits the string with the provided regular expression, returning an |
||
| 1712 | * array of Stringy objects. An optional integer $limit will truncate the |
||
| 1713 | * results. |
||
| 1714 | * |
||
| 1715 | * @param string $pattern The regex with which to split the string |
||
| 1716 | * @param int $limit Optional maximum number of results to return |
||
| 1717 | * |
||
| 1718 | * @return Stringy[] An array of Stringy objects |
||
| 1719 | */ |
||
| 1720 | 19 | public function split($pattern, $limit = null) |
|
| 1754 | |||
| 1755 | /** |
||
| 1756 | * Surrounds $str with the given substring. |
||
| 1757 | * |
||
| 1758 | * @param string $substring The substring to add to both sides |
||
| 1759 | * |
||
| 1760 | * @return Stringy Object whose $str had the substring both prepended and |
||
| 1761 | * appended |
||
| 1762 | */ |
||
| 1763 | 5 | public function surround($substring) |
|
| 1769 | |||
| 1770 | /** |
||
| 1771 | * Returns a case swapped version of the string. |
||
| 1772 | * |
||
| 1773 | * @return Stringy Object whose $str has each character's case swapped |
||
| 1774 | */ |
||
| 1775 | 5 | public function swapCase() |
|
| 1783 | |||
| 1784 | /** |
||
| 1785 | * Returns a string with smart quotes, ellipsis characters, and dashes from |
||
| 1786 | * Windows-1252 (commonly used in Word documents) replaced by their ASCII |
||
| 1787 | * equivalents. |
||
| 1788 | * |
||
| 1789 | * @return Stringy Object whose $str has those characters removed |
||
| 1790 | */ |
||
| 1791 | 4 | public function tidy() |
|
| 1797 | |||
| 1798 | /** |
||
| 1799 | * Returns a trimmed string with the first letter of each word capitalized. |
||
| 1800 | * Also accepts an array, $ignore, allowing you to list words not to be |
||
| 1801 | * capitalized. |
||
| 1802 | * |
||
| 1803 | * @param array $ignore An array of words not to capitalize |
||
| 1804 | * |
||
| 1805 | * @return Stringy Object with a titleized $str |
||
| 1806 | */ |
||
| 1807 | 5 | public function titleize($ignore = null) |
|
| 1828 | |||
| 1829 | /** |
||
| 1830 | * Converts all characters in the string to lowercase. An alias for PHP's |
||
| 1831 | * UTF8::strtolower(). |
||
| 1832 | * |
||
| 1833 | * @return Stringy Object with all characters of $str being lowercase |
||
| 1834 | */ |
||
| 1835 | 27 | public function toLowerCase() |
|
| 1841 | |||
| 1842 | /** |
||
| 1843 | * Returns true if the string is base64 encoded, false otherwise. |
||
| 1844 | * |
||
| 1845 | * @return bool Whether or not $str is base64 encoded |
||
| 1846 | */ |
||
| 1847 | 7 | public function isBase64() |
|
| 1851 | |||
| 1852 | /** |
||
| 1853 | * Returns an ASCII version of the string. A set of non-ASCII characters are |
||
| 1854 | * replaced with their closest ASCII counterparts, and the rest are removed |
||
| 1855 | * unless instructed otherwise. |
||
| 1856 | * |
||
| 1857 | * @param $strict [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad performance</p> |
||
| 1858 | * |
||
| 1859 | * @return Stringy Object whose $str contains only ASCII characters |
||
| 1860 | */ |
||
| 1861 | 16 | public function toAscii($strict = false) |
|
| 1867 | |||
| 1868 | /** |
||
| 1869 | * Returns a boolean representation of the given logical string value. |
||
| 1870 | * For example, 'true', '1', 'on' and 'yes' will return true. 'false', '0', |
||
| 1871 | * 'off', and 'no' will return false. In all instances, case is ignored. |
||
| 1872 | * For other numeric strings, their sign will determine the return value. |
||
| 1873 | * In addition, blank strings consisting of only whitespace will return |
||
| 1874 | * false. For all other strings, the return value is a result of a |
||
| 1875 | * boolean cast. |
||
| 1876 | * |
||
| 1877 | * @return bool A boolean value for the string |
||
| 1878 | */ |
||
| 1879 | 15 | public function toBoolean() |
|
| 1901 | |||
| 1902 | /** |
||
| 1903 | * Return Stringy object as string, but you can also use (string) for automatically casting the object into a string. |
||
| 1904 | * |
||
| 1905 | * @return string |
||
| 1906 | */ |
||
| 1907 | 967 | public function toString() |
|
| 1911 | |||
| 1912 | /** |
||
| 1913 | * Converts each tab in the string to some number of spaces, as defined by |
||
| 1914 | * $tabLength. By default, each tab is converted to 4 consecutive spaces. |
||
| 1915 | * |
||
| 1916 | * @param int $tabLength Number of spaces to replace each tab with |
||
| 1917 | * |
||
| 1918 | * @return Stringy Object whose $str has had tabs switched to spaces |
||
| 1919 | */ |
||
| 1920 | 6 | View Code Duplication | public function toSpaces($tabLength = 4) |
| 1927 | |||
| 1928 | /** |
||
| 1929 | * Converts each occurrence of some consecutive number of spaces, as |
||
| 1930 | * defined by $tabLength, to a tab. By default, each 4 consecutive spaces |
||
| 1931 | * are converted to a tab. |
||
| 1932 | * |
||
| 1933 | * @param int $tabLength Number of spaces to replace with a tab |
||
| 1934 | * |
||
| 1935 | * @return Stringy Object whose $str has had spaces switched to tabs |
||
| 1936 | */ |
||
| 1937 | 5 | View Code Duplication | public function toTabs($tabLength = 4) |
| 1944 | |||
| 1945 | /** |
||
| 1946 | * Converts the first character of each word in the string to uppercase. |
||
| 1947 | * |
||
| 1948 | * @return Stringy Object with all characters of $str being title-cased |
||
| 1949 | */ |
||
| 1950 | 5 | public function toTitleCase() |
|
| 1957 | |||
| 1958 | /** |
||
| 1959 | * Converts all characters in the string to uppercase. An alias for PHP's |
||
| 1960 | * UTF8::strtoupper(). |
||
| 1961 | * |
||
| 1962 | * @return Stringy Object with all characters of $str being uppercase |
||
| 1963 | */ |
||
| 1964 | 5 | public function toUpperCase() |
|
| 1970 | |||
| 1971 | /** |
||
| 1972 | * Returns a string with whitespace removed from the start of the string. |
||
| 1973 | * Supports the removal of unicode whitespace. Accepts an optional |
||
| 1974 | * string of characters to strip instead of the defaults. |
||
| 1975 | * |
||
| 1976 | * @param string $chars Optional string of characters to strip |
||
| 1977 | * |
||
| 1978 | * @return Stringy Object with a trimmed $str |
||
| 1979 | */ |
||
| 1980 | 13 | View Code Duplication | public function trimLeft($chars = null) |
| 1990 | |||
| 1991 | /** |
||
| 1992 | * Returns a string with whitespace removed from the end of the string. |
||
| 1993 | * Supports the removal of unicode whitespace. Accepts an optional |
||
| 1994 | * string of characters to strip instead of the defaults. |
||
| 1995 | * |
||
| 1996 | * @param string $chars Optional string of characters to strip |
||
| 1997 | * |
||
| 1998 | * @return Stringy Object with a trimmed $str |
||
| 1999 | */ |
||
| 2000 | 13 | View Code Duplication | public function trimRight($chars = null) |
| 2010 | |||
| 2011 | /** |
||
| 2012 | * Truncates the string to a given length. If $substring is provided, and |
||
| 2013 | * truncating occurs, the string is further truncated so that the substring |
||
| 2014 | * may be appended without exceeding the desired length. |
||
| 2015 | * |
||
| 2016 | * @param int $length Desired length of the truncated string |
||
| 2017 | * @param string $substring The substring to append if it can fit |
||
| 2018 | * |
||
| 2019 | * @return Stringy Object with the resulting $str after truncating |
||
| 2020 | */ |
||
| 2021 | 22 | View Code Duplication | public function truncate($length, $substring = '') |
| 2037 | |||
| 2038 | /** |
||
| 2039 | * Returns a lowercase and trimmed string separated by underscores. |
||
| 2040 | * Underscores are inserted before uppercase characters (with the exception |
||
| 2041 | * of the first character of the string), and in place of spaces as well as |
||
| 2042 | * dashes. |
||
| 2043 | * |
||
| 2044 | * @return Stringy Object with an underscored $str |
||
| 2045 | */ |
||
| 2046 | 16 | public function underscored() |
|
| 2050 | |||
| 2051 | /** |
||
| 2052 | * Returns an UpperCamelCase version of the supplied string. It trims |
||
| 2053 | * surrounding spaces, capitalizes letters following digits, spaces, dashes |
||
| 2054 | * and underscores, and removes spaces, dashes, underscores. |
||
| 2055 | * |
||
| 2056 | * @return Stringy Object with $str in UpperCamelCase |
||
| 2057 | */ |
||
| 2058 | 13 | public function upperCamelize() |
|
| 2062 | |||
| 2063 | /** |
||
| 2064 | * Returns a camelCase version of the string. Trims surrounding spaces, |
||
| 2065 | * capitalizes letters following digits, spaces, dashes and underscores, |
||
| 2066 | * and removes spaces, dashes, as well as underscores. |
||
| 2067 | * |
||
| 2068 | * @return Stringy Object with $str in camelCase |
||
| 2069 | */ |
||
| 2070 | 32 | public function camelize() |
|
| 2098 | |||
| 2099 | /** |
||
| 2100 | * Convert a string to e.g.: "snake_case" |
||
| 2101 | * |
||
| 2102 | * @return Stringy Object with $str in snake_case |
||
| 2103 | */ |
||
| 2104 | 20 | public function snakeize() |
|
| 2147 | |||
| 2148 | /** |
||
| 2149 | * Converts the first character of the string to lower case. |
||
| 2150 | * |
||
| 2151 | * @return Stringy Object with the first character of $str being lower case |
||
| 2152 | */ |
||
| 2153 | 37 | View Code Duplication | public function lowerCaseFirst() |
| 2162 | |||
| 2163 | /** |
||
| 2164 | * Shorten the string after $length, but also after the next word. |
||
| 2165 | * |
||
| 2166 | * @param int $length |
||
| 2167 | * @param string $strAddOn |
||
| 2168 | * |
||
| 2169 | * @return Stringy |
||
| 2170 | */ |
||
| 2171 | 4 | public function shortenAfterWord($length, $strAddOn = '...') |
|
| 2177 | |||
| 2178 | /** |
||
| 2179 | * Line-Wrap the string after $limit, but also after the next word. |
||
| 2180 | * |
||
| 2181 | * @param int $limit |
||
| 2182 | * |
||
| 2183 | * @return Stringy |
||
| 2184 | */ |
||
| 2185 | 1 | public function lineWrapAfterWord($limit) |
|
| 2197 | |||
| 2198 | /** |
||
| 2199 | * Gets the substring after the first occurrence of a separator. |
||
| 2200 | * If no match is found returns new empty Stringy object. |
||
| 2201 | * |
||
| 2202 | * @param string $separator |
||
| 2203 | * |
||
| 2204 | * @return Stringy |
||
| 2205 | */ |
||
| 2206 | 1 | View Code Duplication | public function afterFirst($separator) |
| 2222 | |||
| 2223 | /** |
||
| 2224 | * Gets the substring after the last occurrence of a separator. |
||
| 2225 | * If no match is found returns new empty Stringy object. |
||
| 2226 | * |
||
| 2227 | * @param string $separator |
||
| 2228 | * |
||
| 2229 | * @return Stringy |
||
| 2230 | */ |
||
| 2231 | 1 | View Code Duplication | public function afterLast($separator) |
| 2248 | |||
| 2249 | /** |
||
| 2250 | * Gets the substring before the first occurrence of a separator. |
||
| 2251 | * If no match is found returns new empty Stringy object. |
||
| 2252 | * |
||
| 2253 | * @param string $separator |
||
| 2254 | * |
||
| 2255 | * @return Stringy |
||
| 2256 | */ |
||
| 2257 | 1 | View Code Duplication | public function beforeFirst($separator) |
| 2274 | |||
| 2275 | /** |
||
| 2276 | * Gets the substring before the last occurrence of a separator. |
||
| 2277 | * If no match is found returns new empty Stringy object. |
||
| 2278 | * |
||
| 2279 | * @param string $separator |
||
| 2280 | * |
||
| 2281 | * @return Stringy |
||
| 2282 | */ |
||
| 2283 | 1 | View Code Duplication | public function beforeLast($separator) |
| 2300 | } |
||
| 2301 |
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: