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 | 1014 | 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 | 972 | 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 | 1004 | 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 marketing the end of the substring |
||
189 | * @param int $offset Index from which to begin the search |
||
190 | * |
||
191 | * @return Stringy Object whose $str has been converted to an URL slug |
||
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 | 26 | 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 | 248 | 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) |
|
495 | |||
496 | /** |
||
497 | * Ensures that the string ends with $substring. If it doesn't, it's |
||
498 | * appended. |
||
499 | * |
||
500 | * @param string $substring The substring to add if not present |
||
501 | * |
||
502 | * @return Stringy Object with its $str suffixed by the $substring |
||
503 | */ |
||
504 | 10 | View Code Duplication | public function ensureRight($substring) |
514 | |||
515 | /** |
||
516 | * Returns true if the string ends with $substring, false otherwise. By |
||
517 | * default, the comparison is case-sensitive, but can be made insensitive |
||
518 | * by setting $caseSensitive to false. |
||
519 | * |
||
520 | * @param string $substring The substring to look for |
||
521 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
522 | * |
||
523 | * @return bool Whether or not $str ends with $substring |
||
524 | */ |
||
525 | 33 | public function endsWith($substring, $caseSensitive = true) |
|
544 | |||
545 | /** |
||
546 | * Returns the first $n characters of the string. |
||
547 | * |
||
548 | * @param int $n Number of characters to retrieve from the start |
||
549 | * |
||
550 | * @return Stringy Object with its $str being the first $n chars |
||
551 | */ |
||
552 | 12 | View Code Duplication | public function first($n) |
564 | |||
565 | /** |
||
566 | * Returns the encoding used by the Stringy object. |
||
567 | * |
||
568 | * @return string The current value of the $encoding property |
||
569 | */ |
||
570 | 3 | public function getEncoding() |
|
574 | |||
575 | /** |
||
576 | * Returns a new ArrayIterator, thus implementing the IteratorAggregate |
||
577 | * interface. The ArrayIterator's constructor is passed an array of chars |
||
578 | * in the multibyte string. This enables the use of foreach with instances |
||
579 | * of Stringy\Stringy. |
||
580 | * |
||
581 | * @return \ArrayIterator An iterator for the characters in the string |
||
582 | */ |
||
583 | 1 | public function getIterator() |
|
587 | |||
588 | /** |
||
589 | * Returns an array consisting of the characters in the string. |
||
590 | * |
||
591 | * @return array An array of string chars |
||
592 | */ |
||
593 | 4 | public function chars() |
|
605 | |||
606 | /** |
||
607 | * Returns the character at $index, with indexes starting at 0. |
||
608 | * |
||
609 | * @param int $index Position of the character |
||
610 | * |
||
611 | * @return Stringy The character at $index |
||
612 | */ |
||
613 | 11 | public function at($index) |
|
617 | |||
618 | /** |
||
619 | * Returns true if the string contains a lower case char, false |
||
620 | * otherwise. |
||
621 | * |
||
622 | * @return bool Whether or not the string contains a lower case character. |
||
623 | */ |
||
624 | 12 | public function hasLowerCase() |
|
628 | |||
629 | /** |
||
630 | * Returns true if $str matches the supplied pattern, false otherwise. |
||
631 | * |
||
632 | * @param string $pattern Regex pattern to match against |
||
633 | * |
||
634 | * @return bool Whether or not $str matches the pattern |
||
635 | */ |
||
636 | 91 | private function matchesPattern($pattern) |
|
644 | |||
645 | /** |
||
646 | * Returns true if the string contains an upper case char, false |
||
647 | * otherwise. |
||
648 | * |
||
649 | * @return bool Whether or not the string contains an upper case character. |
||
650 | */ |
||
651 | 12 | public function hasUpperCase() |
|
655 | |||
656 | /** |
||
657 | * Convert all HTML entities to their applicable characters. |
||
658 | * |
||
659 | * @param int|null $flags Optional flags |
||
660 | * |
||
661 | * @return Stringy Object with the resulting $str after being html decoded. |
||
662 | */ |
||
663 | 5 | public function htmlDecode($flags = ENT_COMPAT) |
|
669 | |||
670 | /** |
||
671 | * Convert all applicable characters to HTML entities. |
||
672 | * |
||
673 | * @param int|null $flags Optional flags |
||
674 | * |
||
675 | * @return Stringy Object with the resulting $str after being html encoded. |
||
676 | */ |
||
677 | 5 | public function htmlEncode($flags = ENT_COMPAT) |
|
683 | |||
684 | /** |
||
685 | * Capitalizes the first word of the string, replaces underscores with |
||
686 | * spaces, and strips '_id'. |
||
687 | * |
||
688 | * @return Stringy Object with a humanized $str |
||
689 | */ |
||
690 | 3 | public function humanize() |
|
696 | |||
697 | /** |
||
698 | * Converts the first character of the supplied string to upper case. |
||
699 | * |
||
700 | * @return Stringy Object with the first character of $str being upper case |
||
701 | */ |
||
702 | 27 | View Code Duplication | public function upperCaseFirst() |
716 | |||
717 | /** |
||
718 | * Returns the index of the last occurrence of $needle in the string, |
||
719 | * and false if not found. Accepts an optional offset from which to begin |
||
720 | * the search. Offsets may be negative to count from the last character |
||
721 | * in the string. |
||
722 | * |
||
723 | * @param string $needle Substring to look for |
||
724 | * @param int $offset Offset from which to search |
||
725 | * |
||
726 | * @return int|bool The last occurrence's index if found, otherwise false |
||
727 | */ |
||
728 | 10 | public function indexOfLast($needle, $offset = 0) |
|
732 | |||
733 | /** |
||
734 | * Inserts $substring into the string at the $index provided. |
||
735 | * |
||
736 | * @param string $substring String to be inserted |
||
737 | * @param int $index The index at which to insert the substring |
||
738 | * |
||
739 | * @return Stringy Object with the resulting $str after the insertion |
||
740 | */ |
||
741 | 8 | View Code Duplication | public function insert($substring, $index) |
758 | |||
759 | /** |
||
760 | * Returns true if the string contains only alphabetic chars, false |
||
761 | * otherwise. |
||
762 | * |
||
763 | * @return bool Whether or not $str contains only alphabetic chars |
||
764 | */ |
||
765 | 10 | public function isAlpha() |
|
769 | |||
770 | /** |
||
771 | * Returns true if the string contains only alphabetic and numeric chars, |
||
772 | * false otherwise. |
||
773 | * |
||
774 | * @return bool Whether or not $str contains only alphanumeric chars |
||
775 | */ |
||
776 | 13 | public function isAlphanumeric() |
|
780 | |||
781 | /** |
||
782 | * Returns true if the string contains only whitespace chars, false |
||
783 | * otherwise. |
||
784 | * |
||
785 | * @return bool Whether or not $str contains only whitespace characters |
||
786 | */ |
||
787 | 15 | public function isBlank() |
|
791 | |||
792 | /** |
||
793 | * Returns true if the string contains only hexadecimal chars, false |
||
794 | * otherwise. |
||
795 | * |
||
796 | * @return bool Whether or not $str contains only hexadecimal chars |
||
797 | */ |
||
798 | 13 | public function isHexadecimal() |
|
802 | |||
803 | /** |
||
804 | * Returns true if the string is JSON, false otherwise. Unlike json_decode |
||
805 | * in PHP 5.x, this method is consistent with PHP 7 and other JSON parsers, |
||
806 | * in that an empty string is not considered valid JSON. |
||
807 | * |
||
808 | * @return bool Whether or not $str is JSON |
||
809 | */ |
||
810 | 20 | public function isJson() |
|
824 | |||
825 | /** |
||
826 | * Returns true if the string contains only lower case chars, false |
||
827 | * otherwise. |
||
828 | * |
||
829 | * @return bool Whether or not $str contains only lower case characters |
||
830 | */ |
||
831 | 8 | public function isLowerCase() |
|
839 | |||
840 | /** |
||
841 | * Returns true if the string is serialized, false otherwise. |
||
842 | * |
||
843 | * @return bool Whether or not $str is serialized |
||
844 | */ |
||
845 | 7 | public function isSerialized() |
|
862 | |||
863 | /** |
||
864 | * Returns true if the string contains only lower case chars, false |
||
865 | * otherwise. |
||
866 | * |
||
867 | * @return bool Whether or not $str contains only lower case characters |
||
868 | */ |
||
869 | 8 | public function isUpperCase() |
|
873 | |||
874 | /** |
||
875 | * Returns the last $n characters of the string. |
||
876 | * |
||
877 | * @param int $n Number of characters to retrieve from the end |
||
878 | * |
||
879 | * @return Stringy Object with its $str being the last $n chars |
||
880 | */ |
||
881 | 12 | View Code Duplication | public function last($n) |
893 | |||
894 | /** |
||
895 | * Splits on newlines and carriage returns, returning an array of Stringy |
||
896 | * objects corresponding to the lines in the string. |
||
897 | * |
||
898 | * @return Stringy[] An array of Stringy objects |
||
899 | */ |
||
900 | 15 | public function lines() |
|
911 | |||
912 | /** |
||
913 | * Returns the longest common prefix between the string and $otherStr. |
||
914 | * |
||
915 | * @param string $otherStr Second string for comparison |
||
916 | * |
||
917 | * @return Stringy Object with its $str being the longest common prefix |
||
918 | */ |
||
919 | 10 | public function longestCommonPrefix($otherStr) |
|
937 | |||
938 | /** |
||
939 | * Returns the longest common suffix between the string and $otherStr. |
||
940 | * |
||
941 | * @param string $otherStr Second string for comparison |
||
942 | * |
||
943 | * @return Stringy Object with its $str being the longest common suffix |
||
944 | */ |
||
945 | 10 | public function longestCommonSuffix($otherStr) |
|
963 | |||
964 | /** |
||
965 | * Returns the longest common substring between the string and $otherStr. |
||
966 | * In the case of ties, it returns that which occurs first. |
||
967 | * |
||
968 | * @param string $otherStr Second string for comparison |
||
969 | * |
||
970 | * @return Stringy Object with its $str being the longest common substring |
||
971 | */ |
||
972 | 10 | public function longestCommonSubstring($otherStr) |
|
1016 | |||
1017 | /** |
||
1018 | * Returns whether or not a character exists at an index. Offsets may be |
||
1019 | * negative to count from the last character in the string. Implements |
||
1020 | * part of the ArrayAccess interface. |
||
1021 | * |
||
1022 | * @param mixed $offset The index to check |
||
1023 | * |
||
1024 | * @return boolean Whether or not the index exists |
||
1025 | */ |
||
1026 | 6 | public function offsetExists($offset) |
|
1038 | |||
1039 | /** |
||
1040 | * Returns the character at the given index. Offsets may be negative to |
||
1041 | * count from the last character in the string. Implements part of the |
||
1042 | * ArrayAccess interface, and throws an OutOfBoundsException if the index |
||
1043 | * does not exist. |
||
1044 | * |
||
1045 | * @param mixed $offset The index from which to retrieve the char |
||
1046 | * |
||
1047 | * @return string The character at the specified index |
||
1048 | * @throws \OutOfBoundsException If the positive or negative offset does |
||
1049 | * not exist |
||
1050 | */ |
||
1051 | 2 | public function offsetGet($offset) |
|
1067 | |||
1068 | /** |
||
1069 | * Implements part of the ArrayAccess interface, but throws an exception |
||
1070 | * when called. This maintains the immutability of Stringy objects. |
||
1071 | * |
||
1072 | * @param mixed $offset The index of the character |
||
1073 | * @param mixed $value Value to set |
||
1074 | * |
||
1075 | * @throws \Exception When called |
||
1076 | */ |
||
1077 | 1 | public function offsetSet($offset, $value) |
|
1082 | |||
1083 | /** |
||
1084 | * Implements part of the ArrayAccess interface, but throws an exception |
||
1085 | * when called. This maintains the immutability of Stringy objects. |
||
1086 | * |
||
1087 | * @param mixed $offset The index of the character |
||
1088 | * |
||
1089 | * @throws \Exception When called |
||
1090 | */ |
||
1091 | 1 | public function offsetUnset($offset) |
|
1096 | |||
1097 | /** |
||
1098 | * Pads the string to a given length with $padStr. If length is less than |
||
1099 | * or equal to the length of the string, no padding takes places. The |
||
1100 | * default string used for padding is a space, and the default type (one of |
||
1101 | * 'left', 'right', 'both') is 'right'. Throws an InvalidArgumentException |
||
1102 | * if $padType isn't one of those 3 values. |
||
1103 | * |
||
1104 | * @param int $length Desired string length after padding |
||
1105 | * @param string $padStr String used to pad, defaults to space |
||
1106 | * @param string $padType One of 'left', 'right', 'both' |
||
1107 | * |
||
1108 | * @return Stringy Object with a padded $str |
||
1109 | * @throws \InvalidArgumentException If $padType isn't one of 'right', 'left' or 'both' |
||
1110 | */ |
||
1111 | 13 | public function pad($length, $padStr = ' ', $padType = 'right') |
|
1128 | |||
1129 | /** |
||
1130 | * Returns a new string of a given length such that the beginning of the |
||
1131 | * string is padded. Alias for pad() with a $padType of 'left'. |
||
1132 | * |
||
1133 | * @param int $length Desired string length after padding |
||
1134 | * @param string $padStr String used to pad, defaults to space |
||
1135 | * |
||
1136 | * @return Stringy String with left padding |
||
1137 | */ |
||
1138 | 10 | public function padLeft($length, $padStr = ' ') |
|
1142 | |||
1143 | /** |
||
1144 | * Adds the specified amount of left and right padding to the given string. |
||
1145 | * The default character used is a space. |
||
1146 | * |
||
1147 | * @param int $left Length of left padding |
||
1148 | * @param int $right Length of right padding |
||
1149 | * @param string $padStr String used to pad |
||
1150 | * |
||
1151 | * @return Stringy String with padding applied |
||
1152 | */ |
||
1153 | 37 | private function applyPadding($left = 0, $right = 0, $padStr = ' ') |
|
1190 | |||
1191 | /** |
||
1192 | * Returns a new string of a given length such that the end of the string |
||
1193 | * is padded. Alias for pad() with a $padType of 'right'. |
||
1194 | * |
||
1195 | * @param int $length Desired string length after padding |
||
1196 | * @param string $padStr String used to pad, defaults to space |
||
1197 | * |
||
1198 | * @return Stringy String with right padding |
||
1199 | */ |
||
1200 | 13 | public function padRight($length, $padStr = ' ') |
|
1204 | |||
1205 | /** |
||
1206 | * Returns a new string of a given length such that both sides of the |
||
1207 | * string are padded. Alias for pad() with a $padType of 'both'. |
||
1208 | * |
||
1209 | * @param int $length Desired string length after padding |
||
1210 | * @param string $padStr String used to pad, defaults to space |
||
1211 | * |
||
1212 | * @return Stringy String with padding applied |
||
1213 | */ |
||
1214 | 14 | public function padBoth($length, $padStr = ' ') |
|
1220 | |||
1221 | /** |
||
1222 | * Returns a new string starting with $string. |
||
1223 | * |
||
1224 | * @param string $string The string to append |
||
1225 | * |
||
1226 | * @return Stringy Object with appended $string |
||
1227 | */ |
||
1228 | 2 | public function prepend($string) |
|
1232 | |||
1233 | /** |
||
1234 | * Returns a new string with the prefix $substring removed, if present. |
||
1235 | * |
||
1236 | * @param string $substring The prefix to remove |
||
1237 | * |
||
1238 | * @return Stringy Object having a $str without the prefix $substring |
||
1239 | */ |
||
1240 | 12 | View Code Duplication | public function removeLeft($substring) |
1252 | |||
1253 | /** |
||
1254 | * Returns a new string with the suffix $substring removed, if present. |
||
1255 | * |
||
1256 | * @param string $substring The suffix to remove |
||
1257 | * |
||
1258 | * @return Stringy Object having a $str without the suffix $substring |
||
1259 | */ |
||
1260 | 12 | View Code Duplication | public function removeRight($substring) |
1272 | |||
1273 | /** |
||
1274 | * Returns a repeated string given a multiplier. |
||
1275 | * |
||
1276 | * @param int $multiplier The number of times to repeat the string |
||
1277 | * |
||
1278 | * @return Stringy Object with a repeated str |
||
1279 | */ |
||
1280 | 7 | public function repeat($multiplier) |
|
1286 | |||
1287 | /** |
||
1288 | * Replaces all occurrences of $search in $str by $replacement. |
||
1289 | * |
||
1290 | * @param string $search The needle to search for |
||
1291 | * @param string $replacement The string to replace with |
||
1292 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
1293 | * |
||
1294 | * @return Stringy Object with the resulting $str after the replacements |
||
1295 | */ |
||
1296 | 28 | View Code Duplication | public function replace($search, $replacement, $caseSensitive = true) |
1306 | |||
1307 | /** |
||
1308 | * Replaces all occurrences of $search in $str by $replacement. |
||
1309 | * |
||
1310 | * @param array $search The elements to search for |
||
1311 | * @param string|array $replacement The string to replace with |
||
1312 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
1313 | * |
||
1314 | * @return Stringy Object with the resulting $str after the replacements |
||
1315 | */ |
||
1316 | 30 | View Code Duplication | public function replaceAll(array $search, $replacement, $caseSensitive = true) |
1326 | |||
1327 | /** |
||
1328 | * Replaces all occurrences of $search from the beginning of string with $replacement |
||
1329 | * |
||
1330 | * @param string $search |
||
1331 | * @param string $replacement |
||
1332 | * |
||
1333 | * @return Stringy Object with the resulting $str after the replacements |
||
1334 | */ |
||
1335 | 16 | public function replaceBeginning($search, $replacement) |
|
1341 | |||
1342 | /** |
||
1343 | * Replaces all occurrences of $search from the ending of string with $replacement |
||
1344 | * |
||
1345 | * @param string $search |
||
1346 | * @param string $replacement |
||
1347 | * |
||
1348 | * @return Stringy Object with the resulting $str after the replacements |
||
1349 | */ |
||
1350 | 16 | public function replaceEnding($search, $replacement) |
|
1356 | |||
1357 | /** |
||
1358 | * Returns a reversed string. A multibyte version of strrev(). |
||
1359 | * |
||
1360 | * @return Stringy Object with a reversed $str |
||
1361 | */ |
||
1362 | 5 | public function reverse() |
|
1368 | |||
1369 | /** |
||
1370 | * Truncates the string to a given length, while ensuring that it does not |
||
1371 | * split words. If $substring is provided, and truncating occurs, the |
||
1372 | * string is further truncated so that the substring may be appended without |
||
1373 | * exceeding the desired length. |
||
1374 | * |
||
1375 | * @param int $length Desired length of the truncated string |
||
1376 | * @param string $substring The substring to append if it can fit |
||
1377 | * |
||
1378 | * @return Stringy Object with the resulting $str after truncating |
||
1379 | */ |
||
1380 | 22 | public function safeTruncate($length, $substring = '') |
|
1405 | |||
1406 | /** |
||
1407 | * A multibyte string shuffle function. It returns a string with its |
||
1408 | * characters in random order. |
||
1409 | * |
||
1410 | * @return Stringy Object with a shuffled $str |
||
1411 | */ |
||
1412 | 3 | public function shuffle() |
|
1418 | |||
1419 | /** |
||
1420 | * Converts the string into an URL slug. This includes replacing non-ASCII |
||
1421 | * characters with their closest ASCII equivalents, removing remaining |
||
1422 | * non-ASCII and non-alphanumeric characters, and replacing whitespace with |
||
1423 | * $replacement. The replacement defaults to a single dash, and the string |
||
1424 | * is also converted to lowercase. |
||
1425 | * |
||
1426 | * @param string $replacement The string used to replace whitespace |
||
1427 | * @param string $language The language for the url |
||
1428 | * @param bool $strToLower string to lower |
||
1429 | * |
||
1430 | * @return Stringy Object whose $str has been converted to an URL slug |
||
1431 | */ |
||
1432 | 15 | public function slugify($replacement = '-', $language = 'de', $strToLower = true) |
|
1438 | |||
1439 | /** |
||
1440 | * Remove css media-queries. |
||
1441 | * |
||
1442 | * @return Stringy |
||
1443 | */ |
||
1444 | 1 | public function stripeCssMediaQueries() |
|
1449 | |||
1450 | /** |
||
1451 | * Remove empty html-tag. |
||
1452 | * |
||
1453 | * e.g.: <tag></tag> |
||
1454 | * |
||
1455 | * @return Stringy |
||
1456 | */ |
||
1457 | 1 | public function stripeEmptyHtmlTags() |
|
1463 | |||
1464 | /** |
||
1465 | * Converts the string into an valid UTF-8 string. |
||
1466 | * |
||
1467 | * @return Stringy |
||
1468 | */ |
||
1469 | 1 | public function utf8ify() |
|
1473 | |||
1474 | /** |
||
1475 | * escape html |
||
1476 | * |
||
1477 | * @return Stringy |
||
1478 | */ |
||
1479 | 6 | public function escape() |
|
1489 | |||
1490 | /** |
||
1491 | * remove xss from html |
||
1492 | * |
||
1493 | * @return Stringy |
||
1494 | */ |
||
1495 | 6 | public function removeXss() |
|
1507 | |||
1508 | /** |
||
1509 | * remove html-break [br | \r\n | \r | \n | ...] |
||
1510 | * |
||
1511 | * @param string $replacement |
||
1512 | * |
||
1513 | * @return Stringy |
||
1514 | */ |
||
1515 | 6 | public function removeHtmlBreak($replacement = '') |
|
1521 | |||
1522 | /** |
||
1523 | * remove html |
||
1524 | * |
||
1525 | * @param $allowableTags |
||
1526 | * |
||
1527 | * @return Stringy |
||
1528 | */ |
||
1529 | 6 | public function removeHtml($allowableTags = null) |
|
1535 | |||
1536 | /** |
||
1537 | * Returns the substring beginning at $start, and up to, but not including |
||
1538 | * the index specified by $end. If $end is omitted, the function extracts |
||
1539 | * the remaining string. If $end is negative, it is computed from the end |
||
1540 | * of the string. |
||
1541 | * |
||
1542 | * @param int $start Initial index from which to begin extraction |
||
1543 | * @param int $end Optional index at which to end extraction |
||
1544 | * |
||
1545 | * @return Stringy Object with its $str being the extracted substring |
||
1546 | */ |
||
1547 | 18 | public function slice($start, $end = null) |
|
1563 | |||
1564 | /** |
||
1565 | * Splits the string with the provided regular expression, returning an |
||
1566 | * array of Stringy objects. An optional integer $limit will truncate the |
||
1567 | * results. |
||
1568 | * |
||
1569 | * @param string $pattern The regex with which to split the string |
||
1570 | * @param int $limit Optional maximum number of results to return |
||
1571 | * |
||
1572 | * @return Stringy[] An array of Stringy objects |
||
1573 | */ |
||
1574 | 19 | public function split($pattern, $limit = null) |
|
1608 | |||
1609 | /** |
||
1610 | * Surrounds $str with the given substring. |
||
1611 | * |
||
1612 | * @param string $substring The substring to add to both sides |
||
1613 | * |
||
1614 | * @return Stringy Object whose $str had the substring both prepended and |
||
1615 | * appended |
||
1616 | */ |
||
1617 | 5 | public function surround($substring) |
|
1623 | |||
1624 | /** |
||
1625 | * Returns a case swapped version of the string. |
||
1626 | * |
||
1627 | * @return Stringy Object whose $str has each character's case swapped |
||
1628 | */ |
||
1629 | 5 | public function swapCase() |
|
1637 | |||
1638 | /** |
||
1639 | * Returns a string with smart quotes, ellipsis characters, and dashes from |
||
1640 | * Windows-1252 (commonly used in Word documents) replaced by their ASCII |
||
1641 | * equivalents. |
||
1642 | * |
||
1643 | * @return Stringy Object whose $str has those characters removed |
||
1644 | */ |
||
1645 | 4 | public function tidy() |
|
1651 | |||
1652 | /** |
||
1653 | * Returns a trimmed string with the first letter of each word capitalized. |
||
1654 | * Also accepts an array, $ignore, allowing you to list words not to be |
||
1655 | * capitalized. |
||
1656 | * |
||
1657 | * @param array $ignore An array of words not to capitalize |
||
1658 | * |
||
1659 | * @return Stringy Object with a titleized $str |
||
1660 | */ |
||
1661 | 5 | public function titleize($ignore = null) |
|
1682 | |||
1683 | /** |
||
1684 | * Converts all characters in the string to lowercase. An alias for PHP's |
||
1685 | * UTF8::strtolower(). |
||
1686 | * |
||
1687 | * @return Stringy Object with all characters of $str being lowercase |
||
1688 | */ |
||
1689 | 27 | public function toLowerCase() |
|
1695 | |||
1696 | /** |
||
1697 | * Returns true if the string is base64 encoded, false otherwise. |
||
1698 | * |
||
1699 | * @return bool Whether or not $str is base64 encoded |
||
1700 | */ |
||
1701 | 7 | public function isBase64() |
|
1705 | |||
1706 | /** |
||
1707 | * Returns an ASCII version of the string. A set of non-ASCII characters are |
||
1708 | * replaced with their closest ASCII counterparts, and the rest are removed |
||
1709 | * unless instructed otherwise. |
||
1710 | * |
||
1711 | * @return Stringy Object whose $str contains only ASCII characters |
||
1712 | */ |
||
1713 | 16 | public function toAscii() |
|
1719 | |||
1720 | /** |
||
1721 | * Returns a boolean representation of the given logical string value. |
||
1722 | * For example, 'true', '1', 'on' and 'yes' will return true. 'false', '0', |
||
1723 | * 'off', and 'no' will return false. In all instances, case is ignored. |
||
1724 | * For other numeric strings, their sign will determine the return value. |
||
1725 | * In addition, blank strings consisting of only whitespace will return |
||
1726 | * false. For all other strings, the return value is a result of a |
||
1727 | * boolean cast. |
||
1728 | * |
||
1729 | * @return bool A boolean value for the string |
||
1730 | */ |
||
1731 | 15 | public function toBoolean() |
|
1753 | |||
1754 | /** |
||
1755 | * Return Stringy object as string, but you can also use (string) for automatically casting the object into a string. |
||
1756 | * |
||
1757 | * @return string |
||
1758 | */ |
||
1759 | 8 | public function toString() |
|
1763 | |||
1764 | /** |
||
1765 | * Converts each tab in the string to some number of spaces, as defined by |
||
1766 | * $tabLength. By default, each tab is converted to 4 consecutive spaces. |
||
1767 | * |
||
1768 | * @param int $tabLength Number of spaces to replace each tab with |
||
1769 | * |
||
1770 | * @return Stringy Object whose $str has had tabs switched to spaces |
||
1771 | */ |
||
1772 | 6 | View Code Duplication | public function toSpaces($tabLength = 4) |
1779 | |||
1780 | /** |
||
1781 | * Converts each occurrence of some consecutive number of spaces, as |
||
1782 | * defined by $tabLength, to a tab. By default, each 4 consecutive spaces |
||
1783 | * are converted to a tab. |
||
1784 | * |
||
1785 | * @param int $tabLength Number of spaces to replace with a tab |
||
1786 | * |
||
1787 | * @return Stringy Object whose $str has had spaces switched to tabs |
||
1788 | */ |
||
1789 | 5 | View Code Duplication | public function toTabs($tabLength = 4) |
1796 | |||
1797 | /** |
||
1798 | * Converts the first character of each word in the string to uppercase. |
||
1799 | * |
||
1800 | * @return Stringy Object with all characters of $str being title-cased |
||
1801 | */ |
||
1802 | 5 | public function toTitleCase() |
|
1809 | |||
1810 | /** |
||
1811 | * Converts all characters in the string to uppercase. An alias for PHP's |
||
1812 | * UTF8::strtoupper(). |
||
1813 | * |
||
1814 | * @return Stringy Object with all characters of $str being uppercase |
||
1815 | */ |
||
1816 | 5 | public function toUpperCase() |
|
1822 | |||
1823 | /** |
||
1824 | * Returns a string with whitespace removed from the start of the string. |
||
1825 | * Supports the removal of unicode whitespace. Accepts an optional |
||
1826 | * string of characters to strip instead of the defaults. |
||
1827 | * |
||
1828 | * @param string $chars Optional string of characters to strip |
||
1829 | * |
||
1830 | * @return Stringy Object with a trimmed $str |
||
1831 | */ |
||
1832 | 13 | View Code Duplication | public function trimLeft($chars = null) |
1842 | |||
1843 | /** |
||
1844 | * Returns a string with whitespace removed from the end of the string. |
||
1845 | * Supports the removal of unicode whitespace. Accepts an optional |
||
1846 | * string of characters to strip instead of the defaults. |
||
1847 | * |
||
1848 | * @param string $chars Optional string of characters to strip |
||
1849 | * |
||
1850 | * @return Stringy Object with a trimmed $str |
||
1851 | */ |
||
1852 | 13 | View Code Duplication | public function trimRight($chars = null) |
1862 | |||
1863 | /** |
||
1864 | * Truncates the string to a given length. If $substring is provided, and |
||
1865 | * truncating occurs, the string is further truncated so that the substring |
||
1866 | * may be appended without exceeding the desired length. |
||
1867 | * |
||
1868 | * @param int $length Desired length of the truncated string |
||
1869 | * @param string $substring The substring to append if it can fit |
||
1870 | * |
||
1871 | * @return Stringy Object with the resulting $str after truncating |
||
1872 | */ |
||
1873 | 22 | View Code Duplication | public function truncate($length, $substring = '') |
1889 | |||
1890 | /** |
||
1891 | * Returns a lowercase and trimmed string separated by underscores. |
||
1892 | * Underscores are inserted before uppercase characters (with the exception |
||
1893 | * of the first character of the string), and in place of spaces as well as |
||
1894 | * dashes. |
||
1895 | * |
||
1896 | * @return Stringy Object with an underscored $str |
||
1897 | */ |
||
1898 | 16 | public function underscored() |
|
1902 | |||
1903 | /** |
||
1904 | * Returns an UpperCamelCase version of the supplied string. It trims |
||
1905 | * surrounding spaces, capitalizes letters following digits, spaces, dashes |
||
1906 | * and underscores, and removes spaces, dashes, underscores. |
||
1907 | * |
||
1908 | * @return Stringy Object with $str in UpperCamelCase |
||
1909 | */ |
||
1910 | 13 | public function upperCamelize() |
|
1914 | |||
1915 | /** |
||
1916 | * Returns a camelCase version of the string. Trims surrounding spaces, |
||
1917 | * capitalizes letters following digits, spaces, dashes and underscores, |
||
1918 | * and removes spaces, dashes, as well as underscores. |
||
1919 | * |
||
1920 | * @return Stringy Object with $str in camelCase |
||
1921 | */ |
||
1922 | 32 | public function camelize() |
|
1950 | |||
1951 | /** |
||
1952 | * Convert a string to e.g.: "snake_case" |
||
1953 | * |
||
1954 | * @return Stringy Object with $str in snake_case |
||
1955 | */ |
||
1956 | 20 | public function snakeize() |
|
1998 | |||
1999 | /** |
||
2000 | * Converts the first character of the string to lower case. |
||
2001 | * |
||
2002 | * @return Stringy Object with the first character of $str being lower case |
||
2003 | */ |
||
2004 | 37 | View Code Duplication | public function lowerCaseFirst() |
2016 | |||
2017 | /** |
||
2018 | * Shorten the string after $length, but also after the next word. |
||
2019 | * |
||
2020 | * @param int $length |
||
2021 | * @param string $strAddOn |
||
2022 | * |
||
2023 | * @return Stringy |
||
2024 | */ |
||
2025 | 4 | public function shortenAfterWord($length, $strAddOn = '...') |
|
2031 | |||
2032 | /** |
||
2033 | * Line-Wrap the string after $limit, but also after the next word. |
||
2034 | * |
||
2035 | * @param int $limit |
||
2036 | * |
||
2037 | * @return Stringy |
||
2038 | */ |
||
2039 | 1 | public function lineWrapAfterWord($limit) |
|
2051 | } |
||
2052 |
In PHP, under loose comparison (like
==
, or!=
, orswitch
conditions), values of different types might be equal.For
string
values, the empty string''
is a special case, in particular the following results might be unexpected: