analogueorm / analogue

src/Relationships/MorphOneOrMany.php

Indentation +115 added lines, -115 removed lines

@@ -7,119 +7,119 @@
 
 abstract class MorphOneOrMany extends HasOneOrMany
 {
-    /**
-     * The foreign key type for the relationship.
-     *
-     * @var string
-     */
-    protected $morphType;
-
-    /**
-     * The class name of the parent model.
-     *
-     * @var string
-     */
-    protected $morphClass;
-
-    /**
-     * Create a new has many relationship instance.
-     *
-     * @param  Mapper                 $mapper
-     * @param  \Analogue\ORM\Mappable $parent
-     * @param  string                 $type
-     * @param  string                 $id
-     * @param  string                 $localKey
-     * @throws \Analogue\ORM\Exceptions\MappingException
-     */
-    public function __construct(Mapper $mapper, $parent, $type, $id, $localKey)
-    {
-        $this->morphType = $type;
-        $this->morphClass = $mapper->getManager()->getMapper($parent)->getEntityMap()->getMorphClass();
-
-        parent::__construct($mapper, $parent, $id, $localKey);
-    }
-
-    /**
-     * Set the base constraints on the relation query.
-     *
-     * @return void
-     */
-    public function addConstraints()
-    {
-        if (static::$constraints) {
-            parent::addConstraints();
-
-            $this->query->where($this->morphType, $this->morphClass);
-        }
-    }
-
-    /**
-     * Get the 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->morphType, $this->morphClass);
-    }
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $entities
-     * @return void
-     */
-    public function addEagerConstraints(array $entities)
-    {
-        parent::addEagerConstraints($entities);
-
-        $this->query->where($this->morphType, $this->morphClass);
-    }
-
-    /**
-     * Get the foreign key "type" name.
-     *
-     * @return string
-     */
-    public function getMorphType()
-    {
-        return $this->morphType;
-    }
-
-    /**
-     * Get the plain morph type name without the table.
-     *
-     * @return string
-     */
-    public function getPlainMorphType()
-    {
-        return last(explode('.', $this->morphType));
-    }
-
-    /**
-     * Get the class name of the parent model.
-     *
-     * @return string
-     */
-    public function getMorphClass()
-    {
-        return $this->morphClass;
-    }
-
-    /**
-     * Get the foreign key as value pair for this relation
-     *
-     * @return array
-     */
-    public function getForeignKeyValuePair()
-    {
-        return [
-            $this->getPlainForeignKey() => $this->getParentKey(),
-            $this->getPlainMorphType() => $this->morphClass,
-        ];
-    }
+	/**
+	 * The foreign key type for the relationship.
+	 *
+	 * @var string
+	 */
+	protected $morphType;
+
+	/**
+	 * The class name of the parent model.
+	 *
+	 * @var string
+	 */
+	protected $morphClass;
+
+	/**
+	 * Create a new has many relationship instance.
+	 *
+	 * @param  Mapper                 $mapper
+	 * @param  \Analogue\ORM\Mappable $parent
+	 * @param  string                 $type
+	 * @param  string                 $id
+	 * @param  string                 $localKey
+	 * @throws \Analogue\ORM\Exceptions\MappingException
+	 */
+	public function __construct(Mapper $mapper, $parent, $type, $id, $localKey)
+	{
+		$this->morphType = $type;
+		$this->morphClass = $mapper->getManager()->getMapper($parent)->getEntityMap()->getMorphClass();
+
+		parent::__construct($mapper, $parent, $id, $localKey);
+	}
+
+	/**
+	 * Set the base constraints on the relation query.
+	 *
+	 * @return void
+	 */
+	public function addConstraints()
+	{
+		if (static::$constraints) {
+			parent::addConstraints();
+
+			$this->query->where($this->morphType, $this->morphClass);
+		}
+	}
+
+	/**
+	 * Get the 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->morphType, $this->morphClass);
+	}
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $entities
+	 * @return void
+	 */
+	public function addEagerConstraints(array $entities)
+	{
+		parent::addEagerConstraints($entities);
+
+		$this->query->where($this->morphType, $this->morphClass);
+	}
+
+	/**
+	 * Get the foreign key "type" name.
+	 *
+	 * @return string
+	 */
+	public function getMorphType()
+	{
+		return $this->morphType;
+	}
+
+	/**
+	 * Get the plain morph type name without the table.
+	 *
+	 * @return string
+	 */
+	public function getPlainMorphType()
+	{
+		return last(explode('.', $this->morphType));
+	}
+
+	/**
+	 * Get the class name of the parent model.
+	 *
+	 * @return string
+	 */
+	public function getMorphClass()
+	{
+		return $this->morphClass;
+	}
+
+	/**
+	 * Get the foreign key as value pair for this relation
+	 *
+	 * @return array
+	 */
+	public function getForeignKeyValuePair()
+	{
+		return [
+			$this->getPlainForeignKey() => $this->getParentKey(),
+			$this->getPlainMorphType() => $this->morphClass,
+		];
+	}
 }

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 $entities
-     * @return void
-     */
-    public function addEagerConstraints(array $entities)
-    {
-        parent::addEagerConstraints($entities);
-
-        $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 $entities
+	 * @return void
+	 */
+	public function addEagerConstraints(array $entities)
+	{
+		parent::addEagerConstraints($entities);
+
+		$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;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -48,7 +48,7 @@ 
     {
         $this->inverse = $inverse;
         
-        $this->morphType = $name . '_type';
+        $this->morphType = $name.'_type';
 
         $this->morphClass = $inverse ? $mapper->getEntityMap()->getClass() : get_class($parent);
 
@@ -64,7 +64,7 @@ 
     {
         parent::setWhere();
 
-        $this->query->where($this->table . '.' . $this->morphType, $this->morphClass);
+        $this->query->where($this->table.'.'.$this->morphType, $this->morphClass);
 
         return $this;
     }
@@ -80,7 +80,7 @@ 
     {
         $query = parent::getRelationCountQuery($query, $parent);
 
-        return $query->where($this->table . '.' . $this->morphType, $this->morphClass);
+        return $query->where($this->table.'.'.$this->morphType, $this->morphClass);
     }
 
     /**
@@ -93,7 +93,7 @@ 
     {
         parent::addEagerConstraints($entities);
 
-        $this->query->where($this->table . '.' . $this->morphType, $this->morphClass);
+        $this->query->where($this->table.'.'.$this->morphType, $this->morphClass);
     }
 
     /**

src/Relationships/HasOneOrMany.php

Spacing +1 added lines, -1 removed lines

@@ -312,7 +312,7 @@
      */
     public function getQualifiedParentKeyName()
     {
-        return $this->parentMap->getTable() . '.' . $this->localKey;
+        return $this->parentMap->getTable().'.'.$this->localKey;
     }
 
     /**

Indentation +292 added lines, -292 removed lines

@@ -7,296 +7,296 @@
 
 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 $entities
-     * @return void
-     */
-    public function addEagerConstraints(array $entities)
-    {
-        $this->query->whereIn($this->foreignKey, $this->getKeys($entities, $this->localKey));
-    }
-
-    /**
-     * Match the eagerly loaded results to their single parents.
-     *
-     * @param  array            $entities
-     * @param  EntityCollection $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function matchOne(array $entities, EntityCollection $results, $relation)
-    {
-        return $this->matchOneOrMany($entities, $results, $relation, 'one');
-    }
-
-    /**
-     * Match the eagerly loaded results to their many parents.
-     *
-     * @param  array            $entities
-     * @param  EntityCollection $results
-     * @param  string           $relation
-     * @return array
-     */
-    public function matchMany(array $entities, EntityCollection $results, $relation)
-    {
-        return $this->matchOneOrMany($entities, $results, $relation, 'many');
-    }
-
-    /**
-     * Match the eagerly loaded results to their many parents.
-     *
-     * @param  array            $entities
-     * @param  EntityCollection $results
-     * @param  string           $relation
-     * @param  string           $type
-     * @return array
-     */
-    protected function matchOneOrMany(array $entities, EntityCollection $results, $relation, $type)
-    {
-        $dictionary = $this->buildDictionary($results);
-
-        $cache = $this->parentMapper->getEntityCache();
-
-        // 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.
-        foreach ($entities as $entity) {
-            $entity = $this->factory->make($entity);
-
-            $key = $entity->getEntityAttribute($this->localKey);
-
-            if (isset($dictionary[$key])) {
-                $value = $this->getRelationValue($dictionary, $key, $type);
-
-                $entity->setEntityAttribute($relation, $value);
-
-                $cache->cacheLoadedRelationResult($entity, $relation, $value, $this);
-            }
-        }
-
-        return $entities;
-    }
-
-    /**
-     * 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()];
-    }
+	/**
+	 * 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 $entities
+	 * @return void
+	 */
+	public function addEagerConstraints(array $entities)
+	{
+		$this->query->whereIn($this->foreignKey, $this->getKeys($entities, $this->localKey));
+	}
+
+	/**
+	 * Match the eagerly loaded results to their single parents.
+	 *
+	 * @param  array            $entities
+	 * @param  EntityCollection $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function matchOne(array $entities, EntityCollection $results, $relation)
+	{
+		return $this->matchOneOrMany($entities, $results, $relation, 'one');
+	}
+
+	/**
+	 * Match the eagerly loaded results to their many parents.
+	 *
+	 * @param  array            $entities
+	 * @param  EntityCollection $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	public function matchMany(array $entities, EntityCollection $results, $relation)
+	{
+		return $this->matchOneOrMany($entities, $results, $relation, 'many');
+	}
+
+	/**
+	 * Match the eagerly loaded results to their many parents.
+	 *
+	 * @param  array            $entities
+	 * @param  EntityCollection $results
+	 * @param  string           $relation
+	 * @param  string           $type
+	 * @return array
+	 */
+	protected function matchOneOrMany(array $entities, EntityCollection $results, $relation, $type)
+	{
+		$dictionary = $this->buildDictionary($results);
+
+		$cache = $this->parentMapper->getEntityCache();
+
+		// 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.
+		foreach ($entities as $entity) {
+			$entity = $this->factory->make($entity);
+
+			$key = $entity->getEntityAttribute($this->localKey);
+
+			if (isset($dictionary[$key])) {
+				$value = $this->getRelationValue($dictionary, $key, $type);
+
+				$entity->setEntityAttribute($relation, $value);
+
+				$cache->cacheLoadedRelationResult($entity, $relation, $value, $this);
+			}
+		}
+
+		return $entities;
+	}
+
+	/**
+	 * 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()];
+	}
 }

src/Relationships/Pivot.php

Indentation +157 added lines, -157 removed lines

@@ -6,161 +6,161 @@
 
 class Pivot extends Entity
 {
-    /**
-     * @var bool
-     */
-    protected $exists;
-
-    /**
-     * Pivot's table
-     *
-     * @var string
-     */
-    protected $table;
-
-    /**
-     * The parent entity of the relationship.
-     *
-     * @var object
-     */
-    protected $parent;
-
-    /**
-     * The parent entity of the relationship.
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $parentMap;
-
-    /**
-     * We may define a pivot mapping to deal with
-     * soft deletes, timestamps, etc.
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $pivotMap;
-
-    /**
-     * The name of the foreign key column.
-     *
-     * @var string
-     */
-    protected $foreignKey;
-
-    /**
-     * The name of the "other key" column.
-     *
-     * @var string
-     */
-    protected $otherKey;
-
-    /**
-     * The attributes that aren't mass assignable.
-     *
-     * @var array
-     */
-    protected $guarded = [];
-
-    /**
-     * Pivot uses timestamps ?
-     *
-     * @var boolean
-     */
-    protected $timestamps;
-
-    /**
-     * Create a new pivot model instance.
-     *
-     * @param \Analogue\ORM\System\InternallyMappable $parent
-     * @param \Analogue\ORM\EntityMap                 $parentMap
-     * @param array                                   $attributes
-     * @param string                                  $table
-     * @param bool                                    $exists
-     */
-    public function __construct($parent, $parentMap, $attributes, $table, $exists = false)
-    {
-        // The pivot model is a "dynamic" model since we will set the tables dynamically
-        // for the instance. This allows it work for any intermediate tables for the
-        // many to many relationship that are defined by this developer's classes.
-        $this->setEntityAttributes($attributes, true);
-
-        $this->table = $table;
-
-        // We store off the parent instance so we will access the timestamp column names
-        // for the model, since the pivot model timestamps aren't easily configurable
-        // from the developer's point of view. We can use the parents to get these.
-        $this->parent = $parent;
-
-        $this->parentMap = $parentMap;
-
-        $this->exists = $exists;
-
-        $this->timestamps = $this->hasTimestampAttributes();
-    }
-
-    /**
-     * Get the foreign key column name.
-     *
-     * @return string
-     */
-    public function getForeignKey()
-    {
-        return $this->foreignKey;
-    }
-
-    /**
-     * Get the "other key" column name.
-     *
-     * @return string
-     */
-    public function getOtherKey()
-    {
-        return $this->otherKey;
-    }
-
-    /**
-     * Set the key names for the pivot model instance.
-     *
-     * @param  string $foreignKey
-     * @param  string $otherKey
-     * @return $this
-     */
-    public function setPivotKeys($foreignKey, $otherKey)
-    {
-        $this->foreignKey = $foreignKey;
-
-        $this->otherKey = $otherKey;
-
-        return $this;
-    }
-
-    /**
-     * Determine if the pivot model has timestamp attributes.
-     *
-     * @return bool
-     */
-    public function hasTimestampAttributes()
-    {
-        return array_key_exists($this->getCreatedAtColumn(), $this->attributes);
-    }
-
-    /**
-     * Get the name of the "created at" column.
-     *
-     * @return string
-     */
-    public function getCreatedAtColumn()
-    {
-        return $this->parentMap->getCreatedAtColumn();
-    }
-
-    /**
-     * Get the name of the "updated at" column.
-     *
-     * @return string
-     */
-    public function getUpdatedAtColumn()
-    {
-        return $this->parentMap->getUpdatedAtColumn();
-    }
+	/**
+	 * @var bool
+	 */
+	protected $exists;
+
+	/**
+	 * Pivot's table
+	 *
+	 * @var string
+	 */
+	protected $table;
+
+	/**
+	 * The parent entity of the relationship.
+	 *
+	 * @var object
+	 */
+	protected $parent;
+
+	/**
+	 * The parent entity of the relationship.
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $parentMap;
+
+	/**
+	 * We may define a pivot mapping to deal with
+	 * soft deletes, timestamps, etc.
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $pivotMap;
+
+	/**
+	 * The name of the foreign key column.
+	 *
+	 * @var string
+	 */
+	protected $foreignKey;
+
+	/**
+	 * The name of the "other key" column.
+	 *
+	 * @var string
+	 */
+	protected $otherKey;
+
+	/**
+	 * The attributes that aren't mass assignable.
+	 *
+	 * @var array
+	 */
+	protected $guarded = [];
+
+	/**
+	 * Pivot uses timestamps ?
+	 *
+	 * @var boolean
+	 */
+	protected $timestamps;
+
+	/**
+	 * Create a new pivot model instance.
+	 *
+	 * @param \Analogue\ORM\System\InternallyMappable $parent
+	 * @param \Analogue\ORM\EntityMap                 $parentMap
+	 * @param array                                   $attributes
+	 * @param string                                  $table
+	 * @param bool                                    $exists
+	 */
+	public function __construct($parent, $parentMap, $attributes, $table, $exists = false)
+	{
+		// The pivot model is a "dynamic" model since we will set the tables dynamically
+		// for the instance. This allows it work for any intermediate tables for the
+		// many to many relationship that are defined by this developer's classes.
+		$this->setEntityAttributes($attributes, true);
+
+		$this->table = $table;
+
+		// We store off the parent instance so we will access the timestamp column names
+		// for the model, since the pivot model timestamps aren't easily configurable
+		// from the developer's point of view. We can use the parents to get these.
+		$this->parent = $parent;
+
+		$this->parentMap = $parentMap;
+
+		$this->exists = $exists;
+
+		$this->timestamps = $this->hasTimestampAttributes();
+	}
+
+	/**
+	 * Get the foreign key column name.
+	 *
+	 * @return string
+	 */
+	public function getForeignKey()
+	{
+		return $this->foreignKey;
+	}
+
+	/**
+	 * Get the "other key" column name.
+	 *
+	 * @return string
+	 */
+	public function getOtherKey()
+	{
+		return $this->otherKey;
+	}
+
+	/**
+	 * Set the key names for the pivot model instance.
+	 *
+	 * @param  string $foreignKey
+	 * @param  string $otherKey
+	 * @return $this
+	 */
+	public function setPivotKeys($foreignKey, $otherKey)
+	{
+		$this->foreignKey = $foreignKey;
+
+		$this->otherKey = $otherKey;
+
+		return $this;
+	}
+
+	/**
+	 * Determine if the pivot model has timestamp attributes.
+	 *
+	 * @return bool
+	 */
+	public function hasTimestampAttributes()
+	{
+		return array_key_exists($this->getCreatedAtColumn(), $this->attributes);
+	}
+
+	/**
+	 * Get the name of the "created at" column.
+	 *
+	 * @return string
+	 */
+	public function getCreatedAtColumn()
+	{
+		return $this->parentMap->getCreatedAtColumn();
+	}
+
+	/**
+	 * Get the name of the "updated at" column.
+	 *
+	 * @return string
+	 */
+	public function getUpdatedAtColumn()
+	{
+		return $this->parentMap->getUpdatedAtColumn();
+	}
 }

src/Relationships/HasManyThrough.php

Spacing +6 added lines, -6 removed lines

@@ -93,7 +93,7 @@ 
             $farParentKeyName = $this->farParentMap->getKeyName();
 
             $this->query->where(
-                $parentTable . '.' . $this->firstKey,
+                $parentTable.'.'.$this->firstKey,
                 '=',
                 $this->farParent->getEntityAttribute($farParentKeyName)
             );
@@ -115,7 +115,7 @@ 
 
         $query->select(new Expression('count(*)'));
 
-        $key = $this->wrap($parentTable . '.' . $this->firstKey);
+        $key = $this->wrap($parentTable.'.'.$this->firstKey);
 
         return $query->where($this->getHasCompareKey(), '=', new Expression($key));
     }
@@ -130,7 +130,7 @@ 
     {
         $query = $query ?: $this->query;
 
-        $foreignKey = $this->relatedMap->getTable() . '.' . $this->secondKey;
+        $foreignKey = $this->relatedMap->getTable().'.'.$this->secondKey;
 
         $query->join($this->parentMap->getTable(), $this->getQualifiedParentKeyName(), '=', $foreignKey);
     }
@@ -145,7 +145,7 @@ 
     {
         $table = $this->parentMap->getTable();
 
-        $this->query->whereIn($table . '.' . $this->firstKey, $this->getKeys($entities));
+        $this->query->whereIn($table.'.'.$this->firstKey, $this->getKeys($entities));
     }
 
     /**
@@ -269,10 +269,10 @@ 
     protected function getSelectColumns(array $columns = ['*'])
     {
         if ($columns == ['*']) {
-            $columns = [$this->relatedMap->getTable() . '.*'];
+            $columns = [$this->relatedMap->getTable().'.*'];
         }
 
-        return array_merge($columns, [$this->parentMap->getTable() . '.' . $this->firstKey]);
+        return array_merge($columns, [$this->parentMap->getTable().'.'.$this->firstKey]);
     }
 
     /**

Doc Comments -1 removed lines

@@ -313,7 +313,6 @@
      * Run synchronization content if needed by the
      * relation type.
      *
-     * @param  array $actualContent
      * @return void
      */
     public function sync(array $entities)

Indentation +292 added lines, -292 removed lines

@@ -9,296 +9,296 @@
 
 class HasManyThrough extends Relationship
 {
-    /**
-     * The distance parent Entity instance.
-     *
-     * @var \Analogue\ORM\Entity
-     */
-    protected $farParent;
-
-    /**
-     * The far parent map instance
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $farParentMap;
-
-    /**
-     * The near key on the relationship.
-     *
-     * @var string
-     */
-    protected $firstKey;
-
-    /**
-     * The far key on the relationship.
-     *
-     * @var string
-     */
-    protected $secondKey;
-
-    /**
-     * Create a new has many relationship instance.
-     *
-     * @param Mapper                  $mapper
-     * @param \Analogue\ORM\Mappable  $farParent
-     * @param \Analogue\ORM\EntityMap $parentMap
-     * @param string                  $firstKey
-     * @param string                  $secondKey
-     * @throws \Analogue\ORM\Exceptions\MappingException
-     */
-    public function __construct(Mapper $mapper, $farParent, $parentMap, $firstKey, $secondKey)
-    {
-        $this->firstKey = $firstKey;
-        $this->secondKey = $secondKey;
-        $this->farParent = $farParent;
-
-        $this->farParentMap = $mapper->getManager()->mapper($farParent)->getEntityMap();
-        $parentInstance = $mapper->getManager()->mapper($parentMap->getClass())->newInstance();
-
-        parent::__construct($mapper, $parentInstance);
-    }
-
-    /**
-     * Set the base constraints on the relation query.
-     *
-     * @return void
-     */
-    public function addConstraints()
-    {
-        $parentTable = $this->parentMap->getTable();
-
-        $this->setJoin();
-
-        if (static::$constraints) {
-            $farParentKeyName = $this->farParentMap->getKeyName();
-
-            $this->query->where(
-                $parentTable . '.' . $this->firstKey,
-                '=',
-                $this->farParent->getEntityAttribute($farParentKeyName)
-            );
-        }
-    }
-
-    /**
-     * Add the constraints for a relationship count query.
-     *
-     * @param  Query $query
-     * @param  Query $parent
-     * @return Query
-     */
-    public function getRelationCountQuery(Query $query, Query $parent)
-    {
-        $parentTable = $this->parentMap->getTable();
-
-        $this->setJoin($query);
-
-        $query->select(new Expression('count(*)'));
-
-        $key = $this->wrap($parentTable . '.' . $this->firstKey);
-
-        return $query->where($this->getHasCompareKey(), '=', new Expression($key));
-    }
-
-    /**
-     * Set the join clause on the query.
-     *
-     * @param  null|Query $query
-     * @return void
-     */
-    protected function setJoin(Query $query = null)
-    {
-        $query = $query ?: $this->query;
-
-        $foreignKey = $this->relatedMap->getTable() . '.' . $this->secondKey;
-
-        $query->join($this->parentMap->getTable(), $this->getQualifiedParentKeyName(), '=', $foreignKey);
-    }
-
-    /**
-     * Set the constraints for an eager load of the relation.
-     *
-     * @param  array $entities
-     * @return void
-     */
-    public function addEagerConstraints(array $entities)
-    {
-        $table = $this->parentMap->getTable();
-
-        $this->query->whereIn($table . '.' . $this->firstKey, $this->getKeys($entities));
-    }
-
-    /**
-     * Initialize the relation on a set of entities.
-     *
-     * @param  \Analogue\ORM\Entity[] $entities
-     * @param  string                 $relation
-     * @return \Analogue\ORM\Entity[]
-     */
-    public function initRelation(array $entities, $relation)
-    {
-        foreach ($entities as $entity) {
-            $entity->setEntityAttribute($relation, $this->relatedMap->newCollection());
-        }
-
-        return $entities;
-    }
-
-    /**
-     * Match the eagerly loaded results to their parents.
-     *
-     * @param  \Analogue\ORM\Entity[] $entities
-     * @param  EntityCollection       $results
-     * @param  string                 $relation
-     * @return \Analogue\ORM\Entity[]
-     */
-    public function match(array $entities, EntityCollection $results, $relation)
-    {
-        $dictionary = $this->buildDictionary($results);
-
-        $relatedKey = $this->relatedMap->getKeyName();
-
-        $cache = $this->parentMapper->getEntityCache();
-
-        // Once we have the dictionary we can simply spin through the parent entities 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.
-        foreach ($entities as $entity) {
-            $key = $entity->getEntityAttribute($relatedKey);
-
-            if (isset($dictionary[$key])) {
-                $value = $this->relatedMap->newCollection($dictionary[$key]);
-
-                $entity->setEntityAttribute($relation, $value);
-
-                $cache->cacheLoadedRelationResult($entity, $relation, $value, $this);
-            }
-        }
-
-        return $entities;
-    }
-
-    /**
-     * Build model dictionary keyed by the relation's foreign key.
-     *
-     * @param  EntityCollection $results
-     * @return array
-     */
-    protected function buildDictionary(EntityCollection $results)
-    {
-        $dictionary = [];
-
-        $foreign = $this->firstKey;
-
-        // First we will create a dictionary of entities keyed by the foreign key of the
-        // relationship as this will allow us to quickly access all of the related
-        // entities without having to do nested looping which will be quite slow.
-        foreach ($results as $result) {
-            $dictionary[$result->{$foreign}][] = $result;
-        }
-
-        return $dictionary;
-    }
-
-    /**
-     * Get the results of the relationship.
-     *
-     * @param  $relation
-     * @return EntityCollection
-     */
-    public function getResults($relation)
-    {
-        $results = $this->query->get();
-
-        $this->cacheRelation($results, $relation);
-
-        return $results;
-    }
-
-    /**
-     * Execute the query as a "select" statement.
-     *
-     * @param  array $columns
-     * @return 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
-        // entities with the result of those columns as a separate model relation.
-        $select = $this->getSelectColumns($columns);
-
-        $entities = $this->query->addSelect($select)->getEntities();
-
-        // If we actually found entities we will also eager load any relationships that
-        // have been specified as needing to be eager loaded. This will solve the
-        // n + 1 query problem for the developer and also increase performance.
-        if (count($entities) > 0) {
-            $entities = $this->query->eagerLoadRelations($entities);
-        }
-
-        return $this->relatedMap->newCollection($entities);
-    }
-
-    /**
-     * Set the select clause for the relation query.
-     *
-     * @param  array $columns
-     * @return BelongsToMany
-     */
-    protected function getSelectColumns(array $columns = ['*'])
-    {
-        if ($columns == ['*']) {
-            $columns = [$this->relatedMap->getTable() . '.*'];
-        }
-
-        return array_merge($columns, [$this->parentMap->getTable() . '.' . $this->firstKey]);
-    }
-
-    /**
-     * Get a paginator for the "select" statement.
-     *
-     * @param  int   $perPage
-     * @param  array $columns
-     * @return \Illuminate\Pagination\LengthAwarePaginator
-     */
-    public function paginate($perPage = null, $columns = ['*'])
-    {
-        $this->query->addSelect($this->getSelectColumns($columns));
-
-        return $this->query->paginate($perPage, $columns);
-    }
-
-    /**
-     * Get the key name of the parent model.
-     *
-     * @return string
-     */
-    protected function getQualifiedParentKeyName()
-    {
-        return $this->parentMap->getQualifiedKeyName();
-    }
-
-    /**
-     * Get the key for comparing against the parent key in "has" query.
-     *
-     * @return string
-     */
-    public function getHasCompareKey()
-    {
-        return $this->farParentMap->getQualifiedKeyName();
-    }
-
-    /**
-     * Run synchronization content if needed by the
-     * relation type.
-     *
-     * @param  array $actualContent
-     * @return void
-     */
-    public function sync(array $entities)
-    {
-        // N/A
-    }
+	/**
+	 * The distance parent Entity instance.
+	 *
+	 * @var \Analogue\ORM\Entity
+	 */
+	protected $farParent;
+
+	/**
+	 * The far parent map instance
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $farParentMap;
+
+	/**
+	 * The near key on the relationship.
+	 *
+	 * @var string
+	 */
+	protected $firstKey;
+
+	/**
+	 * The far key on the relationship.
+	 *
+	 * @var string
+	 */
+	protected $secondKey;
+
+	/**
+	 * Create a new has many relationship instance.
+	 *
+	 * @param Mapper                  $mapper
+	 * @param \Analogue\ORM\Mappable  $farParent
+	 * @param \Analogue\ORM\EntityMap $parentMap
+	 * @param string                  $firstKey
+	 * @param string                  $secondKey
+	 * @throws \Analogue\ORM\Exceptions\MappingException
+	 */
+	public function __construct(Mapper $mapper, $farParent, $parentMap, $firstKey, $secondKey)
+	{
+		$this->firstKey = $firstKey;
+		$this->secondKey = $secondKey;
+		$this->farParent = $farParent;
+
+		$this->farParentMap = $mapper->getManager()->mapper($farParent)->getEntityMap();
+		$parentInstance = $mapper->getManager()->mapper($parentMap->getClass())->newInstance();
+
+		parent::__construct($mapper, $parentInstance);
+	}
+
+	/**
+	 * Set the base constraints on the relation query.
+	 *
+	 * @return void
+	 */
+	public function addConstraints()
+	{
+		$parentTable = $this->parentMap->getTable();
+
+		$this->setJoin();
+
+		if (static::$constraints) {
+			$farParentKeyName = $this->farParentMap->getKeyName();
+
+			$this->query->where(
+				$parentTable . '.' . $this->firstKey,
+				'=',
+				$this->farParent->getEntityAttribute($farParentKeyName)
+			);
+		}
+	}
+
+	/**
+	 * Add the constraints for a relationship count query.
+	 *
+	 * @param  Query $query
+	 * @param  Query $parent
+	 * @return Query
+	 */
+	public function getRelationCountQuery(Query $query, Query $parent)
+	{
+		$parentTable = $this->parentMap->getTable();
+
+		$this->setJoin($query);
+
+		$query->select(new Expression('count(*)'));
+
+		$key = $this->wrap($parentTable . '.' . $this->firstKey);
+
+		return $query->where($this->getHasCompareKey(), '=', new Expression($key));
+	}
+
+	/**
+	 * Set the join clause on the query.
+	 *
+	 * @param  null|Query $query
+	 * @return void
+	 */
+	protected function setJoin(Query $query = null)
+	{
+		$query = $query ?: $this->query;
+
+		$foreignKey = $this->relatedMap->getTable() . '.' . $this->secondKey;
+
+		$query->join($this->parentMap->getTable(), $this->getQualifiedParentKeyName(), '=', $foreignKey);
+	}
+
+	/**
+	 * Set the constraints for an eager load of the relation.
+	 *
+	 * @param  array $entities
+	 * @return void
+	 */
+	public function addEagerConstraints(array $entities)
+	{
+		$table = $this->parentMap->getTable();
+
+		$this->query->whereIn($table . '.' . $this->firstKey, $this->getKeys($entities));
+	}
+
+	/**
+	 * Initialize the relation on a set of entities.
+	 *
+	 * @param  \Analogue\ORM\Entity[] $entities
+	 * @param  string                 $relation
+	 * @return \Analogue\ORM\Entity[]
+	 */
+	public function initRelation(array $entities, $relation)
+	{
+		foreach ($entities as $entity) {
+			$entity->setEntityAttribute($relation, $this->relatedMap->newCollection());
+		}
+
+		return $entities;
+	}
+
+	/**
+	 * Match the eagerly loaded results to their parents.
+	 *
+	 * @param  \Analogue\ORM\Entity[] $entities
+	 * @param  EntityCollection       $results
+	 * @param  string                 $relation
+	 * @return \Analogue\ORM\Entity[]
+	 */
+	public function match(array $entities, EntityCollection $results, $relation)
+	{
+		$dictionary = $this->buildDictionary($results);
+
+		$relatedKey = $this->relatedMap->getKeyName();
+
+		$cache = $this->parentMapper->getEntityCache();
+
+		// Once we have the dictionary we can simply spin through the parent entities 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.
+		foreach ($entities as $entity) {
+			$key = $entity->getEntityAttribute($relatedKey);
+
+			if (isset($dictionary[$key])) {
+				$value = $this->relatedMap->newCollection($dictionary[$key]);
+
+				$entity->setEntityAttribute($relation, $value);
+
+				$cache->cacheLoadedRelationResult($entity, $relation, $value, $this);
+			}
+		}
+
+		return $entities;
+	}
+
+	/**
+	 * Build model dictionary keyed by the relation's foreign key.
+	 *
+	 * @param  EntityCollection $results
+	 * @return array
+	 */
+	protected function buildDictionary(EntityCollection $results)
+	{
+		$dictionary = [];
+
+		$foreign = $this->firstKey;
+
+		// First we will create a dictionary of entities keyed by the foreign key of the
+		// relationship as this will allow us to quickly access all of the related
+		// entities without having to do nested looping which will be quite slow.
+		foreach ($results as $result) {
+			$dictionary[$result->{$foreign}][] = $result;
+		}
+
+		return $dictionary;
+	}
+
+	/**
+	 * Get the results of the relationship.
+	 *
+	 * @param  $relation
+	 * @return EntityCollection
+	 */
+	public function getResults($relation)
+	{
+		$results = $this->query->get();
+
+		$this->cacheRelation($results, $relation);
+
+		return $results;
+	}
+
+	/**
+	 * Execute the query as a "select" statement.
+	 *
+	 * @param  array $columns
+	 * @return 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
+		// entities with the result of those columns as a separate model relation.
+		$select = $this->getSelectColumns($columns);
+
+		$entities = $this->query->addSelect($select)->getEntities();
+
+		// If we actually found entities we will also eager load any relationships that
+		// have been specified as needing to be eager loaded. This will solve the
+		// n + 1 query problem for the developer and also increase performance.
+		if (count($entities) > 0) {
+			$entities = $this->query->eagerLoadRelations($entities);
+		}
+
+		return $this->relatedMap->newCollection($entities);
+	}
+
+	/**
+	 * Set the select clause for the relation query.
+	 *
+	 * @param  array $columns
+	 * @return BelongsToMany
+	 */
+	protected function getSelectColumns(array $columns = ['*'])
+	{
+		if ($columns == ['*']) {
+			$columns = [$this->relatedMap->getTable() . '.*'];
+		}
+
+		return array_merge($columns, [$this->parentMap->getTable() . '.' . $this->firstKey]);
+	}
+
+	/**
+	 * Get a paginator for the "select" statement.
+	 *
+	 * @param  int   $perPage
+	 * @param  array $columns
+	 * @return \Illuminate\Pagination\LengthAwarePaginator
+	 */
+	public function paginate($perPage = null, $columns = ['*'])
+	{
+		$this->query->addSelect($this->getSelectColumns($columns));
+
+		return $this->query->paginate($perPage, $columns);
+	}
+
+	/**
+	 * Get the key name of the parent model.
+	 *
+	 * @return string
+	 */
+	protected function getQualifiedParentKeyName()
+	{
+		return $this->parentMap->getQualifiedKeyName();
+	}
+
+	/**
+	 * Get the key for comparing against the parent key in "has" query.
+	 *
+	 * @return string
+	 */
+	public function getHasCompareKey()
+	{
+		return $this->farParentMap->getQualifiedKeyName();
+	}
+
+	/**
+	 * Run synchronization content if needed by the
+	 * relation type.
+	 *
+	 * @param  array $actualContent
+	 * @return void
+	 */
+	public function sync(array $entities)
+	{
+		// N/A
+	}
 }

src/Relationships/Relationship.php

Spacing +2 added lines, -2 removed lines

@@ -257,7 +257,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);
             }
@@ -416,7 +416,7 @@ 
 
         $keyName = Mapper::getMapper($class)->getEntityMap()->getKeyName();
 
-        return $class . '.' . $entity->getEntityAttribute($keyName);
+        return $class.'.'.$entity->getEntityAttribute($keyName);
     }
 
     /**

Indentation +424 added lines, -424 removed lines

@@ -19,429 +19,429 @@
  */
 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  Mappable $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 = $this->query->getEntityInstance();
-
-        $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 $models
-     * @return void
-     */
-    abstract public function addEagerConstraints(array $models);
-
-    /**
-     * Initialize the relation on a set of models.
-     *
-     * @param  array  $models
-     * @param  string $relation
-     * @return array
-     */
-    abstract public function initRelation(array $models, $relation);
-
-    /**
-     * Match the eagerly loaded results to their parents.
-     *
-     * @param  array            $entities
-     * @param  EntityCollection $results
-     * @param  string           $relation
-     * @return array
-     */
-    abstract public function match(array $entities, EntityCollection $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 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, $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  Mappable $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 = $this->query->getEntityInstance();
+
+		$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 $models
+	 * @return void
+	 */
+	abstract public function addEagerConstraints(array $models);
+
+	/**
+	 * Initialize the relation on a set of models.
+	 *
+	 * @param  array  $models
+	 * @param  string $relation
+	 * @return array
+	 */
+	abstract public function initRelation(array $models, $relation);
+
+	/**
+	 * Match the eagerly loaded results to their parents.
+	 *
+	 * @param  array            $entities
+	 * @param  EntityCollection $results
+	 * @param  string           $relation
+	 * @return array
+	 */
+	abstract public function match(array $entities, EntityCollection $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 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, $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;
+	}
 }

src/Commands/Delete.php

Indentation +29 added lines, -29 removed lines

@@ -6,38 +6,38 @@
 
 class Delete extends Command
 {
-    /**
-     * Execute the Delete Statement
-     *
-     * @throws MappingException
-     * @throws \InvalidArgumentException
-     * @return false|void
-     */
-    public function execute()
-    {
-        $aggregate = $this->aggregate;
-
-        $entity = $aggregate->getEntityObject();
-
-        $mapper = $aggregate->getMapper();
-
-        if ($mapper->fireEvent('deleting', $entity) === false) {
-            return false;
-        }
-
-        $keyName = $aggregate->getEntityMap()->getKeyName();
+	/**
+	 * Execute the Delete Statement
+	 *
+	 * @throws MappingException
+	 * @throws \InvalidArgumentException
+	 * @return false|void
+	 */
+	public function execute()
+	{
+		$aggregate = $this->aggregate;
+
+		$entity = $aggregate->getEntityObject();
+
+		$mapper = $aggregate->getMapper();
+
+		if ($mapper->fireEvent('deleting', $entity) === false) {
+			return false;
+		}
+
+		$keyName = $aggregate->getEntityMap()->getKeyName();
         
-        $id = $this->aggregate->getEntityId();
+		$id = $this->aggregate->getEntityId();
 
-        if (is_null($id)) {
-            throw new MappingException('Executed a delete command on an entity with "null" as primary key');
-        }
+		if (is_null($id)) {
+			throw new MappingException('Executed a delete command on an entity with "null" as primary key');
+		}
 
-        $this->query->where($keyName, '=', $id)->delete();
+		$this->query->where($keyName, '=', $id)->delete();
 
-        $mapper->fireEvent('deleted', $entity, false);
+		$mapper->fireEvent('deleted', $entity, false);
 
-        // Once the Entity is successfully deleted, we'll just set the primary key to null.
-        $aggregate->setEntityAttribute($keyName, null);
-    }
+		// Once the Entity is successfully deleted, we'll just set the primary key to null.
+		$aggregate->setEntityAttribute($keyName, null);
+	}
 }

src/Plugins/SoftDeletes/Restore.php

Indentation +25 added lines, -25 removed lines

@@ -6,36 +6,36 @@
 
 class Restore extends Command
 {
-    /**
-     * @throws \InvalidArgumentException
-     *
-     * @return false|mixed
-     */
-    public function execute()
-    {
-        $aggregate = $this->aggregate;
-        $entity = $aggregate->getEntityObject();
-        $mapper = $aggregate->getMapper();
-        $entityMap = $mapper->getEntityMap();
-
-        if ($mapper->fireEvent('restoring', $entity) === false) {
-            return false;
-        }
-
-        $keyName = $entityMap->getKeyName();
+	/**
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return false|mixed
+	 */
+	public function execute()
+	{
+		$aggregate = $this->aggregate;
+		$entity = $aggregate->getEntityObject();
+		$mapper = $aggregate->getMapper();
+		$entityMap = $mapper->getEntityMap();
+
+		if ($mapper->fireEvent('restoring', $entity) === false) {
+			return false;
+		}
+
+		$keyName = $entityMap->getKeyName();
         
-        $query = $this->query->where($keyName, '=', $aggregate->getEntityAttribute($keyName));
+		$query = $this->query->where($keyName, '=', $aggregate->getEntityAttribute($keyName));
 
-        $deletedAtColumn = $entityMap->getQualifiedDeletedAtColumn();
+		$deletedAtColumn = $entityMap->getQualifiedDeletedAtColumn();
 
-        $query->update([$deletedAtColumn => null]);
+		$query->update([$deletedAtColumn => null]);
         
-        $aggregate->setEntityAttribute($deletedAtColumn, null);
+		$aggregate->setEntityAttribute($deletedAtColumn, null);
         
-        $mapper->fireEvent('restored', $entity, false);
+		$mapper->fireEvent('restored', $entity, false);
 
-        $mapper->getEntityCache()->refresh($aggregate);
+		$mapper->getEntityCache()->refresh($aggregate);
 
-        return $entity;
-    }
+		return $entity;
+	}
 }

src/Plugins/SoftDeletes/SoftDeletesPlugin.php

Indentation +66 added lines, -66 removed lines

@@ -13,80 +13,80 @@
  */
 class SoftDeletesPlugin extends AnaloguePlugin
 {
-    /**
-     * Register the plugin
-     *
-     * @throws \Exception
-     * @return void
-     */
-    public function register()
-    {
-        $host = $this;
-
-        // Hook any mapper init and check the mapping include soft deletes.
-        $this->manager->registerGlobalEvent('initialized', function (Mapper $mapper) use ($host) {
-            $entityMap = $mapper->getEntityMap();
-
-            if ($entityMap->usesSoftDeletes()) {
-                $host->registerSoftDelete($mapper);
-            }
-
-        });
-    }
-
-    /**
-     * By hooking to the mapper initialization event, we can extend it
-     * with the softDelete capacity.
-     *
-     * @param  \Analogue\ORM\System\Mapper $mapper
-     * @throws \Analogue\ORM\Exceptions\MappingException
-     * @return bool|void
-     */
-    protected function registerSoftDelete(Mapper $mapper)
-    {
-        $entityMap = $mapper->getEntityMap();
-
-        // Add Scopes
-        $mapper->addGlobalScope(new SoftDeletingScope);
-
-        $host = $this;
-
-        // Register 'deleting' events
-        $mapper->registerEvent('deleting', function ($entity) use ($entityMap, $host) {
+	/**
+	 * Register the plugin
+	 *
+	 * @throws \Exception
+	 * @return void
+	 */
+	public function register()
+	{
+		$host = $this;
+
+		// Hook any mapper init and check the mapping include soft deletes.
+		$this->manager->registerGlobalEvent('initialized', function (Mapper $mapper) use ($host) {
+			$entityMap = $mapper->getEntityMap();
+
+			if ($entityMap->usesSoftDeletes()) {
+				$host->registerSoftDelete($mapper);
+			}
+
+		});
+	}
+
+	/**
+	 * By hooking to the mapper initialization event, we can extend it
+	 * with the softDelete capacity.
+	 *
+	 * @param  \Analogue\ORM\System\Mapper $mapper
+	 * @throws \Analogue\ORM\Exceptions\MappingException
+	 * @return bool|void
+	 */
+	protected function registerSoftDelete(Mapper $mapper)
+	{
+		$entityMap = $mapper->getEntityMap();
+
+		// Add Scopes
+		$mapper->addGlobalScope(new SoftDeletingScope);
+
+		$host = $this;
+
+		// Register 'deleting' events
+		$mapper->registerEvent('deleting', function ($entity) use ($entityMap, $host) {
             
-            // Convert Entity into an EntityWrapper
-            $factory = new Factory;
+			// Convert Entity into an EntityWrapper
+			$factory = new Factory;
 
-            $wrappedEntity = $factory->make($entity);
+			$wrappedEntity = $factory->make($entity);
 
-            $deletedAtField = $entityMap->getQualifiedDeletedAtColumn();
+			$deletedAtField = $entityMap->getQualifiedDeletedAtColumn();
 
-            if (!is_null($wrappedEntity->getEntityAttribute($deletedAtField))) {
-                return true;
-            } else {
-                $time = new Carbon;
+			if (!is_null($wrappedEntity->getEntityAttribute($deletedAtField))) {
+				return true;
+			} else {
+				$time = new Carbon;
 
-                $wrappedEntity->setEntityAttribute($deletedAtField, $time);
+				$wrappedEntity->setEntityAttribute($deletedAtField, $time);
 
-                $plainObject = $wrappedEntity->getObject();
-                $host->manager->mapper(get_class($plainObject))->store($plainObject);
+				$plainObject = $wrappedEntity->getObject();
+				$host->manager->mapper(get_class($plainObject))->store($plainObject);
 
-                return false;
-            }
+				return false;
+			}
 
-        });
+		});
 
-        // Register RestoreCommand
-        $mapper->addCustomCommand('Analogue\ORM\Plugins\SoftDeletes\Restore');
-    }
+		// Register RestoreCommand
+		$mapper->addCustomCommand('Analogue\ORM\Plugins\SoftDeletes\Restore');
+	}
 
-    /**
-     * Get custom events provided by the plugin
-     *
-     * @return string[]
-     */
-    public function getCustomEvents()
-    {
-        return ['restoring', 'restored'];
-    }
+	/**
+	 * Get custom events provided by the plugin
+	 *
+	 * @return string[]
+	 */
+	public function getCustomEvents()
+	{
+		return ['restoring', 'restored'];
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
         $host = $this;
 
         // Hook any mapper init and check the mapping include soft deletes.
-        $this->manager->registerGlobalEvent('initialized', function (Mapper $mapper) use ($host) {
+        $this->manager->registerGlobalEvent('initialized', function(Mapper $mapper) use ($host) {
             $entityMap = $mapper->getEntityMap();
 
             if ($entityMap->usesSoftDeletes()) {
@@ -52,7 +52,7 @@ 
         $host = $this;
 
         // Register 'deleting' events
-        $mapper->registerEvent('deleting', function ($entity) use ($entityMap, $host) {
+        $mapper->registerEvent('deleting', function($entity) use ($entityMap, $host) {
             
             // Convert Entity into an EntityWrapper
             $factory = new Factory;