analogueorm / analogue

src/System/Query.php

Indentation +642 added lines, -642 removed lines

@@ -19,646 +19,646 @@
  */
 class Query
 {
-    /**
-     * Mapper Instance
-     *
-     * @var \Analogue\ORM\System\Mapper
-     */
-    protected $mapper;
-
-    /**
-     * DB Adatper
-     *
-     * @var \Analogue\ORM\Drivers\DBAdapter
-     */
-    protected $adapter;
-
-    /**
-     * Query Builder Instance
-     *
-     * @var \Analogue\ORM\Drivers\QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter
-     */
-    protected $query;
-
-    /**
-     * Entity Map Instance
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $entityMap;
-
-    /**
-     * The relationships that should be eager loaded.
-     *
-     * @var array
-     */
-    protected $eagerLoad = [];
-
-    /**
-     * All of the registered builder macros.
-     *
-     * @var array
-     */
-    protected $macros = [];
-
-    /**
-     * The methods that should be returned from query builder.
-     *
-     * @var array
-     */
-    protected $passthru = [
-        'toSql',
-        'lists',
-        'pluck',
-        'count',
-        'min',
-        'max',
-        'avg',
-        'sum',
-        'exists',
-        'getBindings',
-    ];
-
-    /**
-     * Query Builder Blacklist
-     */
-    protected $blacklist = [
-        'insert',
-        'insertGetId',
-        'lock',
-        'lockForUpdate',
-        'sharedLock',
-        'update',
-        'increment',
-        'decrement',
-        'delete',
-        'truncate',
-        'raw',
-    ];
-
-    /**
-     * Create a new Analogue Query Builder instance.
-     *
-     * @param  Mapper    $mapper
-     * @param  DBAdapter $adapter
-     */
-    public function __construct(Mapper $mapper, DBAdapter $adapter)
-    {
-        $this->mapper = $mapper;
-
-        $this->adapter = $adapter;
-
-        $this->entityMap = $mapper->getEntityMap();
-
-        // Specify the table to work on
-        $this->query = $adapter->getQuery()->from($this->entityMap->getTable());
-
-        $this->with($this->entityMap->getEagerloadedRelationships());
-    }
-
-    /**
-     * Run the query and return the result
-     *
-     * @param  array $columns
-     * @return \Analogue\ORM\EntityCollection
-     */
-    public function get($columns = ['*'])
-    {
-        $entities = $this->getEntities($columns);
-
-        // TODO Should move the call to new Collection on the result builder
-        return $this->entityMap->newCollection($entities);
-    }
-
-    /**
-     * Find an entity by its primary key
-     *
-     * @param  string|integer $id
-     * @param  array          $columns
-     * @return \Analogue\ORM\Mappable
-     */
-    public function find($id, $columns = ['*'])
-    {
-        if (is_array($id)) {
-            return $this->findMany($id, $columns);
-        }
-
-        $this->query->where($this->entityMap->getKeyName(), '=', $id);
-
-        return $this->first($columns);
-    }
-
-    /**
-     * Find many entities by their primary keys.
-     *
-     * @param  array $id
-     * @param  array $columns
-     * @return EntityCollection
-     */
-    public function findMany($id, $columns = ['*'])
-    {
-        if (empty($id)) {
-            return new EntityCollection;
-        }
-
-        $this->query->whereIn($this->entityMap->getKeyName(), $id);
-
-        return $this->get($columns);
-    }
-
-    /**
-     * Find a model by its primary key or throw an exception.
-     *
-     * @param  mixed $id
-     * @param  array $columns
-     * @throws \Analogue\ORM\Exceptions\EntityNotFoundException
-     * @return mixed|self
-     */
-    public function findOrFail($id, $columns = ['*'])
-    {
-        if (!is_null($entity = $this->find($id, $columns))) {
-            return $entity;
-        }
-
-        throw (new EntityNotFoundException)->setEntity(get_class($this->entityMap));
-    }
-
-
-    /**
-     * Execute the query and get the first result.
-     *
-     * @param  array $columns
-     * @return \Analogue\ORM\Entity
-     */
-    public function first($columns = ['*'])
-    {
-        return $this->take(1)->get($columns)->first();
-    }
-
-    /**
-     * Execute the query and get the first result or throw an exception.
-     *
-     * @param  array $columns
-     * @throws EntityNotFoundException
-     * @return \Analogue\ORM\Entity
-     */
-    public function firstOrFail($columns = ['*'])
-    {
-        if (!is_null($entity = $this->first($columns))) {
-            return $entity;
-        }
-
-        throw (new EntityNotFoundException)->setEntity(get_class($this->entityMap));
-    }
-
-    /**
-     * Pluck a single column from the database.
-     *
-     * @param  string $column
-     * @return mixed
-     */
-    public function pluck($column)
-    {
-        $result = $this->first([$column]);
-
-        if ($result) {
-            return $result->{$column};
-        }
-    }
-
-    /**
-     * Chunk the results of the query.
-     *
-     * @param  int      $count
-     * @param  callable $callback
-     * @return void
-     */
-    public function chunk($count, callable $callback)
-    {
-        $results = $this->forPage($page = 1, $count)->get();
-
-        while (count($results) > 0) {
-            // On each chunk result set, we will pass them to the callback and then let the
-            // developer take care of everything within the callback, which allows us to
-            // keep the memory low for spinning through large result sets for working.
-            call_user_func($callback, $results);
-
-            $page++;
-
-            $results = $this->forPage($page, $count)->get();
-        }
-    }
-
-    /**
-     * Get an array with the values of a given column.
-     *
-     * @param  string $column
-     * @param  string $key
-     * @return array
-     */
-    public function lists($column, $key = null)
-    {
-        return $this->query->pluck($column, $key);
-    }
-
-    /**
-     * Get a paginator for the "select" statement.
-     *
-     * @param  int   $perPage
-     * @param  array $columns
-     * @return LengthAwarePaginator
-     */
-    public function paginate($perPage = null, $columns = ['*'])
-    {
-        $total = $this->query->getCountForPagination();
-
-        $this->query->forPage(
-            $page = Paginator::resolveCurrentPage(),
-            $perPage = $perPage ?: $this->entityMap->getPerPage()
-        );
-
-        return new LengthAwarePaginator($this->get($columns)->all(), $total, $perPage, $page, [
-            'path' => Paginator::resolveCurrentPath()
-        ]);
-    }
-
-    /**
-     * Get a paginator for a grouped statement.
-     *
-     * @param  \Illuminate\Pagination\Factory $paginator
-     * @param  int                            $perPage
-     * @param  array                          $columns
-     * @return \Illuminate\Pagination\Paginator
-     */
-    protected function groupedPaginate($paginator, $perPage, $columns)
-    {
-        $results = $this->get($columns)->all();
-
-        return $this->query->buildRawPaginator($paginator, $results, $perPage);
-    }
-
-    /**
-     * Get a paginator for an ungrouped statement.
-     *
-     * @param  \Illuminate\Pagination\Factory $paginator
-     * @param  int                            $perPage
-     * @param  array                          $columns
-     * @return \Illuminate\Pagination\Paginator
-     */
-    protected function ungroupedPaginate($paginator, $perPage, $columns)
-    {
-        $total = $this->query->getPaginationCount();
-
-        // Once we have the paginator we need to set the limit and offset values for
-        // the query so we can get the properly paginated items. Once we have an
-        // array of items we can create the paginator instances for the items.
-        $page = $paginator->getCurrentPage($total);
-
-        $this->query->forPage($page, $perPage);
-
-        return $paginator->make($this->get($columns)->all(), $total, $perPage);
-    }
-
-    /**
-     * Paginate the given query into a simple paginator.
-     *
-     * @param  int   $perPage
-     * @param  array $columns
-     * @return \Illuminate\Contracts\Pagination\Paginator
-     */
-    public function simplePaginate($perPage = null, $columns = ['*'])
-    {
-        $page = Paginator::resolveCurrentPage();
-
-        $perPage = $perPage ?: $this->entityMap->getPerPage();
-
-        $this->skip(($page - 1) * $perPage)->take($perPage + 1);
-
-        return new Paginator($this->get($columns)->all(), $perPage, $page, ['path' => Paginator::resolveCurrentPath()]);
-    }
-
-    /**
-     * Add a basic where clause to the query.
-     *
-     * @param  string $column
-     * @param  string $operator
-     * @param  mixed  $value
-     * @param  string $boolean
-     * @return $this
-     */
-    public function where($column, $operator = null, $value = null, $boolean = 'and')
-    {
-        if ($column instanceof Closure) {
-            $query = $this->newQueryWithoutScopes();
-
-            call_user_func($column, $query);
-
-            $this->query->addNestedWhereQuery($query->getQuery(), $boolean);
-        } else {
-            call_user_func_array([$this->query, 'where'], func_get_args());
-        }
-
-        return $this;
-    }
-
-    /**
-     * Add an "or where" clause to the query.
-     *
-     * @param  string $column
-     * @param  string $operator
-     * @param  mixed  $value
-     * @return \Analogue\ORM\System\Query
-     */
-    public function orWhere($column, $operator = null, $value = null)
-    {
-        return $this->where($column, $operator, $value, 'or');
-    }
-
-    /**
-     * Add a relationship count condition to the query.
-     *
-     * @param  string   $relation
-     * @param  string   $operator
-     * @param  int      $count
-     * @param  string   $boolean
-     * @param  \Closure $callback
-     * @return \Analogue\ORM\System\Query
-     */
-    public function has($relation, $operator = '>=', $count = 1, $boolean = 'and', $callback = null)
-    {
-        $entity = $this->mapper->newInstance();
-
-        $relation = $this->getHasRelationQuery($relation, $entity);
-
-        $query = $relation->getRelationCountQuery($relation->getRelatedMapper()->getQuery(), $this);
-
-        if ($callback) {
-            call_user_func($callback, $query);
-        }
-
-        return $this->addHasWhere($query, $relation, $operator, $count, $boolean);
-    }
-
-    /**
-     * Add a relationship count condition to the query with where clauses.
-     *
-     * @param  string   $relation
-     * @param  \Closure $callback
-     * @param  string   $operator
-     * @param  int      $count
-     * @return \Analogue\ORM\System\Query
-     */
-    public function whereHas($relation, Closure $callback, $operator = '>=', $count = 1)
-    {
-        return $this->has($relation, $operator, $count, 'and', $callback);
-    }
-
-    /**
-     * Add a relationship count condition to the query with an "or".
-     *
-     * @param  string $relation
-     * @param  string $operator
-     * @param  int    $count
-     * @return \Analogue\ORM\System\Query
-     */
-    public function orHas($relation, $operator = '>=', $count = 1)
-    {
-        return $this->has($relation, $operator, $count, 'or');
-    }
-
-    /**
-     * Add a relationship count condition to the query with where clauses and an "or".
-     *
-     * @param  string   $relation
-     * @param  \Closure $callback
-     * @param  string   $operator
-     * @param  int      $count
-     * @return \Analogue\ORM\System\Query
-     */
-    public function orWhereHas($relation, Closure $callback, $operator = '>=', $count = 1)
-    {
-        return $this->has($relation, $operator, $count, 'or', $callback);
-    }
-
-    /**
-     * Add the "has" condition where clause to the query.
-     *
-     * @param  \Analogue\ORM\System\Query               $hasQuery
-     * @param  \Analogue\ORM\Relationships\Relationship $relation
-     * @param  string                                   $operator
-     * @param  int                                      $count
-     * @param  string                                   $boolean
-     * @return \Analogue\ORM\System\Query
-     */
-    protected function addHasWhere(Query $hasQuery, Relationship $relation, $operator, $count, $boolean)
-    {
-        $this->mergeWheresToHas($hasQuery, $relation);
-
-        if (is_numeric($count)) {
-            $count = new Expression($count);
-        }
-
-        return $this->where(new Expression('(' . $hasQuery->toSql() . ')'), $operator, $count, $boolean);
-    }
-
-    /**
-     * Merge the "wheres" from a relation query to a has query.
-     *
-     * @param  \Analogue\ORM\System\Query               $hasQuery
-     * @param  \Analogue\ORM\Relationships\Relationship $relation
-     * @return void
-     */
-    protected function mergeWheresToHas(Query $hasQuery, Relationship $relation)
-    {
-        // Here we have the "has" query and the original relation. We need to copy over any
-        // where clauses the developer may have put in the relationship function over to
-        // the has query, and then copy the bindings from the "has" query to the main.
-        $relationQuery = $relation->getBaseQuery();
-
-        $hasQuery->mergeWheres(
-            $relationQuery->wheres, $relationQuery->getBindings()
-        );
-
-        $this->query->mergeBindings($hasQuery->getQuery());
-    }
-
-    /**
-     * Get the "has relation" base query instance.
-     *
-     * @param  string $relation
-     * @param         $entity
-     * @return \Analogue\ORM\System\Query
-     */
-    protected function getHasRelationQuery($relation, $entity)
-    {
-        return Relationship::noConstraints(function () use ($relation, $entity) {
-            return $this->entityMap->$relation($entity);
-        });
-    }
-
-    /**
-     * Get the table for the current query object
-     *
-     * @return string
-     */
-    public function getTable()
-    {
-        return $this->entityMap->getTable();
-    }
-
-    /**
-     * Set the relationships that should be eager loaded.
-     *
-     * @param  mixed $relations
-     * @return $this
-     */
-    public function with($relations)
-    {
-        if (is_string($relations)) {
-            $relations = func_get_args();
-        }
-
-        $this->eagerLoad = array_merge($this->eagerLoad, $relations);
-
-        return $this;
-    }
-
-    /**
-     * Get the relationships being eagerly loaded.
-     *
-     * @return array
-     */
-    public function getEagerLoads()
-    {
-        return $this->eagerLoad;
-    }
-
-    /**
-     * Add the Entity primary key if not in requested columns
-     *
-     * @param  array $columns
-     * @return array
-     */
-    protected function enforceIdColumn($columns)
-    {
-        if (!in_array($this->entityMap->getKeyName(), $columns)) {
-            $columns[] = $this->entityMap->getKeyName();
-        }
-        return $columns;
-    }
-
-    /**
-     * Get the hydrated models without eager loading.
-     *
-     * @param  array  $columns
-     * @return \Analogue\ORM\EntityCollection
-     */
-    public function getEntities($columns = ['*'])
-    {
-        // As we need the primary key to feed the
-        // entity cache, we need it loaded on each
-        // request
-        $columns = $this->enforceIdColumn($columns);
-
-        // Run the query
-        $results = $this->query->get($columns)->toArray();
-
-        // Create a result builder.
-        $builder = new ResultBuilder($this->mapper); 
-
-        return $builder->build($results, $this->getEagerLoads());
-    }
-
-    /**
-     * Extend the builder with a given callback.
-     *
-     * @param  string   $name
-     * @param  \Closure $callback
-     * @return void
-     */
-    public function macro($name, Closure $callback)
-    {
-        $this->macros[$name] = $callback;
-    }
-
-    /**
-     * Get the given macro by name.
-     *
-     * @param  string $name
-     * @return \Closure
-     */
-    public function getMacro($name)
-    {
-        return array_get($this->macros, $name);
-    }
-
-    /**
-     * Get a new query builder for the model's table.
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function newQuery()
-    {
-        $builder = new Query($this->mapper, $this->adapter);
-
-        return $this->applyGlobalScopes($builder);
-    }
-
-    /**
-     * Get a new query builder without any scope applied.
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function newQueryWithoutScopes()
-    {
-        return new Query($this->mapper, $this->adapter);
-    }
-
-    /**
-     * Get the Mapper instance for this Query Builder
-     *
-     * @return \Analogue\ORM\System\Mapper
-     */
-    public function getMapper()
-    {
-        return $this->mapper;
-    }
-
-    /**
-     * Get the underlying query adapter
-     *
-     * (REFACTOR: this method should move out, we need to provide the client classes
-     * with the adapter instead.)
-     *
-     * @return \Analogue\ORM\Drivers\QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter
-     */
-    public function getQuery()
-    {
-        return $this->query;
-    }
-
-    /**
-     * Dynamically handle calls into the query instance.
-     *
-     * @param  string $method
-     * @param  array  $parameters
-     * @throws Exception
-     * @return mixed
-     */
-    public function __call($method, $parameters)
-    {
-        if (isset($this->macros[$method])) {
-            array_unshift($parameters, $this);
-
-            return call_user_func_array($this->macros[$method], $parameters);
-        }
-
-        if (in_array($method, $this->blacklist)) {
-            throw new Exception("Method $method doesn't exist");
-        }
-
-        $result = call_user_func_array([$this->query, $method], $parameters);
-
-        return in_array($method, $this->passthru) ? $result : $this;
-    }
+	/**
+	 * Mapper Instance
+	 *
+	 * @var \Analogue\ORM\System\Mapper
+	 */
+	protected $mapper;
+
+	/**
+	 * DB Adatper
+	 *
+	 * @var \Analogue\ORM\Drivers\DBAdapter
+	 */
+	protected $adapter;
+
+	/**
+	 * Query Builder Instance
+	 *
+	 * @var \Analogue\ORM\Drivers\QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter
+	 */
+	protected $query;
+
+	/**
+	 * Entity Map Instance
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $entityMap;
+
+	/**
+	 * The relationships that should be eager loaded.
+	 *
+	 * @var array
+	 */
+	protected $eagerLoad = [];
+
+	/**
+	 * All of the registered builder macros.
+	 *
+	 * @var array
+	 */
+	protected $macros = [];
+
+	/**
+	 * The methods that should be returned from query builder.
+	 *
+	 * @var array
+	 */
+	protected $passthru = [
+		'toSql',
+		'lists',
+		'pluck',
+		'count',
+		'min',
+		'max',
+		'avg',
+		'sum',
+		'exists',
+		'getBindings',
+	];
+
+	/**
+	 * Query Builder Blacklist
+	 */
+	protected $blacklist = [
+		'insert',
+		'insertGetId',
+		'lock',
+		'lockForUpdate',
+		'sharedLock',
+		'update',
+		'increment',
+		'decrement',
+		'delete',
+		'truncate',
+		'raw',
+	];
+
+	/**
+	 * Create a new Analogue Query Builder instance.
+	 *
+	 * @param  Mapper    $mapper
+	 * @param  DBAdapter $adapter
+	 */
+	public function __construct(Mapper $mapper, DBAdapter $adapter)
+	{
+		$this->mapper = $mapper;
+
+		$this->adapter = $adapter;
+
+		$this->entityMap = $mapper->getEntityMap();
+
+		// Specify the table to work on
+		$this->query = $adapter->getQuery()->from($this->entityMap->getTable());
+
+		$this->with($this->entityMap->getEagerloadedRelationships());
+	}
+
+	/**
+	 * Run the query and return the result
+	 *
+	 * @param  array $columns
+	 * @return \Analogue\ORM\EntityCollection
+	 */
+	public function get($columns = ['*'])
+	{
+		$entities = $this->getEntities($columns);
+
+		// TODO Should move the call to new Collection on the result builder
+		return $this->entityMap->newCollection($entities);
+	}
+
+	/**
+	 * Find an entity by its primary key
+	 *
+	 * @param  string|integer $id
+	 * @param  array          $columns
+	 * @return \Analogue\ORM\Mappable
+	 */
+	public function find($id, $columns = ['*'])
+	{
+		if (is_array($id)) {
+			return $this->findMany($id, $columns);
+		}
+
+		$this->query->where($this->entityMap->getKeyName(), '=', $id);
+
+		return $this->first($columns);
+	}
+
+	/**
+	 * Find many entities by their primary keys.
+	 *
+	 * @param  array $id
+	 * @param  array $columns
+	 * @return EntityCollection
+	 */
+	public function findMany($id, $columns = ['*'])
+	{
+		if (empty($id)) {
+			return new EntityCollection;
+		}
+
+		$this->query->whereIn($this->entityMap->getKeyName(), $id);
+
+		return $this->get($columns);
+	}
+
+	/**
+	 * Find a model by its primary key or throw an exception.
+	 *
+	 * @param  mixed $id
+	 * @param  array $columns
+	 * @throws \Analogue\ORM\Exceptions\EntityNotFoundException
+	 * @return mixed|self
+	 */
+	public function findOrFail($id, $columns = ['*'])
+	{
+		if (!is_null($entity = $this->find($id, $columns))) {
+			return $entity;
+		}
+
+		throw (new EntityNotFoundException)->setEntity(get_class($this->entityMap));
+	}
+
+
+	/**
+	 * Execute the query and get the first result.
+	 *
+	 * @param  array $columns
+	 * @return \Analogue\ORM\Entity
+	 */
+	public function first($columns = ['*'])
+	{
+		return $this->take(1)->get($columns)->first();
+	}
+
+	/**
+	 * Execute the query and get the first result or throw an exception.
+	 *
+	 * @param  array $columns
+	 * @throws EntityNotFoundException
+	 * @return \Analogue\ORM\Entity
+	 */
+	public function firstOrFail($columns = ['*'])
+	{
+		if (!is_null($entity = $this->first($columns))) {
+			return $entity;
+		}
+
+		throw (new EntityNotFoundException)->setEntity(get_class($this->entityMap));
+	}
+
+	/**
+	 * Pluck a single column from the database.
+	 *
+	 * @param  string $column
+	 * @return mixed
+	 */
+	public function pluck($column)
+	{
+		$result = $this->first([$column]);
+
+		if ($result) {
+			return $result->{$column};
+		}
+	}
+
+	/**
+	 * Chunk the results of the query.
+	 *
+	 * @param  int      $count
+	 * @param  callable $callback
+	 * @return void
+	 */
+	public function chunk($count, callable $callback)
+	{
+		$results = $this->forPage($page = 1, $count)->get();
+
+		while (count($results) > 0) {
+			// On each chunk result set, we will pass them to the callback and then let the
+			// developer take care of everything within the callback, which allows us to
+			// keep the memory low for spinning through large result sets for working.
+			call_user_func($callback, $results);
+
+			$page++;
+
+			$results = $this->forPage($page, $count)->get();
+		}
+	}
+
+	/**
+	 * Get an array with the values of a given column.
+	 *
+	 * @param  string $column
+	 * @param  string $key
+	 * @return array
+	 */
+	public function lists($column, $key = null)
+	{
+		return $this->query->pluck($column, $key);
+	}
+
+	/**
+	 * Get a paginator for the "select" statement.
+	 *
+	 * @param  int   $perPage
+	 * @param  array $columns
+	 * @return LengthAwarePaginator
+	 */
+	public function paginate($perPage = null, $columns = ['*'])
+	{
+		$total = $this->query->getCountForPagination();
+
+		$this->query->forPage(
+			$page = Paginator::resolveCurrentPage(),
+			$perPage = $perPage ?: $this->entityMap->getPerPage()
+		);
+
+		return new LengthAwarePaginator($this->get($columns)->all(), $total, $perPage, $page, [
+			'path' => Paginator::resolveCurrentPath()
+		]);
+	}
+
+	/**
+	 * Get a paginator for a grouped statement.
+	 *
+	 * @param  \Illuminate\Pagination\Factory $paginator
+	 * @param  int                            $perPage
+	 * @param  array                          $columns
+	 * @return \Illuminate\Pagination\Paginator
+	 */
+	protected function groupedPaginate($paginator, $perPage, $columns)
+	{
+		$results = $this->get($columns)->all();
+
+		return $this->query->buildRawPaginator($paginator, $results, $perPage);
+	}
+
+	/**
+	 * Get a paginator for an ungrouped statement.
+	 *
+	 * @param  \Illuminate\Pagination\Factory $paginator
+	 * @param  int                            $perPage
+	 * @param  array                          $columns
+	 * @return \Illuminate\Pagination\Paginator
+	 */
+	protected function ungroupedPaginate($paginator, $perPage, $columns)
+	{
+		$total = $this->query->getPaginationCount();
+
+		// Once we have the paginator we need to set the limit and offset values for
+		// the query so we can get the properly paginated items. Once we have an
+		// array of items we can create the paginator instances for the items.
+		$page = $paginator->getCurrentPage($total);
+
+		$this->query->forPage($page, $perPage);
+
+		return $paginator->make($this->get($columns)->all(), $total, $perPage);
+	}
+
+	/**
+	 * Paginate the given query into a simple paginator.
+	 *
+	 * @param  int   $perPage
+	 * @param  array $columns
+	 * @return \Illuminate\Contracts\Pagination\Paginator
+	 */
+	public function simplePaginate($perPage = null, $columns = ['*'])
+	{
+		$page = Paginator::resolveCurrentPage();
+
+		$perPage = $perPage ?: $this->entityMap->getPerPage();
+
+		$this->skip(($page - 1) * $perPage)->take($perPage + 1);
+
+		return new Paginator($this->get($columns)->all(), $perPage, $page, ['path' => Paginator::resolveCurrentPath()]);
+	}
+
+	/**
+	 * Add a basic where clause to the query.
+	 *
+	 * @param  string $column
+	 * @param  string $operator
+	 * @param  mixed  $value
+	 * @param  string $boolean
+	 * @return $this
+	 */
+	public function where($column, $operator = null, $value = null, $boolean = 'and')
+	{
+		if ($column instanceof Closure) {
+			$query = $this->newQueryWithoutScopes();
+
+			call_user_func($column, $query);
+
+			$this->query->addNestedWhereQuery($query->getQuery(), $boolean);
+		} else {
+			call_user_func_array([$this->query, 'where'], func_get_args());
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Add an "or where" clause to the query.
+	 *
+	 * @param  string $column
+	 * @param  string $operator
+	 * @param  mixed  $value
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function orWhere($column, $operator = null, $value = null)
+	{
+		return $this->where($column, $operator, $value, 'or');
+	}
+
+	/**
+	 * Add a relationship count condition to the query.
+	 *
+	 * @param  string   $relation
+	 * @param  string   $operator
+	 * @param  int      $count
+	 * @param  string   $boolean
+	 * @param  \Closure $callback
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function has($relation, $operator = '>=', $count = 1, $boolean = 'and', $callback = null)
+	{
+		$entity = $this->mapper->newInstance();
+
+		$relation = $this->getHasRelationQuery($relation, $entity);
+
+		$query = $relation->getRelationCountQuery($relation->getRelatedMapper()->getQuery(), $this);
+
+		if ($callback) {
+			call_user_func($callback, $query);
+		}
+
+		return $this->addHasWhere($query, $relation, $operator, $count, $boolean);
+	}
+
+	/**
+	 * Add a relationship count condition to the query with where clauses.
+	 *
+	 * @param  string   $relation
+	 * @param  \Closure $callback
+	 * @param  string   $operator
+	 * @param  int      $count
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function whereHas($relation, Closure $callback, $operator = '>=', $count = 1)
+	{
+		return $this->has($relation, $operator, $count, 'and', $callback);
+	}
+
+	/**
+	 * Add a relationship count condition to the query with an "or".
+	 *
+	 * @param  string $relation
+	 * @param  string $operator
+	 * @param  int    $count
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function orHas($relation, $operator = '>=', $count = 1)
+	{
+		return $this->has($relation, $operator, $count, 'or');
+	}
+
+	/**
+	 * Add a relationship count condition to the query with where clauses and an "or".
+	 *
+	 * @param  string   $relation
+	 * @param  \Closure $callback
+	 * @param  string   $operator
+	 * @param  int      $count
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function orWhereHas($relation, Closure $callback, $operator = '>=', $count = 1)
+	{
+		return $this->has($relation, $operator, $count, 'or', $callback);
+	}
+
+	/**
+	 * Add the "has" condition where clause to the query.
+	 *
+	 * @param  \Analogue\ORM\System\Query               $hasQuery
+	 * @param  \Analogue\ORM\Relationships\Relationship $relation
+	 * @param  string                                   $operator
+	 * @param  int                                      $count
+	 * @param  string                                   $boolean
+	 * @return \Analogue\ORM\System\Query
+	 */
+	protected function addHasWhere(Query $hasQuery, Relationship $relation, $operator, $count, $boolean)
+	{
+		$this->mergeWheresToHas($hasQuery, $relation);
+
+		if (is_numeric($count)) {
+			$count = new Expression($count);
+		}
+
+		return $this->where(new Expression('(' . $hasQuery->toSql() . ')'), $operator, $count, $boolean);
+	}
+
+	/**
+	 * Merge the "wheres" from a relation query to a has query.
+	 *
+	 * @param  \Analogue\ORM\System\Query               $hasQuery
+	 * @param  \Analogue\ORM\Relationships\Relationship $relation
+	 * @return void
+	 */
+	protected function mergeWheresToHas(Query $hasQuery, Relationship $relation)
+	{
+		// Here we have the "has" query and the original relation. We need to copy over any
+		// where clauses the developer may have put in the relationship function over to
+		// the has query, and then copy the bindings from the "has" query to the main.
+		$relationQuery = $relation->getBaseQuery();
+
+		$hasQuery->mergeWheres(
+			$relationQuery->wheres, $relationQuery->getBindings()
+		);
+
+		$this->query->mergeBindings($hasQuery->getQuery());
+	}
+
+	/**
+	 * Get the "has relation" base query instance.
+	 *
+	 * @param  string $relation
+	 * @param         $entity
+	 * @return \Analogue\ORM\System\Query
+	 */
+	protected function getHasRelationQuery($relation, $entity)
+	{
+		return Relationship::noConstraints(function () use ($relation, $entity) {
+			return $this->entityMap->$relation($entity);
+		});
+	}
+
+	/**
+	 * Get the table for the current query object
+	 *
+	 * @return string
+	 */
+	public function getTable()
+	{
+		return $this->entityMap->getTable();
+	}
+
+	/**
+	 * Set the relationships that should be eager loaded.
+	 *
+	 * @param  mixed $relations
+	 * @return $this
+	 */
+	public function with($relations)
+	{
+		if (is_string($relations)) {
+			$relations = func_get_args();
+		}
+
+		$this->eagerLoad = array_merge($this->eagerLoad, $relations);
+
+		return $this;
+	}
+
+	/**
+	 * Get the relationships being eagerly loaded.
+	 *
+	 * @return array
+	 */
+	public function getEagerLoads()
+	{
+		return $this->eagerLoad;
+	}
+
+	/**
+	 * Add the Entity primary key if not in requested columns
+	 *
+	 * @param  array $columns
+	 * @return array
+	 */
+	protected function enforceIdColumn($columns)
+	{
+		if (!in_array($this->entityMap->getKeyName(), $columns)) {
+			$columns[] = $this->entityMap->getKeyName();
+		}
+		return $columns;
+	}
+
+	/**
+	 * Get the hydrated models without eager loading.
+	 *
+	 * @param  array  $columns
+	 * @return \Analogue\ORM\EntityCollection
+	 */
+	public function getEntities($columns = ['*'])
+	{
+		// As we need the primary key to feed the
+		// entity cache, we need it loaded on each
+		// request
+		$columns = $this->enforceIdColumn($columns);
+
+		// Run the query
+		$results = $this->query->get($columns)->toArray();
+
+		// Create a result builder.
+		$builder = new ResultBuilder($this->mapper); 
+
+		return $builder->build($results, $this->getEagerLoads());
+	}
+
+	/**
+	 * Extend the builder with a given callback.
+	 *
+	 * @param  string   $name
+	 * @param  \Closure $callback
+	 * @return void
+	 */
+	public function macro($name, Closure $callback)
+	{
+		$this->macros[$name] = $callback;
+	}
+
+	/**
+	 * Get the given macro by name.
+	 *
+	 * @param  string $name
+	 * @return \Closure
+	 */
+	public function getMacro($name)
+	{
+		return array_get($this->macros, $name);
+	}
+
+	/**
+	 * Get a new query builder for the model's table.
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function newQuery()
+	{
+		$builder = new Query($this->mapper, $this->adapter);
+
+		return $this->applyGlobalScopes($builder);
+	}
+
+	/**
+	 * Get a new query builder without any scope applied.
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function newQueryWithoutScopes()
+	{
+		return new Query($this->mapper, $this->adapter);
+	}
+
+	/**
+	 * Get the Mapper instance for this Query Builder
+	 *
+	 * @return \Analogue\ORM\System\Mapper
+	 */
+	public function getMapper()
+	{
+		return $this->mapper;
+	}
+
+	/**
+	 * Get the underlying query adapter
+	 *
+	 * (REFACTOR: this method should move out, we need to provide the client classes
+	 * with the adapter instead.)
+	 *
+	 * @return \Analogue\ORM\Drivers\QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter
+	 */
+	public function getQuery()
+	{
+		return $this->query;
+	}
+
+	/**
+	 * Dynamically handle calls into the query instance.
+	 *
+	 * @param  string $method
+	 * @param  array  $parameters
+	 * @throws Exception
+	 * @return mixed
+	 */
+	public function __call($method, $parameters)
+	{
+		if (isset($this->macros[$method])) {
+			array_unshift($parameters, $this);
+
+			return call_user_func_array($this->macros[$method], $parameters);
+		}
+
+		if (in_array($method, $this->blacklist)) {
+			throw new Exception("Method $method doesn't exist");
+		}
+
+		$result = call_user_func_array([$this->query, $method], $parameters);
+
+		return in_array($method, $this->passthru) ? $result : $this;
+	}
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -458,7 +458,7 @@ 
             $count = new Expression($count);
         }
 
-        return $this->where(new Expression('(' . $hasQuery->toSql() . ')'), $operator, $count, $boolean);
+        return $this->where(new Expression('('.$hasQuery->toSql().')'), $operator, $count, $boolean);
     }
 
     /**
@@ -491,7 +491,7 @@ 
      */
     protected function getHasRelationQuery($relation, $entity)
     {
-        return Relationship::noConstraints(function () use ($relation, $entity) {
+        return Relationship::noConstraints(function() use ($relation, $entity) {
             return $this->entityMap->$relation($entity);
         });
     }

src/System/Aggregate.php

Indentation +1054 added lines, -1054 removed lines

@@ -16,1080 +16,1080 @@
  */
 class Aggregate implements InternallyMappable
 {
-    /**
-     * The Root Entity
-     *
-     * @var \Analogue\ORM\System\Wrappers\Wrapper
-     */
-    protected $wrappedEntity;
-
-    /** 
-     * Class of the entity being aggregated
-     * 
-     * @var string
-     */
-    protected $class;
-
-    /**
-     * Parent Root Aggregate
-     *
-     * @var \Analogue\ORM\System\Aggregate
-     */
-    protected $parent;
-
-    /**
-     * Parent's relationship method
-     *
-     * @var string
-     */
-    protected $parentRelationship;
-
-    /**
-     * Root Entity
-     *
-     * @var \Analogue\ORM\System\Aggregate
-     */
-    protected $root;
-
-    /**
-     * An associative array containing entity's
-     * relationships converted to Aggregates
-     *
-     * @var array
-     */
-    protected $relationships = [];
-
-    /**
-     * Relationship that need post-command synchronization
-     *
-     * @var array
-     */
-    protected $needSync = [];
-
-    /**
-     * Mapper
-     *
-     * @var \Analogue\ORM\System\Mapper;
-     */
-    protected $mapper;
-
-    /**
-     * Entity Map
-     *
-     * @var \Analogue\ORM\EntityMap;
-     */
-    protected $entityMap;
-
-    /**
-     * Create a new Aggregated Entity instance
-     *
-     * @param mixed          $entity
-     * @param Aggregate|null $parent
-     * @param string         $parentRelationship
-     * @param Aggregate|null $root
-     * @throws MappingException
-     */
-    public function __construct($entity, Aggregate $parent = null, $parentRelationship = null, Aggregate $root = null)
-    {
-        $factory = new Factory;
+	/**
+	 * The Root Entity
+	 *
+	 * @var \Analogue\ORM\System\Wrappers\Wrapper
+	 */
+	protected $wrappedEntity;
+
+	/** 
+	 * Class of the entity being aggregated
+	 * 
+	 * @var string
+	 */
+	protected $class;
+
+	/**
+	 * Parent Root Aggregate
+	 *
+	 * @var \Analogue\ORM\System\Aggregate
+	 */
+	protected $parent;
+
+	/**
+	 * Parent's relationship method
+	 *
+	 * @var string
+	 */
+	protected $parentRelationship;
+
+	/**
+	 * Root Entity
+	 *
+	 * @var \Analogue\ORM\System\Aggregate
+	 */
+	protected $root;
+
+	/**
+	 * An associative array containing entity's
+	 * relationships converted to Aggregates
+	 *
+	 * @var array
+	 */
+	protected $relationships = [];
+
+	/**
+	 * Relationship that need post-command synchronization
+	 *
+	 * @var array
+	 */
+	protected $needSync = [];
+
+	/**
+	 * Mapper
+	 *
+	 * @var \Analogue\ORM\System\Mapper;
+	 */
+	protected $mapper;
+
+	/**
+	 * Entity Map
+	 *
+	 * @var \Analogue\ORM\EntityMap;
+	 */
+	protected $entityMap;
+
+	/**
+	 * Create a new Aggregated Entity instance
+	 *
+	 * @param mixed          $entity
+	 * @param Aggregate|null $parent
+	 * @param string         $parentRelationship
+	 * @param Aggregate|null $root
+	 * @throws MappingException
+	 */
+	public function __construct($entity, Aggregate $parent = null, $parentRelationship = null, Aggregate $root = null)
+	{
+		$factory = new Factory;
         
-        $this->class = get_class($entity);
+		$this->class = get_class($entity);
 
-        $this->wrappedEntity = $factory->make($entity);
+		$this->wrappedEntity = $factory->make($entity);
 
-        $this->parent = $parent;
+		$this->parent = $parent;
 
-        $this->parentRelationship = $parentRelationship;
+		$this->parentRelationship = $parentRelationship;
 
-        $this->root = $root;
+		$this->root = $root;
 
-        $mapper = $this->getMapper($entity);
+		$mapper = $this->getMapper($entity);
 
-        $this->entityMap = $mapper->getEntityMap();
+		$this->entityMap = $mapper->getEntityMap();
              
-        $this->parseRelationships();
-    }
-
-    /**
-     * Parse Every relationships defined on the entity
-     *
-     * @throws MappingException
-     * @return void
-     */
-    protected function parseRelationships()
-    {
-        foreach ($this->entityMap->getSingleRelationships() as $relation) {
-            $this->parseSingleRelationship($relation);
-        }
-
-        foreach ($this->entityMap->getManyRelationships() as $relation) {
-            $this->parseManyRelationship($relation);
-        }
-    }
-
-    /**
-     * Parse for values common to single & many relations
-     *
-     * @param  string $relation
-     * @throws MappingException
-     * @return mixed|boolean
-     */
-    protected function parseForCommonValues($relation)
-    {
-        if (!$this->hasAttribute($relation)) {
-            // If no attribute exists for this relationships
-            // we'll make it a simple empty array. This will
-            // save us from constantly checking for the attributes
-            // actual existence.
-            $this->relationships[$relation] = [];
-            return false;
-        }
-
-        $value = $this->getRelationshipValue($relation);
-
-        if (is_null($value)) {
-            $this->relationships[$relation] = [];
-
-            // If the relationship's content is the null value
-            // and the Entity's exist in DB, we'll interpret this
-            // as the need to detach all related Entities,
-            // therefore a sync operation is needed.
-            $this->needSync[] = $relation;
-            return false;
-        }
-
-        return $value;
-    }
-
-    /**
-     * Parse a 'single' relationship
-     *
-     * @param  string $relation
-     * @throws MappingException
-     * @return boolean
-     */
-    protected function parseSingleRelationship($relation)
-    {
-        if (!$value = $this->parseForCommonValues($relation)) {
-            return true;
-        }
+		$this->parseRelationships();
+	}
+
+	/**
+	 * Parse Every relationships defined on the entity
+	 *
+	 * @throws MappingException
+	 * @return void
+	 */
+	protected function parseRelationships()
+	{
+		foreach ($this->entityMap->getSingleRelationships() as $relation) {
+			$this->parseSingleRelationship($relation);
+		}
+
+		foreach ($this->entityMap->getManyRelationships() as $relation) {
+			$this->parseManyRelationship($relation);
+		}
+	}
+
+	/**
+	 * Parse for values common to single & many relations
+	 *
+	 * @param  string $relation
+	 * @throws MappingException
+	 * @return mixed|boolean
+	 */
+	protected function parseForCommonValues($relation)
+	{
+		if (!$this->hasAttribute($relation)) {
+			// If no attribute exists for this relationships
+			// we'll make it a simple empty array. This will
+			// save us from constantly checking for the attributes
+			// actual existence.
+			$this->relationships[$relation] = [];
+			return false;
+		}
+
+		$value = $this->getRelationshipValue($relation);
+
+		if (is_null($value)) {
+			$this->relationships[$relation] = [];
+
+			// If the relationship's content is the null value
+			// and the Entity's exist in DB, we'll interpret this
+			// as the need to detach all related Entities,
+			// therefore a sync operation is needed.
+			$this->needSync[] = $relation;
+			return false;
+		}
+
+		return $value;
+	}
+
+	/**
+	 * Parse a 'single' relationship
+	 *
+	 * @param  string $relation
+	 * @throws MappingException
+	 * @return boolean
+	 */
+	protected function parseSingleRelationship($relation)
+	{
+		if (!$value = $this->parseForCommonValues($relation)) {
+			return true;
+		}
         
-        if ($value instanceof Collection || is_array($value) || $value instanceof CollectionProxy) {
-            throw new MappingException("Entity's attribute $relation should not be array, or collection");
-        }
-
-        if ($value instanceof LazyLoadingInterface && !$value->isProxyInitialized()) {
-            $this->relationships[$relation] = [];
-            return true;
-        }
-
-        // If the attribute is a loaded proxy, swap it for its
-        // loaded entity.
-        if ($value instanceof LazyLoadingInterface && $value->isProxyInitialized()) {
-            $value = $value->getWrappedValueHolderValue();
-        }
-
-        if ($this->isParentOrRoot($value)) {
-            $this->relationships[$relation] = [];
-            return true;
-        }
-
-        // At this point, we can assume the attribute is an Entity instance
-        // so we'll treat it as such.
-        $subAggregate = $this->createSubAggregate($value, $relation);
+		if ($value instanceof Collection || is_array($value) || $value instanceof CollectionProxy) {
+			throw new MappingException("Entity's attribute $relation should not be array, or collection");
+		}
+
+		if ($value instanceof LazyLoadingInterface && !$value->isProxyInitialized()) {
+			$this->relationships[$relation] = [];
+			return true;
+		}
+
+		// If the attribute is a loaded proxy, swap it for its
+		// loaded entity.
+		if ($value instanceof LazyLoadingInterface && $value->isProxyInitialized()) {
+			$value = $value->getWrappedValueHolderValue();
+		}
+
+		if ($this->isParentOrRoot($value)) {
+			$this->relationships[$relation] = [];
+			return true;
+		}
+
+		// At this point, we can assume the attribute is an Entity instance
+		// so we'll treat it as such.
+		$subAggregate = $this->createSubAggregate($value, $relation);
          
-        // Even if it's a single entity, we'll store it as an array
-        // just for consistency with other relationships
-        $this->relationships[$relation] = [$subAggregate];
-
-        // We always need to check a loaded relation is in sync
-        // with its local key
-        $this->needSync[] = $relation;
-
-        return true;
-    }
-
-    /**
-     * Check if value isn't parent or root in the aggregate
-     *
-     * @param  mixed
-     * @return boolean|null
-     */
-    protected function isParentOrRoot($value)
-    {
-        if (!is_null($this->root)) {
-            $rootClass = get_class($this->root->getEntityObject());
-            if ($rootClass == get_class($value)) {
-                return true;
-            }
-        }
-
-        if (!is_null($this->parent)) {
-            $parentClass = get_class($this->parent->getEntityObject());
-            if ($parentClass == get_class($value)) {
-                return true;
-            }
-        }
-    }
-
-    /**
-     * Parse a 'many' relationship
-     *
-     * @param  string $relation
-     * @throws MappingException
-     * @return boolean
-     */
-    protected function parseManyRelationship($relation)
-    {
-        if (!$value = $this->parseForCommonValues($relation)) {
-            return true;
-        }
+		// Even if it's a single entity, we'll store it as an array
+		// just for consistency with other relationships
+		$this->relationships[$relation] = [$subAggregate];
+
+		// We always need to check a loaded relation is in sync
+		// with its local key
+		$this->needSync[] = $relation;
+
+		return true;
+	}
+
+	/**
+	 * Check if value isn't parent or root in the aggregate
+	 *
+	 * @param  mixed
+	 * @return boolean|null
+	 */
+	protected function isParentOrRoot($value)
+	{
+		if (!is_null($this->root)) {
+			$rootClass = get_class($this->root->getEntityObject());
+			if ($rootClass == get_class($value)) {
+				return true;
+			}
+		}
+
+		if (!is_null($this->parent)) {
+			$parentClass = get_class($this->parent->getEntityObject());
+			if ($parentClass == get_class($value)) {
+				return true;
+			}
+		}
+	}
+
+	/**
+	 * Parse a 'many' relationship
+	 *
+	 * @param  string $relation
+	 * @throws MappingException
+	 * @return boolean
+	 */
+	protected function parseManyRelationship($relation)
+	{
+		if (!$value = $this->parseForCommonValues($relation)) {
+			return true;
+		}
         
-        if (is_array($value) || (! $value instanceof CollectionProxy && $value instanceof Collection)) {
-            $this->needSync[] = $relation;
-        }
-
-        // If the relation is a proxy, we test is the relation
-        // has been lazy loaded, otherwise we'll just treat
-        // the subset of newly added items.
-        if ($value instanceof CollectionProxy && $value->isProxyInitialized()) {
-            $this->needSync[] = $relation;
-            //$value = $value->getUnderlyingCollection();
-        }
-
-        if ($value instanceof CollectionProxy && ! $value->isProxyInitialized()) {
-            $value = $value->getAddedItems();
-        }
-
-        // At this point $value should be either an array or an instance
-        // of a collection class.
-        if (!is_array($value) && !$value instanceof Collection) {
-            throw new MappingException("'$relation' attribute should be array() or Collection");
-        }
-
-        $this->relationships[$relation] = $this->createSubAggregates($value, $relation);
+		if (is_array($value) || (! $value instanceof CollectionProxy && $value instanceof Collection)) {
+			$this->needSync[] = $relation;
+		}
+
+		// If the relation is a proxy, we test is the relation
+		// has been lazy loaded, otherwise we'll just treat
+		// the subset of newly added items.
+		if ($value instanceof CollectionProxy && $value->isProxyInitialized()) {
+			$this->needSync[] = $relation;
+			//$value = $value->getUnderlyingCollection();
+		}
+
+		if ($value instanceof CollectionProxy && ! $value->isProxyInitialized()) {
+			$value = $value->getAddedItems();
+		}
+
+		// At this point $value should be either an array or an instance
+		// of a collection class.
+		if (!is_array($value) && !$value instanceof Collection) {
+			throw new MappingException("'$relation' attribute should be array() or Collection");
+		}
+
+		$this->relationships[$relation] = $this->createSubAggregates($value, $relation);
         
-        return true;
-    }
-
-    /**
-     * Return Entity's relationship attribute
-     *
-     * @param  string $relation
-     * @throws MappingException
-     * @return mixed
-     */
-    protected function getRelationshipValue($relation)
-    {
-        $value = $this->getEntityAttribute($relation);
-        //if($relation == "role") tdd($this->wrappedEntity->getEntityAttributes());
-        if (is_bool($value) || is_float($value) || is_int($value) || is_string($value)) {
-            throw new MappingException("Entity's attribute $relation should be array, object, collection or null");
-        }
-
-        return $value;
-    }
-
-    /**
-     * Create a child, aggregated entity
-     *
-     * @param  mixed $entities
-     * @param string $relation
-     * @return array
-     */
-    protected function createSubAggregates($entities, $relation)
-    {
-        $aggregates = [];
-
-        foreach ($entities as $entity) {
-            $aggregates[] = $this->createSubAggregate($entity, $relation);
-        }
-
-        return $aggregates;
-    }
-
-    /**
-     * Create a related subAggregate
-     *
-     * @param  mixed $entity
-     * @param  string $relation
-     * @throws MappingException
-     * @return self
-     */
-    protected function createSubAggregate($entity, $relation)
-    {
-        // If root isn't defined, then this is the Aggregate Root
-        if (is_null($this->root)) {
-            $root = $this;
-        } else {
-            $root = $this->root;
-        }
-
-        return new self($entity, $this, $relation, $root);
-    }
-
-    /**
-     * Get the Entity's primary key attribute
-     *
-     * @return string|integer
-     */
-    public function getEntityId()
-    {
-        return $this->wrappedEntity->getEntityKey();
-    }
-
-    /**
-     * Get the name of the primary key
-     *
-     * @return string
-     */
-    public function getEntityKey()
-    {
-        return $this->entityMap->getKeyName();
-    }
-
-    /**
-     * Return the entity map for the current entity
-     *
-     * @return \Analogue\ORM\EntityMap
-     */
-    public function getEntityMap()
-    {
-        return $this->entityMap;
-    }
-
-    /**
-     * Return the Entity's hash $class.$id
-     *
-     * @return string
-     */
-    public function getEntityHash()
-    {
-        return $this->getEntityClass() . '.' . $this->getEntityId();
-    }
-
-    /**
-     * Get wrapped entity class
-     *
-     * @return string
-     */
-    public function getEntityClass()
-    {
-        return $this->entityMap->getClass();
-    }
-
-    /**
-     * Return the Mapper's entity cache
-     *
-     * @return \Analogue\ORM\System\EntityCache
-     */
-    protected function getEntityCache()
-    {
-        return $this->getMapper()->getEntityCache();
-    }
-
-    /**
-     * Get a relationship as an aggregated entities' array
-     *
-     * @param  string $name
-     * @return array
-     */
-    public function getRelationship($name)
-    {
-        if (array_key_exists($name, $this->relationships)) {
-            return $this->relationships[$name];
-        } else {
-            return [];
-        }
-    }
-
-    /**
-     * [TO IMPLEMENT]
-     *
-     * @return array
-     */
-    public function getPivotAttributes()
-    {
-        return [];
-    }
-
-    /**
-     * Get Non existing related entities from several relationships
-     *
-     * @param  array $relationships
-     * @return array
-     */
-    public function getNonExistingRelated(array $relationships)
-    {
-        $nonExisting = [];
-
-        foreach ($relationships as $relation) {
-
-            if ($this->hasAttribute($relation) && array_key_exists($relation, $this->relationships)) {
-                $nonExisting = array_merge($nonExisting, $this->getNonExistingFromRelation($relation));
-            }
-        }
-
-        return $nonExisting;
-    }
-
-    /**
-     * Get non-existing related entities from a single relation
-     *
-     * @param  string $relation
-     * @return array
-     */
-    protected function getNonExistingFromRelation($relation)
-    {
-        $nonExisting = [];
-
-        foreach ($this->relationships[$relation] as $aggregate) {
-            if (!$aggregate->exists()) {
-                $nonExisting[] = $aggregate;
-            }
-        }
-
-        return $nonExisting;
-    }
-
-    /**
-     * Synchronize relationships if needed
-     *
-     * @param array
-     * @return void
-     */
-    public function syncRelationships(array $relationships)
-    {
-        foreach ($relationships as $relation) {
-            if (in_array($relation, $this->needSync)) {
-                $this->synchronize($relation);
-            }
-        }
-    }
-
-    /**
-     * Synchronize a relationship attribute
-     *
-     * @param $relation
-     * @return void
-     */
-    protected function synchronize($relation)
-    {
-        $actualContent = $this->relationships[$relation];
-
-        $relationshipObject = $this->entityMap->$relation($this->getEntityObject());
-        $relationshipObject->setParent($this->wrappedEntity);
-        $relationshipObject->sync($actualContent);
-    }
-
-    /**
-     * Returns an array of Missing related Entities for the
-     * given $relation
-     *
-     * @param  string $relation
-     * @return array
-     */
-    public function getMissingEntities($relation)
-    {
-        $cachedRelations = $this->getCachedAttribute($relation);
-
-        if (!is_null($cachedRelations)) {
-            $missing = [];
-
-            foreach ($cachedRelations as $hash) {
-                if (!$this->getRelatedAggregateFromHash($hash, $relation)) {
-                    $missing[] = $hash;
-                }
-            }
-
-            return $missing;
-        } else {
-            return [];
-        }
-    }
+		return true;
+	}
+
+	/**
+	 * Return Entity's relationship attribute
+	 *
+	 * @param  string $relation
+	 * @throws MappingException
+	 * @return mixed
+	 */
+	protected function getRelationshipValue($relation)
+	{
+		$value = $this->getEntityAttribute($relation);
+		//if($relation == "role") tdd($this->wrappedEntity->getEntityAttributes());
+		if (is_bool($value) || is_float($value) || is_int($value) || is_string($value)) {
+			throw new MappingException("Entity's attribute $relation should be array, object, collection or null");
+		}
+
+		return $value;
+	}
+
+	/**
+	 * Create a child, aggregated entity
+	 *
+	 * @param  mixed $entities
+	 * @param string $relation
+	 * @return array
+	 */
+	protected function createSubAggregates($entities, $relation)
+	{
+		$aggregates = [];
+
+		foreach ($entities as $entity) {
+			$aggregates[] = $this->createSubAggregate($entity, $relation);
+		}
+
+		return $aggregates;
+	}
+
+	/**
+	 * Create a related subAggregate
+	 *
+	 * @param  mixed $entity
+	 * @param  string $relation
+	 * @throws MappingException
+	 * @return self
+	 */
+	protected function createSubAggregate($entity, $relation)
+	{
+		// If root isn't defined, then this is the Aggregate Root
+		if (is_null($this->root)) {
+			$root = $this;
+		} else {
+			$root = $this->root;
+		}
+
+		return new self($entity, $this, $relation, $root);
+	}
+
+	/**
+	 * Get the Entity's primary key attribute
+	 *
+	 * @return string|integer
+	 */
+	public function getEntityId()
+	{
+		return $this->wrappedEntity->getEntityKey();
+	}
+
+	/**
+	 * Get the name of the primary key
+	 *
+	 * @return string
+	 */
+	public function getEntityKey()
+	{
+		return $this->entityMap->getKeyName();
+	}
+
+	/**
+	 * Return the entity map for the current entity
+	 *
+	 * @return \Analogue\ORM\EntityMap
+	 */
+	public function getEntityMap()
+	{
+		return $this->entityMap;
+	}
+
+	/**
+	 * Return the Entity's hash $class.$id
+	 *
+	 * @return string
+	 */
+	public function getEntityHash()
+	{
+		return $this->getEntityClass() . '.' . $this->getEntityId();
+	}
+
+	/**
+	 * Get wrapped entity class
+	 *
+	 * @return string
+	 */
+	public function getEntityClass()
+	{
+		return $this->entityMap->getClass();
+	}
+
+	/**
+	 * Return the Mapper's entity cache
+	 *
+	 * @return \Analogue\ORM\System\EntityCache
+	 */
+	protected function getEntityCache()
+	{
+		return $this->getMapper()->getEntityCache();
+	}
+
+	/**
+	 * Get a relationship as an aggregated entities' array
+	 *
+	 * @param  string $name
+	 * @return array
+	 */
+	public function getRelationship($name)
+	{
+		if (array_key_exists($name, $this->relationships)) {
+			return $this->relationships[$name];
+		} else {
+			return [];
+		}
+	}
+
+	/**
+	 * [TO IMPLEMENT]
+	 *
+	 * @return array
+	 */
+	public function getPivotAttributes()
+	{
+		return [];
+	}
+
+	/**
+	 * Get Non existing related entities from several relationships
+	 *
+	 * @param  array $relationships
+	 * @return array
+	 */
+	public function getNonExistingRelated(array $relationships)
+	{
+		$nonExisting = [];
+
+		foreach ($relationships as $relation) {
+
+			if ($this->hasAttribute($relation) && array_key_exists($relation, $this->relationships)) {
+				$nonExisting = array_merge($nonExisting, $this->getNonExistingFromRelation($relation));
+			}
+		}
+
+		return $nonExisting;
+	}
+
+	/**
+	 * Get non-existing related entities from a single relation
+	 *
+	 * @param  string $relation
+	 * @return array
+	 */
+	protected function getNonExistingFromRelation($relation)
+	{
+		$nonExisting = [];
+
+		foreach ($this->relationships[$relation] as $aggregate) {
+			if (!$aggregate->exists()) {
+				$nonExisting[] = $aggregate;
+			}
+		}
+
+		return $nonExisting;
+	}
+
+	/**
+	 * Synchronize relationships if needed
+	 *
+	 * @param array
+	 * @return void
+	 */
+	public function syncRelationships(array $relationships)
+	{
+		foreach ($relationships as $relation) {
+			if (in_array($relation, $this->needSync)) {
+				$this->synchronize($relation);
+			}
+		}
+	}
+
+	/**
+	 * Synchronize a relationship attribute
+	 *
+	 * @param $relation
+	 * @return void
+	 */
+	protected function synchronize($relation)
+	{
+		$actualContent = $this->relationships[$relation];
+
+		$relationshipObject = $this->entityMap->$relation($this->getEntityObject());
+		$relationshipObject->setParent($this->wrappedEntity);
+		$relationshipObject->sync($actualContent);
+	}
+
+	/**
+	 * Returns an array of Missing related Entities for the
+	 * given $relation
+	 *
+	 * @param  string $relation
+	 * @return array
+	 */
+	public function getMissingEntities($relation)
+	{
+		$cachedRelations = $this->getCachedAttribute($relation);
+
+		if (!is_null($cachedRelations)) {
+			$missing = [];
+
+			foreach ($cachedRelations as $hash) {
+				if (!$this->getRelatedAggregateFromHash($hash, $relation)) {
+					$missing[] = $hash;
+				}
+			}
+
+			return $missing;
+		} else {
+			return [];
+		}
+	}
        
-    /**
-     * Get Relationships who have dirty attributes / dirty relationships
-     *
-     * @return array
-     */
-    public function getDirtyRelationships()
-    {
-        $dirtyAggregates = [];
-
-        foreach ($this->relationships as $relation) {
-            foreach ($relation as $aggregate) {
-
-                if (!$aggregate->exists() || $aggregate->isDirty() || count($aggregate->getDirtyRelationships()) > 0) {
-                    $dirtyAggregates[] = $aggregate;
-                }
-            }
-        }
-
-        return $dirtyAggregates;
-    }
+	/**
+	 * Get Relationships who have dirty attributes / dirty relationships
+	 *
+	 * @return array
+	 */
+	public function getDirtyRelationships()
+	{
+		$dirtyAggregates = [];
+
+		foreach ($this->relationships as $relation) {
+			foreach ($relation as $aggregate) {
+
+				if (!$aggregate->exists() || $aggregate->isDirty() || count($aggregate->getDirtyRelationships()) > 0) {
+					$dirtyAggregates[] = $aggregate;
+				}
+			}
+		}
+
+		return $dirtyAggregates;
+	}
     
-    /**
-     * Compare the object's raw attributes with the record in cache
-     *
-     * @return boolean
-     */
-    public function isDirty()
-    {
-        if (count($this->getDirtyRawAttributes()) > 0) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Get Raw Entity's attributes, as they are represented
-     * in the database, including value objects, foreign keys,
-     * and discriminator column
-     *
-     * @return array
-     */
-    public function getRawAttributes()
-    {
-        $attributes = $this->wrappedEntity->getEntityAttributes();
-
-        foreach ($this->entityMap->getRelationships() as $relation) {
-            unset($attributes[$relation]);
-        }
-
-        if($this->entityMap->getInheritanceType() == 'single_table') {
-            $attributes = $this->addDiscriminatorColumn($attributes);
-        }
-
-        $attributes = $this->flattenEmbeddables($attributes);
-
-        $foreignKeys = $this->getForeignKeyAttributes();
-
-        return $attributes + $foreignKeys;
-    }
-
-    /**
-     * Add Discriminator Column if it doesn't exist on the actual entity
-     * 
-     * @param array $attributes
-     * @return array
-     */
-    protected function addDiscriminatorColumn($attributes)
-    {
-        $discriminatorColumn = $this->entityMap->getDiscriminatorColumn();
-        $entityClass = $this->entityMap->getClass();
-
-        if(! array_key_exists($discriminatorColumn, $attributes)) {
+	/**
+	 * Compare the object's raw attributes with the record in cache
+	 *
+	 * @return boolean
+	 */
+	public function isDirty()
+	{
+		if (count($this->getDirtyRawAttributes()) > 0) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Get Raw Entity's attributes, as they are represented
+	 * in the database, including value objects, foreign keys,
+	 * and discriminator column
+	 *
+	 * @return array
+	 */
+	public function getRawAttributes()
+	{
+		$attributes = $this->wrappedEntity->getEntityAttributes();
+
+		foreach ($this->entityMap->getRelationships() as $relation) {
+			unset($attributes[$relation]);
+		}
+
+		if($this->entityMap->getInheritanceType() == 'single_table') {
+			$attributes = $this->addDiscriminatorColumn($attributes);
+		}
+
+		$attributes = $this->flattenEmbeddables($attributes);
+
+		$foreignKeys = $this->getForeignKeyAttributes();
+
+		return $attributes + $foreignKeys;
+	}
+
+	/**
+	 * Add Discriminator Column if it doesn't exist on the actual entity
+	 * 
+	 * @param array $attributes
+	 * @return array
+	 */
+	protected function addDiscriminatorColumn($attributes)
+	{
+		$discriminatorColumn = $this->entityMap->getDiscriminatorColumn();
+		$entityClass = $this->entityMap->getClass();
+
+		if(! array_key_exists($discriminatorColumn, $attributes)) {
             
-            // Use key if present in discriminatorMap
-            $map = $this->entityMap->getDiscriminatorColumnMap();
-
-            $type = array_search($entityClass, $map);
-
-            if($type === false) {
-                // Use entity FQDN if no corresponding key is set
-                $attributes[$discriminatorColumn] = $entityClass;
-            }
-            else {
-                $attributes[$discriminatorColumn] = $type;
-            }
-        }
-
-        return $attributes;
-    }
-
-    /**
-     * Convert Value Objects to raw db attributes
-     *
-     * @param  array $attributes
-     * @return array
-     */
-    protected function flattenEmbeddables($attributes)
-    {
-        $embeddables = $this->entityMap->getEmbeddables();
+			// Use key if present in discriminatorMap
+			$map = $this->entityMap->getDiscriminatorColumnMap();
+
+			$type = array_search($entityClass, $map);
+
+			if($type === false) {
+				// Use entity FQDN if no corresponding key is set
+				$attributes[$discriminatorColumn] = $entityClass;
+			}
+			else {
+				$attributes[$discriminatorColumn] = $type;
+			}
+		}
+
+		return $attributes;
+	}
+
+	/**
+	 * Convert Value Objects to raw db attributes
+	 *
+	 * @param  array $attributes
+	 * @return array
+	 */
+	protected function flattenEmbeddables($attributes)
+	{
+		$embeddables = $this->entityMap->getEmbeddables();
         
-        foreach ($embeddables as $localKey => $embed) {
-            // Retrieve the value object from the entity's attributes
-            $valueObject = $attributes[$localKey];
+		foreach ($embeddables as $localKey => $embed) {
+			// Retrieve the value object from the entity's attributes
+			$valueObject = $attributes[$localKey];
 
-            // Unset the corresponding key
-            unset($attributes[$localKey]);
+			// Unset the corresponding key
+			unset($attributes[$localKey]);
 
-            // TODO Make wrapper object compatible with value objects
-            $valueObjectAttributes = $valueObject->getEntityAttributes();
+			// TODO Make wrapper object compatible with value objects
+			$valueObjectAttributes = $valueObject->getEntityAttributes();
 
-            // Now (if setup in the entity map) we prefix the value object's
-            // attributes with the snake_case name of the embedded class.
-            $prefix = snake_case(class_basename($embed));
+			// Now (if setup in the entity map) we prefix the value object's
+			// attributes with the snake_case name of the embedded class.
+			$prefix = snake_case(class_basename($embed));
 
-            foreach ($valueObjectAttributes as $key=>$value) {
-                $valueObjectAttributes[$prefix . '_' . $key] = $value;
-                unset($valueObjectAttributes[$key]);
-            }
+			foreach ($valueObjectAttributes as $key=>$value) {
+				$valueObjectAttributes[$prefix . '_' . $key] = $value;
+				unset($valueObjectAttributes[$key]);
+			}
 
-            $attributes = array_merge($attributes, $valueObjectAttributes);
-        }
+			$attributes = array_merge($attributes, $valueObjectAttributes);
+		}
         
-        return $attributes;
-    }
-
-    /**
-     * Return's entity raw attributes in the state they were at last
-     * query.
-     *
-     * @param  array|null $columns
-     * @return array
-     */
-    protected function getCachedRawAttributes(array $columns = null)
-    {
-        $cachedAttributes = $this->getCache()->get($this->getEntityId());
-
-        if (is_null($columns)) {
-            return $cachedAttributes;
-        } else {
-            return array_only($cachedAttributes, $columns);
-        }
-    }
-
-    /**
-     * Return a single attribute from the cache
-     * @param  string $key
-     * @return mixed
-     */
-    protected function getCachedAttribute($key)
-    {
-        $cachedAttributes = $this->getCache()->get($this->getEntityId());
-
-        if (!array_key_exists($key, $cachedAttributes)) {
-            return null;
-        } else {
-            return $cachedAttributes[$key];
-        }
-    }
-
-    /**
-     * Convert related Entity's attributes to foreign keys
-     *
-     * @return array
-     */
-    protected function getForeignKeyAttributes()
-    {
-        $foreignKeys = [];
-
-        foreach ($this->entityMap->getLocalRelationships() as $relation) {
-            // check if relationship has been parsed, meaning it has an actual object
-            // in the entity's attributes
-            if ($this->isActualRelationships($relation)) {
-                $foreignKeys = $foreignKeys + $this->getForeignKeyAttributesFromRelation($relation);
-            }
-        }
-
-        if ( ! is_null($this->parent)) {
-            $foreignKeys = $foreignKeys + $this->getForeignKeyAttributesFromParent();
-        }
-
-        return $foreignKeys;
-    }
-
-    /**
-     * Return an associative array containing the key-value pair(s) from
-     * the related entity.
-     *
-     * @param  string $relation
-     * @return array
-     */
-    protected function getForeignKeyAttributesFromRelation($relation)
-    {
-        $localRelations = $this->entityMap->getLocalRelationships();
-
-        if (in_array($relation, $localRelations)) {
-            // Call Relationship's method
-            $relationship = $this->entityMap->$relation($this->getEntityObject());
-
-            $relatedAggregate = $this->relationships[$relation][0];
-
-            return $relationship->getForeignKeyValuePair($relatedAggregate->getEntityObject());
-        } else {
-            return [];
-        }
-    }
-
-    /**
-     * Get foreign key attribute(s) from a parent entity in this
-     * aggregate context
-     *
-     * @return array
-     */
-    protected function getForeignKeyAttributesFromParent()
-    {
-        $parentMap = $this->parent->getEntityMap();
-
-        $parentForeignRelations = $parentMap->getForeignRelationships();
-        $parentPivotRelations = $parentMap->getPivotRelationships();
-
-        // The parentRelation is the name of the relationship
-        // methods on the parent entity map
-        $parentRelation = $this->parentRelationship;
-
-        if (in_array($parentRelation, $parentForeignRelations)
-            && !in_array($parentRelation, $parentPivotRelations)
-        ) {
-            $parentObject = $this->parent->getEntityObject();
-
-            // Call Relationship's method on parent map
-            $relationship = $parentMap->$parentRelation($parentObject);
-
-            return $relationship->getForeignKeyValuePair();
-        } else {
-            return [];
-        }
-    }
-
-    /**
-     * Update Pivot records on loaded relationships, by comparing the
-     * values from the Entity Cache to the actual relationship inside
-     * the aggregated entity.
-     *
-     * @return void
-     */
-    public function updatePivotRecords()
-    {
-        $pivots = $this->entityMap->getPivotRelationships();
-
-        foreach ($pivots as $pivot) {
-            if (array_key_exists($pivot, $this->relationships)) {
-                $this->updatePivotRelation($pivot);
-            }
-        }
-    }
-
-    /**
-     * Update Single pivot relationship
-     *
-     * @param  string $relation
-     * @return void
-     */
-    protected function updatePivotRelation($relation)
-    {
-        $hashes = $this->getEntityHashesFromRelation($relation);
-
-        $cachedAttributes = $this->getCachedRawAttributes();
-
-        if (array_key_exists($relation, $cachedAttributes)) {
-            // Compare the two array of hashes to find out existing
-            // pivot records, and the ones to be created.
-            $new = array_diff($hashes, array_keys($cachedAttributes[$relation]));
-            $existing = array_intersect($hashes, array_keys($cachedAttributes[$relation]));
-        } else {
-            $existing = [];
-            $new = $hashes;
-        }
-
-        if (count($new) > 0) {
-            $pivots = $this->getRelatedAggregatesFromHashes($new, $relation);
-
-            $this->entityMap->$relation($this->getEntityObject())->createPivots($pivots);
-        }
-
-        if (count($existing) > 0) {
-            foreach ($existing as $pivotHash) {
-                $this->updatePivotIfDirty($pivotHash, $relation);
-            }
-        }
-    }
-
-    /**
-     * Compare existing pivot record in cache and update it
-     * if the pivot attributes are dirty
-     *
-     * @param  string $pivotHash
-     * @param  string $relation
-     * @return void
-     */
-    protected function updatePivotIfDirty($pivotHash, $relation)
-    {
-        $aggregate = $this->getRelatedAggregateFromHash($pivotHash, $relation);
-
-        if ($aggregate->hasAttribute('pivot')) {
-            $pivot = $aggregate->getEntityAttribute('pivot')->getEntityAttributes();
-
-            $cachedPivotAttributes = $this->getPivotAttributesFromCache($pivotHash, $relation);
-
-            $actualPivotAttributes = array_only($pivot, array_keys($cachedPivotAttributes));
-
-            $dirty = $this->getDirtyAttributes($actualPivotAttributes, $cachedPivotAttributes);
-
-            if (count($dirty) > 0) {
-                $id = $aggregate->getEntityId();
-
-                $this->entityMap->$relation($this->getEntityObject())->updateExistingPivot($id, $dirty);
-            }
-        }
-    }
-
-    /**
-     * Compare two attributes array and return dirty attributes
-     *
-     * @param  array $actual
-     * @param  array $cached
-     * @return array
-     */
-    protected function getDirtyAttributes(array $actual, array $cached)
-    {
-        $dirty = [];
-
-        foreach ($actual as $key => $value) {
-            if (!$this->originalIsNumericallyEquivalent($value, $cached[$key])) {
-                $dirty[$key] = $actual[$key];
-            }
-        }
-
-        return $dirty;
-    }
-
-    /**
-     *
-     * @param  string $pivotHash
-     * @param  string $relation
-     * @return array
-     */
-    protected function getPivotAttributesFromCache($pivotHash, $relation)
-    {
-        $cachedAttributes = $this->getCachedRawAttributes();
-
-        $cachedRelations = $cachedAttributes[$relation];
-
-        foreach ($cachedRelations as $cachedRelation) {
-            if ($cachedRelation == $pivotHash) {
-                return $cachedRelation->getPivotAttributes();
-            }
-        }
-    }
-
-    /**
-     * Returns an array of related Aggregates from its entity hashes
-     *
-     * @param  array  $hashes
-     * @param  string $relation
-     * @return array
-     */
-    protected function getRelatedAggregatesFromHashes(array $hashes, $relation)
-    {
-        $related = [];
-
-        foreach ($hashes as $hash) {
-            $aggregate = $this->getRelatedAggregateFromHash($hash, $relation);
-
-            if (!is_null($aggregate)) {
-                $related[] = $aggregate;
-            }
-        }
-
-        return $related;
-    }
-
-    /**
-     * Get related aggregate from its hash
-     *
-     * @param  string $hash
-     * @param  string $relation
-     * @return \Analogue\ORM\System\Aggregate|null
-     */
-    protected function getRelatedAggregateFromHash($hash, $relation)
-    {
-        foreach ($this->relationships[$relation] as $aggregate) {
-            if ($aggregate->getEntityHash() == $hash) {
-                return $aggregate;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Return an array of Entity Hashes from a specific relation
-     *
-     * @param  string $relation
-     * @return array
-     */
-    protected function getEntityHashesFromRelation($relation)
-    {
-        return array_map(function ($aggregate) {
-            return $aggregate->getEntityHash();
-        }, $this->relationships[$relation]);
-    }
-
-    /**
-     * Check the existence of an actual relationship
-     *
-     * @param  string $relation
-     * @return boolean
-     */
-    protected function isActualRelationships($relation)
-    {
-        return array_key_exists($relation, $this->relationships)
-            && count($this->relationships[$relation]) > 0;
-    }
-
-    /**
-     * Return cache instance for the current entity type
-     *
-     * @return \Analogue\ORM\System\EntityCache
-     */
-    protected function getCache()
-    {
-        return $this->getMapper()->getEntityCache();
-    }
-
-    /**
-     * Get Only Raw Entiy's attributes which have been modified
-     * since last query
-     *
-     * @return array
-     */
-    public function getDirtyRawAttributes()
-    {
-        $attributes = $this->getRawAttributes();
-        $cachedAttributes = $this->getCachedRawAttributes(array_keys($attributes));
-
-        $dirty = [];
-
-        foreach ($attributes as $key => $value) {
-            if ($this->isRelation($key) || $key == 'pivot') {
-                continue;
-            }
-
-            if (!array_key_exists($key, $cachedAttributes) && !$value instanceof Pivot) {
-                $dirty[$key] = $value;
-            } elseif ($value !== $cachedAttributes[$key] &&
-                !$this->originalIsNumericallyEquivalent($value, $cachedAttributes[$key])) {
-                $dirty[$key] = $value;
-            }
-        }
-
-        return $dirty;
-    }
-
-    /**
-     * @param $key
-     * @return bool
-     */
-    protected function isRelation($key)
-    {
-        return in_array($key, $this->entityMap->getRelationships());
-    }
-
-    /**
-     * Determine if the new and old values for a given key are numerically equivalent.
-     *
-     * @param $current
-     * @param $original
-     * @return boolean
-     */
-    protected function originalIsNumericallyEquivalent($current, $original)
-    {
-        return is_numeric($current) && is_numeric($original) && strcmp((string) $current, (string) $original) === 0;
-    }
-
-    /**
-     * Get the underlying entity object
-     *
-     * @return mixed
-     */
-    public function getEntityObject()
-    {
-        return $this->wrappedEntity->getObject();
-    }
-
-    /**
-     * Return the Mapper instance for the current Entity Type
-     *
-     * @return \Analogue\ORM\System\Mapper
-     */
-    public function getMapper()
-    {
-        return Manager::getMapper($this->class);
-    }
-
-    /**
-     * Check that the entity already exists in the database, by checking
-     * if it has an EntityCache record
-     *
-     * @return boolean
-     */
-    public function exists()
-    {
-        return $this->getCache()->has($this->getEntityId());
-    }
-
-    /**
-     * Set the object attribute raw values (hydration)
-     *
-     * @param array $attributes
-     */
-    public function setEntityAttributes(array $attributes)
-    {
-        $this->wrappedEntity->setEntityAttributes($attributes);
-    }
-
-    /**
-     * Get the raw object's values.
-     *
-     * @return array
-     */
-    public function getEntityAttributes()
-    {
-        return $this->wrappedEntity->getEntityAttributes();
-    }
-
-    /**
-     * Set the raw entity attributes
-     * @param string $key
-     * @param string $value
-     */
-    public function setEntityAttribute($key, $value)
-    {
-        $this->wrappedEntity->setEntityAttribute($key, $value);
-    }
-
-    /**
-     * Return the entity's attribute
-     * @param  string $key
-     * @return mixed
-     */
-    public function getEntityAttribute($key)
-    {
-        return $this->wrappedEntity->getEntityAttribute($key);
-    }
-
-    /**
-     * Does the attribute exists on the entity
-     *
-     * @param  string  $key
-     * @return boolean
-     */
-    public function hasAttribute($key)
-    {
-        return $this->wrappedEntity->hasAttribute($key);
-    }
-
-    /**
-     * Set the lazyloading proxies on the wrapped entity
-     * 
-     * @return  void
-     */
-    public function setProxies()
-    {
-        $this->wrappedEntity->setProxies();
-    }
-
-    /**  
-     * Hydrate the actual entity
-     * 
-     * @return void
-     */
-    public function hydrate()
-    {
-        $this->wrappedEntity->hydrate();
-    }
+		return $attributes;
+	}
+
+	/**
+	 * Return's entity raw attributes in the state they were at last
+	 * query.
+	 *
+	 * @param  array|null $columns
+	 * @return array
+	 */
+	protected function getCachedRawAttributes(array $columns = null)
+	{
+		$cachedAttributes = $this->getCache()->get($this->getEntityId());
+
+		if (is_null($columns)) {
+			return $cachedAttributes;
+		} else {
+			return array_only($cachedAttributes, $columns);
+		}
+	}
+
+	/**
+	 * Return a single attribute from the cache
+	 * @param  string $key
+	 * @return mixed
+	 */
+	protected function getCachedAttribute($key)
+	{
+		$cachedAttributes = $this->getCache()->get($this->getEntityId());
+
+		if (!array_key_exists($key, $cachedAttributes)) {
+			return null;
+		} else {
+			return $cachedAttributes[$key];
+		}
+	}
+
+	/**
+	 * Convert related Entity's attributes to foreign keys
+	 *
+	 * @return array
+	 */
+	protected function getForeignKeyAttributes()
+	{
+		$foreignKeys = [];
+
+		foreach ($this->entityMap->getLocalRelationships() as $relation) {
+			// check if relationship has been parsed, meaning it has an actual object
+			// in the entity's attributes
+			if ($this->isActualRelationships($relation)) {
+				$foreignKeys = $foreignKeys + $this->getForeignKeyAttributesFromRelation($relation);
+			}
+		}
+
+		if ( ! is_null($this->parent)) {
+			$foreignKeys = $foreignKeys + $this->getForeignKeyAttributesFromParent();
+		}
+
+		return $foreignKeys;
+	}
+
+	/**
+	 * Return an associative array containing the key-value pair(s) from
+	 * the related entity.
+	 *
+	 * @param  string $relation
+	 * @return array
+	 */
+	protected function getForeignKeyAttributesFromRelation($relation)
+	{
+		$localRelations = $this->entityMap->getLocalRelationships();
+
+		if (in_array($relation, $localRelations)) {
+			// Call Relationship's method
+			$relationship = $this->entityMap->$relation($this->getEntityObject());
+
+			$relatedAggregate = $this->relationships[$relation][0];
+
+			return $relationship->getForeignKeyValuePair($relatedAggregate->getEntityObject());
+		} else {
+			return [];
+		}
+	}
+
+	/**
+	 * Get foreign key attribute(s) from a parent entity in this
+	 * aggregate context
+	 *
+	 * @return array
+	 */
+	protected function getForeignKeyAttributesFromParent()
+	{
+		$parentMap = $this->parent->getEntityMap();
+
+		$parentForeignRelations = $parentMap->getForeignRelationships();
+		$parentPivotRelations = $parentMap->getPivotRelationships();
+
+		// The parentRelation is the name of the relationship
+		// methods on the parent entity map
+		$parentRelation = $this->parentRelationship;
+
+		if (in_array($parentRelation, $parentForeignRelations)
+			&& !in_array($parentRelation, $parentPivotRelations)
+		) {
+			$parentObject = $this->parent->getEntityObject();
+
+			// Call Relationship's method on parent map
+			$relationship = $parentMap->$parentRelation($parentObject);
+
+			return $relationship->getForeignKeyValuePair();
+		} else {
+			return [];
+		}
+	}
+
+	/**
+	 * Update Pivot records on loaded relationships, by comparing the
+	 * values from the Entity Cache to the actual relationship inside
+	 * the aggregated entity.
+	 *
+	 * @return void
+	 */
+	public function updatePivotRecords()
+	{
+		$pivots = $this->entityMap->getPivotRelationships();
+
+		foreach ($pivots as $pivot) {
+			if (array_key_exists($pivot, $this->relationships)) {
+				$this->updatePivotRelation($pivot);
+			}
+		}
+	}
+
+	/**
+	 * Update Single pivot relationship
+	 *
+	 * @param  string $relation
+	 * @return void
+	 */
+	protected function updatePivotRelation($relation)
+	{
+		$hashes = $this->getEntityHashesFromRelation($relation);
+
+		$cachedAttributes = $this->getCachedRawAttributes();
+
+		if (array_key_exists($relation, $cachedAttributes)) {
+			// Compare the two array of hashes to find out existing
+			// pivot records, and the ones to be created.
+			$new = array_diff($hashes, array_keys($cachedAttributes[$relation]));
+			$existing = array_intersect($hashes, array_keys($cachedAttributes[$relation]));
+		} else {
+			$existing = [];
+			$new = $hashes;
+		}
+
+		if (count($new) > 0) {
+			$pivots = $this->getRelatedAggregatesFromHashes($new, $relation);
+
+			$this->entityMap->$relation($this->getEntityObject())->createPivots($pivots);
+		}
+
+		if (count($existing) > 0) {
+			foreach ($existing as $pivotHash) {
+				$this->updatePivotIfDirty($pivotHash, $relation);
+			}
+		}
+	}
+
+	/**
+	 * Compare existing pivot record in cache and update it
+	 * if the pivot attributes are dirty
+	 *
+	 * @param  string $pivotHash
+	 * @param  string $relation
+	 * @return void
+	 */
+	protected function updatePivotIfDirty($pivotHash, $relation)
+	{
+		$aggregate = $this->getRelatedAggregateFromHash($pivotHash, $relation);
+
+		if ($aggregate->hasAttribute('pivot')) {
+			$pivot = $aggregate->getEntityAttribute('pivot')->getEntityAttributes();
+
+			$cachedPivotAttributes = $this->getPivotAttributesFromCache($pivotHash, $relation);
+
+			$actualPivotAttributes = array_only($pivot, array_keys($cachedPivotAttributes));
+
+			$dirty = $this->getDirtyAttributes($actualPivotAttributes, $cachedPivotAttributes);
+
+			if (count($dirty) > 0) {
+				$id = $aggregate->getEntityId();
+
+				$this->entityMap->$relation($this->getEntityObject())->updateExistingPivot($id, $dirty);
+			}
+		}
+	}
+
+	/**
+	 * Compare two attributes array and return dirty attributes
+	 *
+	 * @param  array $actual
+	 * @param  array $cached
+	 * @return array
+	 */
+	protected function getDirtyAttributes(array $actual, array $cached)
+	{
+		$dirty = [];
+
+		foreach ($actual as $key => $value) {
+			if (!$this->originalIsNumericallyEquivalent($value, $cached[$key])) {
+				$dirty[$key] = $actual[$key];
+			}
+		}
+
+		return $dirty;
+	}
+
+	/**
+	 *
+	 * @param  string $pivotHash
+	 * @param  string $relation
+	 * @return array
+	 */
+	protected function getPivotAttributesFromCache($pivotHash, $relation)
+	{
+		$cachedAttributes = $this->getCachedRawAttributes();
+
+		$cachedRelations = $cachedAttributes[$relation];
+
+		foreach ($cachedRelations as $cachedRelation) {
+			if ($cachedRelation == $pivotHash) {
+				return $cachedRelation->getPivotAttributes();
+			}
+		}
+	}
+
+	/**
+	 * Returns an array of related Aggregates from its entity hashes
+	 *
+	 * @param  array  $hashes
+	 * @param  string $relation
+	 * @return array
+	 */
+	protected function getRelatedAggregatesFromHashes(array $hashes, $relation)
+	{
+		$related = [];
+
+		foreach ($hashes as $hash) {
+			$aggregate = $this->getRelatedAggregateFromHash($hash, $relation);
+
+			if (!is_null($aggregate)) {
+				$related[] = $aggregate;
+			}
+		}
+
+		return $related;
+	}
+
+	/**
+	 * Get related aggregate from its hash
+	 *
+	 * @param  string $hash
+	 * @param  string $relation
+	 * @return \Analogue\ORM\System\Aggregate|null
+	 */
+	protected function getRelatedAggregateFromHash($hash, $relation)
+	{
+		foreach ($this->relationships[$relation] as $aggregate) {
+			if ($aggregate->getEntityHash() == $hash) {
+				return $aggregate;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Return an array of Entity Hashes from a specific relation
+	 *
+	 * @param  string $relation
+	 * @return array
+	 */
+	protected function getEntityHashesFromRelation($relation)
+	{
+		return array_map(function ($aggregate) {
+			return $aggregate->getEntityHash();
+		}, $this->relationships[$relation]);
+	}
+
+	/**
+	 * Check the existence of an actual relationship
+	 *
+	 * @param  string $relation
+	 * @return boolean
+	 */
+	protected function isActualRelationships($relation)
+	{
+		return array_key_exists($relation, $this->relationships)
+			&& count($this->relationships[$relation]) > 0;
+	}
+
+	/**
+	 * Return cache instance for the current entity type
+	 *
+	 * @return \Analogue\ORM\System\EntityCache
+	 */
+	protected function getCache()
+	{
+		return $this->getMapper()->getEntityCache();
+	}
+
+	/**
+	 * Get Only Raw Entiy's attributes which have been modified
+	 * since last query
+	 *
+	 * @return array
+	 */
+	public function getDirtyRawAttributes()
+	{
+		$attributes = $this->getRawAttributes();
+		$cachedAttributes = $this->getCachedRawAttributes(array_keys($attributes));
+
+		$dirty = [];
+
+		foreach ($attributes as $key => $value) {
+			if ($this->isRelation($key) || $key == 'pivot') {
+				continue;
+			}
+
+			if (!array_key_exists($key, $cachedAttributes) && !$value instanceof Pivot) {
+				$dirty[$key] = $value;
+			} elseif ($value !== $cachedAttributes[$key] &&
+				!$this->originalIsNumericallyEquivalent($value, $cachedAttributes[$key])) {
+				$dirty[$key] = $value;
+			}
+		}
+
+		return $dirty;
+	}
+
+	/**
+	 * @param $key
+	 * @return bool
+	 */
+	protected function isRelation($key)
+	{
+		return in_array($key, $this->entityMap->getRelationships());
+	}
+
+	/**
+	 * Determine if the new and old values for a given key are numerically equivalent.
+	 *
+	 * @param $current
+	 * @param $original
+	 * @return boolean
+	 */
+	protected function originalIsNumericallyEquivalent($current, $original)
+	{
+		return is_numeric($current) && is_numeric($original) && strcmp((string) $current, (string) $original) === 0;
+	}
+
+	/**
+	 * Get the underlying entity object
+	 *
+	 * @return mixed
+	 */
+	public function getEntityObject()
+	{
+		return $this->wrappedEntity->getObject();
+	}
+
+	/**
+	 * Return the Mapper instance for the current Entity Type
+	 *
+	 * @return \Analogue\ORM\System\Mapper
+	 */
+	public function getMapper()
+	{
+		return Manager::getMapper($this->class);
+	}
+
+	/**
+	 * Check that the entity already exists in the database, by checking
+	 * if it has an EntityCache record
+	 *
+	 * @return boolean
+	 */
+	public function exists()
+	{
+		return $this->getCache()->has($this->getEntityId());
+	}
+
+	/**
+	 * Set the object attribute raw values (hydration)
+	 *
+	 * @param array $attributes
+	 */
+	public function setEntityAttributes(array $attributes)
+	{
+		$this->wrappedEntity->setEntityAttributes($attributes);
+	}
+
+	/**
+	 * Get the raw object's values.
+	 *
+	 * @return array
+	 */
+	public function getEntityAttributes()
+	{
+		return $this->wrappedEntity->getEntityAttributes();
+	}
+
+	/**
+	 * Set the raw entity attributes
+	 * @param string $key
+	 * @param string $value
+	 */
+	public function setEntityAttribute($key, $value)
+	{
+		$this->wrappedEntity->setEntityAttribute($key, $value);
+	}
+
+	/**
+	 * Return the entity's attribute
+	 * @param  string $key
+	 * @return mixed
+	 */
+	public function getEntityAttribute($key)
+	{
+		return $this->wrappedEntity->getEntityAttribute($key);
+	}
+
+	/**
+	 * Does the attribute exists on the entity
+	 *
+	 * @param  string  $key
+	 * @return boolean
+	 */
+	public function hasAttribute($key)
+	{
+		return $this->wrappedEntity->hasAttribute($key);
+	}
+
+	/**
+	 * Set the lazyloading proxies on the wrapped entity
+	 * 
+	 * @return  void
+	 */
+	public function setProxies()
+	{
+		$this->wrappedEntity->setProxies();
+	}
+
+	/**  
+	 * Hydrate the actual entity
+	 * 
+	 * @return void
+	 */
+	public function hydrate()
+	{
+		$this->wrappedEntity->hydrate();
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -245,7 +245,7 @@ 
             return true;
         }
         
-        if (is_array($value) || (! $value instanceof CollectionProxy && $value instanceof Collection)) {
+        if (is_array($value) || (!$value instanceof CollectionProxy && $value instanceof Collection)) {
             $this->needSync[] = $relation;
         }
 
@@ -257,7 +257,7 @@ 
             //$value = $value->getUnderlyingCollection();
         }
 
-        if ($value instanceof CollectionProxy && ! $value->isProxyInitialized()) {
+        if ($value instanceof CollectionProxy && !$value->isProxyInitialized()) {
             $value = $value->getAddedItems();
         }
 
@@ -365,7 +365,7 @@ 
      */
     public function getEntityHash()
     {
-        return $this->getEntityClass() . '.' . $this->getEntityId();
+        return $this->getEntityClass().'.'.$this->getEntityId();
     }
 
     /**
@@ -558,7 +558,7 @@ 
             unset($attributes[$relation]);
         }
 
-        if($this->entityMap->getInheritanceType() == 'single_table') {
+        if ($this->entityMap->getInheritanceType() == 'single_table') {
             $attributes = $this->addDiscriminatorColumn($attributes);
         }
 
@@ -580,14 +580,14 @@ 
         $discriminatorColumn = $this->entityMap->getDiscriminatorColumn();
         $entityClass = $this->entityMap->getClass();
 
-        if(! array_key_exists($discriminatorColumn, $attributes)) {
+        if (!array_key_exists($discriminatorColumn, $attributes)) {
             
             // Use key if present in discriminatorMap
             $map = $this->entityMap->getDiscriminatorColumnMap();
 
             $type = array_search($entityClass, $map);
 
-            if($type === false) {
+            if ($type === false) {
                 // Use entity FQDN if no corresponding key is set
                 $attributes[$discriminatorColumn] = $entityClass;
             }
@@ -624,7 +624,7 @@ 
             $prefix = snake_case(class_basename($embed));
 
             foreach ($valueObjectAttributes as $key=>$value) {
-                $valueObjectAttributes[$prefix . '_' . $key] = $value;
+                $valueObjectAttributes[$prefix.'_'.$key] = $value;
                 unset($valueObjectAttributes[$key]);
             }
 
@@ -685,7 +685,7 @@ 
             }
         }
 
-        if ( ! is_null($this->parent)) {
+        if (!is_null($this->parent)) {
             $foreignKeys = $foreignKeys + $this->getForeignKeyAttributesFromParent();
         }
 
@@ -914,7 +914,7 @@ 
      */
     protected function getEntityHashesFromRelation($relation)
     {
-        return array_map(function ($aggregate) {
+        return array_map(function($aggregate) {
             return $aggregate->getEntityHash();
         }, $this->relationships[$relation]);
     }

src/Relationships/BelongsTo.php

Indentation +283 added lines, -283 removed lines

@@ -10,289 +10,289 @@
 
 class BelongsTo extends Relationship
 {
-    /**
-     * The foreign key of the parent model.
-     *
-     * @var string
-     */
-    protected $foreignKey;
-
-    /**
-     * The associated key on the parent model.
-     *
-     * @var string
-     */
-    protected $otherKey;
-
-    /**
-     * The name of the relationship.
-     *
-     * @var string
-     */
-    protected $relation;
-
-    /**
-     * Indicate if the parent entity hold the key for the relation.
-     *
-     * @var boolean
-     */
-    protected static $ownForeignKey = true;
-
-    /**
-     * Create a new belongs to relationship instance.
-     *
-     * @param Mapper   $mapper
-     * @param Mappable $parent
-     * @param string   $foreignKey
-     * @param string   $otherKey
-     * @param string   $relation
-     */
-    public function __construct(Mapper $mapper, $parent, $foreignKey, $otherKey, $relation)
-    {
-        $this->otherKey = $otherKey;
-        $this->relation = $relation;
-        $this->foreignKey = $foreignKey;
-
-        parent::__construct($mapper, $parent);
-    }
-
-    /**
-     * Get the results of the relationship.
-     *
-     * @param  $relation
-     *
-     * @return \Analogue\ORM\Entity
-     */
-    public function getResults($relation)
-    {
-        $result = $this->query->first();
-
-        $this->cacheRelation($result, $relation);
-
-        return $result;
-    }
-
-    /**
-     * Set the base constraints on the relation query.
-     *
-     * @return void
-     */
-    public function addConstraints()
-    {
-        if (static::$constraints) {
-            // For belongs to relationships, which are essentially the inverse of has one
-            // or has many relationships, we need to actually query on the primary key
-            // of the related models matching on the foreign key that's on a parent.
-            $this->query->where($this->otherKey, '=', $this->parent->getEntityAttribute($this->foreignKey));
-        }
-    }
-
-    /**
-     * Add the constraints for a relationship count query.
-     *
-     * @param  Query $query
-     * @param  Query $parent
-     * @return Query
-     */
-    public function getRelationCountQuery(Query $query, Query $parent)
-    {
-        $query->select(new Expression('count(*)'));
-
-        $otherKey = $this->wrap($query->getTable() . '.' . $this->otherKey);
-
-        return $query->where($this->getQualifiedForeignKey(), '=', new Expression($otherKey));
-    }
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $results
-     * @return void
-     */
-    public function addEagerConstraints(array $results)
-    {
-        // We'll grab the primary key name of the related models since it could be set to
-        // a non-standard name and not "id". We will then construct the constraint for
-        // our eagerly loading query so it returns the proper models from execution.
-        $key = $this->otherKey;
-
-        $this->query->whereIn($key, $this->getEagerModelKeys($results));
-    }
-
-    /**
-     * Gather the keys from an array of related models.
-     *
-     * @param  array $results
-     * @return array
-     */
-    protected function getEagerModelKeys(array $results)
-    {
-        $keys = [];
-
-        // First we need to gather all of the keys from the result set so we know what
-        // to query for via the eager loading query. We will add them to an array then
-        // execute a "where in" statement to gather up all of those related records.
-        foreach ($results as $result) {
-
-            if(!is_null($value = $result[$this->foreignKey])) {
-                $keys[] = $value;
-            }
-        }
-
-        // If there are no keys that were not null we will just return an array with 0 in
-        // it so the query doesn't fail, but will not return any results, which should
-        // be what this developer is expecting in a case where this happens to them.
-        if (count($keys) == 0) {
-            return [0];
-        }
-
-        return array_values(array_unique($keys));
-    }
-
-    /**
-     * Match the Results array to an eagerly loaded relation
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function match(array $results, $relation)
-    {
-        $foreign = $this->foreignKey;
-
-        $other = $this->otherKey;
-
-        // Execute the relationship and get related entities as an EntityCollection
-        $entities = $this->getEager();
-
-        // First we will get to build a dictionary of the child models by their primary
-        // key of the relationship, then we can easily match the children back onto
-        // the parents using that dictionary and the primary key of the children.
-        $dictionary = [];
-
-        // TODO ; see if otherKey is the primary key of the related entity, we can
-        // simply use the EntityCollection key to match entities to results, which
-        // will be much more efficient, and use this method as a fallback if the 
-        // otherKey is not the same as the primary Key.
-        foreach ($entities as $entity) {
-            $entity = $this->factory->make($entity);
-            $dictionary[$entity->getEntityAttribute($other)] = $entity->getObject();
-        }
-
-        // Once we have the dictionary constructed, we can loop through all the parents
-        // and match back onto their children using these keys of the dictionary and
-        // the primary key of the children to map them onto the correct instances.
-        return array_map(function($result) use ($dictionary, $foreign, $relation) {
+	/**
+	 * The foreign key of the parent model.
+	 *
+	 * @var string
+	 */
+	protected $foreignKey;
+
+	/**
+	 * The associated key on the parent model.
+	 *
+	 * @var string
+	 */
+	protected $otherKey;
+
+	/**
+	 * The name of the relationship.
+	 *
+	 * @var string
+	 */
+	protected $relation;
+
+	/**
+	 * Indicate if the parent entity hold the key for the relation.
+	 *
+	 * @var boolean
+	 */
+	protected static $ownForeignKey = true;
+
+	/**
+	 * Create a new belongs to relationship instance.
+	 *
+	 * @param Mapper   $mapper
+	 * @param Mappable $parent
+	 * @param string   $foreignKey
+	 * @param string   $otherKey
+	 * @param string   $relation
+	 */
+	public function __construct(Mapper $mapper, $parent, $foreignKey, $otherKey, $relation)
+	{
+		$this->otherKey = $otherKey;
+		$this->relation = $relation;
+		$this->foreignKey = $foreignKey;
+
+		parent::__construct($mapper, $parent);
+	}
+
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @param  $relation
+	 *
+	 * @return \Analogue\ORM\Entity
+	 */
+	public function getResults($relation)
+	{
+		$result = $this->query->first();
+
+		$this->cacheRelation($result, $relation);
+
+		return $result;
+	}
+
+	/**
+	 * Set the base constraints on the relation query.
+	 *
+	 * @return void
+	 */
+	public function addConstraints()
+	{
+		if (static::$constraints) {
+			// For belongs to relationships, which are essentially the inverse of has one
+			// or has many relationships, we need to actually query on the primary key
+			// of the related models matching on the foreign key that's on a parent.
+			$this->query->where($this->otherKey, '=', $this->parent->getEntityAttribute($this->foreignKey));
+		}
+	}
+
+	/**
+	 * Add the constraints for a relationship count query.
+	 *
+	 * @param  Query $query
+	 * @param  Query $parent
+	 * @return Query
+	 */
+	public function getRelationCountQuery(Query $query, Query $parent)
+	{
+		$query->select(new Expression('count(*)'));
+
+		$otherKey = $this->wrap($query->getTable() . '.' . $this->otherKey);
+
+		return $query->where($this->getQualifiedForeignKey(), '=', new Expression($otherKey));
+	}
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $results
+	 * @return void
+	 */
+	public function addEagerConstraints(array $results)
+	{
+		// We'll grab the primary key name of the related models since it could be set to
+		// a non-standard name and not "id". We will then construct the constraint for
+		// our eagerly loading query so it returns the proper models from execution.
+		$key = $this->otherKey;
+
+		$this->query->whereIn($key, $this->getEagerModelKeys($results));
+	}
+
+	/**
+	 * Gather the keys from an array of related models.
+	 *
+	 * @param  array $results
+	 * @return array
+	 */
+	protected function getEagerModelKeys(array $results)
+	{
+		$keys = [];
+
+		// First we need to gather all of the keys from the result set so we know what
+		// to query for via the eager loading query. We will add them to an array then
+		// execute a "where in" statement to gather up all of those related records.
+		foreach ($results as $result) {
+
+			if(!is_null($value = $result[$this->foreignKey])) {
+				$keys[] = $value;
+			}
+		}
+
+		// If there are no keys that were not null we will just return an array with 0 in
+		// it so the query doesn't fail, but will not return any results, which should
+		// be what this developer is expecting in a case where this happens to them.
+		if (count($keys) == 0) {
+			return [0];
+		}
+
+		return array_values(array_unique($keys));
+	}
+
+	/**
+	 * Match the Results array to an eagerly loaded relation
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function match(array $results, $relation)
+	{
+		$foreign = $this->foreignKey;
+
+		$other = $this->otherKey;
+
+		// Execute the relationship and get related entities as an EntityCollection
+		$entities = $this->getEager();
+
+		// First we will get to build a dictionary of the child models by their primary
+		// key of the relationship, then we can easily match the children back onto
+		// the parents using that dictionary and the primary key of the children.
+		$dictionary = [];
+
+		// TODO ; see if otherKey is the primary key of the related entity, we can
+		// simply use the EntityCollection key to match entities to results, which
+		// will be much more efficient, and use this method as a fallback if the 
+		// otherKey is not the same as the primary Key.
+		foreach ($entities as $entity) {
+			$entity = $this->factory->make($entity);
+			$dictionary[$entity->getEntityAttribute($other)] = $entity->getObject();
+		}
+
+		// Once we have the dictionary constructed, we can loop through all the parents
+		// and match back onto their children using these keys of the dictionary and
+		// the primary key of the children to map them onto the correct instances.
+		return array_map(function($result) use ($dictionary, $foreign, $relation) {
             
-            if (isset($dictionary[$result[$foreign]])) {
-                $result[$relation] = $dictionary[$result[$foreign]];
-            }
-            else {
-                $result[$relation] = null;
-            }
-            return $result;
-
-        }, $results);
-    }
-
-    public function sync(array $entities)
-    {
-        if (count($entities) > 1) {
-            throw new MappingException("Single Relationship shouldn't be synced with more than one entity");
-        }
+			if (isset($dictionary[$result[$foreign]])) {
+				$result[$relation] = $dictionary[$result[$foreign]];
+			}
+			else {
+				$result[$relation] = null;
+			}
+			return $result;
+
+		}, $results);
+	}
+
+	public function sync(array $entities)
+	{
+		if (count($entities) > 1) {
+			throw new MappingException("Single Relationship shouldn't be synced with more than one entity");
+		}
         
-        if (count($entities) == 1) {
-            return $this->associate($entities[0]);
-        }
-
-        return false;
-    }
-
-    /**
-     * Associate the model instance to the given parent.
-     *
-     * @param  mixed $entity
-     * @return void
-     */
-    public function associate($entity)
-    {
-        $this->parent->setEntityAttribute($this->foreignKey, $entity->getEntityAttribute($this->otherKey));
-    }
-
-    /**
-     * Dissociate previously associated model from the given parent.
-     *
-     * @return Mappable
-     */
-    public function dissociate()
-    {
-        // The Mapper will retrieve this association within the object model, we won't be using
-        // the foreign key attribute inside the parent Entity.
-        //
-        //$this->parent->setEntityAttribute($this->foreignKey, null);
-
-        $this->parent->setEntityAttribute($this->relation, null);
-    }
-
-    /**
-     * Get the foreign key of the relationship.
-     *
-     * @return string
-     */
-    public function getForeignKey()
-    {
-        return $this->foreignKey;
-    }
-
-    /**
-     * Get the foreign key value pair for a related object
-     *
-     * @param  mixed $related
-     *
-     * @return array
-     */
-    public function getForeignKeyValuePair($related)
-    {
-        $foreignKey = $this->getForeignKey();
-
-        if ($related) {
-            $wrapper = $this->factory->make($related);
-
-            $relatedKey = $this->relatedMap->getKeyName();
-
-            return [$foreignKey => $wrapper->getEntityAttribute($relatedKey)];
-        } else {
-            return [$foreignKey => null];
-        }
-    }
-
-    /**
-     * Get the fully qualified foreign key of the relationship.
-     *
-     * @return string
-     */
-    public function getQualifiedForeignKey()
-    {
-        return $this->parentMap->getTable() . '.' . $this->foreignKey;
-    }
-
-    /**
-     * Get the associated key of the relationship.
-     *
-     * @return string
-     */
-    public function getOtherKey()
-    {
-        return $this->otherKey;
-    }
-
-    /**
-     * Get the fully qualified associated key of the relationship.
-     *
-     * @return string
-     */
-    public function getQualifiedOtherKeyName()
-    {
-        return $this->relatedMap->getTable() . '.' . $this->otherKey;
-    }
+		if (count($entities) == 1) {
+			return $this->associate($entities[0]);
+		}
+
+		return false;
+	}
+
+	/**
+	 * Associate the model instance to the given parent.
+	 *
+	 * @param  mixed $entity
+	 * @return void
+	 */
+	public function associate($entity)
+	{
+		$this->parent->setEntityAttribute($this->foreignKey, $entity->getEntityAttribute($this->otherKey));
+	}
+
+	/**
+	 * Dissociate previously associated model from the given parent.
+	 *
+	 * @return Mappable
+	 */
+	public function dissociate()
+	{
+		// The Mapper will retrieve this association within the object model, we won't be using
+		// the foreign key attribute inside the parent Entity.
+		//
+		//$this->parent->setEntityAttribute($this->foreignKey, null);
+
+		$this->parent->setEntityAttribute($this->relation, null);
+	}
+
+	/**
+	 * Get the foreign key of the relationship.
+	 *
+	 * @return string
+	 */
+	public function getForeignKey()
+	{
+		return $this->foreignKey;
+	}
+
+	/**
+	 * Get the foreign key value pair for a related object
+	 *
+	 * @param  mixed $related
+	 *
+	 * @return array
+	 */
+	public function getForeignKeyValuePair($related)
+	{
+		$foreignKey = $this->getForeignKey();
+
+		if ($related) {
+			$wrapper = $this->factory->make($related);
+
+			$relatedKey = $this->relatedMap->getKeyName();
+
+			return [$foreignKey => $wrapper->getEntityAttribute($relatedKey)];
+		} else {
+			return [$foreignKey => null];
+		}
+	}
+
+	/**
+	 * Get the fully qualified foreign key of the relationship.
+	 *
+	 * @return string
+	 */
+	public function getQualifiedForeignKey()
+	{
+		return $this->parentMap->getTable() . '.' . $this->foreignKey;
+	}
+
+	/**
+	 * Get the associated key of the relationship.
+	 *
+	 * @return string
+	 */
+	public function getOtherKey()
+	{
+		return $this->otherKey;
+	}
+
+	/**
+	 * Get the fully qualified associated key of the relationship.
+	 *
+	 * @return string
+	 */
+	public function getQualifiedOtherKeyName()
+	{
+		return $this->relatedMap->getTable() . '.' . $this->otherKey;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -98,7 +98,7 @@ 
     {
         $query->select(new Expression('count(*)'));
 
-        $otherKey = $this->wrap($query->getTable() . '.' . $this->otherKey);
+        $otherKey = $this->wrap($query->getTable().'.'.$this->otherKey);
 
         return $query->where($this->getQualifiedForeignKey(), '=', new Expression($otherKey));
     }
@@ -134,7 +134,7 @@ 
         // execute a "where in" statement to gather up all of those related records.
         foreach ($results as $result) {
 
-            if(!is_null($value = $result[$this->foreignKey])) {
+            if (!is_null($value = $result[$this->foreignKey])) {
                 $keys[] = $value;
             }
         }
@@ -273,7 +273,7 @@ 
      */
     public function getQualifiedForeignKey()
     {
-        return $this->parentMap->getTable() . '.' . $this->foreignKey;
+        return $this->parentMap->getTable().'.'.$this->foreignKey;
     }
 
     /**
@@ -293,6 +293,6 @@ 
      */
     public function getQualifiedOtherKeyName()
     {
-        return $this->relatedMap->getTable() . '.' . $this->otherKey;
+        return $this->relatedMap->getTable().'.'.$this->otherKey;
     }
 }

src/Relationships/MorphOne.php

Indentation +23 added lines, -23 removed lines

@@ -4,30 +4,30 @@
 
 class MorphOne extends MorphOneOrMany
 {
-    /**
-     * Get the results of the relationship.
-     *
-     * @param  $relation
-     * @return mixed
-     */
-    public function getResults($relation)
-    {
-        $result = $this->query->first();
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @param  $relation
+	 * @return mixed
+	 */
+	public function getResults($relation)
+	{
+		$result = $this->query->first();
 
-        $this->cacheRelation($result, $relation);
+		$this->cacheRelation($result, $relation);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Match the eagerly loaded results to their parents.
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function match(array $results, $relation)
-    {
-        return $this->matchOne($results, $relation);
-    }
+	/**
+	 * Match the eagerly loaded results to their parents.
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function match(array $results, $relation)
+	{
+		return $this->matchOne($results, $relation);
+	}
 }

src/Relationships/Relationship.php

Indentation +433 added lines, -433 removed lines

@@ -19,438 +19,438 @@
  */
 abstract class Relationship
 {
-    /**
-     * The mapper instance for the related entity
-     *
-     * @var Mapper
-     */
-    protected $relatedMapper;
-
-    /**
-     * The Analogue Query Builder instance.
-     *
-     * @var Query
-     */
-    protected $query;
-
-    /**
-     * The parent entity proxy instance.
-     *
-     * @var InternallyMappable
-     */
-    protected $parent;
-
-    /**
-     * The parent entity map
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $parentMap;
-
-    /**
-     * The Parent Mapper instance
-     *
-     * @var Mapper
-     */
-    protected $parentMapper;
-
-    /**
-     * The related entity instance.
-     *
-     * @var object
-     */
-    protected $related;
-
-    /**
-     * The related entity Map
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $relatedMap;
-
-    /**
-     * Indicate if the parent entity hold the key for the relation.
-     *
-     * @var boolean
-     */
-    protected static $ownForeignKey = false;
-
-    /**
-     * Indicate if the relationships use a pivot table.*
-     *
-     * @var boolean
-     */
-    protected static $hasPivot = false;
-
-    /**
-     * Indicates if the relation is adding constraints.
-     *
-     * @var bool
-     */
-    protected static $constraints = true;
-
-    /**
-     * Wrapper factory
-     *
-     * @var \Analogue\ORM\System\Wrappers\Factory
-     */
-    protected $factory;
-
-    /**
-     * Create a new relation instance.
-     *
-     * @param  Mapper   $mapper
-     * @param  mixed    $parent
-     * @throws \Analogue\ORM\Exceptions\MappingException
-     */
-    public function __construct(Mapper $mapper, $parent)
-    {
-        $this->relatedMapper = $mapper;
-
-        $this->query = $mapper->getQuery();
-
-        $this->factory = new Factory;
-
-        $this->parent = $this->factory->make($parent);
-
-        $this->parentMapper = $mapper->getManager()->getMapper($parent);
-
-        $this->parentMap = $this->parentMapper->getEntityMap();
-
-        $this->related = $mapper->newInstance();
-
-        $this->relatedMap = $mapper->getEntityMap();
-
-        $this->addConstraints();
-    }
-
-    /**
-     * Indicate if the parent entity hold the foreign key for relation.
-     *
-     * @return boolean
-     */
-    public function ownForeignKey()
-    {
-        return static::$ownForeignKey;
-    }
-
-    /**
-     * Indicate if the relationship uses a pivot table
-     *
-     * @return boolean
-     */
-    public function hasPivot()
-    {
-        return static::$hasPivot;
-    }
-
-    /**
-     * Set the base constraints on the relation query.
-     *
-     * @return void
-     */
-    abstract public function addConstraints();
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $results
-     * @return void
-     */
-    abstract public function addEagerConstraints(array $results);
-
-    /**
-     * Match the eagerly loaded results to their parents, then return
-     * updated results
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @return array
-     */
-    abstract public function match(array $results, $relation);
-
-    /**
-     * Get the results of the relationship.
-     *
-     * @param string $relation relation name in parent's entity map
-     * @return mixed
-     */
-    abstract public function getResults($relation);
-
-    /**
-     * Get the relationship for eager loading.
-     *
-     * @return EntityCollection
-     */
-    public function getEager()
-    {
-        return $this->get();
-    }
-
-    /**
-     * Add the constraints for a relationship count query.
-     *
-     * @param  Query $query
-     * @param  Query $parent
-     * @return Query
-     */
-    public function getRelationCountQuery(Query $query, Query $parent)
-    {
-        $query->select(new Expression('count(*)'));
-
-        $key = $this->wrap($this->getQualifiedParentKeyName());
-
-        return $query->where($this->getHasCompareKey(), '=', new Expression($key));
-    }
-
-    /**
-     * Run a callback with constraints disabled on the relation.
-     *
-     * @param  Closure $callback
-     * @return mixed
-     */
-    public static function noConstraints(Closure $callback)
-    {
-        static::$constraints = false;
-
-        // When resetting the relation where clause, we want to shift the first element
-        // off of the bindings, leaving only the constraints that the developers put
-        // as "extra" on the relationships, and not original relation constraints.
-        $results = call_user_func($callback);
-
-        static::$constraints = true;
-
-        return $results;
-    }
-
-    /**
-     * Get all of the primary keys for an array of entities.
-     *
-     * @param  array  $entities
-     * @param  string $key
-     * @return array
-     */
-    protected function getKeys(array $entities, $key = null)
-    {
-        if (is_null($key)) {
-            $key = $this->relatedMap->getKeyName();
-        }
-
-        $host = $this;
-
-        return array_unique(array_values(array_map(function ($value) use ($key, $host) {
-            if (!$value instanceof InternallyMappable) {
-                $value = $host->factory->make($value);
-            }
-
-            return $value->getEntityAttribute($key);
-
-        }, $entities)));
-    }
-
-    /**  
-     * Get all the keys from a result set
-     * 
-     * @param  array  $results 
-     * @param  string  $key    
-     * @return array          
-     */
-    protected function getKeysFromResults(array $results, $key = null)
-    {
-        if (is_null($key)) {
-            $key = $this->relatedMap->getKeyName();
-        }
-
-        return array_unique(array_values(array_map(function ($value) use ($key) {
-            return $value[$key];
-        }, $results)));
-    }
-
-    /**
-     * Get the underlying query for the relation.
-     *
-     * @return Query
-     */
-    public function getQuery()
-    {
-        return $this->query;
-    }
-
-    /**
-     * Get the base query builder
-     *
-     * @return \Analogue\ORM\Drivers\QueryAdapter
-     */
-    public function getBaseQuery()
-    {
-        return $this->query->getQuery();
-    }
-
-    /**
-     * Get the parent model of the relation.
-     *
-     * @return InternallyMappable
-     */
-    public function getParent()
-    {
-        return $this->parent;
-    }
-
-    /**
-     * Set the parent model of the relation
-     * 
-     * @param InternallyMappable $parent 
-     * @return void
-     */
-    public function setParent(InternallyMappable $parent)
-    {
-        $this->parent = $parent;
-    }
-
-    /**
-     * Get the fully qualified parent key name.
-     *
-     * @return string
-     */
-    protected function getQualifiedParentKeyName()
-    {
-        return $this->parent->getQualifiedKeyName();
-    }
-
-    /**
-     * Get the related entity of the relation.
-     *
-     * @return \Analogue\ORM\Entity
-     */
-    public function getRelated()
-    {
-        return $this->related;
-    }
-
-    /**
-     * Get the related mapper for the relation
-     *
-     * @return Mapper
-     */
-    public function getRelatedMapper()
-    {
-        return $this->relatedMapper;
-    }
-
-
-    /**
-     * Get the name of the "created at" column.
-     *
-     * @return string
-     */
-    public function createdAt()
-    {
-        return $this->parentMap->getCreatedAtColumn();
-    }
-
-    /**
-     * Get the name of the "updated at" column.
-     *
-     * @return string
-     */
-    public function updatedAt()
-    {
-        return $this->parentMap->getUpdatedAtColumn();
-    }
-
-    /**
-     * Get the name of the related model's "updated at" column.
-     *
-     * @return string
-     */
-    public function relatedUpdatedAt()
-    {
-        return $this->related->getUpdatedAtColumn();
-    }
-
-    /**
-     * Wrap the given value with the parent query's grammar.
-     *
-     * @param  string $value
-     * @return string
-     */
-    public function wrap($value)
-    {
-        return $this->parentMapper->getQuery()->getQuery()->getGrammar()->wrap($value);
-    }
-
-    /**
-     * Get a fresh timestamp
-     *
-     * @return Carbon
-     */
-    protected function freshTimestamp()
-    {
-        return new Carbon;
-    }
-
-    /**
-     * Cache the link between parent and related
-     * into the mapper's Entity Cache.
-     *
-     * @param  EntityCollection|Mappable $results  result of the relation query
-     * @param  string                    $relation name of the relation method on the parent entity
-     * @return void
-     */
-    protected function cacheRelation($results, $relation)
-    {
-        $cache = $this->parentMapper->getEntityCache();
-
-        $cache->cacheLoadedRelationResult($this->parent->getEntityKey(), $relation, $results, $this);
-    }
-
-    /**
-     * Return Pivot attributes when available on a relationship
-     *
-     * @return array
-     */
-    public function getPivotAttributes()
-    {
-        return [];
-    }
-
-    /**
-     * Get a combo type.primaryKey
-     *
-     * @param  Mappable $entity
-     * @return string
-     */
-    protected function getEntityHash(Mappable $entity)
-    {
-        $class = get_class($entity);
-
-        $keyName = Mapper::getMapper($class)->getEntityMap()->getKeyName();
-
-        return $class . '.' . $entity->getEntityAttribute($keyName);
-    }
-
-    /**
-     * Run synchronization content if needed by the
-     * relation type.
-     *
-     * @param  array $actualContent
-     * @return void
-     */
-    abstract public function sync(array $actualContent);
+	/**
+	 * The mapper instance for the related entity
+	 *
+	 * @var Mapper
+	 */
+	protected $relatedMapper;
+
+	/**
+	 * The Analogue Query Builder instance.
+	 *
+	 * @var Query
+	 */
+	protected $query;
+
+	/**
+	 * The parent entity proxy instance.
+	 *
+	 * @var InternallyMappable
+	 */
+	protected $parent;
+
+	/**
+	 * The parent entity map
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $parentMap;
+
+	/**
+	 * The Parent Mapper instance
+	 *
+	 * @var Mapper
+	 */
+	protected $parentMapper;
+
+	/**
+	 * The related entity instance.
+	 *
+	 * @var object
+	 */
+	protected $related;
+
+	/**
+	 * The related entity Map
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $relatedMap;
+
+	/**
+	 * Indicate if the parent entity hold the key for the relation.
+	 *
+	 * @var boolean
+	 */
+	protected static $ownForeignKey = false;
+
+	/**
+	 * Indicate if the relationships use a pivot table.*
+	 *
+	 * @var boolean
+	 */
+	protected static $hasPivot = false;
+
+	/**
+	 * Indicates if the relation is adding constraints.
+	 *
+	 * @var bool
+	 */
+	protected static $constraints = true;
+
+	/**
+	 * Wrapper factory
+	 *
+	 * @var \Analogue\ORM\System\Wrappers\Factory
+	 */
+	protected $factory;
+
+	/**
+	 * Create a new relation instance.
+	 *
+	 * @param  Mapper   $mapper
+	 * @param  mixed    $parent
+	 * @throws \Analogue\ORM\Exceptions\MappingException
+	 */
+	public function __construct(Mapper $mapper, $parent)
+	{
+		$this->relatedMapper = $mapper;
+
+		$this->query = $mapper->getQuery();
+
+		$this->factory = new Factory;
+
+		$this->parent = $this->factory->make($parent);
+
+		$this->parentMapper = $mapper->getManager()->getMapper($parent);
+
+		$this->parentMap = $this->parentMapper->getEntityMap();
+
+		$this->related = $mapper->newInstance();
+
+		$this->relatedMap = $mapper->getEntityMap();
+
+		$this->addConstraints();
+	}
+
+	/**
+	 * Indicate if the parent entity hold the foreign key for relation.
+	 *
+	 * @return boolean
+	 */
+	public function ownForeignKey()
+	{
+		return static::$ownForeignKey;
+	}
+
+	/**
+	 * Indicate if the relationship uses a pivot table
+	 *
+	 * @return boolean
+	 */
+	public function hasPivot()
+	{
+		return static::$hasPivot;
+	}
+
+	/**
+	 * Set the base constraints on the relation query.
+	 *
+	 * @return void
+	 */
+	abstract public function addConstraints();
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $results
+	 * @return void
+	 */
+	abstract public function addEagerConstraints(array $results);
+
+	/**
+	 * Match the eagerly loaded results to their parents, then return
+	 * updated results
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	abstract public function match(array $results, $relation);
+
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @param string $relation relation name in parent's entity map
+	 * @return mixed
+	 */
+	abstract public function getResults($relation);
+
+	/**
+	 * Get the relationship for eager loading.
+	 *
+	 * @return EntityCollection
+	 */
+	public function getEager()
+	{
+		return $this->get();
+	}
+
+	/**
+	 * Add the constraints for a relationship count query.
+	 *
+	 * @param  Query $query
+	 * @param  Query $parent
+	 * @return Query
+	 */
+	public function getRelationCountQuery(Query $query, Query $parent)
+	{
+		$query->select(new Expression('count(*)'));
+
+		$key = $this->wrap($this->getQualifiedParentKeyName());
+
+		return $query->where($this->getHasCompareKey(), '=', new Expression($key));
+	}
+
+	/**
+	 * Run a callback with constraints disabled on the relation.
+	 *
+	 * @param  Closure $callback
+	 * @return mixed
+	 */
+	public static function noConstraints(Closure $callback)
+	{
+		static::$constraints = false;
+
+		// When resetting the relation where clause, we want to shift the first element
+		// off of the bindings, leaving only the constraints that the developers put
+		// as "extra" on the relationships, and not original relation constraints.
+		$results = call_user_func($callback);
+
+		static::$constraints = true;
+
+		return $results;
+	}
+
+	/**
+	 * Get all of the primary keys for an array of entities.
+	 *
+	 * @param  array  $entities
+	 * @param  string $key
+	 * @return array
+	 */
+	protected function getKeys(array $entities, $key = null)
+	{
+		if (is_null($key)) {
+			$key = $this->relatedMap->getKeyName();
+		}
+
+		$host = $this;
+
+		return array_unique(array_values(array_map(function ($value) use ($key, $host) {
+			if (!$value instanceof InternallyMappable) {
+				$value = $host->factory->make($value);
+			}
+
+			return $value->getEntityAttribute($key);
+
+		}, $entities)));
+	}
+
+	/**  
+	 * Get all the keys from a result set
+	 * 
+	 * @param  array  $results 
+	 * @param  string  $key    
+	 * @return array          
+	 */
+	protected function getKeysFromResults(array $results, $key = null)
+	{
+		if (is_null($key)) {
+			$key = $this->relatedMap->getKeyName();
+		}
+
+		return array_unique(array_values(array_map(function ($value) use ($key) {
+			return $value[$key];
+		}, $results)));
+	}
+
+	/**
+	 * Get the underlying query for the relation.
+	 *
+	 * @return Query
+	 */
+	public function getQuery()
+	{
+		return $this->query;
+	}
+
+	/**
+	 * Get the base query builder
+	 *
+	 * @return \Analogue\ORM\Drivers\QueryAdapter
+	 */
+	public function getBaseQuery()
+	{
+		return $this->query->getQuery();
+	}
+
+	/**
+	 * Get the parent model of the relation.
+	 *
+	 * @return InternallyMappable
+	 */
+	public function getParent()
+	{
+		return $this->parent;
+	}
+
+	/**
+	 * Set the parent model of the relation
+	 * 
+	 * @param InternallyMappable $parent 
+	 * @return void
+	 */
+	public function setParent(InternallyMappable $parent)
+	{
+		$this->parent = $parent;
+	}
+
+	/**
+	 * Get the fully qualified parent key name.
+	 *
+	 * @return string
+	 */
+	protected function getQualifiedParentKeyName()
+	{
+		return $this->parent->getQualifiedKeyName();
+	}
+
+	/**
+	 * Get the related entity of the relation.
+	 *
+	 * @return \Analogue\ORM\Entity
+	 */
+	public function getRelated()
+	{
+		return $this->related;
+	}
+
+	/**
+	 * Get the related mapper for the relation
+	 *
+	 * @return Mapper
+	 */
+	public function getRelatedMapper()
+	{
+		return $this->relatedMapper;
+	}
+
+
+	/**
+	 * Get the name of the "created at" column.
+	 *
+	 * @return string
+	 */
+	public function createdAt()
+	{
+		return $this->parentMap->getCreatedAtColumn();
+	}
+
+	/**
+	 * Get the name of the "updated at" column.
+	 *
+	 * @return string
+	 */
+	public function updatedAt()
+	{
+		return $this->parentMap->getUpdatedAtColumn();
+	}
+
+	/**
+	 * Get the name of the related model's "updated at" column.
+	 *
+	 * @return string
+	 */
+	public function relatedUpdatedAt()
+	{
+		return $this->related->getUpdatedAtColumn();
+	}
+
+	/**
+	 * Wrap the given value with the parent query's grammar.
+	 *
+	 * @param  string $value
+	 * @return string
+	 */
+	public function wrap($value)
+	{
+		return $this->parentMapper->getQuery()->getQuery()->getGrammar()->wrap($value);
+	}
+
+	/**
+	 * Get a fresh timestamp
+	 *
+	 * @return Carbon
+	 */
+	protected function freshTimestamp()
+	{
+		return new Carbon;
+	}
+
+	/**
+	 * Cache the link between parent and related
+	 * into the mapper's Entity Cache.
+	 *
+	 * @param  EntityCollection|Mappable $results  result of the relation query
+	 * @param  string                    $relation name of the relation method on the parent entity
+	 * @return void
+	 */
+	protected function cacheRelation($results, $relation)
+	{
+		$cache = $this->parentMapper->getEntityCache();
+
+		$cache->cacheLoadedRelationResult($this->parent->getEntityKey(), $relation, $results, $this);
+	}
+
+	/**
+	 * Return Pivot attributes when available on a relationship
+	 *
+	 * @return array
+	 */
+	public function getPivotAttributes()
+	{
+		return [];
+	}
+
+	/**
+	 * Get a combo type.primaryKey
+	 *
+	 * @param  Mappable $entity
+	 * @return string
+	 */
+	protected function getEntityHash(Mappable $entity)
+	{
+		$class = get_class($entity);
+
+		$keyName = Mapper::getMapper($class)->getEntityMap()->getKeyName();
+
+		return $class . '.' . $entity->getEntityAttribute($keyName);
+	}
+
+	/**
+	 * Run synchronization content if needed by the
+	 * relation type.
+	 *
+	 * @param  array $actualContent
+	 * @return void
+	 */
+	abstract public function sync(array $actualContent);
     
-    /**
-     * Handle dynamic method calls to the relationship.
-     *
-     * @param  string $method
-     * @param  array  $parameters
-     * @return mixed
-     */
-    public function __call($method, $parameters)
-    {
-        $result = call_user_func_array([$this->query, $method], $parameters);
-
-        if ($result === $this->query) {
-            return $this;
-        }
-
-        return $result;
-    }
+	/**
+	 * Handle dynamic method calls to the relationship.
+	 *
+	 * @param  string $method
+	 * @param  array  $parameters
+	 * @return mixed
+	 */
+	public function __call($method, $parameters)
+	{
+		$result = call_user_func_array([$this->query, $method], $parameters);
+
+		if ($result === $this->query) {
+			return $this;
+		}
+
+		return $result;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -236,7 +236,7 @@ 
 
         $host = $this;
 
-        return array_unique(array_values(array_map(function ($value) use ($key, $host) {
+        return array_unique(array_values(array_map(function($value) use ($key, $host) {
             if (!$value instanceof InternallyMappable) {
                 $value = $host->factory->make($value);
             }
@@ -259,7 +259,7 @@ 
             $key = $this->relatedMap->getKeyName();
         }
 
-        return array_unique(array_values(array_map(function ($value) use ($key) {
+        return array_unique(array_values(array_map(function($value) use ($key) {
             return $value[$key];
         }, $results)));
     }
@@ -424,7 +424,7 @@ 
 
         $keyName = Mapper::getMapper($class)->getEntityMap()->getKeyName();
 
-        return $class . '.' . $entity->getEntityAttribute($keyName);
+        return $class.'.'.$entity->getEntityAttribute($keyName);
     }
 
     /**

src/Relationships/BelongsToMany.php

Indentation +888 added lines, -888 removed lines

@@ -12,898 +12,898 @@
 
 class BelongsToMany extends Relationship
 {
-    /**
-     * The intermediate table for the relation.
-     *
-     * @var string
-     */
-    protected $table;
-
-    /**
-     * The foreign key of the parent model.
-     *
-     * @var string
-     */
-    protected $foreignKey;
-
-    /**
-     * The associated key of the relation.
-     *
-     * @var string
-     */
-    protected $otherKey;
-
-    /**
-     * The "name" of the relationship.
-     *
-     * @var string
-     */
-    protected $relationName;
-
-    /**
-     * The pivot table columns to retrieve.
-     *
-     * @var array
-     */
-    protected $pivotColumns = [];
-
-    /**
-     * This relationship has pivot attributes
-     *
-     * @var boolean
-     */
-    protected static $hasPivot = true;
-
-    /**
-     * Create a new has many relationship instance.
-     *
-     * @param Mapper   $mapper
-     * @param Mappable $parent
-     * @param string   $table
-     * @param string   $foreignKey
-     * @param string   $otherKey
-     * @param string   $relationName
-     */
-    public function __construct(Mapper $mapper, $parent, $table, $foreignKey, $otherKey, $relationName = null)
-    {
-        $this->table = $table;
-        $this->otherKey = $otherKey;
-        $this->foreignKey = $foreignKey;
-        $this->relationName = $relationName;
-
-        parent::__construct($mapper, $parent);
-    }
-
-    /**
-     * @param $related
-     */
-    public function detachMany($related)
-    {
-        $ids = $this->getIdsFromHashes($related);
-
-        $this->detach($ids);
-    }
-
-    /**
-     * @param array $hashes
-     * @return array
-     */
-    protected function getIdsFromHashes(array $hashes)
-    {
-        $ids = [];
-
-        foreach ($hashes as $hash) {
-            $split = explode('.', $hash);
-            $ids[] = $split[1];
-        }
-        return $ids;
-    }
-
-    /**
-     * Get the results of the relationship.
-     *
-     * @param $relation
-     *
-     * @return EntityCollection
-     */
-    public function getResults($relation)
-    {
-        $results = $this->get();
-
-        $this->cacheRelation($results, $relation);
-
-        return $results;
-    }
-
-    /**
-     * Set a where clause for a pivot table column.
-     *
-     * @param  string $column
-     * @param  string $operator
-     * @param  mixed  $value
-     * @param  string $boolean
-     * @return self
-     */
-    public function wherePivot($column, $operator = null, $value = null, $boolean = 'and')
-    {
-        return $this->where($this->table . '.' . $column, $operator, $value, $boolean);
-    }
-
-    /**
-     * Set an or where clause for a pivot table column.
-     *
-     * @param  string $column
-     * @param  string $operator
-     * @param  mixed  $value
-     * @return self
-     */
-    public function orWherePivot($column, $operator = null, $value = null)
-    {
-        return $this->wherePivot($column, $operator, $value, 'or');
-    }
-
-    /**
-     * Return Pivot attributes when available on a relationship
-     *
-     * @return array
-     */
-    public function getPivotAttributes()
-    {
-        return $this->pivotColumns;
-    }
-
-    /**
-     * Execute the query and get the first result.
-     *
-     * @param  array $columns
-     * @return mixed
-     */
-    public function first($columns = ['*'])
-    {
-        $results = $this->take(1)->get($columns);
-
-        return count($results) > 0 ? $results->first() : null;
-    }
-
-    /**
-     * Execute the query and get the first result or throw an exception.
-     *
-     * @param  array $columns
-     *
-     * @throws EntityNotFoundException
-     *
-     * @return Mappable|self
-     */
-    public function firstOrFail($columns = ['*'])
-    {
-        if (!is_null($entity = $this->first($columns))) {
-            return $entity;
-        }
-
-        throw new EntityNotFoundException;
-    }
-
-    /**
-     * Execute the query as a "select" statement.
-     *
-     * @param  array $columns
-     * @return \Analogue\ORM\EntityCollection
-     */
-    public function get($columns = ['*'])
-    {
-        // First we'll add the proper select columns onto the query so it is run with
-        // the proper columns. Then, we will get the results and hydrate out pivot
-        // models with the result of those columns as a separate model relation.
-        $columns = $this->query->getQuery()->columns ? [] : $columns;
-
-        $select = $this->getSelectColumns($columns);
-
-        $entities = $this->query->addSelect($select)->getEntities();
-
-        $entities = $this->hydratePivotRelation($entities);
+	/**
+	 * The intermediate table for the relation.
+	 *
+	 * @var string
+	 */
+	protected $table;
+
+	/**
+	 * The foreign key of the parent model.
+	 *
+	 * @var string
+	 */
+	protected $foreignKey;
+
+	/**
+	 * The associated key of the relation.
+	 *
+	 * @var string
+	 */
+	protected $otherKey;
+
+	/**
+	 * The "name" of the relationship.
+	 *
+	 * @var string
+	 */
+	protected $relationName;
+
+	/**
+	 * The pivot table columns to retrieve.
+	 *
+	 * @var array
+	 */
+	protected $pivotColumns = [];
+
+	/**
+	 * This relationship has pivot attributes
+	 *
+	 * @var boolean
+	 */
+	protected static $hasPivot = true;
+
+	/**
+	 * Create a new has many relationship instance.
+	 *
+	 * @param Mapper   $mapper
+	 * @param Mappable $parent
+	 * @param string   $table
+	 * @param string   $foreignKey
+	 * @param string   $otherKey
+	 * @param string   $relationName
+	 */
+	public function __construct(Mapper $mapper, $parent, $table, $foreignKey, $otherKey, $relationName = null)
+	{
+		$this->table = $table;
+		$this->otherKey = $otherKey;
+		$this->foreignKey = $foreignKey;
+		$this->relationName = $relationName;
+
+		parent::__construct($mapper, $parent);
+	}
+
+	/**
+	 * @param $related
+	 */
+	public function detachMany($related)
+	{
+		$ids = $this->getIdsFromHashes($related);
+
+		$this->detach($ids);
+	}
+
+	/**
+	 * @param array $hashes
+	 * @return array
+	 */
+	protected function getIdsFromHashes(array $hashes)
+	{
+		$ids = [];
+
+		foreach ($hashes as $hash) {
+			$split = explode('.', $hash);
+			$ids[] = $split[1];
+		}
+		return $ids;
+	}
+
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @param $relation
+	 *
+	 * @return EntityCollection
+	 */
+	public function getResults($relation)
+	{
+		$results = $this->get();
+
+		$this->cacheRelation($results, $relation);
+
+		return $results;
+	}
+
+	/**
+	 * Set a where clause for a pivot table column.
+	 *
+	 * @param  string $column
+	 * @param  string $operator
+	 * @param  mixed  $value
+	 * @param  string $boolean
+	 * @return self
+	 */
+	public function wherePivot($column, $operator = null, $value = null, $boolean = 'and')
+	{
+		return $this->where($this->table . '.' . $column, $operator, $value, $boolean);
+	}
+
+	/**
+	 * Set an or where clause for a pivot table column.
+	 *
+	 * @param  string $column
+	 * @param  string $operator
+	 * @param  mixed  $value
+	 * @return self
+	 */
+	public function orWherePivot($column, $operator = null, $value = null)
+	{
+		return $this->wherePivot($column, $operator, $value, 'or');
+	}
+
+	/**
+	 * Return Pivot attributes when available on a relationship
+	 *
+	 * @return array
+	 */
+	public function getPivotAttributes()
+	{
+		return $this->pivotColumns;
+	}
+
+	/**
+	 * Execute the query and get the first result.
+	 *
+	 * @param  array $columns
+	 * @return mixed
+	 */
+	public function first($columns = ['*'])
+	{
+		$results = $this->take(1)->get($columns);
+
+		return count($results) > 0 ? $results->first() : null;
+	}
+
+	/**
+	 * Execute the query and get the first result or throw an exception.
+	 *
+	 * @param  array $columns
+	 *
+	 * @throws EntityNotFoundException
+	 *
+	 * @return Mappable|self
+	 */
+	public function firstOrFail($columns = ['*'])
+	{
+		if (!is_null($entity = $this->first($columns))) {
+			return $entity;
+		}
+
+		throw new EntityNotFoundException;
+	}
+
+	/**
+	 * Execute the query as a "select" statement.
+	 *
+	 * @param  array $columns
+	 * @return \Analogue\ORM\EntityCollection
+	 */
+	public function get($columns = ['*'])
+	{
+		// First we'll add the proper select columns onto the query so it is run with
+		// the proper columns. Then, we will get the results and hydrate out pivot
+		// models with the result of those columns as a separate model relation.
+		$columns = $this->query->getQuery()->columns ? [] : $columns;
+
+		$select = $this->getSelectColumns($columns);
+
+		$entities = $this->query->addSelect($select)->getEntities();
+
+		$entities = $this->hydratePivotRelation($entities);
         
-        return $this->relatedMap->newCollection($entities);
-    }
-
-    /**
-     * Hydrate the pivot table relationship on the models.
-     *
-     * @param  array $entities
-     * @return void
-     */
-    protected function hydratePivotRelation(array $entities)
-    {
-        // TODO (note) We should definitely get rid of the pivot in a next
-        // release, as this is not quite relevant in a datamapper context. 
-        $host = $this;
-        return array_map(function($entity) use ($host) {
-            $entityWrapper = $this->factory->make($entity);
-
-            $pivot = $this->newExistingPivot($this->cleanPivotAttributes($entityWrapper));
-            $entityWrapper->setEntityAttribute('pivot', $pivot);
-
-            return $entityWrapper->getObject();
-        }, $entities);
-    }
-
-    /**
-     * Get the pivot attributes from a model.
-     *
-     * @param  $entity
-     * @return array
-     */
-    protected function cleanPivotAttributes(InternallyMappable $entity)
-    {
-        $values = [];
-
-        $attributes = $entity->getEntityAttributes();
-
-        foreach ($attributes as $key => $value) {
-            // To get the pivots attributes we will just take any of the attributes which
-            // begin with "pivot_" and add those to this arrays, as well as unsetting
-            // them from the parent's models since they exist in a different table.
-            if (strpos($key, 'pivot_') === 0) {
-                $values[substr($key, 6)] = $value;
-
-                unset($attributes[$key]);
-            }
-        }
-
-        // Rehydrate Entity with cleaned array.
-        $entity->setEntityAttributes($attributes);
-
-        return $values;
-    }
-
-    /**
-     * Set the base constraints on the relation query.
-     *
-     * @return void
-     */
-    public function addConstraints()
-    {
-        $this->setJoin();
-
-        if (static::$constraints) {
-            $this->setWhere();
-        }
-    }
-
-    /**
-     * Add the constraints for a relationship count query.
-     *
-     * @param  Query $query
-     * @param  Query $parent
-     * @return Query
-     */
-    public function getRelationCountQuery(Query $query, Query $parent)
-    {
-        if ($parent->getQuery()->from == $query->getQuery()->from) {
-            return $this->getRelationCountQueryForSelfJoin($query, $parent);
-        }
-
-        $this->setJoin($query);
-
-        return parent::getRelationCountQuery($query, $parent);
-    }
-
-    /**
-     * Add the constraints for a relationship count query on the same table.
-     *
-     * @param  Query $query
-     * @param  Query $parent
-     * @return Query
-     */
-    public function getRelationCountQueryForSelfJoin(Query $query, Query $parent)
-    {
-        $query->select(new Expression('count(*)'));
-
-        $tablePrefix = $this->query->getQuery()->getConnection()->getTablePrefix();
-
-        $query->from($this->table . ' as ' . $tablePrefix . $hash = $this->getRelationCountHash());
-
-        $key = $this->wrap($this->getQualifiedParentKeyName());
-
-        return $query->where($hash . '.' . $this->foreignKey, '=', new Expression($key));
-    }
-
-    /**
-     * Get a relationship join table hash.
-     *
-     * @return string
-     */
-    public function getRelationCountHash()
-    {
-        return 'self_' . md5(microtime(true));
-    }
-
-    /**
-     * Set the select clause for the relation query.
-     *
-     * @param  array $columns
-     * @return \Analogue\ORM\Relationships\BelongsToMany
-     */
-    protected function getSelectColumns(array $columns = ['*'])
-    {
-        if ($columns == ['*']) {
-            $columns = [$this->relatedMap->getTable() . '.*'];
-        }
-
-        return array_merge($columns, $this->getAliasedPivotColumns());
-    }
-
-    /**
-     * Get the pivot columns for the relation.
-     *
-     * @return array
-     */
-    protected function getAliasedPivotColumns()
-    {
-        $defaults = [$this->foreignKey, $this->otherKey];
-
-        // We need to alias all of the pivot columns with the "pivot_" prefix so we
-        // can easily extract them out of the models and put them into the pivot
-        // relationships when they are retrieved and hydrated into the models.
-        $columns = [];
-
-        foreach (array_merge($defaults, $this->pivotColumns) as $column) {
-            $columns[] = $this->table . '.' . $column . ' as pivot_' . $column;
-        }
-
-        return array_unique($columns);
-    }
-
-    /**
-     * Set the join clause for the relation query.
-     *
-     * @param  \Analogue\ORM\Query|null
-     * @return $this
-     */
-    protected function setJoin($query = null)
-    {
-        $query = $query ?: $this->query;
-
-        // We need to join to the intermediate table on the related model's primary
-        // key column with the intermediate table's foreign key for the related
-        // model instance. Then we can set the "where" for the parent models.
-        $baseTable = $this->relatedMap->getTable();
-
-        $key = $baseTable . '.' . $this->relatedMap->getKeyName();
-
-        $query->join($this->table, $key, '=', $this->getOtherKey());
-
-        return $this;
-    }
-
-    /**
-     * Set the where clause for the relation query.
-     *
-     * @return $this
-     */
-    protected function setWhere()
-    {
-        $foreign = $this->getForeignKey();
-
-        $parentKey = $this->parentMap->getKeyName();
-
-        $this->query->where($foreign, '=', $this->parent->getEntityAttribute($parentKey));
-
-        return $this;
-    }
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $results
-     * @return void
-     */
-    public function addEagerConstraints(array $results)
-    {
-        $this->query->whereIn($this->getForeignKey(), $this->getKeysFromResults($results));
-    }
-
-    /**
-     * Match Eagerly loaded relation to result
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function match(array $results, $relation)
-    {
-        $entities = $this->getEager();
-
-        // TODO; optimize this operation
-        $dictionary = $this->buildDictionary($entities);
-
-        $keyName = $this->relatedMap->getKeyName();
-
-        $cache = $this->parentMapper->getEntityCache();
-
-        $host = $this;
-
-        // Once we have an array dictionary of child objects we can easily match the
-        // children back to their parent using the dictionary and the keys on the
-        // the parent models. Then we will return the hydrated models back out.
-        return array_map(function($result) use ($dictionary, $keyName, $cache, $relation, $host) {
-
-            if (isset($dictionary[$key = $result[$keyName]])) {
-                $collection = $host->relatedMap->newCollection($dictionary[$key]);
-
-                $result[$relation] = $collection;
-
-                // TODO Refactor this
-                $cache->cacheLoadedRelationResult($key, $relation, $collection, $this);
-            }
-            else {
-                $result[$relation] = $host->relatedMap->newCollection();
-            }
-            return $result;
-
-        }, $results);
-    }
-
-    /**
-     * Build model dictionary keyed by the relation's foreign key.
-     *
-     * @param  EntityCollection $results
-     * @return array
-     */
-    protected function buildDictionary(EntityCollection $results)
-    {
-        $foreign = $this->foreignKey;
-
-        // First we will build a dictionary of child models keyed by the foreign key
-        // of the relation so that we will easily and quickly match them to their
-        // parents without having a possibly slow inner loops for every models.
-        $dictionary = [];
-
-        foreach ($results as $entity) {
-            $wrapper = $this->factory->make($entity);
-            $dictionary[$wrapper->getEntityAttribute('pivot')->$foreign][] = $entity;
-        }
-
-        return $dictionary;
-    }
-
-    /**
-     * Get all of the IDs for the related models.
-     *
-     * @return array
-     */
-    public function getRelatedIds()
-    {
-        $fullKey = $this->relatedMap->getQualifiedKeyName();
-
-        return $this->getQuery()->select($fullKey)->lists($this->relatedMap->getKeyName());
-    }
-
-    /**
-     * Update Pivot
-     *
-     * @param  \Analogue\ORM\Entity $entity
-     * @return void
-     */
-    public function updatePivot($entity)
-    {
-        $keyName = $this->relatedMap->getKeyName();
-
-        $this->updateExistingPivot(
-            $entity->getEntityAttribute($keyName),
-            $entity->getEntityAttribute('pivot')->getEntityAttributes()
-        );
-    }
-
-    /**
-     * Update Multiple pivot
-     *
-     * @param  $relatedEntities
-     * @return void
-     */
-    public function updatePivots($relatedEntities)
-    {
-        foreach ($relatedEntities as $entity) {
-            $this->updatePivot($entity);
-        }
-    }
-
-    /**
-     * Create Pivot Records
-     *
-     * @param \Analogue\ORM\Entity[] $relatedEntities
-     * @return void
-     */
-    public function createPivots($relatedEntities)
-    {
-        $keys = [];
-        $attributes = [];
-
-        $keyName = $this->relatedMap->getKeyName();
-
-        foreach ($relatedEntities as $entity) {
-            $keys[] = $entity->getEntityAttribute($keyName);
-        }
-
-        $records = $this->createAttachRecords($keys, $attributes);
-
-        $this->query->getQuery()->from($this->table)->insert($records);
-    }
-
-    /**
-     * Update an existing pivot record on the table.
-     *
-     * @param  mixed $id
-     * @param  array $attributes
-     * @throws \InvalidArgumentException
-     * @return integer
-     */
-    public function updateExistingPivot($id, array $attributes)
-    {
-        if (in_array($this->updatedAt(), $this->pivotColumns)) {
-            $attributes = $this->setTimestampsOnAttach($attributes, true);
-        }
-
-        return $this->newPivotStatementForId($id)->update($attributes);
-    }
-
-    /**
-     * Attach a model to the parent.
-     *
-     * @param  mixed $id
-     * @param  array $attributes
-     * @return void
-     */
-    public function attach($id, array $attributes = [])
-    {
-        $query = $this->newPivotStatement();
-
-        $query->insert($this->createAttachRecords((array) $id, $attributes));
-    }
-
-    /**
-     * @param  array $entities
-     *
-     * @throws \InvalidArgumentException
-     */
-    public function sync(array $entities)
-    {
-        $this->detachExcept($entities);
-    }
-
-    /**
-     * Detach related entities that are not in $id
-     *
-     * @param  array $entities
-     *
-     * @throws \InvalidArgumentException
-     *
-     * @return void
-     */
-    protected function detachExcept(array $entities = [])
-    {
-        $query = $this->newPivotQuery();
-
-        if (count($entities) > 0) {
-            $keys = $this->getKeys($entities);
-
-            $query->whereNotIn($this->otherKey, $keys);
-        }
-        $parentKey = $this->parentMap->getKeyName();
-
-        $query->where($this->foreignKey, '=', $this->parent->getEntityAttribute($parentKey));
+		return $this->relatedMap->newCollection($entities);
+	}
+
+	/**
+	 * Hydrate the pivot table relationship on the models.
+	 *
+	 * @param  array $entities
+	 * @return void
+	 */
+	protected function hydratePivotRelation(array $entities)
+	{
+		// TODO (note) We should definitely get rid of the pivot in a next
+		// release, as this is not quite relevant in a datamapper context. 
+		$host = $this;
+		return array_map(function($entity) use ($host) {
+			$entityWrapper = $this->factory->make($entity);
+
+			$pivot = $this->newExistingPivot($this->cleanPivotAttributes($entityWrapper));
+			$entityWrapper->setEntityAttribute('pivot', $pivot);
+
+			return $entityWrapper->getObject();
+		}, $entities);
+	}
+
+	/**
+	 * Get the pivot attributes from a model.
+	 *
+	 * @param  $entity
+	 * @return array
+	 */
+	protected function cleanPivotAttributes(InternallyMappable $entity)
+	{
+		$values = [];
+
+		$attributes = $entity->getEntityAttributes();
+
+		foreach ($attributes as $key => $value) {
+			// To get the pivots attributes we will just take any of the attributes which
+			// begin with "pivot_" and add those to this arrays, as well as unsetting
+			// them from the parent's models since they exist in a different table.
+			if (strpos($key, 'pivot_') === 0) {
+				$values[substr($key, 6)] = $value;
+
+				unset($attributes[$key]);
+			}
+		}
+
+		// Rehydrate Entity with cleaned array.
+		$entity->setEntityAttributes($attributes);
+
+		return $values;
+	}
+
+	/**
+	 * Set the base constraints on the relation query.
+	 *
+	 * @return void
+	 */
+	public function addConstraints()
+	{
+		$this->setJoin();
+
+		if (static::$constraints) {
+			$this->setWhere();
+		}
+	}
+
+	/**
+	 * Add the constraints for a relationship count query.
+	 *
+	 * @param  Query $query
+	 * @param  Query $parent
+	 * @return Query
+	 */
+	public function getRelationCountQuery(Query $query, Query $parent)
+	{
+		if ($parent->getQuery()->from == $query->getQuery()->from) {
+			return $this->getRelationCountQueryForSelfJoin($query, $parent);
+		}
+
+		$this->setJoin($query);
+
+		return parent::getRelationCountQuery($query, $parent);
+	}
+
+	/**
+	 * Add the constraints for a relationship count query on the same table.
+	 *
+	 * @param  Query $query
+	 * @param  Query $parent
+	 * @return Query
+	 */
+	public function getRelationCountQueryForSelfJoin(Query $query, Query $parent)
+	{
+		$query->select(new Expression('count(*)'));
+
+		$tablePrefix = $this->query->getQuery()->getConnection()->getTablePrefix();
+
+		$query->from($this->table . ' as ' . $tablePrefix . $hash = $this->getRelationCountHash());
+
+		$key = $this->wrap($this->getQualifiedParentKeyName());
+
+		return $query->where($hash . '.' . $this->foreignKey, '=', new Expression($key));
+	}
+
+	/**
+	 * Get a relationship join table hash.
+	 *
+	 * @return string
+	 */
+	public function getRelationCountHash()
+	{
+		return 'self_' . md5(microtime(true));
+	}
+
+	/**
+	 * Set the select clause for the relation query.
+	 *
+	 * @param  array $columns
+	 * @return \Analogue\ORM\Relationships\BelongsToMany
+	 */
+	protected function getSelectColumns(array $columns = ['*'])
+	{
+		if ($columns == ['*']) {
+			$columns = [$this->relatedMap->getTable() . '.*'];
+		}
+
+		return array_merge($columns, $this->getAliasedPivotColumns());
+	}
+
+	/**
+	 * Get the pivot columns for the relation.
+	 *
+	 * @return array
+	 */
+	protected function getAliasedPivotColumns()
+	{
+		$defaults = [$this->foreignKey, $this->otherKey];
+
+		// We need to alias all of the pivot columns with the "pivot_" prefix so we
+		// can easily extract them out of the models and put them into the pivot
+		// relationships when they are retrieved and hydrated into the models.
+		$columns = [];
+
+		foreach (array_merge($defaults, $this->pivotColumns) as $column) {
+			$columns[] = $this->table . '.' . $column . ' as pivot_' . $column;
+		}
+
+		return array_unique($columns);
+	}
+
+	/**
+	 * Set the join clause for the relation query.
+	 *
+	 * @param  \Analogue\ORM\Query|null
+	 * @return $this
+	 */
+	protected function setJoin($query = null)
+	{
+		$query = $query ?: $this->query;
+
+		// We need to join to the intermediate table on the related model's primary
+		// key column with the intermediate table's foreign key for the related
+		// model instance. Then we can set the "where" for the parent models.
+		$baseTable = $this->relatedMap->getTable();
+
+		$key = $baseTable . '.' . $this->relatedMap->getKeyName();
+
+		$query->join($this->table, $key, '=', $this->getOtherKey());
+
+		return $this;
+	}
+
+	/**
+	 * Set the where clause for the relation query.
+	 *
+	 * @return $this
+	 */
+	protected function setWhere()
+	{
+		$foreign = $this->getForeignKey();
+
+		$parentKey = $this->parentMap->getKeyName();
+
+		$this->query->where($foreign, '=', $this->parent->getEntityAttribute($parentKey));
+
+		return $this;
+	}
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $results
+	 * @return void
+	 */
+	public function addEagerConstraints(array $results)
+	{
+		$this->query->whereIn($this->getForeignKey(), $this->getKeysFromResults($results));
+	}
+
+	/**
+	 * Match Eagerly loaded relation to result
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function match(array $results, $relation)
+	{
+		$entities = $this->getEager();
+
+		// TODO; optimize this operation
+		$dictionary = $this->buildDictionary($entities);
+
+		$keyName = $this->relatedMap->getKeyName();
+
+		$cache = $this->parentMapper->getEntityCache();
+
+		$host = $this;
+
+		// Once we have an array dictionary of child objects we can easily match the
+		// children back to their parent using the dictionary and the keys on the
+		// the parent models. Then we will return the hydrated models back out.
+		return array_map(function($result) use ($dictionary, $keyName, $cache, $relation, $host) {
+
+			if (isset($dictionary[$key = $result[$keyName]])) {
+				$collection = $host->relatedMap->newCollection($dictionary[$key]);
+
+				$result[$relation] = $collection;
+
+				// TODO Refactor this
+				$cache->cacheLoadedRelationResult($key, $relation, $collection, $this);
+			}
+			else {
+				$result[$relation] = $host->relatedMap->newCollection();
+			}
+			return $result;
+
+		}, $results);
+	}
+
+	/**
+	 * Build model dictionary keyed by the relation's foreign key.
+	 *
+	 * @param  EntityCollection $results
+	 * @return array
+	 */
+	protected function buildDictionary(EntityCollection $results)
+	{
+		$foreign = $this->foreignKey;
+
+		// First we will build a dictionary of child models keyed by the foreign key
+		// of the relation so that we will easily and quickly match them to their
+		// parents without having a possibly slow inner loops for every models.
+		$dictionary = [];
+
+		foreach ($results as $entity) {
+			$wrapper = $this->factory->make($entity);
+			$dictionary[$wrapper->getEntityAttribute('pivot')->$foreign][] = $entity;
+		}
+
+		return $dictionary;
+	}
+
+	/**
+	 * Get all of the IDs for the related models.
+	 *
+	 * @return array
+	 */
+	public function getRelatedIds()
+	{
+		$fullKey = $this->relatedMap->getQualifiedKeyName();
+
+		return $this->getQuery()->select($fullKey)->lists($this->relatedMap->getKeyName());
+	}
+
+	/**
+	 * Update Pivot
+	 *
+	 * @param  \Analogue\ORM\Entity $entity
+	 * @return void
+	 */
+	public function updatePivot($entity)
+	{
+		$keyName = $this->relatedMap->getKeyName();
+
+		$this->updateExistingPivot(
+			$entity->getEntityAttribute($keyName),
+			$entity->getEntityAttribute('pivot')->getEntityAttributes()
+		);
+	}
+
+	/**
+	 * Update Multiple pivot
+	 *
+	 * @param  $relatedEntities
+	 * @return void
+	 */
+	public function updatePivots($relatedEntities)
+	{
+		foreach ($relatedEntities as $entity) {
+			$this->updatePivot($entity);
+		}
+	}
+
+	/**
+	 * Create Pivot Records
+	 *
+	 * @param \Analogue\ORM\Entity[] $relatedEntities
+	 * @return void
+	 */
+	public function createPivots($relatedEntities)
+	{
+		$keys = [];
+		$attributes = [];
+
+		$keyName = $this->relatedMap->getKeyName();
+
+		foreach ($relatedEntities as $entity) {
+			$keys[] = $entity->getEntityAttribute($keyName);
+		}
+
+		$records = $this->createAttachRecords($keys, $attributes);
+
+		$this->query->getQuery()->from($this->table)->insert($records);
+	}
+
+	/**
+	 * Update an existing pivot record on the table.
+	 *
+	 * @param  mixed $id
+	 * @param  array $attributes
+	 * @throws \InvalidArgumentException
+	 * @return integer
+	 */
+	public function updateExistingPivot($id, array $attributes)
+	{
+		if (in_array($this->updatedAt(), $this->pivotColumns)) {
+			$attributes = $this->setTimestampsOnAttach($attributes, true);
+		}
+
+		return $this->newPivotStatementForId($id)->update($attributes);
+	}
+
+	/**
+	 * Attach a model to the parent.
+	 *
+	 * @param  mixed $id
+	 * @param  array $attributes
+	 * @return void
+	 */
+	public function attach($id, array $attributes = [])
+	{
+		$query = $this->newPivotStatement();
+
+		$query->insert($this->createAttachRecords((array) $id, $attributes));
+	}
+
+	/**
+	 * @param  array $entities
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public function sync(array $entities)
+	{
+		$this->detachExcept($entities);
+	}
+
+	/**
+	 * Detach related entities that are not in $id
+	 *
+	 * @param  array $entities
+	 *
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return void
+	 */
+	protected function detachExcept(array $entities = [])
+	{
+		$query = $this->newPivotQuery();
+
+		if (count($entities) > 0) {
+			$keys = $this->getKeys($entities);
+
+			$query->whereNotIn($this->otherKey, $keys);
+		}
+		$parentKey = $this->parentMap->getKeyName();
+
+		$query->where($this->foreignKey, '=', $this->parent->getEntityAttribute($parentKey));
         
-        $query->delete();
-
-        $query = $this->newPivotQuery();
-    }
-
-
-    /**
-     * Create an array of records to insert into the pivot table.
-     *
-     * @param  array $ids
-     * @param  array $attributes
-     * @return array
-     */
-    protected function createAttachRecords($ids, array $attributes)
-    {
-        $records = [];
-
-        $timed = in_array($this->createdAt(), $this->pivotColumns);
-
-        // To create the attachment records, we will simply spin through the IDs given
-        // and create a new record to insert for each ID. Each ID may actually be a
-        // key in the array, with extra attributes to be placed in other columns.
-        foreach ($ids as $key => $value) {
-            $records[] = $this->attacher($key, $value, $attributes, $timed);
-        }
+		$query->delete();
+
+		$query = $this->newPivotQuery();
+	}
+
+
+	/**
+	 * Create an array of records to insert into the pivot table.
+	 *
+	 * @param  array $ids
+	 * @param  array $attributes
+	 * @return array
+	 */
+	protected function createAttachRecords($ids, array $attributes)
+	{
+		$records = [];
+
+		$timed = in_array($this->createdAt(), $this->pivotColumns);
+
+		// To create the attachment records, we will simply spin through the IDs given
+		// and create a new record to insert for each ID. Each ID may actually be a
+		// key in the array, with extra attributes to be placed in other columns.
+		foreach ($ids as $key => $value) {
+			$records[] = $this->attacher($key, $value, $attributes, $timed);
+		}
         
-        return $records;
-    }
-
-    /**
-     * Create a full attachment record payload.
-     *
-     * @param  int   $key
-     * @param  mixed $value
-     * @param  array $attributes
-     * @param  bool  $timed
-     * @return array
-     */
-    protected function attacher($key, $value, $attributes, $timed)
-    {
-        list($id, $extra) = $this->getAttachId($key, $value, $attributes);
+		return $records;
+	}
+
+	/**
+	 * Create a full attachment record payload.
+	 *
+	 * @param  int   $key
+	 * @param  mixed $value
+	 * @param  array $attributes
+	 * @param  bool  $timed
+	 * @return array
+	 */
+	protected function attacher($key, $value, $attributes, $timed)
+	{
+		list($id, $extra) = $this->getAttachId($key, $value, $attributes);
         
-        // To create the attachment records, we will simply spin through the IDs given
-        // and create a new record to insert for each ID. Each ID may actually be a
-        // key in the array, with extra attributes to be placed in other columns.
-        $record = $this->createAttachRecord($id, $timed);
-
-        return array_merge($record, $extra);
-    }
-
-    /**
-     * Get the attach record ID and extra attributes.
-     *
-     * @param  int   $key
-     * @param  mixed $value
-     * @param  array $attributes
-     * @return array
-     */
-    protected function getAttachId($key, $value, array $attributes)
-    {
-        if (is_array($value)) {
-            return [$key, array_merge($value, $attributes)];
-        }
-
-        return [$value, $attributes];
-    }
-
-    /**
-     * Create a new pivot attachment record.
-     *
-     * @param  int  $id
-     * @param  bool $timed
-     * @return array
-     */
-    protected function createAttachRecord($id, $timed)
-    {
-        $parentKey = $this->parentMap->getKeyName();
-
-        $record = [];
-
-        $record[$this->foreignKey] = $this->parent->getEntityAttribute($parentKey);
-
-        $record[$this->otherKey] = $id;
-
-        // If the record needs to have creation and update timestamps, we will make
-        // them by calling the parent model's "freshTimestamp" method which will
-        // provide us with a fresh timestamp in this model's preferred format.
-        if ($timed) {
-            $record = $this->setTimestampsOnAttach($record);
-        }
-
-        return $record;
-    }
-
-    /**
-     * Set the creation and update timestamps on an attach record.
-     *
-     * @param  array $record
-     * @param  bool  $exists
-     * @return array
-     */
-    protected function setTimestampsOnAttach(array $record, $exists = false)
-    {
-        $fresh = $this->freshTimestamp();
-
-        if (!$exists) {
-            $record[$this->createdAt()] = $fresh;
-        }
-
-        $record[$this->updatedAt()] = $fresh;
-
-        return $record;
-    }
-
-    /**
-     * @param EntityCollection $entities
-     * @return array
-     */
-    protected function getModelKeysFromCollection(EntityCollection $entities)
-    {
-        $keyName = $this->relatedMap->getKeyName();
-
-        return array_map(function ($m) use ($keyName) {
-            return $m->$keyName;
-        }, $entities);
-    }
-
-    /**
-     * Detach models from the relationship.
-     *
-     * @param  int|array $ids
-     * @throws \InvalidArgumentException
-     * @return int
-     */
-    public function detach($ids = [])
-    {
-        if ($ids instanceof EntityCollection) {
-            $ids = (array) $ids->modelKeys();
-        }
-
-        $query = $this->newPivotQuery();
-
-        // If associated IDs were passed to the method we will only delete those
-        // associations, otherwise all of the association ties will be broken.
-        // We'll return the numbers of affected rows when we do the deletes.
-        $ids = (array) $ids;
-
-        if (count($ids) > 0) {
-            $query->whereIn($this->otherKey, (array) $ids);
-        }
-
-        // Once we have all of the conditions set on the statement, we are ready
-        // to run the delete on the pivot table. Then, if the touch parameter
-        // is true, we will go ahead and touch all related models to sync.
-        return $query->delete();
-    }
+		// To create the attachment records, we will simply spin through the IDs given
+		// and create a new record to insert for each ID. Each ID may actually be a
+		// key in the array, with extra attributes to be placed in other columns.
+		$record = $this->createAttachRecord($id, $timed);
+
+		return array_merge($record, $extra);
+	}
+
+	/**
+	 * Get the attach record ID and extra attributes.
+	 *
+	 * @param  int   $key
+	 * @param  mixed $value
+	 * @param  array $attributes
+	 * @return array
+	 */
+	protected function getAttachId($key, $value, array $attributes)
+	{
+		if (is_array($value)) {
+			return [$key, array_merge($value, $attributes)];
+		}
+
+		return [$value, $attributes];
+	}
+
+	/**
+	 * Create a new pivot attachment record.
+	 *
+	 * @param  int  $id
+	 * @param  bool $timed
+	 * @return array
+	 */
+	protected function createAttachRecord($id, $timed)
+	{
+		$parentKey = $this->parentMap->getKeyName();
+
+		$record = [];
+
+		$record[$this->foreignKey] = $this->parent->getEntityAttribute($parentKey);
+
+		$record[$this->otherKey] = $id;
+
+		// If the record needs to have creation and update timestamps, we will make
+		// them by calling the parent model's "freshTimestamp" method which will
+		// provide us with a fresh timestamp in this model's preferred format.
+		if ($timed) {
+			$record = $this->setTimestampsOnAttach($record);
+		}
+
+		return $record;
+	}
+
+	/**
+	 * Set the creation and update timestamps on an attach record.
+	 *
+	 * @param  array $record
+	 * @param  bool  $exists
+	 * @return array
+	 */
+	protected function setTimestampsOnAttach(array $record, $exists = false)
+	{
+		$fresh = $this->freshTimestamp();
+
+		if (!$exists) {
+			$record[$this->createdAt()] = $fresh;
+		}
+
+		$record[$this->updatedAt()] = $fresh;
+
+		return $record;
+	}
+
+	/**
+	 * @param EntityCollection $entities
+	 * @return array
+	 */
+	protected function getModelKeysFromCollection(EntityCollection $entities)
+	{
+		$keyName = $this->relatedMap->getKeyName();
+
+		return array_map(function ($m) use ($keyName) {
+			return $m->$keyName;
+		}, $entities);
+	}
+
+	/**
+	 * Detach models from the relationship.
+	 *
+	 * @param  int|array $ids
+	 * @throws \InvalidArgumentException
+	 * @return int
+	 */
+	public function detach($ids = [])
+	{
+		if ($ids instanceof EntityCollection) {
+			$ids = (array) $ids->modelKeys();
+		}
+
+		$query = $this->newPivotQuery();
+
+		// If associated IDs were passed to the method we will only delete those
+		// associations, otherwise all of the association ties will be broken.
+		// We'll return the numbers of affected rows when we do the deletes.
+		$ids = (array) $ids;
+
+		if (count($ids) > 0) {
+			$query->whereIn($this->otherKey, (array) $ids);
+		}
+
+		// Once we have all of the conditions set on the statement, we are ready
+		// to run the delete on the pivot table. Then, if the touch parameter
+		// is true, we will go ahead and touch all related models to sync.
+		return $query->delete();
+	}
     
-    /**
-     * Create a new query builder for the pivot table.
-     *
-     * @throws \InvalidArgumentException
-     *
-     * @return \Illuminate\Database\Query\Builder
-     */
-    protected function newPivotQuery()
-    {
-        $query = $this->newPivotStatement();
-
-        $parentKey = $this->parentMap->getKeyName();
-
-        return $query->where($this->foreignKey, $this->parent->getEntityAttribute($parentKey));
-    }
-
-    /**
-     * Get a new plain query builder for the pivot table.
-     *
-     * @return \Illuminate\Database\Query\Builder
-     */
-    public function newPivotStatement()
-    {
-        return $this->query->getQuery()->newQuery()->from($this->table);
-    }
-
-    /**
-     * Get a new pivot statement for a given "other" ID.
-     *
-     * @param  mixed $id
-     *
-     * @throws \InvalidArgumentException
-     *
-     * @return \Illuminate\Database\Query\Builder
-     */
-    public function newPivotStatementForId($id)
-    {
-        $pivot = $this->newPivotStatement();
-
-        $parentKeyName = $this->parentMap->getKeyName();
-
-        $key = $this->parent->getEntityAttribute($parentKeyName);
-
-        return $pivot->where($this->foreignKey, $key)->where($this->otherKey, $id);
-    }
-
-    /**
-     * Create a new pivot model instance.
-     *
-     * @param  array $attributes
-     * @param  bool  $exists
-     * @return \Analogue\ORM\Relationships\Pivot
-     */
-    public function newPivot(array $attributes = [], $exists = false)
-    {
-        $pivot = new Pivot($this->parent, $this->parentMap, $attributes, $this->table, $exists);
+	/**
+	 * Create a new query builder for the pivot table.
+	 *
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return \Illuminate\Database\Query\Builder
+	 */
+	protected function newPivotQuery()
+	{
+		$query = $this->newPivotStatement();
+
+		$parentKey = $this->parentMap->getKeyName();
+
+		return $query->where($this->foreignKey, $this->parent->getEntityAttribute($parentKey));
+	}
+
+	/**
+	 * Get a new plain query builder for the pivot table.
+	 *
+	 * @return \Illuminate\Database\Query\Builder
+	 */
+	public function newPivotStatement()
+	{
+		return $this->query->getQuery()->newQuery()->from($this->table);
+	}
+
+	/**
+	 * Get a new pivot statement for a given "other" ID.
+	 *
+	 * @param  mixed $id
+	 *
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return \Illuminate\Database\Query\Builder
+	 */
+	public function newPivotStatementForId($id)
+	{
+		$pivot = $this->newPivotStatement();
+
+		$parentKeyName = $this->parentMap->getKeyName();
+
+		$key = $this->parent->getEntityAttribute($parentKeyName);
+
+		return $pivot->where($this->foreignKey, $key)->where($this->otherKey, $id);
+	}
+
+	/**
+	 * Create a new pivot model instance.
+	 *
+	 * @param  array $attributes
+	 * @param  bool  $exists
+	 * @return \Analogue\ORM\Relationships\Pivot
+	 */
+	public function newPivot(array $attributes = [], $exists = false)
+	{
+		$pivot = new Pivot($this->parent, $this->parentMap, $attributes, $this->table, $exists);
         
-        return $pivot->setPivotKeys($this->foreignKey, $this->otherKey);
-    }
-
-    /**
-     * Create a new existing pivot model instance.
-     *
-     * @param  array $attributes
-     * @return \Analogue\ORM\Relationships\Pivot
-     */
-    public function newExistingPivot(array $attributes = [])
-    {
-        return $this->newPivot($attributes, true);
-    }
-
-    /**
-     * Set the columns on the pivot table to retrieve.
-     *
-     * @param  array $columns
-     * @return $this
-     */
-    public function withPivot($columns)
-    {
-        $columns = is_array($columns) ? $columns : func_get_args();
-
-        $this->pivotColumns = array_merge($this->pivotColumns, $columns);
-
-        return $this;
-    }
-
-    /**
-     * Specify that the pivot table has creation and update timestamps.
-     *
-     * @param  mixed $createdAt
-     * @param  mixed $updatedAt
-     * @return \Analogue\ORM\Relationships\BelongsToMany
-     */
-    public function withTimestamps($createdAt = null, $updatedAt = null)
-    {
-        return $this->withPivot($createdAt ?: $this->createdAt(), $updatedAt ?: $this->updatedAt());
-    }
-
-    /**
-     * Get the key for comparing against the parent key in "has" query.
-     *
-     * @return string
-     */
-    public function getHasCompareKey()
-    {
-        return $this->getForeignKey();
-    }
-
-    /**
-     * Get the fully qualified foreign key for the relation.
-     *
-     * @return string
-     */
-    public function getForeignKey()
-    {
-        return $this->table . '.' . $this->foreignKey;
-    }
-
-    /**
-     * Get the fully qualified "other key" for the relation.
-     *
-     * @return string
-     */
-    public function getOtherKey()
-    {
-        return $this->table . '.' . $this->otherKey;
-    }
-
-    /**
-     * Get the fully qualified parent key name.
-     *
-     * @return string
-     */
-    protected function getQualifiedParentKeyName()
-    {
-        return $this->parentMap->getQualifiedKeyName();
-    }
-
-    /**
-     * Get the intermediate table for the relationship.
-     *
-     * @return string
-     */
-    public function getTable()
-    {
-        return $this->table;
-    }
-
-    /**
-     * Get the relationship name for the relationship.
-     *
-     * @return string
-     */
-    public function getRelationName()
-    {
-        return $this->relationName;
-    }
+		return $pivot->setPivotKeys($this->foreignKey, $this->otherKey);
+	}
+
+	/**
+	 * Create a new existing pivot model instance.
+	 *
+	 * @param  array $attributes
+	 * @return \Analogue\ORM\Relationships\Pivot
+	 */
+	public function newExistingPivot(array $attributes = [])
+	{
+		return $this->newPivot($attributes, true);
+	}
+
+	/**
+	 * Set the columns on the pivot table to retrieve.
+	 *
+	 * @param  array $columns
+	 * @return $this
+	 */
+	public function withPivot($columns)
+	{
+		$columns = is_array($columns) ? $columns : func_get_args();
+
+		$this->pivotColumns = array_merge($this->pivotColumns, $columns);
+
+		return $this;
+	}
+
+	/**
+	 * Specify that the pivot table has creation and update timestamps.
+	 *
+	 * @param  mixed $createdAt
+	 * @param  mixed $updatedAt
+	 * @return \Analogue\ORM\Relationships\BelongsToMany
+	 */
+	public function withTimestamps($createdAt = null, $updatedAt = null)
+	{
+		return $this->withPivot($createdAt ?: $this->createdAt(), $updatedAt ?: $this->updatedAt());
+	}
+
+	/**
+	 * Get the key for comparing against the parent key in "has" query.
+	 *
+	 * @return string
+	 */
+	public function getHasCompareKey()
+	{
+		return $this->getForeignKey();
+	}
+
+	/**
+	 * Get the fully qualified foreign key for the relation.
+	 *
+	 * @return string
+	 */
+	public function getForeignKey()
+	{
+		return $this->table . '.' . $this->foreignKey;
+	}
+
+	/**
+	 * Get the fully qualified "other key" for the relation.
+	 *
+	 * @return string
+	 */
+	public function getOtherKey()
+	{
+		return $this->table . '.' . $this->otherKey;
+	}
+
+	/**
+	 * Get the fully qualified parent key name.
+	 *
+	 * @return string
+	 */
+	protected function getQualifiedParentKeyName()
+	{
+		return $this->parentMap->getQualifiedKeyName();
+	}
+
+	/**
+	 * Get the intermediate table for the relationship.
+	 *
+	 * @return string
+	 */
+	public function getTable()
+	{
+		return $this->table;
+	}
+
+	/**
+	 * Get the relationship name for the relationship.
+	 *
+	 * @return string
+	 */
+	public function getRelationName()
+	{
+		return $this->relationName;
+	}
 }

src/Relationships/MorphToMany.php

Indentation +162 added lines, -162 removed lines

@@ -7,167 +7,167 @@
 
 class MorphToMany extends BelongsToMany
 {
-    /**
-     * The type of the polymorphic relation.
-     *
-     * @var string
-     */
-    protected $morphType;
-
-    /**
-     * The class name of the morph type constraint.
-     *
-     * @var string
-     */
-    protected $morphClass;
-
-    /**
-     * Indicates if we are connecting the inverse of the relation.
-     *
-     * This primarily affects the morphClass constraint.
-     *
-     * @var bool
-     */
-    protected $inverse;
-
-    protected static $hasPivot = true;
-
-    /**
-     * Create a new has many relationship instance.
-     *
-     * @param Mapper                $mapper
-     * @param  \Analogue\ORM\Entity $parent
-     * @param  string               $name
-     * @param  string               $table
-     * @param  string               $foreignKey
-     * @param  string               $otherKey
-     * @param  string|null          $relationName
-     * @param  bool                 $inverse
-     */
-    public function __construct(Mapper $mapper, $parent, $name, $table, $foreignKey, $otherKey, $relationName = null, $inverse = false)
-    {
-        $this->inverse = $inverse;
+	/**
+	 * The type of the polymorphic relation.
+	 *
+	 * @var string
+	 */
+	protected $morphType;
+
+	/**
+	 * The class name of the morph type constraint.
+	 *
+	 * @var string
+	 */
+	protected $morphClass;
+
+	/**
+	 * Indicates if we are connecting the inverse of the relation.
+	 *
+	 * This primarily affects the morphClass constraint.
+	 *
+	 * @var bool
+	 */
+	protected $inverse;
+
+	protected static $hasPivot = true;
+
+	/**
+	 * Create a new has many relationship instance.
+	 *
+	 * @param Mapper                $mapper
+	 * @param  \Analogue\ORM\Entity $parent
+	 * @param  string               $name
+	 * @param  string               $table
+	 * @param  string               $foreignKey
+	 * @param  string               $otherKey
+	 * @param  string|null          $relationName
+	 * @param  bool                 $inverse
+	 */
+	public function __construct(Mapper $mapper, $parent, $name, $table, $foreignKey, $otherKey, $relationName = null, $inverse = false)
+	{
+		$this->inverse = $inverse;
         
-        $this->morphType = $name . '_type';
-
-        $this->morphClass = $inverse ? $mapper->getEntityMap()->getClass() : get_class($parent);
-
-        parent::__construct($mapper, $parent, $table, $foreignKey, $otherKey, $relationName);
-    }
-
-    /**
-     * Set the where clause for the relation query.
-     *
-     * @return self
-     */
-    protected function setWhere()
-    {
-        parent::setWhere();
-
-        $this->query->where($this->table . '.' . $this->morphType, $this->morphClass);
-
-        return $this;
-    }
-
-    /**
-     * Add the constraints for a relationship count query.
-     *
-     * @param  Query $query
-     * @param  Query $parent
-     * @return Query
-     */
-    public function getRelationCountQuery(Query $query, Query $parent)
-    {
-        $query = parent::getRelationCountQuery($query, $parent);
-
-        return $query->where($this->table . '.' . $this->morphType, $this->morphClass);
-    }
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $results
-     * @return void
-     */
-    public function addEagerConstraints(array $results)
-    {
-        parent::addEagerConstraints($results);
-
-        $this->query->where($this->table . '.' . $this->morphType, $this->morphClass);
-    }
-
-    /**
-     * Create a new pivot attachment record.
-     *
-     * @param  int  $id
-     * @param  bool $timed
-     * @return array
-     */
-    protected function createAttachRecord($id, $timed)
-    {
-        $record = parent::createAttachRecord($id, $timed);
-
-        return array_add($record, $this->morphType, $this->morphClass);
-    }
-
-    /**
-     * Create a new query builder for the pivot table.
-     *
-     * @throws \InvalidArgumentException
-     * @return \Illuminate\Database\Query\Builder
-     */
-    protected function newPivotQuery()
-    {
-        $query = parent::newPivotQuery();
-
-        return $query->where($this->morphType, $this->morphClass);
-    }
-
-    /**
-     * Create a new pivot model instance.
-     *
-     * @param  array $attributes
-     * @param  bool  $exists
-     * @return Pivot
-     */
-    public function newPivot(array $attributes = [], $exists = false)
-    {
-        $pivot = new MorphPivot($this->parent, $this->parentMap, $attributes, $this->table, $exists);
-
-        $pivot->setPivotKeys($this->foreignKey, $this->otherKey)
-            ->setMorphType($this->morphType)
-            ->setMorphClass($this->morphClass);
-
-        return $pivot;
-    }
-
-    /**
-     * Return Pivot attributes when available on a relationship
-     *
-     * @return array
-     */
-    public function getPivotAttributes()
-    {
-        return $this->pivotColumns;
-    }
-
-    /**
-     * Get the foreign key "type" name.
-     *
-     * @return string
-     */
-    public function getMorphType()
-    {
-        return $this->morphType;
-    }
-
-    /**
-     * Get the class name of the parent model.
-     *
-     * @return string
-     */
-    public function getMorphClass()
-    {
-        return $this->morphClass;
-    }
+		$this->morphType = $name . '_type';
+
+		$this->morphClass = $inverse ? $mapper->getEntityMap()->getClass() : get_class($parent);
+
+		parent::__construct($mapper, $parent, $table, $foreignKey, $otherKey, $relationName);
+	}
+
+	/**
+	 * Set the where clause for the relation query.
+	 *
+	 * @return self
+	 */
+	protected function setWhere()
+	{
+		parent::setWhere();
+
+		$this->query->where($this->table . '.' . $this->morphType, $this->morphClass);
+
+		return $this;
+	}
+
+	/**
+	 * Add the constraints for a relationship count query.
+	 *
+	 * @param  Query $query
+	 * @param  Query $parent
+	 * @return Query
+	 */
+	public function getRelationCountQuery(Query $query, Query $parent)
+	{
+		$query = parent::getRelationCountQuery($query, $parent);
+
+		return $query->where($this->table . '.' . $this->morphType, $this->morphClass);
+	}
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $results
+	 * @return void
+	 */
+	public function addEagerConstraints(array $results)
+	{
+		parent::addEagerConstraints($results);
+
+		$this->query->where($this->table . '.' . $this->morphType, $this->morphClass);
+	}
+
+	/**
+	 * Create a new pivot attachment record.
+	 *
+	 * @param  int  $id
+	 * @param  bool $timed
+	 * @return array
+	 */
+	protected function createAttachRecord($id, $timed)
+	{
+		$record = parent::createAttachRecord($id, $timed);
+
+		return array_add($record, $this->morphType, $this->morphClass);
+	}
+
+	/**
+	 * Create a new query builder for the pivot table.
+	 *
+	 * @throws \InvalidArgumentException
+	 * @return \Illuminate\Database\Query\Builder
+	 */
+	protected function newPivotQuery()
+	{
+		$query = parent::newPivotQuery();
+
+		return $query->where($this->morphType, $this->morphClass);
+	}
+
+	/**
+	 * Create a new pivot model instance.
+	 *
+	 * @param  array $attributes
+	 * @param  bool  $exists
+	 * @return Pivot
+	 */
+	public function newPivot(array $attributes = [], $exists = false)
+	{
+		$pivot = new MorphPivot($this->parent, $this->parentMap, $attributes, $this->table, $exists);
+
+		$pivot->setPivotKeys($this->foreignKey, $this->otherKey)
+			->setMorphType($this->morphType)
+			->setMorphClass($this->morphClass);
+
+		return $pivot;
+	}
+
+	/**
+	 * Return Pivot attributes when available on a relationship
+	 *
+	 * @return array
+	 */
+	public function getPivotAttributes()
+	{
+		return $this->pivotColumns;
+	}
+
+	/**
+	 * Get the foreign key "type" name.
+	 *
+	 * @return string
+	 */
+	public function getMorphType()
+	{
+		return $this->morphType;
+	}
+
+	/**
+	 * Get the class name of the parent model.
+	 *
+	 * @return string
+	 */
+	public function getMorphClass()
+	{
+		return $this->morphClass;
+	}
 }

src/Relationships/HasOne.php

Indentation +32 added lines, -32 removed lines

@@ -6,40 +6,40 @@
 
 class HasOne extends HasOneOrMany
 {
-    /**
-     * Get the results of the relationship.
-     *
-     * @param $relation
-     * @return mixed
-     */
-    public function getResults($relation)
-    {
-        $result = $this->query->first();
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @param $relation
+	 * @return mixed
+	 */
+	public function getResults($relation)
+	{
+		$result = $this->query->first();
 
-        $this->cacheRelation($result, $relation);
+		$this->cacheRelation($result, $relation);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Get the results of the relationship.
-     *
-     * @return mixed
-     */
-    public function fetch()
-    {
-        return $this->query->first();
-    }
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @return mixed
+	 */
+	public function fetch()
+	{
+		return $this->query->first();
+	}
 
-    /**
-     * Match the eagerly loaded results to their parents.
-     *
-     * @param  array     $results
-     * @param  string    $relation
-     * @return array
-     */
-    public function match(array $results, $relation)
-    {
-        return $this->matchOne($results, $relation);
-    }
+	/**
+	 * Match the eagerly loaded results to their parents.
+	 *
+	 * @param  array     $results
+	 * @param  string    $relation
+	 * @return array
+	 */
+	public function match(array $results, $relation)
+	{
+		return $this->matchOne($results, $relation);
+	}
 }

src/Relationships/HasOneOrMany.php

Indentation +296 added lines, -296 removed lines

@@ -7,303 +7,303 @@
 
 abstract class HasOneOrMany extends Relationship
 {
-    /**
-     * The foreign key of the parent model.
-     *
-     * @var string
-     */
-    protected $foreignKey;
-
-    /**
-     * The local key of the parent model.
-     *
-     * @var string
-     */
-    protected $localKey;
-
-    /**
-     * Create a new has many relationship instance.
-     *
-     * @param Mapper                 $mapper
-     * @param \Analogue\ORM\Mappable $parentEntity
-     * @param string                 $foreignKey
-     * @param string                 $localKey
-     */
-    public function __construct(Mapper $mapper, $parentEntity, $foreignKey, $localKey)
-    {
-        $this->localKey = $localKey;
-        $this->foreignKey = $foreignKey;
-
-        parent::__construct($mapper, $parentEntity);
-    }
-
-    /**
-     * @param \Analogue\ORM\Entity $entity
-     */
-    public function attachOne($entity)
-    {
-        $wrapper = $this->factory->make($entity);
-
-        // Ok, we need to guess the inverse of the relation from there.
-        // Let's assume the inverse of the relation method is the name of
-        // the entity.
-
-        $wrapper->setEntityAttribute($this->getPlainForeignKey(), $this->getParentKey());
-    }
-
-    /**
-     * @param EntityCollection $entities
-     */
-    public function attachMany(EntityCollection $entities)
-    {
-        foreach ($entities as $entity) {
-            $this->attachOne($entity);
-        }
-    }
-
-    /**
-     * @param $entityHash
-     */
-    protected function detachOne($entityHash)
-    {
-        $this->detachMany([$entityHash]);
-    }
-
-    /**
-     * Attach ids that are passed as arguments, and detach any other
-     * @param  mixed $entities
-     * @throws \InvalidArgumentException
-     * @return void
-     */
-    public function sync(array $entities)
-    {
-        $this->detachExcept($entities);
-    }
-
-    /**
-     * @param  $entities
-     * @throws \InvalidArgumentException
-     */
-    protected function detachExcept($entities)
-    {
-        $query = $this->query->getQuery()->from($this->relatedMap->getTable());
-
-        if (count($entities) > 0) {
-            $keys = $this->getKeys($entities);
-            $query->whereNotIn($this->relatedMap->getKeyName(), $keys);
-        }
-
-        $parentKey = $this->parentMap->getKeyName();
-
-        $query->where($this->getPlainForeignKey(), '=', $this->parent->getEntityAttribute($parentKey))
-            ->update([$this->getPlainForeignKey() => null]);
-    }
-
-    /**
-     * @param array $entityHashes
-     */
-    public function detachMany(array $entityHashes)
-    {
-        $keys = [];
-
-        foreach ($entityHashes as $hash) {
-            $split = explode('.', $hash);
-            $keys[] = $split[1];
-        }
-
-        $query = $this->query->getQuery()->from($this->relatedMap->getTable());
-
-        $query->whereIn($this->relatedMap->getKeyName(), $keys)
-            ->update([$this->getPlainForeignKey() => null]);
-    }
-
-    /**
-     * Set the base constraints on the relation query.
-     *
-     * @return void
-     */
-    public function addConstraints()
-    {
-        if (static::$constraints) {
-            $this->query->where($this->foreignKey, '=', $this->getParentKey());
-        }
-    }
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $results
-     * @return void
-     */
-    public function addEagerConstraints(array $results)
-    {
-        $this->query->whereIn($this->foreignKey, $this->getKeysFromResults($results, $this->localKey));
-    }
-
-    /**
-     * Match the eagerly loaded relationship to the current result set
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function matchOne(array $results, $relation)
-    {
-        return $this->matchOneOrMany($results, $relation, 'one');
-    }
-
-    /**
-     * Match the eagerly loaded results to their many parents.
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function matchMany(array $results, $relation)
-    {
-        return $this->matchOneOrMany($results, $relation, 'many');
-    }
-
-    /**
-     * Match the eagerly loaded results to their many parents.
-     *
-     * @param  array            $results
-     * @param  string           $relation
-     * @param  string           $type
-     * @return array
-     */
-    protected function matchOneOrMany(array $results, $relation, $type)
-    {
-        $entities = $this->getEager();
-
-        $dictionary = $this->buildDictionary($entities);
-
-        $cache = $this->parentMapper->getEntityCache();
-
-        $host = $this;
-
-        // Once we have the dictionary we can simply spin through the parent models to
-        // link them up with their children using the keyed dictionary to make the
-        // matching very convenient and easy work. Then we'll just return them.
-        return array_map(function($result) use ($dictionary, $cache, $type, $relation, $host) { 
+	/**
+	 * The foreign key of the parent model.
+	 *
+	 * @var string
+	 */
+	protected $foreignKey;
+
+	/**
+	 * The local key of the parent model.
+	 *
+	 * @var string
+	 */
+	protected $localKey;
+
+	/**
+	 * Create a new has many relationship instance.
+	 *
+	 * @param Mapper                 $mapper
+	 * @param \Analogue\ORM\Mappable $parentEntity
+	 * @param string                 $foreignKey
+	 * @param string                 $localKey
+	 */
+	public function __construct(Mapper $mapper, $parentEntity, $foreignKey, $localKey)
+	{
+		$this->localKey = $localKey;
+		$this->foreignKey = $foreignKey;
+
+		parent::__construct($mapper, $parentEntity);
+	}
+
+	/**
+	 * @param \Analogue\ORM\Entity $entity
+	 */
+	public function attachOne($entity)
+	{
+		$wrapper = $this->factory->make($entity);
+
+		// Ok, we need to guess the inverse of the relation from there.
+		// Let's assume the inverse of the relation method is the name of
+		// the entity.
+
+		$wrapper->setEntityAttribute($this->getPlainForeignKey(), $this->getParentKey());
+	}
+
+	/**
+	 * @param EntityCollection $entities
+	 */
+	public function attachMany(EntityCollection $entities)
+	{
+		foreach ($entities as $entity) {
+			$this->attachOne($entity);
+		}
+	}
+
+	/**
+	 * @param $entityHash
+	 */
+	protected function detachOne($entityHash)
+	{
+		$this->detachMany([$entityHash]);
+	}
+
+	/**
+	 * Attach ids that are passed as arguments, and detach any other
+	 * @param  mixed $entities
+	 * @throws \InvalidArgumentException
+	 * @return void
+	 */
+	public function sync(array $entities)
+	{
+		$this->detachExcept($entities);
+	}
+
+	/**
+	 * @param  $entities
+	 * @throws \InvalidArgumentException
+	 */
+	protected function detachExcept($entities)
+	{
+		$query = $this->query->getQuery()->from($this->relatedMap->getTable());
+
+		if (count($entities) > 0) {
+			$keys = $this->getKeys($entities);
+			$query->whereNotIn($this->relatedMap->getKeyName(), $keys);
+		}
+
+		$parentKey = $this->parentMap->getKeyName();
+
+		$query->where($this->getPlainForeignKey(), '=', $this->parent->getEntityAttribute($parentKey))
+			->update([$this->getPlainForeignKey() => null]);
+	}
+
+	/**
+	 * @param array $entityHashes
+	 */
+	public function detachMany(array $entityHashes)
+	{
+		$keys = [];
+
+		foreach ($entityHashes as $hash) {
+			$split = explode('.', $hash);
+			$keys[] = $split[1];
+		}
+
+		$query = $this->query->getQuery()->from($this->relatedMap->getTable());
+
+		$query->whereIn($this->relatedMap->getKeyName(), $keys)
+			->update([$this->getPlainForeignKey() => null]);
+	}
+
+	/**
+	 * Set the base constraints on the relation query.
+	 *
+	 * @return void
+	 */
+	public function addConstraints()
+	{
+		if (static::$constraints) {
+			$this->query->where($this->foreignKey, '=', $this->getParentKey());
+		}
+	}
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $results
+	 * @return void
+	 */
+	public function addEagerConstraints(array $results)
+	{
+		$this->query->whereIn($this->foreignKey, $this->getKeysFromResults($results, $this->localKey));
+	}
+
+	/**
+	 * Match the eagerly loaded relationship to the current result set
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function matchOne(array $results, $relation)
+	{
+		return $this->matchOneOrMany($results, $relation, 'one');
+	}
+
+	/**
+	 * Match the eagerly loaded results to their many parents.
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function matchMany(array $results, $relation)
+	{
+		return $this->matchOneOrMany($results, $relation, 'many');
+	}
+
+	/**
+	 * Match the eagerly loaded results to their many parents.
+	 *
+	 * @param  array            $results
+	 * @param  string           $relation
+	 * @param  string           $type
+	 * @return array
+	 */
+	protected function matchOneOrMany(array $results, $relation, $type)
+	{
+		$entities = $this->getEager();
+
+		$dictionary = $this->buildDictionary($entities);
+
+		$cache = $this->parentMapper->getEntityCache();
+
+		$host = $this;
+
+		// Once we have the dictionary we can simply spin through the parent models to
+		// link them up with their children using the keyed dictionary to make the
+		// matching very convenient and easy work. Then we'll just return them.
+		return array_map(function($result) use ($dictionary, $cache, $type, $relation, $host) { 
             
-            $key = $result[$host->localKey];
+			$key = $result[$host->localKey];
 
-            if (isset($dictionary[$key])) {
+			if (isset($dictionary[$key])) {
                 
-                $value = $host->getRelationValue($dictionary, $key, $type);
-
-                $result[$relation] = $value;
-
-                // TODO : Refactor This
-                $cache->cacheLoadedRelationResult($key, $relation, $value, $this);
-            }
-            else {
-                // TODO set an empty collection or entityCollection if type is many ? 
-                $result[$relation] = null;
-            }
-
-            return $result;
-
-        }, $results);
-    }
-
-    /**
-     * Get the value of a relationship by one or many type.
-     *
-     * @param  array  $dictionary
-     * @param  string $key
-     * @param  string $type
-     * @return mixed
-     */
-    protected function getRelationValue(array $dictionary, $key, $type)
-    {
-        $value = $dictionary[$key];
-
-        return $type == 'one' ? reset($value) : $this->relatedMap->newCollection($value);
-    }
-
-    /**
-     * Build model dictionary keyed by the relation's foreign key.
-     *
-     * @param  EntityCollection $results
-     * @return array
-     */
-    protected function buildDictionary(EntityCollection $results)
-    {
-        $dictionary = [];
-
-        $foreign = $this->getPlainForeignKey();
-
-        // First we will create a dictionary of models keyed by the foreign key of the
-        // relationship as this will allow us to quickly access all of the related
-        // models without having to do nested looping which will be quite slow.
-        foreach ($results as $result) {
-            $dictionary[$result->{$foreign}][] = $result;
-        }
-
-        return $dictionary;
-    }
-
-    /**
-     * Get the key for comparing against the parent key in "has" query.
-     *
-     * @return string
-     */
-    public function getHasCompareKey()
-    {
-        return $this->getForeignKey();
-    }
-
-    /**
-     * Get the foreign key for the relationship.
-     *
-     * @return string
-     */
-    public function getForeignKey()
-    {
-        return $this->foreignKey;
-    }
-
-    /**
-     * Get the plain foreign key.
-     *
-     * @return string
-     */
-    public function getPlainForeignKey()
-    {
-        $segments = explode('.', $this->getForeignKey());
-
-        return $segments[count($segments) - 1];
-    }
-
-    /**
-     * Get the key value of the parent's local key.
-     *
-     * @return mixed
-     */
-    public function getParentKey()
-    {
-        return $this->parent->getEntityAttribute($this->localKey);
-    }
-
-    /**
-     * Get the fully qualified parent key name.
-     *
-     * @return string
-     */
-    public function getQualifiedParentKeyName()
-    {
-        return $this->parentMap->getTable() . '.' . $this->localKey;
-    }
-
-    /**
-     * Get the foreign key as value pair for this relation
-     *
-     * @return array
-     */
-    public function getForeignKeyValuePair()
-    {
-        return [$this->getPlainForeignKey() => $this->getParentKey()];
-    }
+				$value = $host->getRelationValue($dictionary, $key, $type);
+
+				$result[$relation] = $value;
+
+				// TODO : Refactor This
+				$cache->cacheLoadedRelationResult($key, $relation, $value, $this);
+			}
+			else {
+				// TODO set an empty collection or entityCollection if type is many ? 
+				$result[$relation] = null;
+			}
+
+			return $result;
+
+		}, $results);
+	}
+
+	/**
+	 * Get the value of a relationship by one or many type.
+	 *
+	 * @param  array  $dictionary
+	 * @param  string $key
+	 * @param  string $type
+	 * @return mixed
+	 */
+	protected function getRelationValue(array $dictionary, $key, $type)
+	{
+		$value = $dictionary[$key];
+
+		return $type == 'one' ? reset($value) : $this->relatedMap->newCollection($value);
+	}
+
+	/**
+	 * Build model dictionary keyed by the relation's foreign key.
+	 *
+	 * @param  EntityCollection $results
+	 * @return array
+	 */
+	protected function buildDictionary(EntityCollection $results)
+	{
+		$dictionary = [];
+
+		$foreign = $this->getPlainForeignKey();
+
+		// First we will create a dictionary of models keyed by the foreign key of the
+		// relationship as this will allow us to quickly access all of the related
+		// models without having to do nested looping which will be quite slow.
+		foreach ($results as $result) {
+			$dictionary[$result->{$foreign}][] = $result;
+		}
+
+		return $dictionary;
+	}
+
+	/**
+	 * Get the key for comparing against the parent key in "has" query.
+	 *
+	 * @return string
+	 */
+	public function getHasCompareKey()
+	{
+		return $this->getForeignKey();
+	}
+
+	/**
+	 * Get the foreign key for the relationship.
+	 *
+	 * @return string
+	 */
+	public function getForeignKey()
+	{
+		return $this->foreignKey;
+	}
+
+	/**
+	 * Get the plain foreign key.
+	 *
+	 * @return string
+	 */
+	public function getPlainForeignKey()
+	{
+		$segments = explode('.', $this->getForeignKey());
+
+		return $segments[count($segments) - 1];
+	}
+
+	/**
+	 * Get the key value of the parent's local key.
+	 *
+	 * @return mixed
+	 */
+	public function getParentKey()
+	{
+		return $this->parent->getEntityAttribute($this->localKey);
+	}
+
+	/**
+	 * Get the fully qualified parent key name.
+	 *
+	 * @return string
+	 */
+	public function getQualifiedParentKeyName()
+	{
+		return $this->parentMap->getTable() . '.' . $this->localKey;
+	}
+
+	/**
+	 * Get the foreign key as value pair for this relation
+	 *
+	 * @return array
+	 */
+	public function getForeignKeyValuePair()
+	{
+		return [$this->getPlainForeignKey() => $this->getParentKey()];
+	}
 }