Allow custom id's, fixes #24

Author: jenssegers

src/Jenssegers/Mongodb/Builder.php

@@ -48,7 +48,7 @@ public function __construct(Connection $connection)
      */
     public function find($id, $columns = array('*'))
     {
-        return $this->where('_id', '=', new MongoID((string) $id))->first($columns);
+        return $this->where('_id', '=', $this->convertKey($id))->first($columns);
     }
 
     /**
@@ -500,6 +500,22 @@ protected function performUpdate($query)
         return 0;
     }
 
+    /**
+     * Convert a key to MongoID if needed
+     * 
+     * @param  mixed $id
+     * @return mixed
+     */
+    protected function convertKey($id)
+    {
+        if (is_string($id) && strlen($id) === 24 && ctype_xdigit($id))
+        {
+            return new MongoId($id);
+        }
+
+        return $id;
+    }
+
     /**
     * Compile the where array
     *
@@ -522,13 +538,13 @@ protected function compileWheres()
                 {
                     foreach ($where['values'] as &$value)
                     {
-                        $value = ($value instanceof MongoID) ? $value : new MongoID($value);
+                        $value = $this->convertKey($value);
                     }
                 }
                 // Single value
                 else
                 {
-                    $where['value'] = ($where['value'] instanceof MongoID) ? $where['value'] : new MongoID($where['value']);
+                    $where['value'] = $this->convertKey($where['value']);
                 }
             }
 

tests/QueryTest.php

@@ -228,4 +228,19 @@ public function testDistinct()
 		$this->assertEquals(array('sharp', 'round'), $types);
 	}
 
+	public function testCustomId()
+	{
+		DB::collection('items')->insert(array(
+			array('_id' => 'knife', 'type' => 'sharp', 'amount' => 34),
+			array('_id' => 'fork',  'type' => 'sharp', 'amount' => 20),
+			array('_id' => 'spoon', 'type' => 'round', 'amount' => 3)
+		));
+
+		$item = DB::collection('items')->find('knife');
+		$this->assertEquals('knife', $item['_id']);
+
+		$item = DB::collection('items')->where('_id', 'fork')->first();
+		$this->assertEquals('fork', $item['_id']);
+	}
+
 }