Tweaking embedsMany, check issue #138

Author: jenssegers

README.md

@@ -359,6 +359,43 @@ The belongsToMany relation will not use a pivot "table", but will push id's to a
 
 Other relations are not yet supported, but may be added in the future. Read more about these relations on http://four.laravel.com/docs/eloquent#relationships
 
+### EmbedsMany Relations
+
+If you want to embed documents, rather than referencing them, you can use the `embedsMany` relation:
+
+    use Jenssegers\Mongodb\Model as Eloquent;
+
+    class User extends Eloquent {
+
+        public function books()
+        {
+            return $this->embedsMany('Book');
+        }
+
+    }
+
+Now we can access the post's comments through the dynamic property:
+
+    $books = User::first()->books;
+
+Inserting and updating embedded documents works just like the `belongsTo` relation:
+
+    $book = new Book(array('title' => 'A Game of Thrones'));
+
+    $user = User::first();
+
+    $book = $user->books()->save($book);
+
+You can remove an embedded document by using the `destroy()` method:
+
+    $book = $user->books()->first();
+
+    $user->books()->destroy($book->_id);
+
+Again, you may override the conventional local key by passing a second argument to the embedsMany method:
+
+    return $this->embedsMany('Book', 'local_key');
+
 ### MySQL Relations
 
 If you're using a hybrid MongoDB and SQL setup, you're in luck! The model will automatically return a MongoDB- or SQL-relation based on the type of the related model. Of course, if you want this functionality to work both ways, your SQL-models will need to extend `Jenssegers\Eloquent\Model`. Note that this functionality only works for hasOne, hasMany and belongsTo relations.

src/Jenssegers/Eloquent/Model.php

@@ -1,6 +1,5 @@
 <?php namespace Jenssegers\Eloquent;
 
-use LogicException;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\MorphOne;
@@ -9,7 +8,6 @@
 use Jenssegers\Mongodb\Relations\BelongsTo;
 use Jenssegers\Mongodb\Relations\BelongsToMany;
 use Jenssegers\Mongodb\Relations\EmbedsMany;
-use Jenssegers\Mongodb\Relations\EmbeddedRelation;
 use Jenssegers\Mongodb\Query\Builder as QueryBuilder;
 
 abstract class Model extends \Illuminate\Database\Eloquent\Model {
@@ -230,36 +228,31 @@ public function belongsToMany($related, $collection = null, $foreignKey = null,
      * @param  string  $collection
      * @return \Illuminate\Database\Eloquent\Relations\EmbedsMany
      */
-    protected function embedsMany($related, $collection = null)
+    protected function embedsMany($related, $localKey = null, $foreignKey = null, $relation = null)
     {
-        // If no collection name was provided, we assume that the standard is the
-        // related model camel_cased, pluralized and suffixed with '_ids'
-        if (is_null($collection))
+        if (is_null($localKey))
         {
-            $collection = str_plural(snake_case($related)) . '_ids';
+            $localKey = snake_case(str_plural($related)) . '_ids';
         }
 
-        return new EmbedsMany($this, $related, $collection);
-    }
-
-    /**
-     * Get a relationship value from a method.
-     *
-     * @param  string  $key
-     * @param  string  $camelKey
-     * @return mixed
-     */
-    protected function getRelationshipFromMethod($key, $camelKey)
-    {
-        $relations = $this->$camelKey();
+        if (is_null($foreignKey))
+        {
+            $foreignKey = snake_case(class_basename($this));
+        }
 
-        if ( ! $relations instanceof Relation and ! $relations instanceof EmbeddedRelation)
+        // If no relation name was given, we will use this debug backtrace to extract
+        // the calling method's name and use that as the relationship name as most
+        // of the time this will be what we desire to use for the relatinoships.
+        if (is_null($relation))
         {
-            throw new LogicException('Relationship method must return an object of type '
-                . 'Illuminate\Database\Eloquent\Relations\Relation or Jenssegers\Mongodb\Relations\EmbeddedRelation');
+            list(, $caller) = debug_backtrace(false);
+
+            $relation = $caller['function'];
         }
 
-        return $this->relations[$key] = $relations->getResults();
+        $query = $this->newQuery();
+
+        return new EmbedsMany($query, $this, $localKey, $foreignKey, $relation);
     }
 
     /**