mirror/stringy
1
0
Fork 0
mirror of https://github.com/danielstjules/Stringy.git synced 2025-08-12 00:04:11 +02:00
Code Issues Releases Wiki Activity

Use php 5.6 creation in examples

Browse Source
This commit is contained in:
Daniel St. Jules
2015-07-25 20:05:34 -07:00
parent fe7b54a4e7
commit 3dcc801483
1 changed files with 75 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
README.md
View File

@@ -221,7 +221,7 @@ Stringy objects are immutable. Methods return new instances.
Returns a new string with $string appended. Returns a new string with $string appended.
```php ```php
S::create('fòô')->append('bàř'); // 'fòôbàř' s('fòô')->append('bàř'); // 'fòôbàř'
``` ```
##### at(int $index) ##### at(int $index)
@@ -229,7 +229,7 @@ S::create('fòô')->append('bàř'); // 'fòôbàř'
Returns the character at $index, with indexes starting at 0. Returns the character at $index, with indexes starting at 0.
```php ```php
S::create('fòô bàř')->at(6); // 'ř' s('fòô bàř')->at(6); // 'ř'
``` ```
##### between(string $start, string $end [, int $offset]) ##### between(string $start, string $end [, int $offset])
@@ -239,7 +239,7 @@ string. An optional offset may be supplied from which to begin the
search for the start string. search for the start string.
```php ```php
S::create('{foo} and {bar}')->between('{', '}'); // 'foo' s('{foo} and {bar}')->between('{', '}'); // 'foo'
``` ```
##### camelize() ##### camelize()
@@ -249,7 +249,7 @@ capitalizes letters following digits, spaces, dashes and underscores,
and removes spaces, dashes, as well as underscores. and removes spaces, dashes, as well as underscores.
```php ```php
S::create('Camel-Case')->camelize(); // 'camelCase' s('Camel-Case')->camelize(); // 'camelCase'
``` ```
##### chars() ##### chars()
@@ -257,7 +257,7 @@ S::create('Camel-Case')->camelize(); // 'camelCase'
Returns an array consisting of the characters in the string. Returns an array consisting of the characters in the string.
```php ```php
S::create('Fòô Bàř')->chars(); s('Fòô Bàř')->chars();
// [F', 'ò', 'ô', ' ', 'B', 'à', 'ř'] // [F', 'ò', 'ô', ' ', 'B', 'à', 'ř']
``` ```
@@ -268,7 +268,7 @@ single space. This includes tabs and newline characters, as well as
multibyte whitespace such as the thin space and ideographic space. multibyte whitespace such as the thin space and ideographic space.
```php ```php
S::create(' Ο συγγραφέας ')->collapseWhitespace(); // 'Ο συγγραφέας' s(' Ο συγγραφέας ')->collapseWhitespace(); // 'Ο συγγραφέας'
``` ```
##### contains(string $needle [, boolean $caseSensitive = true ]) ##### contains(string $needle [, boolean $caseSensitive = true ])
@@ -278,7 +278,7 @@ the comparison is case-sensitive, but can be made insensitive
by setting $caseSensitive to false. by setting $caseSensitive to false.
```php ```php
S::create('Ο συγγραφέας είπε')->contains('συγγραφέας'); // true s('Ο συγγραφέας είπε')->contains('συγγραφέας'); // true
``` ```
##### containsAll(array $needles [, boolean $caseSensitive = true ]) ##### containsAll(array $needles [, boolean $caseSensitive = true ])
@@ -288,7 +288,7 @@ default the comparison is case-sensitive, but can be made insensitive by
setting $caseSensitive to false. setting $caseSensitive to false.
```php ```php
S::create('Str contains foo and bar')->containsAll(['foo', 'bar']); // true s('Str contains foo and bar')->containsAll(['foo', 'bar']); // true
``` ```
##### containsAny(array $needles [, boolean $caseSensitive = true ]) ##### containsAny(array $needles [, boolean $caseSensitive = true ])
@@ -298,7 +298,7 @@ default the comparison is case-sensitive, but can be made insensitive by
setting $caseSensitive to false. setting $caseSensitive to false.
```php ```php
S::create('Str contains foo')->containsAny(['foo', 'bar']); // true s('Str contains foo')->containsAny(['foo', 'bar']); // true
``` ```
##### countSubstr(string $substring [, boolean $caseSensitive = true ]) ##### countSubstr(string $substring [, boolean $caseSensitive = true ])
@@ -308,7 +308,7 @@ By default, the comparison is case-sensitive, but can be made insensitive
by setting $caseSensitive to false. by setting $caseSensitive to false.
```php ```php
S::create('Ο συγγραφέας είπε')->countSubstr('α'); // 2 s('Ο συγγραφέας είπε')->countSubstr('α'); // 2
``` ```
##### dasherize() ##### dasherize()
@@ -318,7 +318,7 @@ inserted before uppercase characters (with the exception of the first
character of the string), and in place of spaces as well as underscores. character of the string), and in place of spaces as well as underscores.
```php ```php
S::create('TestDCase')->dasherize(); // 'test-d-case' s('TestDCase')->dasherize(); // 'test-d-case'
``` ```
##### delimit(int $delimiter) ##### delimit(int $delimiter)
@@ -329,7 +329,7 @@ of the first character of the string), and in place of spaces, dashes,
and underscores. Alpha delimiters are not converted to lowercase. and underscores. Alpha delimiters are not converted to lowercase.
```php ```php
S::create('TestDCase')->delimit('>>'); // 'test>>case' s('TestDCase')->delimit('>>'); // 'test>>case'
``` ```
##### endsWith(string $substring [, boolean $caseSensitive = true ]) ##### endsWith(string $substring [, boolean $caseSensitive = true ])
@@ -339,7 +339,7 @@ default, the comparison is case-sensitive, but can be made insensitive by
setting $caseSensitive to false. setting $caseSensitive to false.
```php ```php
S::create('FÒÔ bàřs')->endsWith('àřs', true); // true s('FÒÔ bàřs')->endsWith('àřs', true); // true
``` ```
##### ensureLeft(string $substring) ##### ensureLeft(string $substring)
@@ -347,7 +347,7 @@ S::create('FÒÔ bàřs')->endsWith('àřs', true); // true
Ensures that the string begins with $substring. If it doesn't, it's prepended. Ensures that the string begins with $substring. If it doesn't, it's prepended.
```php ```php
S::create('foobar')->ensureLeft('http://'); // 'http://foobar' s('foobar')->ensureLeft('http://'); // 'http://foobar'
``` ```
##### ensureRight(string $substring) ##### ensureRight(string $substring)
@@ -355,7 +355,7 @@ S::create('foobar')->ensureLeft('http://'); // 'http://foobar'
Ensures that the string begins with $substring. If it doesn't, it's appended. Ensures that the string begins with $substring. If it doesn't, it's appended.
```php ```php
S::create('foobar')->ensureRight('.com'); // 'foobar.com' s('foobar')->ensureRight('.com'); // 'foobar.com'
``` ```
##### first(int $n) ##### first(int $n)
@@ -363,7 +363,7 @@ S::create('foobar')->ensureRight('.com'); // 'foobar.com'
Returns the first $n characters of the string. Returns the first $n characters of the string.
```php ```php
S::create('fòô bàř')->first(3); // 'fòô' s('fòô bàř')->first(3); // 'fòô'
``` ```
##### getEncoding() ##### getEncoding()
@@ -371,7 +371,7 @@ S::create('fòô bàř')->first(3); // 'fòô'
Returns the encoding used by the Stringy object. Returns the encoding used by the Stringy object.
```php ```php
S::create('fòô bàř', 'UTF-8')->getEncoding(); // 'UTF-8' s('fòô bàř', 'UTF-8')->getEncoding(); // 'UTF-8'
``` ```
##### hasLowerCase() ##### hasLowerCase()
@@ -379,7 +379,7 @@ S::create('fòô bàř', 'UTF-8')->getEncoding(); // 'UTF-8'
Returns true if the string contains a lower case char, false otherwise. Returns true if the string contains a lower case char, false otherwise.
```php ```php
S::create('fòô bàř')->hasLowerCase(); // true s('fòô bàř')->hasLowerCase(); // true
``` ```
##### hasUpperCase() ##### hasUpperCase()
@@ -387,7 +387,7 @@ S::create('fòô bàř')->hasLowerCase(); // true
Returns true if the string contains an upper case char, false otherwise. Returns true if the string contains an upper case char, false otherwise.
```php ```php
S::create('fòô bàř')->hasUpperCase(); // false s('fòô bàř')->hasUpperCase(); // false
``` ```
##### htmlDecode() ##### htmlDecode()
@@ -395,7 +395,7 @@ S::create('fòô bàř')->hasUpperCase(); // false
Convert all HTML entities to their applicable characters. Convert all HTML entities to their applicable characters.
```php ```php
S::create('&')->htmlDecode(); // '&' s('&')->htmlDecode(); // '&'
``` ```
##### htmlEncode() ##### htmlEncode()
@@ -403,7 +403,7 @@ S::create('&')->htmlDecode(); // '&'
Convert all applicable characters to HTML entities. Convert all applicable characters to HTML entities.
```php ```php
S::create('&')->htmlEncode(); // '&' s('&')->htmlEncode(); // '&'
``` ```
##### humanize() ##### humanize()
@@ -412,7 +412,7 @@ Capitalizes the first word of the string, replaces underscores with
spaces, and strips '_id'. spaces, and strips '_id'.
```php ```php
S::create('author_id')->humanize(); // 'Author' s('author_id')->humanize(); // 'Author'
``` ```
##### indexOf(string $needle [, $offset = 0 ]); ##### indexOf(string $needle [, $offset = 0 ]);
@@ -422,7 +422,7 @@ and false if not found. Accepts an optional offset from which to begin
the search. the search.
```php ```php
S::create('string')->indexOf('ing'); // 3 s('string')->indexOf('ing'); // 3
``` ```
##### indexOfLast(string $needle [, $offset = 0 ]); ##### indexOfLast(string $needle [, $offset = 0 ]);
@@ -432,7 +432,7 @@ and false if not found. Accepts an optional offset from which to begin
the search. the search.
```php ```php
S::create('string')->indexOfLast('ing'); // 10 s('string')->indexOfLast('ing'); // 10
``` ```
##### insert(int $index, string $substring) ##### insert(int $index, string $substring)
@@ -440,7 +440,7 @@ S::create('string')->indexOfLast('ing'); // 10
Inserts $substring into the string at the $index provided. Inserts $substring into the string at the $index provided.
```php ```php
S::create('fòô bà')->insert('ř', 6); // 'fòô bàř' s('fòô bà')->insert('ř', 6); // 'fòô bàř'
``` ```
##### isAlpha() ##### isAlpha()
@@ -448,7 +448,7 @@ S::create('fòô bà')->insert('ř', 6); // 'fòô bàř'
Returns true if the string contains only alphabetic chars, false otherwise. Returns true if the string contains only alphabetic chars, false otherwise.
```php ```php
S::create('丹尼爾')->isAlpha(); // true s('丹尼爾')->isAlpha(); // true
``` ```
##### isAlphanumeric() ##### isAlphanumeric()
@@ -457,7 +457,7 @@ Returns true if the string contains only alphabetic and numeric chars, false
otherwise. otherwise.
```php ```php
S::create('دانيال1')->isAlphanumeric(); // true s('دانيال1')->isAlphanumeric(); // true
``` ```
##### isBlank() ##### isBlank()
@@ -465,7 +465,7 @@ S::create('دانيال1')->isAlphanumeric(); // true
Returns true if the string contains only whitespace chars, false otherwise. Returns true if the string contains only whitespace chars, false otherwise.
```php ```php
S::create("\n\t \v\f")->isBlank(); // true s("\n\t \v\f")->isBlank(); // true
``` ```
##### isHexadecimal() ##### isHexadecimal()
@@ -473,7 +473,7 @@ S::create("\n\t \v\f")->isBlank(); // true
Returns true if the string contains only hexadecimal chars, false otherwise. Returns true if the string contains only hexadecimal chars, false otherwise.
```php ```php
S::create('A102F')->isHexadecimal(); // true s('A102F')->isHexadecimal(); // true
``` ```
##### isJson() ##### isJson()
@@ -481,7 +481,7 @@ S::create('A102F')->isHexadecimal(); // true
Returns true if the string is JSON, false otherwise. Returns true if the string is JSON, false otherwise.
```php ```php
S::create('{"foo":"bar"}')->isJson(); // true s('{"foo":"bar"}')->isJson(); // true
``` ```
##### isLowerCase() ##### isLowerCase()
@@ -489,7 +489,7 @@ S::create('{"foo":"bar"}')->isJson(); // true
Returns true if the string contains only lower case chars, false otherwise. Returns true if the string contains only lower case chars, false otherwise.
```php ```php
S::create('fòô bàř')->isLowerCase(); // true s('fòô bàř')->isLowerCase(); // true
``` ```
##### isSerialized() ##### isSerialized()
@@ -497,7 +497,7 @@ S::create('fòô bàř')->isLowerCase(); // true
Returns true if the string is serialized, false otherwise. Returns true if the string is serialized, false otherwise.
```php ```php
S::create('a:1:{s:3:"foo";s:3:"bar";}')->isSerialized(); // true s('a:1:{s:3:"foo";s:3:"bar";}')->isSerialized(); // true
``` ```
##### isUpperCase() ##### isUpperCase()
@@ -505,7 +505,7 @@ S::create('a:1:{s:3:"foo";s:3:"bar";}')->isSerialized(); // true
Returns true if the string contains only upper case chars, false otherwise. Returns true if the string contains only upper case chars, false otherwise.
```php ```php
S::create('FÒÔBÀŘ')->isUpperCase(); // true s('FÒÔBÀŘ')->isUpperCase(); // true
``` ```
##### last(int $n) ##### last(int $n)
@@ -513,7 +513,7 @@ S::create('FÒÔBÀŘ')->isUpperCase(); // true
Returns the last $n characters of the string. Returns the last $n characters of the string.
```php ```php
S::create('fòô bàř')->last(3); // 'bàř' s('fòô bàř')->last(3); // 'bàř'
``` ```
##### length() ##### length()
@@ -521,7 +521,7 @@ S::create('fòô bàř')->last(3); // 'bàř'
Returns the length of the string. An alias for PHP's mb_strlen() function. Returns the length of the string. An alias for PHP's mb_strlen() function.
```php ```php
S::create('fòô bàř')->length(); // 7 s('fòô bàř')->length(); // 7
``` ```
##### longestCommonPrefix(string $otherStr) ##### longestCommonPrefix(string $otherStr)
@@ -529,7 +529,7 @@ S::create('fòô bàř')->length(); // 7
Returns the longest common prefix between the string and $otherStr. Returns the longest common prefix between the string and $otherStr.
```php ```php
S::create('fòô bar')->longestCommonPrefix('fòr bar'); // 'fò' s('fòô bar')->longestCommonPrefix('fòr bar'); // 'fò'
``` ```
##### longestCommonSuffix(string $otherStr) ##### longestCommonSuffix(string $otherStr)
@@ -537,7 +537,7 @@ S::create('fòô bar')->longestCommonPrefix('fòr bar'); // 'fò'
Returns the longest common suffix between the string and $otherStr. Returns the longest common suffix between the string and $otherStr.
```php ```php
S::create('fòô bàř')->longestCommonSuffix('fòr bàř'); // ' bàř' s('fòô bàř')->longestCommonSuffix('fòr bàř'); // ' bàř'
``` ```
##### longestCommonSubstring(string $otherStr) ##### longestCommonSubstring(string $otherStr)
@@ -546,7 +546,7 @@ Returns the longest common substring between the string and $otherStr. In the
case of ties, it returns that which occurs first. case of ties, it returns that which occurs first.
```php ```php
S::create('foo bar')->longestCommonSubstring('boo far'); // 'oo ' s('foo bar')->longestCommonSubstring('boo far'); // 'oo '
``` ```
##### lowerCaseFirst() ##### lowerCaseFirst()
@@ -554,7 +554,7 @@ S::create('foo bar')->longestCommonSubstring('boo far'); // 'oo '
Converts the first character of the supplied string to lower case. Converts the first character of the supplied string to lower case.
```php ```php
S::create('Σ test')->lowerCaseFirst(); // 'σ test' s('Σ test')->lowerCaseFirst(); // 'σ test'
``` ```
##### pad(int $length [, string $padStr = ' ' [, string $padType = 'right' ]]) ##### pad(int $length [, string $padStr = ' ' [, string $padType = 'right' ]])
@@ -566,7 +566,7 @@ string used for padding is a space, and the default type (one of 'left',
$padType isn't one of those 3 values. $padType isn't one of those 3 values.
```php ```php
S::create('fòô bàř')->pad( 10, '¬ø', 'left'); // '¬ø¬fòô bàř' s('fòô bàř')->pad( 10, '¬ø', 'left'); // '¬ø¬fòô bàř'
``` ```
##### padBoth(int $length [, string $padStr = ' ' ]) ##### padBoth(int $length [, string $padStr = ' ' ])
@@ -575,7 +575,7 @@ Returns a new string of a given length such that both sides of the string
string are padded. Alias for pad() with a $padType of 'both'. string are padded. Alias for pad() with a $padType of 'both'.
```php ```php
S::create('foo bar')->padBoth(9, ' '); // ' foo bar ' s('foo bar')->padBoth(9, ' '); // ' foo bar '
``` ```
##### padLeft(int $length [, string $padStr = ' ' ]) ##### padLeft(int $length [, string $padStr = ' ' ])
@@ -584,7 +584,7 @@ Returns a new string of a given length such that the beginning of the
string is padded. Alias for pad() with a $padType of 'left'. string is padded. Alias for pad() with a $padType of 'left'.
```php ```php
S::create('foo bar')->padLeft($length, $padStr); // ' foo bar' s('foo bar')->padLeft($length, $padStr); // ' foo bar'
``` ```
##### padRight(int $length [, string $padStr = ' ' ]) ##### padRight(int $length [, string $padStr = ' ' ])
@@ -593,7 +593,7 @@ Returns a new string of a given length such that the end of the string is
padded. Alias for pad() with a $padType of 'right'. padded. Alias for pad() with a $padType of 'right'.
```php ```php
S::create('foo bar')->padRight(10, '_*'); // 'foo bar_*_' s('foo bar')->padRight(10, '_*'); // 'foo bar_*_'
``` ```
##### prepend(string $string) ##### prepend(string $string)
@@ -601,7 +601,7 @@ S::create('foo bar')->padRight(10, '_*'); // 'foo bar_*_'
Returns a new string starting with $string. Returns a new string starting with $string.
```php ```php
S::create('bàř')->prepend('fòô'); // 'fòôbàř' s('bàř')->prepend('fòô'); // 'fòôbàř'
``` ```
##### regexReplace(string $pattern, string $replacement [, string $options = 'msr']) ##### regexReplace(string $pattern, string $replacement [, string $options = 'msr'])
@@ -612,7 +612,7 @@ in mb_ereg_replace() requires PHP 5.4+. This is due to a lack of support
in the bundled version of Oniguruma in PHP 5.3. in the bundled version of Oniguruma in PHP 5.3.
```php ```php
S::create('fòô ')->regexReplace('f[òô]+\s', 'bàř', 'msr'); // 'bàř' s('fòô ')->regexReplace('f[òô]+\s', 'bàř', 'msr'); // 'bàř'
``` ```
##### removeLeft(string $substring) ##### removeLeft(string $substring)
@@ -620,7 +620,7 @@ S::create('fòô ')->regexReplace('f[òô]+\s', 'bàř', 'msr'); // 'bàř'
Returns a new string with the prefix $substring removed, if present. Returns a new string with the prefix $substring removed, if present.
```php ```php
S::create('fòô bàř')->removeLeft('fòô '); // 'bàř' s('fòô bàř')->removeLeft('fòô '); // 'bàř'
``` ```
##### removeRight(string $substring) ##### removeRight(string $substring)
@@ -628,7 +628,7 @@ S::create('fòô bàř')->removeLeft('fòô '); // 'bàř'
Returns a new string with the suffix $substring removed, if present. Returns a new string with the suffix $substring removed, if present.
```php ```php
S::create('fòô bàř')->removeRight(' bàř'); // 'fòô' s('fòô bàř')->removeRight(' bàř'); // 'fòô'
``` ```
##### repeat(int $multiplier) ##### repeat(int $multiplier)
@@ -636,7 +636,7 @@ S::create('fòô bàř')->removeRight(' bàř'); // 'fòô'
Returns a repeated string given a multiplier. An alias for str_repeat. Returns a repeated string given a multiplier. An alias for str_repeat.
```php ```php
S::create('à')->repeat(3); // 'ààà' s('à')->repeat(3); // 'ààà'
``` ```
##### replace(string $search, string $replacement) ##### replace(string $search, string $replacement)
@@ -644,7 +644,7 @@ S::create('à')->repeat(3); // 'ààà'
Replaces all occurrences of $search in $str by $replacement. Replaces all occurrences of $search in $str by $replacement.
```php ```php
S::create('fòô bàř fòô bàř')->replace('fòô ', ''); // 'bàř bàř' s('fòô bàř fòô bàř')->replace('fòô ', ''); // 'bàř bàř'
``` ```
##### reverse() ##### reverse()
@@ -652,7 +652,7 @@ S::create('fòô bàř fòô bàř')->replace('fòô ', ''); // 'bàř bàř'
Returns a reversed string. A multibyte version of strrev(). Returns a reversed string. A multibyte version of strrev().
```php ```php
S::create('fòô bàř')->reverse(); // 'řàb ôòf' s('fòô bàř')->reverse(); // 'řàb ôòf'
``` ```
##### safeTruncate(int $length [, string $substring = '' ]) ##### safeTruncate(int $length [, string $substring = '' ])
@@ -663,7 +663,7 @@ string is further truncated so that the substring may be appended without
exceeding the desired length. exceeding the desired length.
```php ```php
S::create('What are your plans today?')->safeTruncate(22, '...'); s('What are your plans today?')->safeTruncate(22, '...');
// 'What are your plans...' // 'What are your plans...'
``` ```
@@ -673,7 +673,7 @@ A multibyte str_shuffle() function. It returns a string with its characters in
random order. random order.
```php ```php
S::create('fòô bàř')->shuffle(); // 'àôřb òf' s('fòô bàř')->shuffle(); // 'àôřb òf'
``` ```
##### slugify([, string $replacement = '-' ]) ##### slugify([, string $replacement = '-' ])
@@ -685,8 +685,7 @@ $replacement. The replacement defaults to a single dash, and the string
is also converted to lowercase. is also converted to lowercase.
```php ```php
S::create('Using strings like fòô bàř')->slugify(); s('Using strings like fòô bàř')->slugify(); // 'using-strings-like-foo-bar'
// 'using-strings-like-foo-bar'
``` ```
##### startsWith(string $substring [, boolean $caseSensitive = true ]) ##### startsWith(string $substring [, boolean $caseSensitive = true ])
@@ -696,7 +695,7 @@ By default, the comparison is case-sensitive, but can be made insensitive
by setting $caseSensitive to false. by setting $caseSensitive to false.
```php ```php
S::create('FÒÔ bàřs')->startsWith('fòô bàř', false); // true s('FÒÔ bàřs')->startsWith('fòô bàř', false); // true
``` ```
##### slice(int $start [, int $end ]) ##### slice(int $start [, int $end ])
@@ -707,7 +706,7 @@ the remaining string. If $end is negative, it is computed from the end
of the string. of the string.
```php ```php
S::create('fòôbàř')->slice(3, -1); // 'bà' s('fòôbàř')->slice(3, -1); // 'bà'
``` ```
##### split(string $pattern [, int $limit ]) ##### split(string $pattern [, int $limit ])
@@ -717,7 +716,7 @@ array of Stringy objects. An optional integer $limit will truncate the
numbers of results returned. numbers of results returned.
```php ```php
S::create('foo,bar,baz')->split(',', 2); // ['foo', 'bar'] s('foo,bar,baz')->split(',', 2); // ['foo', 'bar']
``` ```
##### substr(int $start [, int $length ]) ##### substr(int $start [, int $length ])
@@ -727,7 +726,7 @@ It differs from the mb_substr() function in that providing a $length of
null will return the rest of the string, rather than an empty string. null will return the rest of the string, rather than an empty string.
```php ```php
S::create('fòô bàř')->substr(2, 3); // 'ô b' s('fòô bàř')->substr(2, 3); // 'ô b'
``` ```
##### surround(string $substring) ##### surround(string $substring)
@@ -735,7 +734,7 @@ S::create('fòô bàř')->substr(2, 3); // 'ô b'
Surrounds a string with the given substring. Surrounds a string with the given substring.
```php ```php
S::create(' ͜ ')->surround('ʘ'); // 'ʘ ͜ ʘ' s(' ͜ ')->surround('ʘ'); // 'ʘ ͜ ʘ'
``` ```
##### swapCase() ##### swapCase()
@@ -743,7 +742,7 @@ S::create(' ͜ ')->surround('ʘ'); // 'ʘ ͜ ʘ'
Returns a case swapped version of the string. Returns a case swapped version of the string.
```php ```php
S::create('Ντανιλ')->swapCase(); // 'νΤΑΝΙΛ' s('Ντανιλ')->swapCase(); // 'νΤΑΝΙΛ'
``` ```
##### tidy() ##### tidy()
@@ -752,7 +751,7 @@ Returns a string with smart quotes, ellipsis characters, and dashes from
Windows-1252 (commonly used in Word documents) replaced by their ASCII equivalents. Windows-1252 (commonly used in Word documents) replaced by their ASCII equivalents.
```php ```php
S::create('“I see…”')->tidy(); // '"I see..."' s('“I see…”')->tidy(); // '"I see..."'
``` ```
##### titleize([, array $ignore]) ##### titleize([, array $ignore])
@@ -763,7 +762,7 @@ an array, $ignore, allowing you to list words not to be capitalized.
```php ```php
$ignore = ['at', 'by', 'for', 'in', 'of', 'on', 'out', 'to', 'the']; $ignore = ['at', 'by', 'for', 'in', 'of', 'on', 'out', 'to', 'the'];
S::create('i like to watch DVDs at home')->titleize($ignore); s('i like to watch DVDs at home')->titleize($ignore);
// 'I Like to Watch DVDs at Home' // 'I Like to Watch DVDs at Home'
``` ```
@@ -774,7 +773,7 @@ replaced with their closest ASCII counterparts, and the rest are removed
unless instructed otherwise. unless instructed otherwise.
```php ```php
S::create('fòô bàř')->toAscii(); // 'foo bar' s('fòô bàř')->toAscii(); // 'foo bar'
``` ```
##### toBoolean() ##### toBoolean()
@@ -788,7 +787,7 @@ false. For all other strings, the return value is a result of a
boolean cast. boolean cast.
```php ```php
S::create('OFF')->toBoolean(); // false s('OFF')->toBoolean(); // false
``` ```
##### toLowerCase() ##### toLowerCase()
@@ -797,7 +796,7 @@ Converts all characters in the string to lowercase. An alias for PHP's
mb_strtolower(). mb_strtolower().
```php ```php
S::create('FÒÔ BÀŘ')->toLowerCase(); // 'fòô bàř' s('FÒÔ BÀŘ')->toLowerCase(); // 'fòô bàř'
``` ```
##### toSpaces([, tabLength = 4 ]) ##### toSpaces([, tabLength = 4 ])
@@ -806,8 +805,7 @@ Converts each tab in the string to some number of spaces, as defined by
$tabLength. By default, each tab is converted to 4 consecutive spaces. $tabLength. By default, each tab is converted to 4 consecutive spaces.
```php ```php
S::create(' String speech = "Hi"')->toSpaces(); s(' String speech = "Hi"')->toSpaces(); // ' String speech = "Hi"'
// ' String speech = "Hi"'
``` ```
##### toTabs([, tabLength = 4 ]) ##### toTabs([, tabLength = 4 ])
@@ -817,7 +815,7 @@ by $tabLength, to a tab. By default, each 4 consecutive spaces are
converted to a tab. converted to a tab.
```php ```php
S::create(' fòô bàř')->toTabs(); s(' fòô bàř')->toTabs();
// ' fòô bàř' // ' fòô bàř'
``` ```
@@ -826,7 +824,7 @@ S::create(' fòô bàř')->toTabs();
Converts the first character of each word in the string to uppercase. Converts the first character of each word in the string to uppercase.
```php ```php
S::create('fòô bàř')->toTitleCase(); // 'Fòô Bàř' s('fòô bàř')->toTitleCase(); // 'Fòô Bàř'
``` ```
##### toUpperCase() ##### toUpperCase()
@@ -835,7 +833,7 @@ Converts all characters in the string to uppercase. An alias for PHP's
mb_strtoupper(). mb_strtoupper().
```php ```php
S::create('fòô bàř')->toUpperCase(); // 'FÒÔ BÀŘ' s('fòô bàř')->toUpperCase(); // 'FÒÔ BÀŘ'
``` ```
##### trim([, string $chars]) ##### trim([, string $chars])
@@ -845,7 +843,7 @@ string. Supports the removal of unicode whitespace. Accepts an optional
string of characters to strip instead of the defaults. string of characters to strip instead of the defaults.
```php ```php
S::create(' fòô bàř ')->trim(); // 'fòô bàř' s(' fòô bàř ')->trim(); // 'fòô bàř'
``` ```
##### trimLeft([, string $chars]) ##### trimLeft([, string $chars])
@@ -855,7 +853,7 @@ Supports the removal of unicode whitespace. Accepts an optional
string of characters to strip instead of the defaults. string of characters to strip instead of the defaults.
```php ```php
S::create(' fòô bàř ')->trimLeft(); // 'fòô bàř ' s(' fòô bàř ')->trimLeft(); // 'fòô bàř '
``` ```
##### trimRight([, string $chars]) ##### trimRight([, string $chars])
@@ -865,7 +863,7 @@ Supports the removal of unicode whitespace. Accepts an optional
string of characters to strip instead of the defaults. string of characters to strip instead of the defaults.
```php ```php
S::create(' fòô bàř ')->trimRight(); // ' fòô bàř' s(' fòô bàř ')->trimRight(); // ' fòô bàř'
``` ```
##### truncate(int $length [, string $substring = '' ]) ##### truncate(int $length [, string $substring = '' ])
@@ -875,8 +873,7 @@ truncating occurs, the string is further truncated so that the substring
may be appended without exceeding the desired length. may be appended without exceeding the desired length.
```php ```php
S::create('What are your plans today?')->truncate(19, '...'); s('What are your plans today?')->truncate(19, '...'); // 'What are your pl...'
// 'What are your pl...'
``` ```
##### underscored() ##### underscored()
@@ -886,7 +883,7 @@ Underscores are inserted before uppercase characters (with the exception
of the first character of the string), and in place of spaces as well as dashes. of the first character of the string), and in place of spaces as well as dashes.
```php ```php
S::create('TestUCase')->underscored(); // 'test_u_case' s('TestUCase')->underscored(); // 'test_u_case'
``` ```
##### upperCamelize() ##### upperCamelize()
@@ -896,7 +893,7 @@ surrounding spaces, capitalizes letters following digits, spaces, dashes
and underscores, and removes spaces, dashes, underscores. and underscores, and removes spaces, dashes, underscores.
```php ```php
S::create('Upper Camel-Case')->upperCamelize(); // 'UpperCamelCase' s('Upper Camel-Case')->upperCamelize(); // 'UpperCamelCase'
``` ```
##### upperCaseFirst() ##### upperCaseFirst()
@@ -904,7 +901,7 @@ S::create('Upper Camel-Case')->upperCamelize(); // 'UpperCamelCase'
Converts the first character of the supplied string to upper case. Converts the first character of the supplied string to upper case.
```php ```php
S::create('σ test')->upperCaseFirst(); // 'Σ test' s('σ test')->upperCaseFirst(); // 'Σ test'
``` ```
## Extensions ## Extensions