voku /
Stringy
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 |
||
| 15 | class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess |
||
| 16 | { |
||
| 17 | /** |
||
| 18 | * An instance's string. |
||
| 19 | * |
||
| 20 | * @var string |
||
| 21 | */ |
||
| 22 | protected $str; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * The string's encoding, which should be one of the mbstring module's |
||
| 26 | * supported encodings. |
||
| 27 | * |
||
| 28 | * @var string |
||
| 29 | */ |
||
| 30 | protected $encoding; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * Initializes a Stringy object and assigns both str and encoding properties |
||
| 34 | * the supplied values. $str is cast to a string prior to assignment, and if |
||
| 35 | * $encoding is not specified, it defaults to mb_internal_encoding(). Throws |
||
| 36 | * an InvalidArgumentException if the first argument is an array or object |
||
| 37 | * without a __toString method. |
||
| 38 | * |
||
| 39 | * @param mixed $str Value to modify, after being cast to string |
||
| 40 | * @param string $encoding The character encoding |
||
| 41 | * |
||
| 42 | * @throws \InvalidArgumentException if an array or object without a |
||
| 43 | * __toString method is passed as the first argument |
||
| 44 | */ |
||
| 45 | 1073 | public function __construct($str = '', $encoding = null) |
|
| 46 | { |
||
| 47 | 1073 | if (is_array($str)) { |
|
| 48 | 1 | throw new \InvalidArgumentException( |
|
| 49 | 1 | 'Passed value cannot be an array' |
|
| 50 | ); |
||
| 51 | 1072 | } elseif (is_object($str) && !method_exists($str, '__toString')) { |
|
| 52 | 1 | throw new \InvalidArgumentException( |
|
| 53 | 1 | 'Passed object must have a __toString method' |
|
| 54 | ); |
||
| 55 | } |
||
| 56 | |||
| 57 | // don't throw a notice on PHP 5.3 |
||
| 58 | 1071 | if (!defined('ENT_SUBSTITUTE')) { |
|
| 59 | define('ENT_SUBSTITUTE', 8); |
||
| 60 | } |
||
| 61 | |||
| 62 | // init |
||
| 63 | 1071 | UTF8::checkForSupport(); |
|
| 64 | |||
| 65 | 1071 | $this->str = (string)$str; |
|
| 66 | |||
| 67 | 1071 | if ($encoding) { |
|
|
|
|||
| 68 | 850 | $this->encoding = $encoding; |
|
| 69 | } else { |
||
| 70 | 699 | UTF8::mbstring_loaded(); |
|
| 71 | 699 | $this->encoding = mb_internal_encoding(); |
|
| 72 | } |
||
| 73 | |||
| 74 | 1071 | if ($encoding) { |
|
| 75 | 850 | $this->encoding = $encoding; |
|
| 76 | } else { |
||
| 77 | 699 | $this->encoding = mb_internal_encoding(); |
|
| 78 | } |
||
| 79 | 1071 | } |
|
| 80 | |||
| 81 | /** |
||
| 82 | * Returns the value in $str. |
||
| 83 | * |
||
| 84 | * @return string The current value of the $str property |
||
| 85 | */ |
||
| 86 | 150 | public function __toString() |
|
| 90 | |||
| 91 | /** |
||
| 92 | * Returns a new string with $string appended. |
||
| 93 | * |
||
| 94 | * @param string $string The string to append |
||
| 95 | * |
||
| 96 | * @return Stringy Object with appended $string |
||
| 97 | */ |
||
| 98 | 5 | public function append($string) |
|
| 102 | |||
| 103 | /** |
||
| 104 | * Append an password (limited to chars that are good readable). |
||
| 105 | * |
||
| 106 | * @param int $length length of the random string |
||
| 107 | * |
||
| 108 | * @return Stringy Object with appended password |
||
| 109 | */ |
||
| 110 | 1 | public function appendPassword($length) |
|
| 116 | |||
| 117 | /** |
||
| 118 | * Append an unique identifier. |
||
| 119 | * |
||
| 120 | * @param string|int $extraPrefix |
||
| 121 | * |
||
| 122 | * @return Stringy Object with appended unique identifier as md5-hash |
||
| 123 | */ |
||
| 124 | 1 | public function appendUniqueIdentifier($extraPrefix = '') |
|
| 134 | |||
| 135 | /** |
||
| 136 | * Append an random string. |
||
| 137 | * |
||
| 138 | * @param int $length length of the random string |
||
| 139 | * @param string $possibleChars characters string for the random selection |
||
| 140 | * |
||
| 141 | * @return Stringy Object with appended random string |
||
| 142 | */ |
||
| 143 | 2 | public function appendRandomString($length, $possibleChars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789') |
|
| 144 | { |
||
| 145 | // init |
||
| 146 | 2 | $i = 0; |
|
| 147 | 2 | $length = (int)$length; |
|
| 148 | 2 | $str = $this->str; |
|
| 149 | 2 | $maxlength = UTF8::strlen($possibleChars, $this->encoding); |
|
| 150 | |||
| 151 | 2 | if ($maxlength === 0) { |
|
| 152 | 1 | return $this; |
|
| 153 | } |
||
| 154 | |||
| 155 | // add random chars |
||
| 156 | 2 | while ($i < $length) { |
|
| 157 | 2 | $char = UTF8::substr($possibleChars, mt_rand(0, $maxlength - 1), 1, $this->encoding); |
|
| 158 | 2 | $str .= $char; |
|
| 159 | 2 | $i++; |
|
| 160 | } |
||
| 161 | |||
| 162 | 2 | return $this->append($str); |
|
| 163 | } |
||
| 164 | |||
| 165 | /** |
||
| 166 | * Creates a Stringy object and assigns both str and encoding properties |
||
| 167 | * the supplied values. $str is cast to a string prior to assignment, and if |
||
| 168 | * $encoding is not specified, it defaults to mb_internal_encoding(). It |
||
| 169 | * then returns the initialized object. Throws an InvalidArgumentException |
||
| 170 | * if the first argument is an array or object without a __toString method. |
||
| 171 | * |
||
| 172 | * @param mixed $str Value to modify, after being cast to string |
||
| 173 | * @param string $encoding The character encoding |
||
| 174 | * |
||
| 175 | * @return Stringy A Stringy object |
||
| 176 | * @throws \InvalidArgumentException if an array or object without a |
||
| 177 | * __toString method is passed as the first argument |
||
| 178 | */ |
||
| 179 | 1063 | public static function create($str = '', $encoding = null) |
|
| 183 | |||
| 184 | /** |
||
| 185 | * Returns the substring between $start and $end, if found, or an empty |
||
| 186 | * string. An optional offset may be supplied from which to begin the |
||
| 187 | * search for the start string. |
||
| 188 | * |
||
| 189 | * @param string $start Delimiter marking the start of the substring |
||
| 190 | * @param string $end Delimiter marking the end of the substring |
||
| 191 | * @param int $offset Index from which to begin the search |
||
| 192 | * |
||
| 193 | * @return Stringy Object whose $str is a substring between $start and $end |
||
| 194 | */ |
||
| 195 | 16 | public function between($start, $end, $offset = 0) |
|
| 210 | |||
| 211 | /** |
||
| 212 | * Returns the index of the first occurrence of $needle in the string, |
||
| 213 | * and false if not found. Accepts an optional offset from which to begin |
||
| 214 | * the search. |
||
| 215 | * |
||
| 216 | * @param string $needle Substring to look for |
||
| 217 | * @param int $offset Offset from which to search |
||
| 218 | * |
||
| 219 | * @return int|bool The occurrence's index if found, otherwise false |
||
| 220 | */ |
||
| 221 | 28 | public function indexOf($needle, $offset = 0) |
|
| 225 | |||
| 226 | /** |
||
| 227 | * Returns the substring beginning at $start with the specified $length. |
||
| 228 | * It differs from the UTF8::substr() function in that providing a $length of |
||
| 229 | * null will return the rest of the string, rather than an empty string. |
||
| 230 | * |
||
| 231 | * @param int $start Position of the first character to use |
||
| 232 | * @param int $length Maximum number of characters used |
||
| 233 | * |
||
| 234 | * @return Stringy Object with its $str being the substring |
||
| 235 | */ |
||
| 236 | 64 | public function substr($start, $length = null) |
|
| 237 | { |
||
| 238 | 64 | if ($length === null) { |
|
| 239 | 19 | $length = $this->length(); |
|
| 240 | } |
||
| 241 | |||
| 242 | 64 | $str = UTF8::substr($this->str, $start, $length, $this->encoding); |
|
| 243 | |||
| 244 | 64 | return static::create($str, $this->encoding); |
|
| 245 | } |
||
| 246 | |||
| 247 | /** |
||
| 248 | * Returns the length of the string. |
||
| 249 | * |
||
| 250 | * @return int The number of characters in $str given the encoding |
||
| 251 | */ |
||
| 252 | 248 | public function length() |
|
| 256 | |||
| 257 | /** |
||
| 258 | * Trims the string and replaces consecutive whitespace characters with a |
||
| 259 | * single space. This includes tabs and newline characters, as well as |
||
| 260 | * multibyte whitespace such as the thin space and ideographic space. |
||
| 261 | * |
||
| 262 | * @return Stringy Object with a trimmed $str and condensed whitespace |
||
| 263 | */ |
||
| 264 | 52 | public function collapseWhitespace() |
|
| 268 | |||
| 269 | /** |
||
| 270 | * Returns a string with whitespace removed from the start and end of the |
||
| 271 | * string. Supports the removal of unicode whitespace. Accepts an optional |
||
| 272 | * string of characters to strip instead of the defaults. |
||
| 273 | * |
||
| 274 | * @param string $chars Optional string of characters to strip |
||
| 275 | * |
||
| 276 | * @return Stringy Object with a trimmed $str |
||
| 277 | */ |
||
| 278 | 153 | View Code Duplication | public function trim($chars = null) |
| 279 | { |
||
| 280 | 153 | if (!$chars) { |
|
| 281 | 152 | $chars = '[:space:]'; |
|
| 282 | } else { |
||
| 283 | 1 | $chars = preg_quote($chars, '/'); |
|
| 284 | } |
||
| 285 | |||
| 286 | 153 | return $this->regexReplace("^[$chars]+|[$chars]+\$", ''); |
|
| 287 | } |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Replaces all occurrences of $pattern in $str by $replacement. |
||
| 291 | * |
||
| 292 | * @param string $pattern The regular expression pattern |
||
| 293 | * @param string $replacement The string to replace with |
||
| 294 | * @param string $options Matching conditions to be used |
||
| 295 | * |
||
| 296 | * @return Stringy Object with the result2ing $str after the replacements |
||
| 297 | */ |
||
| 298 | 223 | public function regexReplace($pattern, $replacement, $options = '') |
|
| 299 | { |
||
| 300 | 223 | if ($options === 'msr') { |
|
| 301 | 8 | $options = 'ms'; |
|
| 302 | } |
||
| 303 | |||
| 304 | 223 | $str = preg_replace( |
|
| 305 | 223 | '/' . $pattern . '/u' . $options, |
|
| 306 | $replacement, |
||
| 307 | 223 | $this->str |
|
| 308 | ); |
||
| 309 | |||
| 310 | 223 | return static::create($str, $this->encoding); |
|
| 311 | } |
||
| 312 | |||
| 313 | /** |
||
| 314 | * Returns true if the string contains all $needles, false otherwise. By |
||
| 315 | * default the comparison is case-sensitive, but can be made insensitive by |
||
| 316 | * setting $caseSensitive to false. |
||
| 317 | * |
||
| 318 | * @param array $needles SubStrings to look for |
||
| 319 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 320 | * |
||
| 321 | * @return bool Whether or not $str contains $needle |
||
| 322 | */ |
||
| 323 | 43 | View Code Duplication | public function containsAll($needles, $caseSensitive = true) |
| 324 | { |
||
| 325 | /** @noinspection IsEmptyFunctionUsageInspection */ |
||
| 326 | 43 | if (empty($needles)) { |
|
| 327 | 1 | return false; |
|
| 328 | } |
||
| 329 | |||
| 330 | 42 | foreach ($needles as $needle) { |
|
| 331 | 42 | if (!$this->contains($needle, $caseSensitive)) { |
|
| 332 | 42 | return false; |
|
| 333 | } |
||
| 334 | } |
||
| 335 | |||
| 336 | 24 | return true; |
|
| 337 | } |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Returns true if the string contains $needle, false otherwise. By default |
||
| 341 | * the comparison is case-sensitive, but can be made insensitive by setting |
||
| 342 | * $caseSensitive to false. |
||
| 343 | * |
||
| 344 | * @param string $needle Substring to look for |
||
| 345 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 346 | * |
||
| 347 | * @return bool Whether or not $str contains $needle |
||
| 348 | */ |
||
| 349 | 105 | public function contains($needle, $caseSensitive = true) |
|
| 359 | |||
| 360 | /** |
||
| 361 | * Returns true if the string contains any $needles, false otherwise. By |
||
| 362 | * default the comparison is case-sensitive, but can be made insensitive by |
||
| 363 | * setting $caseSensitive to false. |
||
| 364 | * |
||
| 365 | * @param array $needles SubStrings to look for |
||
| 366 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 367 | * |
||
| 368 | * @return bool Whether or not $str contains $needle |
||
| 369 | */ |
||
| 370 | 43 | View Code Duplication | public function containsAny($needles, $caseSensitive = true) |
| 371 | { |
||
| 372 | /** @noinspection IsEmptyFunctionUsageInspection */ |
||
| 373 | 43 | if (empty($needles)) { |
|
| 374 | 1 | return false; |
|
| 375 | } |
||
| 376 | |||
| 377 | 42 | foreach ($needles as $needle) { |
|
| 378 | 42 | if ($this->contains($needle, $caseSensitive)) { |
|
| 379 | 42 | return true; |
|
| 380 | } |
||
| 381 | } |
||
| 382 | |||
| 383 | 18 | return false; |
|
| 384 | } |
||
| 385 | |||
| 386 | /** |
||
| 387 | * Returns the length of the string, implementing the countable interface. |
||
| 388 | * |
||
| 389 | * @return int The number of characters in the string, given the encoding |
||
| 390 | */ |
||
| 391 | 1 | public function count() |
|
| 395 | |||
| 396 | /** |
||
| 397 | * Returns the number of occurrences of $substring in the given string. |
||
| 398 | * By default, the comparison is case-sensitive, but can be made insensitive |
||
| 399 | * by setting $caseSensitive to false. |
||
| 400 | * |
||
| 401 | * @param string $substring The substring to search for |
||
| 402 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 403 | * |
||
| 404 | * @return int The number of $substring occurrences |
||
| 405 | */ |
||
| 406 | 15 | public function countSubstr($substring, $caseSensitive = true) |
|
| 417 | |||
| 418 | /** |
||
| 419 | * Returns a lowercase and trimmed string separated by dashes. Dashes are |
||
| 420 | * inserted before uppercase characters (with the exception of the first |
||
| 421 | * character of the string), and in place of spaces as well as underscores. |
||
| 422 | * |
||
| 423 | * @return Stringy Object with a dasherized $str |
||
| 424 | */ |
||
| 425 | 19 | public function dasherize() |
|
| 429 | |||
| 430 | /** |
||
| 431 | * Returns a lowercase and trimmed string separated by the given delimiter. |
||
| 432 | * Delimiters are inserted before uppercase characters (with the exception |
||
| 433 | * of the first character of the string), and in place of spaces, dashes, |
||
| 434 | * and underscores. Alpha delimiters are not converted to lowercase. |
||
| 435 | * |
||
| 436 | * @param string $delimiter Sequence used to separate parts of the string |
||
| 437 | * |
||
| 438 | * @return Stringy Object with a delimited $str |
||
| 439 | */ |
||
| 440 | 49 | public function delimit($delimiter) |
|
| 452 | |||
| 453 | /** |
||
| 454 | * Ensures that the string begins with $substring. If it doesn't, it's |
||
| 455 | * prepended. |
||
| 456 | * |
||
| 457 | * @param string $substring The substring to add if not present |
||
| 458 | * |
||
| 459 | * @return Stringy Object with its $str prefixed by the $substring |
||
| 460 | */ |
||
| 461 | 10 | View Code Duplication | public function ensureLeft($substring) |
| 471 | |||
| 472 | /** |
||
| 473 | * Returns true if the string begins with $substring, false otherwise. By |
||
| 474 | * default, the comparison is case-sensitive, but can be made insensitive |
||
| 475 | * by setting $caseSensitive to false. |
||
| 476 | * |
||
| 477 | * @param string $substring The substring to look for |
||
| 478 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 479 | * |
||
| 480 | * @return bool Whether or not $str starts with $substring |
||
| 481 | */ |
||
| 482 | 45 | public function startsWith($substring, $caseSensitive = true) |
|
| 493 | |||
| 494 | /** |
||
| 495 | * Returns true if the string begins with any $substrings, false otherwise. By |
||
| 496 | * default the comparison is case-sensitive, but can be made insensitive by |
||
| 497 | * setting $caseSensitive to false. |
||
| 498 | * |
||
| 499 | * @param array $substrings Substrings to look for |
||
| 500 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 501 | * |
||
| 502 | * @return bool Whether or not $str starts with $substring |
||
| 503 | */ |
||
| 504 | 12 | public function startsWithAny(array $substrings, $caseSensitive = true) |
|
| 518 | |||
| 519 | /** |
||
| 520 | * Ensures that the string ends with $substring. If it doesn't, it's |
||
| 521 | * appended. |
||
| 522 | * |
||
| 523 | * @param string $substring The substring to add if not present |
||
| 524 | * |
||
| 525 | * @return Stringy Object with its $str suffixed by the $substring |
||
| 526 | */ |
||
| 527 | 10 | View Code Duplication | public function ensureRight($substring) |
| 537 | |||
| 538 | /** |
||
| 539 | * Returns true if the string ends with $substring, false otherwise. By |
||
| 540 | * default, the comparison is case-sensitive, but can be made insensitive |
||
| 541 | * by setting $caseSensitive to false. |
||
| 542 | * |
||
| 543 | * @param string $substring The substring to look for |
||
| 544 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 545 | * |
||
| 546 | * @return bool Whether or not $str ends with $substring |
||
| 547 | */ |
||
| 548 | 33 | public function endsWith($substring, $caseSensitive = true) |
|
| 567 | |||
| 568 | /** |
||
| 569 | * Returns the first $n characters of the string. |
||
| 570 | * |
||
| 571 | * @param int $n Number of characters to retrieve from the start |
||
| 572 | * |
||
| 573 | * @return Stringy Object with its $str being the first $n chars |
||
| 574 | */ |
||
| 575 | 12 | View Code Duplication | public function first($n) |
| 587 | |||
| 588 | /** |
||
| 589 | * Returns the encoding used by the Stringy object. |
||
| 590 | * |
||
| 591 | * @return string The current value of the $encoding property |
||
| 592 | */ |
||
| 593 | 3 | public function getEncoding() |
|
| 597 | |||
| 598 | /** |
||
| 599 | * Returns a new ArrayIterator, thus implementing the IteratorAggregate |
||
| 600 | * interface. The ArrayIterator's constructor is passed an array of chars |
||
| 601 | * in the multibyte string. This enables the use of foreach with instances |
||
| 602 | * of Stringy\Stringy. |
||
| 603 | * |
||
| 604 | * @return \ArrayIterator An iterator for the characters in the string |
||
| 605 | */ |
||
| 606 | 1 | public function getIterator() |
|
| 610 | |||
| 611 | /** |
||
| 612 | * Returns an array consisting of the characters in the string. |
||
| 613 | * |
||
| 614 | * @return array An array of string chars |
||
| 615 | */ |
||
| 616 | 4 | public function chars() |
|
| 628 | |||
| 629 | /** |
||
| 630 | * Returns the character at $index, with indexes starting at 0. |
||
| 631 | * |
||
| 632 | * @param int $index Position of the character |
||
| 633 | * |
||
| 634 | * @return Stringy The character at $index |
||
| 635 | */ |
||
| 636 | 11 | public function at($index) |
|
| 640 | |||
| 641 | /** |
||
| 642 | * Returns true if the string contains a lower case char, false |
||
| 643 | * otherwise. |
||
| 644 | * |
||
| 645 | * @return bool Whether or not the string contains a lower case character. |
||
| 646 | */ |
||
| 647 | 12 | public function hasLowerCase() |
|
| 651 | |||
| 652 | /** |
||
| 653 | * Returns true if $str matches the supplied pattern, false otherwise. |
||
| 654 | * |
||
| 655 | * @param string $pattern Regex pattern to match against |
||
| 656 | * |
||
| 657 | * @return bool Whether or not $str matches the pattern |
||
| 658 | */ |
||
| 659 | 91 | private function matchesPattern($pattern) |
|
| 667 | |||
| 668 | /** |
||
| 669 | * Returns true if the string contains an upper case char, false |
||
| 670 | * otherwise. |
||
| 671 | * |
||
| 672 | * @return bool Whether or not the string contains an upper case character. |
||
| 673 | */ |
||
| 674 | 12 | public function hasUpperCase() |
|
| 678 | |||
| 679 | /** |
||
| 680 | * Convert all HTML entities to their applicable characters. |
||
| 681 | * |
||
| 682 | * @param int|null $flags Optional flags |
||
| 683 | * |
||
| 684 | * @return Stringy Object with the resulting $str after being html decoded. |
||
| 685 | */ |
||
| 686 | 5 | public function htmlDecode($flags = ENT_COMPAT) |
|
| 692 | |||
| 693 | /** |
||
| 694 | * Convert all applicable characters to HTML entities. |
||
| 695 | * |
||
| 696 | * @param int|null $flags Optional flags |
||
| 697 | * |
||
| 698 | * @return Stringy Object with the resulting $str after being html encoded. |
||
| 699 | */ |
||
| 700 | 5 | public function htmlEncode($flags = ENT_COMPAT) |
|
| 706 | |||
| 707 | /** |
||
| 708 | * Capitalizes the first word of the string, replaces underscores with |
||
| 709 | * spaces, and strips '_id'. |
||
| 710 | * |
||
| 711 | * @return Stringy Object with a humanized $str |
||
| 712 | */ |
||
| 713 | 3 | public function humanize() |
|
| 719 | |||
| 720 | /** |
||
| 721 | * Converts the first character of the supplied string to upper case. |
||
| 722 | * |
||
| 723 | * @return Stringy Object with the first character of $str being upper case |
||
| 724 | */ |
||
| 725 | 27 | View Code Duplication | public function upperCaseFirst() |
| 739 | |||
| 740 | /** |
||
| 741 | * Returns the index of the last occurrence of $needle in the string, |
||
| 742 | * and false if not found. Accepts an optional offset from which to begin |
||
| 743 | * the search. Offsets may be negative to count from the last character |
||
| 744 | * in the string. |
||
| 745 | * |
||
| 746 | * @param string $needle Substring to look for |
||
| 747 | * @param int $offset Offset from which to search |
||
| 748 | * |
||
| 749 | * @return int|bool The last occurrence's index if found, otherwise false |
||
| 750 | */ |
||
| 751 | 12 | public function indexOfLast($needle, $offset = 0) |
|
| 755 | |||
| 756 | /** |
||
| 757 | * Inserts $substring into the string at the $index provided. |
||
| 758 | * |
||
| 759 | * @param string $substring String to be inserted |
||
| 760 | * @param int $index The index at which to insert the substring |
||
| 761 | * |
||
| 762 | * @return Stringy Object with the resulting $str after the insertion |
||
| 763 | */ |
||
| 764 | 8 | View Code Duplication | public function insert($substring, $index) |
| 778 | |||
| 779 | /** |
||
| 780 | * Returns true if the string contains only alphabetic chars, false |
||
| 781 | * otherwise. |
||
| 782 | * |
||
| 783 | * @return bool Whether or not $str contains only alphabetic chars |
||
| 784 | */ |
||
| 785 | 10 | public function isAlpha() |
|
| 789 | |||
| 790 | /** |
||
| 791 | * Determine whether the string is considered to be empty. |
||
| 792 | * |
||
| 793 | * A variable is considered empty if it does not exist or if its value equals FALSE. |
||
| 794 | * empty() does not generate a warning if the variable does not exist. |
||
| 795 | * |
||
| 796 | * @return bool |
||
| 797 | */ |
||
| 798 | public function isEmpty() |
||
| 802 | |||
| 803 | /** |
||
| 804 | * Returns true if the string contains only alphabetic and numeric chars, |
||
| 805 | * false otherwise. |
||
| 806 | * |
||
| 807 | * @return bool Whether or not $str contains only alphanumeric chars |
||
| 808 | */ |
||
| 809 | 13 | public function isAlphanumeric() |
|
| 813 | |||
| 814 | /** |
||
| 815 | * Returns true if the string contains only whitespace chars, false |
||
| 816 | * otherwise. |
||
| 817 | * |
||
| 818 | * @return bool Whether or not $str contains only whitespace characters |
||
| 819 | */ |
||
| 820 | 15 | public function isBlank() |
|
| 824 | |||
| 825 | /** |
||
| 826 | * Returns true if the string contains only hexadecimal chars, false |
||
| 827 | * otherwise. |
||
| 828 | * |
||
| 829 | * @return bool Whether or not $str contains only hexadecimal chars |
||
| 830 | */ |
||
| 831 | 13 | public function isHexadecimal() |
|
| 835 | |||
| 836 | /** |
||
| 837 | * Returns true if the string contains HTML-Tags, false otherwise. |
||
| 838 | * |
||
| 839 | * @return bool Whether or not $str contains HTML-Tags |
||
| 840 | */ |
||
| 841 | 1 | public function isHtml() |
|
| 845 | |||
| 846 | /** |
||
| 847 | * Returns true if the string contains a valid E-Mail address, false otherwise. |
||
| 848 | * |
||
| 849 | * @param bool $useExampleDomainCheck |
||
| 850 | * @param bool $useTypoInDomainCheck |
||
| 851 | * @param bool $useTemporaryDomainCheck |
||
| 852 | * @param bool $useDnsCheck |
||
| 853 | * |
||
| 854 | * @return bool Whether or not $str contains a valid E-Mail address |
||
| 855 | */ |
||
| 856 | 1 | public function isEmail($useExampleDomainCheck = false, $useTypoInDomainCheck = false, $useTemporaryDomainCheck = false, $useDnsCheck = false) |
|
| 860 | |||
| 861 | /** |
||
| 862 | * Returns true if the string is JSON, false otherwise. Unlike json_decode |
||
| 863 | * in PHP 5.x, this method is consistent with PHP 7 and other JSON parsers, |
||
| 864 | * in that an empty string is not considered valid JSON. |
||
| 865 | * |
||
| 866 | * @return bool Whether or not $str is JSON |
||
| 867 | */ |
||
| 868 | 20 | public function isJson() |
|
| 882 | |||
| 883 | /** |
||
| 884 | * Returns true if the string contains only lower case chars, false |
||
| 885 | * otherwise. |
||
| 886 | * |
||
| 887 | * @return bool Whether or not $str contains only lower case characters |
||
| 888 | */ |
||
| 889 | 8 | public function isLowerCase() |
|
| 897 | |||
| 898 | /** |
||
| 899 | * Returns true if the string is serialized, false otherwise. |
||
| 900 | * |
||
| 901 | * @return bool Whether or not $str is serialized |
||
| 902 | */ |
||
| 903 | 7 | public function isSerialized() |
|
| 920 | |||
| 921 | /** |
||
| 922 | * Returns true if the string contains only lower case chars, false |
||
| 923 | * otherwise. |
||
| 924 | * |
||
| 925 | * @return bool Whether or not $str contains only lower case characters |
||
| 926 | */ |
||
| 927 | 8 | public function isUpperCase() |
|
| 931 | |||
| 932 | /** |
||
| 933 | * Returns the last $n characters of the string. |
||
| 934 | * |
||
| 935 | * @param int $n Number of characters to retrieve from the end |
||
| 936 | * |
||
| 937 | * @return Stringy Object with its $str being the last $n chars |
||
| 938 | */ |
||
| 939 | 12 | View Code Duplication | public function last($n) |
| 951 | |||
| 952 | /** |
||
| 953 | * Splits on newlines and carriage returns, returning an array of Stringy |
||
| 954 | * objects corresponding to the lines in the string. |
||
| 955 | * |
||
| 956 | * @return Stringy[] An array of Stringy objects |
||
| 957 | */ |
||
| 958 | 15 | public function lines() |
|
| 969 | |||
| 970 | /** |
||
| 971 | * Returns the longest common prefix between the string and $otherStr. |
||
| 972 | * |
||
| 973 | * @param string $otherStr Second string for comparison |
||
| 974 | * |
||
| 975 | * @return Stringy Object with its $str being the longest common prefix |
||
| 976 | */ |
||
| 977 | 10 | public function longestCommonPrefix($otherStr) |
|
| 995 | |||
| 996 | /** |
||
| 997 | * Returns the longest common suffix between the string and $otherStr. |
||
| 998 | * |
||
| 999 | * @param string $otherStr Second string for comparison |
||
| 1000 | * |
||
| 1001 | * @return Stringy Object with its $str being the longest common suffix |
||
| 1002 | */ |
||
| 1003 | 10 | public function longestCommonSuffix($otherStr) |
|
| 1021 | |||
| 1022 | /** |
||
| 1023 | * Returns the longest common substring between the string and $otherStr. |
||
| 1024 | * In the case of ties, it returns that which occurs first. |
||
| 1025 | * |
||
| 1026 | * @param string $otherStr Second string for comparison |
||
| 1027 | * |
||
| 1028 | * @return Stringy Object with its $str being the longest common substring |
||
| 1029 | */ |
||
| 1030 | 10 | public function longestCommonSubstring($otherStr) |
|
| 1074 | |||
| 1075 | /** |
||
| 1076 | * Returns whether or not a character exists at an index. Offsets may be |
||
| 1077 | * negative to count from the last character in the string. Implements |
||
| 1078 | * part of the ArrayAccess interface. |
||
| 1079 | * |
||
| 1080 | * @param mixed $offset The index to check |
||
| 1081 | * |
||
| 1082 | * @return boolean Whether or not the index exists |
||
| 1083 | */ |
||
| 1084 | 6 | public function offsetExists($offset) |
|
| 1096 | |||
| 1097 | /** |
||
| 1098 | * Returns the character at the given index. Offsets may be negative to |
||
| 1099 | * count from the last character in the string. Implements part of the |
||
| 1100 | * ArrayAccess interface, and throws an OutOfBoundsException if the index |
||
| 1101 | * does not exist. |
||
| 1102 | * |
||
| 1103 | * @param mixed $offset The index from which to retrieve the char |
||
| 1104 | * |
||
| 1105 | * @return string The character at the specified index |
||
| 1106 | * @throws \OutOfBoundsException If the positive or negative offset does |
||
| 1107 | * not exist |
||
| 1108 | */ |
||
| 1109 | 2 | public function offsetGet($offset) |
|
| 1125 | |||
| 1126 | /** |
||
| 1127 | * Implements part of the ArrayAccess interface, but throws an exception |
||
| 1128 | * when called. This maintains the immutability of Stringy objects. |
||
| 1129 | * |
||
| 1130 | * @param mixed $offset The index of the character |
||
| 1131 | * @param mixed $value Value to set |
||
| 1132 | * |
||
| 1133 | * @throws \Exception When called |
||
| 1134 | */ |
||
| 1135 | 1 | public function offsetSet($offset, $value) |
|
| 1140 | |||
| 1141 | /** |
||
| 1142 | * Implements part of the ArrayAccess interface, but throws an exception |
||
| 1143 | * when called. This maintains the immutability of Stringy objects. |
||
| 1144 | * |
||
| 1145 | * @param mixed $offset The index of the character |
||
| 1146 | * |
||
| 1147 | * @throws \Exception When called |
||
| 1148 | */ |
||
| 1149 | 1 | public function offsetUnset($offset) |
|
| 1154 | |||
| 1155 | /** |
||
| 1156 | * Pads the string to a given length with $padStr. If length is less than |
||
| 1157 | * or equal to the length of the string, no padding takes places. The |
||
| 1158 | * default string used for padding is a space, and the default type (one of |
||
| 1159 | * 'left', 'right', 'both') is 'right'. Throws an InvalidArgumentException |
||
| 1160 | * if $padType isn't one of those 3 values. |
||
| 1161 | * |
||
| 1162 | * @param int $length Desired string length after padding |
||
| 1163 | * @param string $padStr String used to pad, defaults to space |
||
| 1164 | * @param string $padType One of 'left', 'right', 'both' |
||
| 1165 | * |
||
| 1166 | * @return Stringy Object with a padded $str |
||
| 1167 | * @throws \InvalidArgumentException If $padType isn't one of 'right', 'left' or 'both' |
||
| 1168 | */ |
||
| 1169 | 13 | public function pad($length, $padStr = ' ', $padType = 'right') |
|
| 1186 | |||
| 1187 | /** |
||
| 1188 | * Returns a new string of a given length such that the beginning of the |
||
| 1189 | * string is padded. Alias for pad() with a $padType of 'left'. |
||
| 1190 | * |
||
| 1191 | * @param int $length Desired string length after padding |
||
| 1192 | * @param string $padStr String used to pad, defaults to space |
||
| 1193 | * |
||
| 1194 | * @return Stringy String with left padding |
||
| 1195 | */ |
||
| 1196 | 10 | public function padLeft($length, $padStr = ' ') |
|
| 1200 | |||
| 1201 | /** |
||
| 1202 | * Adds the specified amount of left and right padding to the given string. |
||
| 1203 | * The default character used is a space. |
||
| 1204 | * |
||
| 1205 | * @param int $left Length of left padding |
||
| 1206 | * @param int $right Length of right padding |
||
| 1207 | * @param string $padStr String used to pad |
||
| 1208 | * |
||
| 1209 | * @return Stringy String with padding applied |
||
| 1210 | */ |
||
| 1211 | 37 | private function applyPadding($left = 0, $right = 0, $padStr = ' ') |
|
| 1248 | |||
| 1249 | /** |
||
| 1250 | * Returns a new string of a given length such that the end of the string |
||
| 1251 | * is padded. Alias for pad() with a $padType of 'right'. |
||
| 1252 | * |
||
| 1253 | * @param int $length Desired string length after padding |
||
| 1254 | * @param string $padStr String used to pad, defaults to space |
||
| 1255 | * |
||
| 1256 | * @return Stringy String with right padding |
||
| 1257 | */ |
||
| 1258 | 13 | public function padRight($length, $padStr = ' ') |
|
| 1262 | |||
| 1263 | /** |
||
| 1264 | * Returns a new string of a given length such that both sides of the |
||
| 1265 | * string are padded. Alias for pad() with a $padType of 'both'. |
||
| 1266 | * |
||
| 1267 | * @param int $length Desired string length after padding |
||
| 1268 | * @param string $padStr String used to pad, defaults to space |
||
| 1269 | * |
||
| 1270 | * @return Stringy String with padding applied |
||
| 1271 | */ |
||
| 1272 | 14 | public function padBoth($length, $padStr = ' ') |
|
| 1278 | |||
| 1279 | /** |
||
| 1280 | * Returns a new string starting with $string. |
||
| 1281 | * |
||
| 1282 | * @param string $string The string to append |
||
| 1283 | * |
||
| 1284 | * @return Stringy Object with appended $string |
||
| 1285 | */ |
||
| 1286 | 2 | public function prepend($string) |
|
| 1290 | |||
| 1291 | /** |
||
| 1292 | * Returns a new string with the prefix $substring removed, if present. |
||
| 1293 | * |
||
| 1294 | * @param string $substring The prefix to remove |
||
| 1295 | * |
||
| 1296 | * @return Stringy Object having a $str without the prefix $substring |
||
| 1297 | */ |
||
| 1298 | 12 | View Code Duplication | public function removeLeft($substring) |
| 1310 | |||
| 1311 | /** |
||
| 1312 | * Returns a new string with the suffix $substring removed, if present. |
||
| 1313 | * |
||
| 1314 | * @param string $substring The suffix to remove |
||
| 1315 | * |
||
| 1316 | * @return Stringy Object having a $str without the suffix $substring |
||
| 1317 | */ |
||
| 1318 | 12 | View Code Duplication | public function removeRight($substring) |
| 1330 | |||
| 1331 | /** |
||
| 1332 | * Returns a repeated string given a multiplier. |
||
| 1333 | * |
||
| 1334 | * @param int $multiplier The number of times to repeat the string |
||
| 1335 | * |
||
| 1336 | * @return Stringy Object with a repeated str |
||
| 1337 | */ |
||
| 1338 | 7 | public function repeat($multiplier) |
|
| 1344 | |||
| 1345 | /** |
||
| 1346 | * Replaces all occurrences of $search in $str by $replacement. |
||
| 1347 | * |
||
| 1348 | * @param string $search The needle to search for |
||
| 1349 | * @param string $replacement The string to replace with |
||
| 1350 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 1351 | * |
||
| 1352 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1353 | */ |
||
| 1354 | 28 | View Code Duplication | public function replace($search, $replacement, $caseSensitive = true) |
| 1364 | |||
| 1365 | /** |
||
| 1366 | * Replaces all occurrences of $search in $str by $replacement. |
||
| 1367 | * |
||
| 1368 | * @param array $search The elements to search for |
||
| 1369 | * @param string|array $replacement The string to replace with |
||
| 1370 | * @param bool $caseSensitive Whether or not to enforce case-sensitivity |
||
| 1371 | * |
||
| 1372 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1373 | */ |
||
| 1374 | 30 | View Code Duplication | public function replaceAll(array $search, $replacement, $caseSensitive = true) |
| 1384 | |||
| 1385 | /** |
||
| 1386 | * Replaces all occurrences of $search from the beginning of string with $replacement |
||
| 1387 | * |
||
| 1388 | * @param string $search |
||
| 1389 | * @param string $replacement |
||
| 1390 | * |
||
| 1391 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1392 | */ |
||
| 1393 | 16 | public function replaceBeginning($search, $replacement) |
|
| 1399 | |||
| 1400 | /** |
||
| 1401 | * Replaces all occurrences of $search from the ending of string with $replacement |
||
| 1402 | * |
||
| 1403 | * @param string $search |
||
| 1404 | * @param string $replacement |
||
| 1405 | * |
||
| 1406 | * @return Stringy Object with the resulting $str after the replacements |
||
| 1407 | */ |
||
| 1408 | 16 | public function replaceEnding($search, $replacement) |
|
| 1414 | |||
| 1415 | /** |
||
| 1416 | * Returns a reversed string. A multibyte version of strrev(). |
||
| 1417 | * |
||
| 1418 | * @return Stringy Object with a reversed $str |
||
| 1419 | */ |
||
| 1420 | 5 | public function reverse() |
|
| 1426 | |||
| 1427 | /** |
||
| 1428 | * Truncates the string to a given length, while ensuring that it does not |
||
| 1429 | * split words. If $substring is provided, and truncating occurs, the |
||
| 1430 | * string is further truncated so that the substring may be appended without |
||
| 1431 | * exceeding the desired length. |
||
| 1432 | * |
||
| 1433 | * @param int $length Desired length of the truncated string |
||
| 1434 | * @param string $substring The substring to append if it can fit |
||
| 1435 | * |
||
| 1436 | * @return Stringy Object with the resulting $str after truncating |
||
| 1437 | */ |
||
| 1438 | 23 | public function safeTruncate($length, $substring = '') |
|
| 1467 | |||
| 1468 | /** |
||
| 1469 | * A multibyte string shuffle function. It returns a string with its |
||
| 1470 | * characters in random order. |
||
| 1471 | * |
||
| 1472 | * @return Stringy Object with a shuffled $str |
||
| 1473 | */ |
||
| 1474 | 3 | public function shuffle() |
|
| 1480 | |||
| 1481 | /** |
||
| 1482 | * Converts the string into an URL slug. This includes replacing non-ASCII |
||
| 1483 | * characters with their closest ASCII equivalents, removing remaining |
||
| 1484 | * non-ASCII and non-alphanumeric characters, and replacing whitespace with |
||
| 1485 | * $replacement. The replacement defaults to a single dash, and the string |
||
| 1486 | * is also converted to lowercase. |
||
| 1487 | * |
||
| 1488 | * @param string $replacement The string used to replace whitespace |
||
| 1489 | * @param string $language The language for the url |
||
| 1490 | * @param bool $strToLower string to lower |
||
| 1491 | * |
||
| 1492 | * @return Stringy Object whose $str has been converted to an URL slug |
||
| 1493 | */ |
||
| 1494 | 15 | public function slugify($replacement = '-', $language = 'de', $strToLower = true) |
|
| 1500 | |||
| 1501 | /** |
||
| 1502 | * Remove css media-queries. |
||
| 1503 | * |
||
| 1504 | * @return Stringy |
||
| 1505 | */ |
||
| 1506 | 1 | public function stripeCssMediaQueries() |
|
| 1512 | |||
| 1513 | /** |
||
| 1514 | * Remove empty html-tag. |
||
| 1515 | * |
||
| 1516 | * e.g.: <tag></tag> |
||
| 1517 | * |
||
| 1518 | * @return Stringy |
||
| 1519 | */ |
||
| 1520 | 1 | public function stripeEmptyHtmlTags() |
|
| 1526 | |||
| 1527 | /** |
||
| 1528 | * Converts the string into an valid UTF-8 string. |
||
| 1529 | * |
||
| 1530 | * @return Stringy |
||
| 1531 | */ |
||
| 1532 | 1 | public function utf8ify() |
|
| 1536 | |||
| 1537 | /** |
||
| 1538 | * escape html |
||
| 1539 | * |
||
| 1540 | * @return Stringy |
||
| 1541 | */ |
||
| 1542 | 6 | public function escape() |
|
| 1552 | |||
| 1553 | /** |
||
| 1554 | * Create an extract from a text, so if the search-string was found, it will be centered in the output. |
||
| 1555 | * |
||
| 1556 | * @param string $search |
||
| 1557 | * @param int|null $length |
||
| 1558 | * @param string $ellipsis |
||
| 1559 | * |
||
| 1560 | * @return Stringy |
||
| 1561 | */ |
||
| 1562 | 1 | public function extractText($search = '', $length = null, $ellipsis = '...') |
|
| 1679 | |||
| 1680 | |||
| 1681 | /** |
||
| 1682 | * remove xss from html |
||
| 1683 | * |
||
| 1684 | * @return Stringy |
||
| 1685 | */ |
||
| 1686 | 6 | public function removeXss() |
|
| 1698 | |||
| 1699 | /** |
||
| 1700 | * remove html-break [br | \r\n | \r | \n | ...] |
||
| 1701 | * |
||
| 1702 | * @param string $replacement |
||
| 1703 | * |
||
| 1704 | * @return Stringy |
||
| 1705 | */ |
||
| 1706 | 6 | public function removeHtmlBreak($replacement = '') |
|
| 1712 | |||
| 1713 | /** |
||
| 1714 | * remove html |
||
| 1715 | * |
||
| 1716 | * @param $allowableTags |
||
| 1717 | * |
||
| 1718 | * @return Stringy |
||
| 1719 | */ |
||
| 1720 | 6 | public function removeHtml($allowableTags = null) |
|
| 1726 | |||
| 1727 | /** |
||
| 1728 | * Returns the substring beginning at $start, and up to, but not including |
||
| 1729 | * the index specified by $end. If $end is omitted, the function extracts |
||
| 1730 | * the remaining string. If $end is negative, it is computed from the end |
||
| 1731 | * of the string. |
||
| 1732 | * |
||
| 1733 | * @param int $start Initial index from which to begin extraction |
||
| 1734 | * @param int $end Optional index at which to end extraction |
||
| 1735 | * |
||
| 1736 | * @return Stringy Object with its $str being the extracted substring |
||
| 1737 | */ |
||
| 1738 | 18 | public function slice($start, $end = null) |
|
| 1754 | |||
| 1755 | /** |
||
| 1756 | * Splits the string with the provided regular expression, returning an |
||
| 1757 | * array of Stringy objects. An optional integer $limit will truncate the |
||
| 1758 | * results. |
||
| 1759 | * |
||
| 1760 | * @param string $pattern The regex with which to split the string |
||
| 1761 | * @param int $limit Optional maximum number of results to return |
||
| 1762 | * |
||
| 1763 | * @return Stringy[] An array of Stringy objects |
||
| 1764 | */ |
||
| 1765 | 19 | public function split($pattern, $limit = null) |
|
| 1799 | |||
| 1800 | /** |
||
| 1801 | * Surrounds $str with the given substring. |
||
| 1802 | * |
||
| 1803 | * @param string $substring The substring to add to both sides |
||
| 1804 | * |
||
| 1805 | * @return Stringy Object whose $str had the substring both prepended and |
||
| 1806 | * appended |
||
| 1807 | */ |
||
| 1808 | 5 | public function surround($substring) |
|
| 1814 | |||
| 1815 | /** |
||
| 1816 | * Returns a case swapped version of the string. |
||
| 1817 | * |
||
| 1818 | * @return Stringy Object whose $str has each character's case swapped |
||
| 1819 | */ |
||
| 1820 | 5 | public function swapCase() |
|
| 1828 | |||
| 1829 | /** |
||
| 1830 | * Returns a string with smart quotes, ellipsis characters, and dashes from |
||
| 1831 | * Windows-1252 (commonly used in Word documents) replaced by their ASCII |
||
| 1832 | * equivalents. |
||
| 1833 | * |
||
| 1834 | * @return Stringy Object whose $str has those characters removed |
||
| 1835 | */ |
||
| 1836 | 4 | public function tidy() |
|
| 1842 | |||
| 1843 | /** |
||
| 1844 | * Returns a trimmed string with the first letter of each word capitalized. |
||
| 1845 | * Also accepts an array, $ignore, allowing you to list words not to be |
||
| 1846 | * capitalized. |
||
| 1847 | * |
||
| 1848 | * @param array $ignore An array of words not to capitalize |
||
| 1849 | * |
||
| 1850 | * @return Stringy Object with a titleized $str |
||
| 1851 | */ |
||
| 1852 | 5 | public function titleize($ignore = null) |
|
| 1873 | |||
| 1874 | /** |
||
| 1875 | * Converts all characters in the string to lowercase. An alias for PHP's |
||
| 1876 | * UTF8::strtolower(). |
||
| 1877 | * |
||
| 1878 | * @return Stringy Object with all characters of $str being lowercase |
||
| 1879 | */ |
||
| 1880 | 27 | public function toLowerCase() |
|
| 1886 | |||
| 1887 | /** |
||
| 1888 | * Returns true if the string is base64 encoded, false otherwise. |
||
| 1889 | * |
||
| 1890 | * @return bool Whether or not $str is base64 encoded |
||
| 1891 | */ |
||
| 1892 | 7 | public function isBase64() |
|
| 1896 | |||
| 1897 | /** |
||
| 1898 | * Returns an ASCII version of the string. A set of non-ASCII characters are |
||
| 1899 | * replaced with their closest ASCII counterparts, and the rest are removed |
||
| 1900 | * unless instructed otherwise. |
||
| 1901 | * |
||
| 1902 | * @param $strict [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad performance</p> |
||
| 1903 | * |
||
| 1904 | * @return Stringy Object whose $str contains only ASCII characters |
||
| 1905 | */ |
||
| 1906 | 16 | public function toAscii($strict = false) |
|
| 1912 | |||
| 1913 | /** |
||
| 1914 | * Returns a boolean representation of the given logical string value. |
||
| 1915 | * For example, 'true', '1', 'on' and 'yes' will return true. 'false', '0', |
||
| 1916 | * 'off', and 'no' will return false. In all instances, case is ignored. |
||
| 1917 | * For other numeric strings, their sign will determine the return value. |
||
| 1918 | * In addition, blank strings consisting of only whitespace will return |
||
| 1919 | * false. For all other strings, the return value is a result of a |
||
| 1920 | * boolean cast. |
||
| 1921 | * |
||
| 1922 | * @return bool A boolean value for the string |
||
| 1923 | */ |
||
| 1924 | 15 | public function toBoolean() |
|
| 1946 | |||
| 1947 | /** |
||
| 1948 | * Return Stringy object as string, but you can also use (string) for automatically casting the object into a string. |
||
| 1949 | * |
||
| 1950 | * @return string |
||
| 1951 | */ |
||
| 1952 | 980 | public function toString() |
|
| 1956 | |||
| 1957 | /** |
||
| 1958 | * Converts each tab in the string to some number of spaces, as defined by |
||
| 1959 | * $tabLength. By default, each tab is converted to 4 consecutive spaces. |
||
| 1960 | * |
||
| 1961 | * @param int $tabLength Number of spaces to replace each tab with |
||
| 1962 | * |
||
| 1963 | * @return Stringy Object whose $str has had tabs switched to spaces |
||
| 1964 | */ |
||
| 1965 | 6 | View Code Duplication | public function toSpaces($tabLength = 4) |
| 1972 | |||
| 1973 | /** |
||
| 1974 | * Converts each occurrence of some consecutive number of spaces, as |
||
| 1975 | * defined by $tabLength, to a tab. By default, each 4 consecutive spaces |
||
| 1976 | * are converted to a tab. |
||
| 1977 | * |
||
| 1978 | * @param int $tabLength Number of spaces to replace with a tab |
||
| 1979 | * |
||
| 1980 | * @return Stringy Object whose $str has had spaces switched to tabs |
||
| 1981 | */ |
||
| 1982 | 5 | View Code Duplication | public function toTabs($tabLength = 4) |
| 1989 | |||
| 1990 | /** |
||
| 1991 | * Converts the first character of each word in the string to uppercase. |
||
| 1992 | * |
||
| 1993 | * @return Stringy Object with all characters of $str being title-cased |
||
| 1994 | */ |
||
| 1995 | 5 | public function toTitleCase() |
|
| 2002 | |||
| 2003 | /** |
||
| 2004 | * Converts all characters in the string to uppercase. An alias for PHP's |
||
| 2005 | * UTF8::strtoupper(). |
||
| 2006 | * |
||
| 2007 | * @return Stringy Object with all characters of $str being uppercase |
||
| 2008 | */ |
||
| 2009 | 5 | public function toUpperCase() |
|
| 2015 | |||
| 2016 | /** |
||
| 2017 | * Returns a string with whitespace removed from the start of the string. |
||
| 2018 | * Supports the removal of unicode whitespace. Accepts an optional |
||
| 2019 | * string of characters to strip instead of the defaults. |
||
| 2020 | * |
||
| 2021 | * @param string $chars Optional string of characters to strip |
||
| 2022 | * |
||
| 2023 | * @return Stringy Object with a trimmed $str |
||
| 2024 | */ |
||
| 2025 | 13 | View Code Duplication | public function trimLeft($chars = null) |
| 2035 | |||
| 2036 | /** |
||
| 2037 | * Returns a string with whitespace removed from the end of the string. |
||
| 2038 | * Supports the removal of unicode whitespace. Accepts an optional |
||
| 2039 | * string of characters to strip instead of the defaults. |
||
| 2040 | * |
||
| 2041 | * @param string $chars Optional string of characters to strip |
||
| 2042 | * |
||
| 2043 | * @return Stringy Object with a trimmed $str |
||
| 2044 | */ |
||
| 2045 | 13 | View Code Duplication | public function trimRight($chars = null) |
| 2055 | |||
| 2056 | /** |
||
| 2057 | * Truncates the string to a given length. If $substring is provided, and |
||
| 2058 | * truncating occurs, the string is further truncated so that the substring |
||
| 2059 | * may be appended without exceeding the desired length. |
||
| 2060 | * |
||
| 2061 | * @param int $length Desired length of the truncated string |
||
| 2062 | * @param string $substring The substring to append if it can fit |
||
| 2063 | * |
||
| 2064 | * @return Stringy Object with the resulting $str after truncating |
||
| 2065 | */ |
||
| 2066 | 22 | View Code Duplication | public function truncate($length, $substring = '') |
| 2082 | |||
| 2083 | /** |
||
| 2084 | * Returns a lowercase and trimmed string separated by underscores. |
||
| 2085 | * Underscores are inserted before uppercase characters (with the exception |
||
| 2086 | * of the first character of the string), and in place of spaces as well as |
||
| 2087 | * dashes. |
||
| 2088 | * |
||
| 2089 | * @return Stringy Object with an underscored $str |
||
| 2090 | */ |
||
| 2091 | 16 | public function underscored() |
|
| 2095 | |||
| 2096 | /** |
||
| 2097 | * Returns an UpperCamelCase version of the supplied string. It trims |
||
| 2098 | * surrounding spaces, capitalizes letters following digits, spaces, dashes |
||
| 2099 | * and underscores, and removes spaces, dashes, underscores. |
||
| 2100 | * |
||
| 2101 | * @return Stringy Object with $str in UpperCamelCase |
||
| 2102 | */ |
||
| 2103 | 13 | public function upperCamelize() |
|
| 2107 | |||
| 2108 | /** |
||
| 2109 | * Returns a camelCase version of the string. Trims surrounding spaces, |
||
| 2110 | * capitalizes letters following digits, spaces, dashes and underscores, |
||
| 2111 | * and removes spaces, dashes, as well as underscores. |
||
| 2112 | * |
||
| 2113 | * @return Stringy Object with $str in camelCase |
||
| 2114 | */ |
||
| 2115 | 32 | public function camelize() |
|
| 2143 | |||
| 2144 | /** |
||
| 2145 | * Convert a string to e.g.: "snake_case" |
||
| 2146 | * |
||
| 2147 | * @return Stringy Object with $str in snake_case |
||
| 2148 | */ |
||
| 2149 | 20 | public function snakeize() |
|
| 2192 | |||
| 2193 | /** |
||
| 2194 | * Converts the first character of the string to lower case. |
||
| 2195 | * |
||
| 2196 | * @return Stringy Object with the first character of $str being lower case |
||
| 2197 | */ |
||
| 2198 | 37 | View Code Duplication | public function lowerCaseFirst() |
| 2207 | |||
| 2208 | /** |
||
| 2209 | * Shorten the string after $length, but also after the next word. |
||
| 2210 | * |
||
| 2211 | * @param int $length |
||
| 2212 | * @param string $strAddOn |
||
| 2213 | * |
||
| 2214 | * @return Stringy |
||
| 2215 | */ |
||
| 2216 | 4 | public function shortenAfterWord($length, $strAddOn = '...') |
|
| 2222 | |||
| 2223 | /** |
||
| 2224 | * Line-Wrap the string after $limit, but also after the next word. |
||
| 2225 | * |
||
| 2226 | * @param int $limit |
||
| 2227 | * |
||
| 2228 | * @return Stringy |
||
| 2229 | */ |
||
| 2230 | 1 | public function lineWrapAfterWord($limit) |
|
| 2242 | |||
| 2243 | /** |
||
| 2244 | * Gets the substring after the first occurrence of a separator. |
||
| 2245 | * If no match is found returns new empty Stringy object. |
||
| 2246 | * |
||
| 2247 | * @param string $separator |
||
| 2248 | * |
||
| 2249 | * @return Stringy |
||
| 2250 | */ |
||
| 2251 | 1 | View Code Duplication | public function afterFirst($separator) |
| 2267 | |||
| 2268 | /** |
||
| 2269 | * Gets the substring after the last occurrence of a separator. |
||
| 2270 | * If no match is found returns new empty Stringy object. |
||
| 2271 | * |
||
| 2272 | * @param string $separator |
||
| 2273 | * |
||
| 2274 | * @return Stringy |
||
| 2275 | */ |
||
| 2276 | 1 | public function afterLast($separator) |
|
| 2293 | |||
| 2294 | /** |
||
| 2295 | * Gets the substring before the first occurrence of a separator. |
||
| 2296 | * If no match is found returns new empty Stringy object. |
||
| 2297 | * |
||
| 2298 | * @param string $separator |
||
| 2299 | * |
||
| 2300 | * @return Stringy |
||
| 2301 | */ |
||
| 2302 | 1 | View Code Duplication | public function beforeFirst($separator) |
| 2319 | |||
| 2320 | /** |
||
| 2321 | * Gets the substring before the last occurrence of a separator. |
||
| 2322 | * If no match is found returns new empty Stringy object. |
||
| 2323 | * |
||
| 2324 | * @param string $separator |
||
| 2325 | * |
||
| 2326 | * @return Stringy |
||
| 2327 | */ |
||
| 2328 | 1 | View Code Duplication | public function beforeLast($separator) |
| 2345 | |||
| 2346 | /** |
||
| 2347 | * Returns the string with the first letter of each word capitalized, |
||
| 2348 | * except for when the word is a name which shouldn't be capitalized. |
||
| 2349 | * |
||
| 2350 | * @return Stringy Object with $str capitalized |
||
| 2351 | */ |
||
| 2352 | 39 | public function capitalizePersonalName() |
|
| 2360 | |||
| 2361 | /** |
||
| 2362 | * @param string $word |
||
| 2363 | * |
||
| 2364 | * @return string |
||
| 2365 | */ |
||
| 2366 | 7 | private function capitalizeWord($word) |
|
| 2376 | |||
| 2377 | /** |
||
| 2378 | * Personal names such as "Marcus Aurelius" are sometimes typed incorrectly using lowercase ("marcus aurelius"). |
||
| 2379 | * |
||
| 2380 | * @param string $names |
||
| 2381 | * @param string $delimiter |
||
| 2382 | * |
||
| 2383 | * @return string |
||
| 2384 | */ |
||
| 2385 | 39 | private function capitalizePersonalNameByDelimiter($names, $delimiter) |
|
| 2461 | } |
||
| 2462 |
Loading history...
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: