mirror/stringy
1
0
Fork 0
mirror of https://github.com/danielstjules/Stringy.git synced 2025-08-14 17:24:29 +02:00
Code Issues Releases Wiki Activity

Style fixes

Browse Source
This commit is contained in:
Daniel St. Jules
2015-06-29 15:33:00 -07:00
parent 2c295fd15d
commit 397d2ca2f8
3 changed files with 60 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -479,30 +479,32 @@ S::humanize('author_id'); // 'Author'
#### indexOf #### indexOf
$stringy->indexOf(string $substr [, $offset = 0 ]); $stringy->indexOf(string $needle [, $offset = 0 ]);
S::indexOf(string $str , string $substr [, $offset = 0 [, $encoding = null ]]) S::indexOf(string $haystack , string $needle [, $offset = 0 [, $encoding = null ]])
Returns the offset/index of the first occurrence of $substr in the string. Returns the index of the first occurrence of $needle in the string,
In case $substr is not a substring of the string, returns false. and false if not found. Accepts an optional offset from which to begin
the search.
```php ```php
S::create('string', 'UTF-8')->indexOf('ing'); S::create('string', 'UTF-8')->indexOf('ing');
S::indexOf('string', 'ing', 0, 'UTF-8'); // 3 S::indexOf('string', 'ing'); // 3
``` ```
#### indexOfLast #### indexOfLast
$stringy->indexOfLast(string $substr [, $offset = 0 ]); $stringy->indexOfLast(string $needle [, $offset = 0 ]);
S::indexOfLast(string $str , string $substr [, $offset = 0 [, $encoding = null ]]) S::indexOfLast(string $haystack , string $needle [, $offset = 0 [, $encoding = null ]])
Returns the offset/index of the last occurrence of $substr in the string. Returns the index of the last occurrence of $needle in the string,
In case $substr is not a substring of the string, returns false. and false if not found. Accepts an optional offset from which to begin
the search.
```php ```php
S::create('string', 'UTF-8')->indexOfLast('ing'); S::create('string', 'UTF-8')->indexOfLast('ing');
S::indexOfLast('string string', 'ing', 0, 'UTF-8'); // 10 S::indexOfLast('string string', 'ing'); // 10
``` ```
#### insert #### insert
@@ -1054,7 +1056,7 @@ $stringy->trim()
S::trim(string $str) S::trim(string $str)
Returns the trimmed string. An alias for PHP's trim() function. Returns the trimmed string.
```php ```php
S::create('fòô bàř', 'UTF-8')->trim(); S::create('fòô bàř', 'UTF-8')->trim();

38
src/StaticStringy.php
View File

@@ -422,31 +422,37 @@ class StaticStringy
} }
/** /**
* Returns the offset/index of the first occurance of $substr in the string. * Returns the index of the first occurrence of $needle in the string,
* In case $substr is not a substring of the string, returns false. * and false if not found. Accepts an optional offset from which to begin
* the search.
* *
* @param string $str The haystack to search through * @param string $haystack String to search
* @param string $substr substring * @param string $needle Substring to look for
* @param int $offset * @param int $offset Offset from which to search
* @return int|bool * @return int|bool The occurrence's index if found, otherwise false
*/ */
public static function indexOf($str, $substr, $offset = 0, $encoding = null) public static function indexOf($haystack, $needle, $offset = 0,
$encoding = null)
{ {
return Stringy::create($str, $encoding)->indexOf($substr, $offset); return Stringy::create($haystack, $encoding)
->indexOf($needle, $offset);
} }
/** /**
* Returns the offset/index of the last occurance of $substr in the string. * Returns the index of the last occurrence of $needle in the string,
* In case $substr is not a substring of the string, returns false. * and false if not found. Accepts an optional offset from which to begin
* the search.
* *
* @param string $str The haystack to search through * @param string $haystack String to search
* @param string $substr substring * @param string $needle Substring to look for
* @param int $offset * @param int $offset Offset from which to search
* @return int|bool * @return int|bool The last occurrence's index if found, otherwise false
*/ */
public static function indexOfLast($str, $substr, $offset = 0, $encoding = null) public static function indexOfLast($haystack, $needle, $offset = 0,
$encoding = null)
{ {
return Stringy::create($str, $encoding)->indexOfLast($substr, $offset); return Stringy::create($haystack, $encoding)
->indexOfLast($needle, $offset);
} }
/** /**

50
src/Stringy.php
View File

@@ -895,29 +895,33 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess
} }
/** /**
* Returns the offset/index of the first occurrence of $substr in the string. * Returns the index of the first occurrence of $needle in the string,
* In case $substr is not a substring of the string, returns false. * and false if not found. Accepts an optional offset from which to begin
* the search.
* *
* @param string $substr substring * @param string $needle Substring to look for
* @param int $offset * @param int $offset Offset from which to search
* @return int|bool * @return int|bool The occurrence's index if found, otherwise false
*/ */
public function indexOf($substr, $offset = 0) public function indexOf($needle, $offset = 0)
{ {
return mb_strpos($this->str, (string)$substr, (int)$offset, $this->encoding); return mb_strpos($this->str, (string) $needle,
(int) $offset, $this->encoding);
} }
/** /**
* Returns the offset/index of the last occurrence of $substr in the string. * Returns the index of the last occurrence of $needle in the string,
* In case $substr is not a substring of the string, returns false. * and false if not found. Accepts an optional offset from which to begin
* the search.
* *
* @param string $substr substring * @param string $needle Substring to look for
* @param int $offset * @param int $offset Offset from which to search
* @return int|bool * @return int|bool The last occurrence's index if found, otherwise false
*/ */
public function indexOfLast($substr, $offset = 0) public function indexOfLast($needle, $offset = 0)
{ {
return mb_strrpos($this->str, (string)$substr, (int)$offset, $this->encoding); return mb_strrpos($this->str, (string) $needle,
(int) $offset, $this->encoding);
} }
/** /**
@@ -1057,10 +1061,10 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess
} }
/** /**
* Returns the trimmed string. An alias for PHP's trim() function. * Returns the trimmed string.
* *
* @param string $charList list with characters to be removed * @param string $charList Characters to be removed
* @param int $type which function will be used to trim the string, trim, ltrim or rtrim * @param int $type One of TRIM_BOTH, TRIM_LEFT or TRIM_RIGHT
* @return Stringy Object with a trimmed $str * @return Stringy Object with a trimmed $str
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
*/ */
@@ -1072,14 +1076,10 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess
); );
} }
if (!in_array($type, array( $validTypes = array(self::TRIM_BOTH, self::TRIM_LEFT, self::TRIM_RIGHT);
self::TRIM_BOTH, if (!in_array($type, $validTypes)) {
self::TRIM_LEFT, throw new \InvalidArgumentException('Type of trim function must ' .
self::TRIM_RIGHT, 'be trim (default), rtrim or ltrim, just as native php.');
))) {
throw new \InvalidArgumentException(
'Type of trim function must be trim (default), rtrim or ltrim, just as native php.'
);
} }
return static::create($type($this->str, $charList), $this->encoding); return static::create($type($this->str, $charList), $this->encoding);