Merge branch 'indexOf'

README.md

@@ -31,6 +31,8 @@ PHP 5.3+ and HHVM. Inspired by underscore.string.js.
     * [htmlDecode](#htmldecode)
     * [htmlEncode](#htmlencode)
     * [humanize](#humanize)
+    * [indexOf](#indexof)
+    * [indexOfLast](#indexoflast)
     * [insert](#insert)
     * [isAlpha](#isalpha)
     * [isAlphanumeric](#isalphanumeric)
@@ -475,6 +477,34 @@ S::create('author_id')->humanize();
 S::humanize('author_id');  // 'Author'
 ```
 
+#### indexOf
+
+$stringy->indexOf(string $substr [, $offset = 0 ]);
+
+S::indexOf(string $str , string $substr [, $offset = 0 [, $encoding = null ]])
+
+Returns the offset/index of the first occurrence of $substr in the string.
+In case $substr is not a substring of the string, returns false.
+
+```php
+S::create('string', 'UTF-8')->indexOf('ing');
+S::indexOf('string', 'ing', 0, 'UTF-8');  // 3
+```
+
+#### indexOfLast
+
+$stringy->indexOfLast(string $substr [, $offset = 0 ]);
+
+S::indexOfLast(string $str , string $substr [, $offset = 0 [, $encoding = null ]])
+
+Returns the offset/index of the last occurrence of $substr in the string.
+In case $substr is not a substring of the string, returns false.
+
+```php
+S::create('string', 'UTF-8')->indexOfLast('ing');
+S::indexOfLast('string string', 'ing', 0, 'UTF-8');  // 10
+```
+
 #### insert
 
 $stringy->insert(int $index, string $substring)

src/StaticStringy.php

@@ -421,6 +421,34 @@ class StaticStringy
             ->containsAll($needles, $caseSensitive);
     }
 
+    /**
+     * Returns the offset/index of the first occurance of $substr in the string.
+     * In case $substr is not a substring of the string, returns false.
+     *
+     * @param string $str         The haystack to search through
+     * @param string $substr substring
+     * @param int $offset
+     * @return int|bool
+     */
+    public static function indexOf($str, $substr, $offset = 0, $encoding = null)
+    {
+        return Stringy::create($str, $encoding)->indexOf($substr, $offset);
+    }
+
+    /**
+     * Returns the offset/index of the last occurance of $substr in the string.
+     * In case $substr is not a substring of the string, returns false.
+     *
+     * @param string $str         The haystack to search through
+     * @param string $substr substring
+     * @param int $offset
+     * @return int|bool
+     */
+    public static function indexOfLast($str, $substr, $offset = 0, $encoding = null)
+    {
+        return Stringy::create($str, $encoding)->indexOfLast($substr, $offset);
+    }
+
     /**
      * Surrounds a string with the given substring.
      *

src/Stringy.php

@@ -894,6 +894,32 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess
         return true;
     }
 
+    /**
+     * Returns the offset/index of the first occurrence of $substr in the string.
+     * In case $substr is not a substring of the string, returns false.
+     *
+     * @param string $substr substring
+     * @param int $offset
+     * @return int|bool
+     */
+    public function indexOf($substr, $offset = 0)
+    {
+        return mb_strpos($this->str, (string)$substr, (int)$offset, $this->encoding);
+    }
+
+    /**
+     * Returns the offset/index of the last occurrence of $substr in the string.
+     * In case $substr is not a substring of the string, returns false.
+     *
+     * @param string $substr substring
+     * @param int $offset
+     * @return int|bool
+     */
+    public function indexOfLast($substr, $offset = 0)
+    {
+        return mb_strrpos($this->str, (string)$substr, (int)$offset, $this->encoding);
+    }
+
     /**
      * Surrounds $str with the given substring.
      *

tests/CommonTest.php

@@ -14,6 +14,26 @@ abstract class CommonTest extends PHPUnit_Framework_TestCase
         $this->assertInstanceOf('Stringy\Stringy', $actual);
     }
 
+    public function indexOfProvider()
+    {
+        return array(
+            array(2, 'This is the string', 'is'),
+            array(2, 'This is the string', 'is', 0, 'UTF-8'),
+            array(false, 'This is the string', 'not-found', 0, 'UTF-8'),
+            array(32, 'This is the string... and there is another thing', 'is', 10, 'UTF-8'),
+        );
+    }
+
+    public function indexOfLastProvider()
+    {
+        return array(
+            array(5, 'This is the string', 'is'),
+            array(5, 'This is the string', 'is', 0, 'UTF-8'),
+            array(false, 'This is the string', 'not-found', 0, 'UTF-8'),
+            array(32, 'This is the string... and there is another thing', 'is', 0, 'UTF-8'),
+        );
+    }
+
     public function charsProvider()
     {
         return array(

tests/StaticStringyTest.php

@@ -6,6 +6,24 @@ use Stringy\StaticStringy as S;
 
 class StaticStringyTestCase extends CommonTest
 {
+	/**
+     * @dataProvider indexOfProvider()
+     */
+    public function testIndexOf($expected, $str, $subStr, $offset = 0, $encoding = null)
+    {
+        $result = S::indexOf($str, $subStr, $offset, $encoding);
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider indexOfLastProvider()
+     */
+    public function testIndexOfLast($expected, $str, $subStr, $offset = 0, $encoding = null)
+    {
+        $result = S::indexOfLast($str, $subStr, $offset, $encoding);
+        $this->assertEquals($expected, $result);
+    }
+
     /**
      * @dataProvider charsProvider()
      */

tests/StringyTest.php

@@ -153,6 +153,24 @@ class StringyTestCase extends CommonTest
         unset($stringy[1]);
     }
 
+    /**
+     * @dataProvider indexOfProvider()
+     */
+    public function testIndexOf($expected, $str, $subStr, $offset = 0, $encoding = null)
+    {
+        $result = S::create($str, $encoding)->indexOf($subStr, $offset);
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider indexOfLastProvider()
+     */
+    public function testIndexOfLast($expected, $str, $subStr, $offset = 0, $encoding = null)
+    {
+        $result = S::create($str, $encoding)->indexOfLast($subStr, $offset);
+        $this->assertEquals($expected, $result);
+    }
+
     /**
      * @dataProvider charsProvider()
      */