Adding ParseObject::fetchAll

Author: Fosco Marotto

src/Parse/ParseObject.php

@@ -11,6 +11,7 @@
 use Parse\Internal\IncrementOperation;
 use Parse\Internal\RemoveOperation;
 use Parse\Internal\SetOperation;
+use Zend\I18n\Exception\ParseException;
 
 /**
  * ParseObject - Representation of an object stored on Parse.
@@ -511,6 +512,58 @@ public function fetch($useMasterKey = false)
         $this->_mergeAfterFetch($response);
     }
 
+    /**
+     * Fetch an array of Parse objects from the server
+     *
+     * @param array $objects The ParseObjects to fetch
+     * @param boolean $useMasterKey Whether to override ACLs
+     *
+     * @return array
+     */
+    public static function fetchAll(array $objects, $useMasterKey = false) {
+        $objectIds = static::toObjectIdArray($objects);
+        if (!count($objectIds)) return $objects;
+        $className = $objects[0]->getClassName();
+        $query = new ParseQuery($className);
+        $query->containedIn("objectId", $objectIds);
+        $query->limit(count($objectIds));
+        $results = $query->find($useMasterKey);
+        return static::updateWithFetchedResults($objects, $results);
+    }
+
+    private static function toObjectIdArray(array $objects) {
+        $objectIds = [];
+        $count = count($objects);
+        if (!$count) return $objectIds;
+        $className = $objects[0]->getClassName();
+        for ($i = 0; $i < $count; $i++) {
+            $obj = $objects[$i];
+            if ($obj->getClassName() !== $className) {
+                throw new ParseException("All objects should be of the same class.");
+            } else if (!$obj->getObjectId()) {
+                throw new ParseException("All objects must have an ID.");
+            }
+            array_push($objectIds, $obj->getObjectId());
+        }
+        return $objectIds;
+    }
+
+    private static function updateWithFetchedResults(array $objects, array $fetched) {
+        $fetchedObjectsById = [];
+        foreach ($fetched as $object) {
+            $fetchedObjectsById[$object->getObjectId()] = $object;
+        }
+        $count = count($objects);
+        for ($i = 0; $i < $count; $i++) {
+            $obj = $objects[$i];
+            if (!isset($fetchedObjectsById[$obj->getObjectId()])) {
+                throw new ParseException("All objects must exist on the server.");
+            }
+            $obj->mergeFromObject($fetchedObjectsById[$obj->getObjectId()]);
+        }
+        return $objects;
+    }
+
     /**
      * Merges data received from the server.
      *
@@ -589,6 +642,17 @@ private function mergeFromServer($data, $completeData = true)
         }
     }
 
+    private function mergeFromObject($other) {
+        if (!$other) return;
+        $this->objectId = $other->getObjectId();
+        $this->createdAt = $other->getCreatedAt();
+        $this->updatedAt = $other->getUpdatedAt();
+        $this->serverData = $other->serverData;
+        $this->operationSet = [];
+        $this->hasBeenFetched = true;
+        $this->rebuildEstimatedData();
+    }
+
     /**
      * Handle merging of special fields for the object.
      *

tests/ParseObjectTest.php

@@ -935,4 +935,23 @@ public function testBatchSaveExceptions()
             $this->assertContains("invalid field name", $errors[1]['error']);
         }
     }
+
+    public function testFetchAll()
+    {
+        $obj1 = ParseObject::create("TestObject");
+        $obj2 = ParseObject::create("TestObject");
+        $obj3 = ParseObject::create("TestObject");
+        $obj1->set("foo", "bar");
+        $obj2->set("foo", "bar");
+        $obj3->set("foo", "bar");
+        ParseObject::saveAll([$obj1, $obj2, $obj3]);
+        $newObj1 = ParseObject::create("TestObject", $obj1->getObjectId());
+        $newObj2 = ParseObject::create("TestObject", $obj2->getObjectId());
+        $newObj3 = ParseObject::create("TestObject", $obj3->getObjectId());
+        $results = ParseObject::fetchAll([$newObj1, $newObj2, $newObj3]);
+        $this->assertEquals(3, count($results));
+        $this->assertEquals("bar", $results[0]->get("foo"));
+        $this->assertEquals("bar", $results[1]->get("foo"));
+        $this->assertEquals("bar", $results[2]->get("foo"));
+    }
 }