Add contains filter to query object.

Author: Arthur Cinader

src/Parse/ParseQuery.php

@@ -267,7 +267,7 @@ public function startsWith($key, $value)
 
         return $this;
     }
-    
+
     /**
      * Add a constraint to the query that requires a particular key's value to
      * end with the provided value.
@@ -283,7 +283,23 @@ public function endsWith($key, $value)
 
         return $this;
     }
-    
+
+    /**
+     * Adds a constraint for finding string values that contain a provided
+     * string. This may be slow for large datasets.
+     *
+     * @param string $key   The key to check.
+     * @param mixed  $value The substring that the value must contain.
+     *
+     * @return ParseQuery Returns this query, so you can chain this call.
+     */
+    public function contains($key, $value)
+    {
+        $this->addCondition($key, '$regex', $this->quote($value));
+
+        return $this;
+    }
+
     /**
      * Returns an associative array of the query constraints.
      *

tests/Parse/ParseQueryTest.php

@@ -330,6 +330,58 @@ public function testStartsWithRegexQuestionmark()
         );
     }
 
+    public function testContainsSingle()
+    {
+        $testObject = ParseObject::create('TestObject');
+        $testObject->set('foo', 'foobarfoo');
+        $testObject->save();
+        $query = new ParseQuery('TestObject');
+        $query->contains('foo', 'bar');
+        $results = $query->find();
+        $this->assertEquals(
+            count($results),
+            1,
+            'Contains should find the string.'
+        );
+    }
+
+    public function testContainsMultiple()
+    {
+        $this->provideTestObjects(10);
+        $query = new ParseQuery('TestObject');
+        $query->contains('foo', 'bar');
+        $results = $query->find();
+        $this->assertEquals(
+            count($results),
+            10,
+            'Contains function did not return correct number of objects.'
+        );
+
+        $query = new ParseQuery('TestObject');
+        $query->contains('foo', '8');
+        $results = $query->find();
+        $this->assertEquals(
+            count($results),
+            1,
+            'Contains function did not return correct number of objects.'
+        );
+    }
+
+    public function testContainsNonExistent()
+    {
+        $testObject = ParseObject::create('TestObject');
+        $testObject->set('foo', 'foobarfoo');
+        $testObject->save();
+        $query = new ParseQuery('TestObject');
+        $query->contains('foo', 'baz');
+        $results = $query->find();
+        $this->assertEquals(
+            count($results),
+            0,
+            'Contains should not find.'
+        );
+    }
+    
     public function testGreaterThan()
     {
         $this->provideTestObjects(10);