analogueorm / analogue

src/EntityMap.php

Doc Comments +3 added lines, -7 removed lines

@@ -928,8 +928,7 @@ 
     /**
      * Define an Embedded Object.
      *
-     * @param mixed  $entity
-     * @param string $related
+     * @param string $relatedClass
      *
      * @return EmbedsOne
      */
@@ -949,8 +948,7 @@ 
     /**
      * Define an Embedded Collection.
      *
-     * @param mixed  $entity
-     * @param string $related
+     * @param string $relatedClass
      *
      * @return EmbedsOne
      */
@@ -1056,7 +1054,6 @@ 
      * @param string      $related
      * @param string|null $foreignKey
      * @param string|null $otherKey
-     * @param string|null $relation
      *
      * @throws MappingException
      *
@@ -1261,11 +1258,10 @@ 
      * Define a many-to-many relationship.
      *
      * @param mixed       $entity
-     * @param string      $relatedClass
+     * @param string      $related
      * @param string|null $table
      * @param string|null $foreignKey
      * @param string|null $otherKey
-     * @param string|null $relation
      *
      * @throws MappingException
      *

Indentation +1553 added lines, -1553 removed lines

@@ -25,1557 +25,1557 @@
  */
 class EntityMap
 {
-    /**
-     * The mapping driver to use with this entity.
-     *
-     * @var string
-     */
-    protected $driver = 'illuminate';
-
-    /**
-     * The Database Connection name for the model.
-     *
-     * @var string
-     */
-    protected $connection;
-
-    /**
-     * The table associated with the entity.
-     *
-     * @var string|null
-     */
-    protected $table = null;
-
-    /**
-     * The primary key for the model.
-     *
-     * @var string
-     */
-    protected $primaryKey = 'id';
-
-    /**
-     * Name of the entity's array property that should
-     * contain the attributes.
-     * If set to null, analogue will only hydrate object's properties.
-     *
-     * @var string|null
-     */
-    protected $arrayName = 'attributes';
-
-    /**
-     * Array containing the list of database columns to be mapped
-     * in the attributes array of the entity.
-     *
-     * @var array
-     */
-    protected $attributes = [];
-
-    /**
-     * Array containing the list of database columns to be mapped
-     * to the entity's class properties.
-     *
-     * @var array
-     */
-    protected $properties = [];
-
-    /**
-     * The Custom Domain Class to use with this mapping.
-     *
-     * @var string|null
-     */
-    protected $class = null;
-
-    /**
-     * Embedded Value Objects.
-     *
-     * @var array
-     */
-    protected $embeddables = [];
-
-    /**
-     * Determine the relationships method used on the entity.
-     * If not set, mapper will autodetect them.
-     *
-     * @var array
-     */
-    private $relationships = [];
-
-    /**
-     * Relationships that should be treated as collection.
-     *
-     * @var array
-     */
-    private $manyRelations = [];
-
-    /**
-     * Relationships that should be treated as single entity.
-     *
-     * @var array
-     */
-    private $singleRelations = [];
-
-    /**
-     * Relationships for which the key is stored in the Entity itself.
-     *
-     * @var array
-     */
-    private $localRelations = [];
-
-    /**
-     * List of local keys associated to local relation methods.
-     *
-     * @var array
-     */
-    private $localForeignKeys = [];
-
-    /**
-     * Relationships for which the key is stored in the Related Entity.
-     *
-     * @var array
-     */
-    private $foreignRelations = [];
-
-    /**
-     * Relationships which use a pivot record.
-     *
-     * @var array
-     */
-    private $pivotRelations = [];
-
-    /**
-     * Polymorphic relationships.
-     *
-     * @var array
-     */
-    private $polymorphicRelations = [];
-
-    /**
-     * Dynamic relationships.
-     *
-     * @var array
-     */
-    private $dynamicRelationships = [];
-
-    /**
-     * Targetted class for the relationship method. value is set to `null` for
-     * polymorphic relations.
-     *
-     * @var array
-     */
-    private $relatedClasses = [];
-
-    /**
-     * Some relation methods like embedded objects, or HasOne and MorphOne,
-     * will never have a proxy loaded on them.
-     *
-     * @var array
-     */
-    private $nonProxyRelationships = [];
-
-    /**
-     * Relation methods that are embedded objects.
-     *
-     * @var array
-     */
-    private $embeddedRelations = [];
-
-    /**
-     * The number of models to return for pagination.
-     *
-     * @var int
-     */
-    protected $perPage = 15;
-
-    /**
-     * The relations to eager load on every query.
-     *
-     * @var array
-     */
-    protected $with = [];
-
-    /**
-     * The class name to be used in polymorphic relations.
-     *
-     * @var string
-     */
-    protected $morphClass;
-
-    /**
-     * Sequence name, to be used with postgreSql
-     * defaults to %table_name%_id_seq.
-     *
-     * @var string|null
-     */
-    protected $sequence = null;
-
-    /**
-     * Indicates if the entity should be timestamped.
-     *
-     * @var bool
-     */
-    public $timestamps = false;
-
-    /**
-     * The name of the "created at" column.
-     *
-     * @var string
-     */
-    protected $createdAtColumn = 'created_at';
-
-    /**
-     * The name of the "updated at" column.
-     *
-     * @var string
-     */
-    protected $updatedAtColumn = 'updated_at';
-
-    /**
-     * Indicates if the entity uses softdeletes.
-     *
-     * @var bool
-     */
-    public $softDeletes = false;
-
-    /**
-     * The name of the "deleted at" column.
-     *
-     * @var string
-     */
-    protected $deletedAtColumn = 'deleted_at';
-
-    /**
-     * The date format to use with the current database connection.
-     *
-     * @var string
-     */
-    protected $dateFormat;
-
-    /**
-     * Set this property to true if the entity should be instantiated
-     * using the IoC Container.
-     *
-     * @var bool
-     */
-    protected $dependencyInjection = false;
-
-    /**
-     * Set the usage of inheritance, possible values are :
-     * "single_table"
-     * null.
-     *
-     * @var string | null
-     */
-    protected $inheritanceType = null;
-
-    /**
-     * Discriminator column name.
-     *
-     * @var string
-     */
-    protected $discriminatorColumn = 'type';
-
-    /**
-     * Allow using a string to define which entity type should be instantiated.
-     * If not set, analogue will uses entity's FQDN.
-     *
-     * @var array
-     */
-    protected $discriminatorColumnMap = [];
-
-    /**
-     * Return Domain class attributes, useful when mapping to a Plain PHP Object.
-     *
-     * @return array
-     */
-    public function getAttributes() : array
-    {
-        return $this->attributes;
-    }
-
-    /**
-     * Set the domain class attributes.
-     *
-     * @param array $attributeNames
-     */
-    public function setAttributes(array $attributeNames)
-    {
-        $this->attributes = $attributeNames;
-    }
-
-    /**
-     * Return true if the Entity has an 'attributes' array property.
-     *
-     * @return bool
-     */
-    public function usesAttributesArray() : bool
-    {
-        if ($this->arrayName === null) {
-            return false;
-        }
-        if ($this->attributes === null) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Return the name of the Entity's attributes property.
-     *
-     * @return string|null
-     */
-    public function getAttributesArrayName()
-    {
-        return $this->arrayName;
-    }
-
-    /**
-     * Get all the attribute names for the class, including relationships, embeddables and primary key.
-     *
-     * @return array
-     */
-    public function getCompiledAttributes() : array
-    {
-        $key = $this->getKeyName();
-
-        $embeddables = array_keys($this->getEmbeddables());
-
-        $relationships = $this->getRelationships();
-
-        $attributes = $this->getAttributes();
-
-        return array_merge([$key], $embeddables, $relationships, $attributes);
-    }
-
-    /**
-     * Set the date format to use with the current database connection.
-     *
-     * @param string $format
-     */
-    public function setDateFormat($format)
-    {
-        $this->dateFormat = $format;
-    }
-
-    /**
-     * Get the date format to use with the current database connection.
-     *
-     *  @return string
-     */
-    public function getDateFormat() : string
-    {
-        return $this->dateFormat;
-    }
-
-    /**
-     * Set the Driver for this mapping.
-     *
-     * @param string $driver
-     */
-    public function setDriver($driver)
-    {
-        $this->driver = $driver;
-    }
-
-    /**
-     * Get the Driver for this mapping.
-     *
-     * @return string
-     */
-    public function getDriver() : string
-    {
-        return $this->driver;
-    }
-
-    /**
-     * Set the db connection to use on the table.
-     *
-     * @param $connection
-     */
-    public function setConnection($connection)
-    {
-        $this->connection = $connection;
-    }
-
-    /**
-     * Get the Database connection the Entity is stored on.
-     *
-     * @return string | null
-     */
-    public function getConnection()
-    {
-        return $this->connection;
-    }
-
-    /**
-     * Get the table associated with the entity.
-     *
-     * @return string
-     */
-    public function getTable() : string
-    {
-        if (!is_null($this->table)) {
-            return $this->table;
-        }
-
-        return str_replace('\\', '', snake_case(str_plural(class_basename($this->getClass()))));
-    }
-
-    /**
-     * Set the database table name.
-     *
-     * @param string $table
-     */
-    public function setTable($table)
-    {
-        $this->table = $table;
-    }
-
-    /**
-     * Get the pgSql sequence name.
-     *
-     * @return string
-     */
-    public function getSequence()
-    {
-        if (!is_null($this->sequence)) {
-            return $this->sequence;
-        } else {
-            return $this->getTable().'_id_seq';
-        }
-    }
-
-    /**
-     * Get the custom entity class.
-     *
-     * @return string namespaced class name
-     */
-    public function getClass() : string
-    {
-        return isset($this->class) ? $this->class : null;
-    }
-
-    /**
-     * Set the custom entity class.
-     *
-     * @param string $class namespaced class name
-     */
-    public function setClass($class)
-    {
-        $this->class = $class;
-    }
-
-    /**
-     * Get the embedded Value Objects.
-     *
-     * @return array
-     */
-    public function getEmbeddables() : array
-    {
-        return $this->embeddables;
-    }
-
-    /**
-     * Return attributes that should be mapped to class properties.
-     *
-     * @return array
-     */
-    public function getProperties() : array
-    {
-        return $this->properties;
-    }
-
-    /**
-     * Return the array property in which will be mapped all attributes
-     * that are not mapped to class properties.
-     *
-     * @return string
-     */
-    public function getAttributesPropertyName() : string
-    {
-    }
-
-    /**
-     * Set the embedded Value Objects.
-     *
-     * @param array $embeddables
-     */
-    public function setEmbeddables(array $embeddables)
-    {
-        $this->embeddables = $embeddables;
-    }
-
-    /**
-     * Get the relationships to map on a custom domain
-     * class.
-     *
-     * @return array
-     */
-    public function getRelationships() : array
-    {
-        return $this->relationships;
-    }
-
-    /**
-     * Return all relationships that are not embedded objects.
-     *
-     * @return array
-     */
-    public function getNonEmbeddedRelationships() : array
-    {
-        return array_diff($this->relationships, $this->embeddedRelations);
-    }
-
-    /**
-     * Get the relationships that will not have a proxy
-     * set on them.
-     *
-     * @return array
-     */
-    public function getRelationshipsWithoutProxy() : array
-    {
-        return $this->nonProxyRelationships;
-    }
-
-    /**
-     * Relationships of the Entity type.
-     *
-     * @return array
-     */
-    public function getSingleRelationships() : array
-    {
-        return $this->singleRelations;
-    }
-
-    /**
-     * Relationships of type Collection.
-     *
-     * @return array
-     */
-    public function getManyRelationships() : array
-    {
-        return $this->manyRelations;
-    }
-
-    /**
-     * Relationships with foreign key in the mapped entity record.
-     *
-     * @return array
-     */
-    public function getLocalRelationships() : array
-    {
-        return $this->localRelations;
-    }
-
-    /**
-     * Return the local keys associated to the relationship.
-     *
-     * @param string $relation
-     *
-     * @return string | array | null
-     */
-    public function getLocalKeys($relation)
-    {
-        return isset($this->localForeignKeys[$relation]) ? $this->localForeignKeys[$relation] : null;
-    }
-
-    /**
-     * Relationships with foreign key in the related Entity record.
-     *
-     * @return array
-     */
-    public function getForeignRelationships() : array
-    {
-        return $this->foreignRelations;
-    }
-
-    /**
-     * Relationships which keys are stored in a pivot record.
-     *
-     * @return array
-     */
-    public function getPivotRelationships() : array
-    {
-        return $this->pivotRelations;
-    }
-
-    /**
-     * Return an array containing all embedded relationships.
-     *
-     * @return array
-     */
-    public function getEmbeddedRelationships() : array
-    {
-        return $this->embeddedRelations;
-    }
-
-    /**
-     * Return true if the relationship method is polymorphic.
-     *
-     * @param string $relation
-     *
-     * @return bool
-     */
-    public function isPolymorphic($relation) : bool
-    {
-        return in_array($relation, $this->polymorphicRelations);
-    }
-
-    /**
-     * Get the targetted type for a relationship. Return null if polymorphic.
-     *
-     * @param string $relation
-     *
-     * @return string | null
-     */
-    public function getTargettedClass($relation)
-    {
-        if (!array_key_exists($relation, $this->relatedClasses)) {
-            return;
-        }
-
-        return $this->relatedClasses[$relation];
-    }
-
-    /**
-     * Add a Dynamic Relationship method at runtime. This has to be done
-     * by hooking the 'initializing' event, before entityMap is initialized.
-     *
-     * @param string   $name         Relation name
-     * @param \Closure $relationship
-     *
-     * @return void
-     */
-    public function addRelationshipMethod($name, \Closure $relationship)
-    {
-        $this->dynamicRelationships[$name] = $relationship;
-    }
-
-    /**
-     * Get the dynamic relationship method names.
-     *
-     * @return array
-     */
-    public function getDynamicRelationships() : array
-    {
-        return array_keys($this->dynamicRelationships);
-    }
-
-    /**
-     * Get the relationships that have to be eager loaded
-     * on each request.
-     *
-     * @return array
-     */
-    public function getEagerloadedRelationships() : array
-    {
-        return $this->with;
-    }
-
-    /**
-     * Get the primary key attribute for the entity.
-     *
-     * @return string
-     */
-    public function getKeyName() : string
-    {
-        return $this->primaryKey;
-    }
-
-    /**
-     * Set the primary key for the entity.
-     *
-     * @param $key
-     *
-     * @return void
-     */
-    public function setKeyName($key)
-    {
-        $this->primaryKey = $key;
-    }
-
-    /**
-     * Get the table qualified key name.
-     *
-     * @return string
-     */
-    public function getQualifiedKeyName() : string
-    {
-        return $this->getTable().'.'.$this->getKeyName();
-    }
-
-    /**
-     * Get the number of models to return per page.
-     *
-     * @return int
-     */
-    public function getPerPage() : int
-    {
-        return $this->perPage;
-    }
-
-    /**
-     * Set the number of models to return per page.
-     *
-     * @param int $perPage
-     *
-     * @return void
-     */
-    public function setPerPage($perPage)
-    {
-        $this->perPage = $perPage;
-    }
-
-    /**
-     * Determine if the entity uses get.
-     *
-     * @return bool
-     */
-    public function usesTimestamps() : bool
-    {
-        return $this->timestamps;
-    }
-
-    /**
-     * Determine if the entity uses soft deletes.
-     *
-     * @return bool
-     */
-    public function usesSoftDeletes() : bool
-    {
-        return $this->softDeletes;
-    }
-
-    /**
-     * Get the 'created_at' column name.
-     *
-     * @return string
-     */
-    public function getCreatedAtColumn() : string
-    {
-        return $this->createdAtColumn;
-    }
-
-    /**
-     * Get the 'updated_at' column name.
-     *
-     * @return string
-     */
-    public function getUpdatedAtColumn() : string
-    {
-        return $this->updatedAtColumn;
-    }
-
-    /**
-     * Get the deleted_at column.
-     *
-     * @return string
-     */
-    public function getQualifiedDeletedAtColumn() : string
-    {
-        return $this->deletedAtColumn;
-    }
-
-    /**
-     * Get the default foreign key name for the model.
-     *
-     * @return string
-     */
-    public function getForeignKey() : string
-    {
-        return snake_case(class_basename($this->getClass())).'_id';
-    }
-
-    /**
-     * Return the inheritance type used by the entity.
-     *
-     * @return string|null
-     */
-    public function getInheritanceType()
-    {
-        return $this->inheritanceType;
-    }
-
-    /**
-     * Return the discriminator column name on the entity that's
-     * used for table inheritance.
-     *
-     * @return string
-     */
-    public function getDiscriminatorColumn() : string
-    {
-        return $this->discriminatorColumn;
-    }
-
-    /**
-     * Return the mapping of discriminator column values to
-     * entity class names that are used for table inheritance.
-     *
-     * @return array
-     */
-    public function getDiscriminatorColumnMap() : array
-    {
-        return $this->discriminatorColumnMap;
-    }
-
-    /**
-     * Return true if the entity should be instanciated using
-     * the IoC Container.
-     *
-     * @return bool
-     */
-    public function useDependencyInjection() : bool
-    {
-        return $this->dependencyInjection;
-    }
-
-    /**
-     * Add a single relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addSingleRelation($relation)
-    {
-        if (!in_array($relation, $this->singleRelations)) {
-            $this->singleRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a foreign relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addForeignRelation($relation)
-    {
-        if (!in_array($relation, $this->foreignRelations)) {
-            $this->foreignRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a polymorphic relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addPolymorphicRelation($relation)
-    {
-        if (!in_array($relation, $this->polymorphicRelations)) {
-            $this->polymorphicRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a non proxy relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addNonProxyRelation($relation)
-    {
-        if (!in_array($relation, $this->nonProxyRelationships)) {
-            $this->nonProxyRelationships[] = $relation;
-        }
-    }
-
-    /**
-     * Add a local relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addLocalRelation($relation)
-    {
-        if (!in_array($relation, $this->localRelations)) {
-            $this->localRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a many relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addManyRelation($relation)
-    {
-        if (!in_array($relation, $this->manyRelations)) {
-            $this->manyRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a pivot relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addPivotRelation($relation)
-    {
-        if (!in_array($relation, $this->pivotRelations)) {
-            $this->pivotRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add an embedded relation.
-     *
-     * @param string $relation
-     */
-    protected function addEmbeddedRelation($relation)
-    {
-        if (!in_array($relation, $this->embeddedRelations)) {
-            $this->embeddedRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Define an Embedded Object.
-     *
-     * @param mixed  $entity
-     * @param string $related
-     *
-     * @return EmbedsOne
-     */
-    public function embedsOne($parent, string $relatedClass, $relation = null) : EmbedsOne
-    {
-        if(is_null($relation)) {
-            list(, $caller) = debug_backtrace(false);
-            $relation = $caller['function'];
-        }
-
-        $this->addEmbeddedRelation($relation);
-        $this->addNonProxyRelation($relation);
-
-        return new EmbedsOne($parent, $relatedClass, $relation);
-    }
-
-    /**
-     * Define an Embedded Collection.
-     *
-     * @param mixed  $entity
-     * @param string $related
-     *
-     * @return EmbedsOne
-     */
-    public function embedsMany($parent, string $relatedClass, $relation = null) : EmbedsMany
-    {
-        if(is_null($relation)) {
-            list(, $caller) = debug_backtrace(false);
-            $relation = $caller['function'];
-        }
-
-        $this->addEmbeddedRelation($relation);
-        $this->addNonProxyRelation($relation);
-
-        return new EmbedsMany($parent, $relatedClass, $relation);
-    }
-
-    /**
-     * Define a one-to-one relationship.
-     *
-     * @param mixed  $entity
-     * @param string $related    entity class
-     * @param string $foreignKey
-     * @param string $localKey
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\HasOne
-     */
-    public function hasOne($entity, $related, $foreignKey = null, $localKey = null)
-    {
-        $foreignKey = $foreignKey ?: $this->getForeignKey();
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        $relatedMap = $relatedMapper->getEntityMap();
-
-        $localKey = $localKey ?: $this->getKeyName();
-
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addSingleRelation($relation);
-        $this->addForeignRelation($relation);
-        $this->addNonProxyRelation($relation);
-
-        // This relationship will always be eager loaded, as proxying it would
-        // mean having an object that doesn't actually exists.
-        if (!in_array($relation, $this->with)) {
-            $this->with[] = $relation;
-        }
-
-        return new HasOne($relatedMapper, $entity, /*$relatedMap->getTable().'.'*/$foreignKey, $localKey);
-    }
-
-    /**
-     * Define a polymorphic one-to-one relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string      $name
-     * @param string|null $type
-     * @param string|null $id
-     * @param string|null $localKey
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\MorphOne
-     */
-    public function morphOne($entity, $related, $name, $type = null, $id = null, $localKey = null)
-    {
-        list($type, $id) = $this->getMorphs($name, $type, $id);
-
-        $localKey = $localKey ?: $this->getKeyName();
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        //$table = $relatedMapper->getEntityMap()->getTable();
-
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addSingleRelation($relation);
-        $this->addForeignRelation($relation);
-        $this->addNonProxyRelation($relation);
-
-        // This relationship will always be eager loaded, as proxying it would
-        // mean having an object that doesn't actually exists.
-        if (!in_array($relation, $this->with)) {
-            $this->with[] = $relation;
-        }
-
-        return new MorphOne($relatedMapper, $entity, /*$table.'.'.*/$type, /*$table.'.'.*/$id, $localKey);
-    }
-
-    /**
-     * Define an inverse one-to-one or many relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string|null $foreignKey
-     * @param string|null $otherKey
-     * @param string|null $relation
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\BelongsTo
-     */
-    public function belongsTo($entity, $related, $foreignKey = null, $otherKey = null)
-    {
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addSingleRelation($relation);
-        $this->addLocalRelation($relation);
-
-        // If no foreign key was supplied, we can use a backtrace to guess the proper
-        // foreign key name by using the name of the relationship function, which
-        // when combined with an "_id" should conventionally match the columns.
-        if (is_null($foreignKey)) {
-            $foreignKey = snake_case($relation).'_id';
-        }
-
-        $this->localForeignKeys[$relation] = $foreignKey;
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        $otherKey = $otherKey ?: $relatedMapper->getEntityMap()->getKeyName();
-
-        return new BelongsTo($relatedMapper, $entity, $foreignKey, $otherKey, $relation);
-    }
-
-    /**
-     * Define a polymorphic, inverse one-to-one or many relationship.
-     *
-     * @param mixed       $entity
-     * @param string|null $name
-     * @param string|null $type
-     * @param string|null $id
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\MorphTo
-     */
-    public function morphTo($entity, $name = null, $type = null, $id = null)
-    {
-        // If no name is provided, we will use the backtrace to get the function name
-        // since that is most likely the name of the polymorphic interface. We can
-        // use that to get both the class and foreign key that will be utilized.
-        if (is_null($name)) {
-            list(, $caller) = debug_backtrace(false);
-
-            $name = snake_case($caller['function']);
-        }
-        $this->addSingleRelation($name);
-        $this->addLocalRelation($name);
-        $this->addPolymorphicRelation($name);
-
-        $this->relatedClass[$name] = null;
-
-        list($type, $id) = $this->getMorphs($name, $type, $id);
-
-        // Store the foreign key in the entity map.
-        // We might want to store the (key, type) as we might need it
-        // to build a MorphTo proxy
-        $this->localForeignKeys[$name] = [
-            'id'   => $id,
-            'type' => $type,
-        ];
-
-        $mapper = Manager::getInstance()->mapper(get_class($entity));
-
-        // If the type value is null it is probably safe to assume we're eager loading
-        // the relationship. When that is the case we will pass in a dummy query as
-        // there are multiple types in the morph and we can't use single queries.
-        $factory = new Factory();
-        $wrapper = $factory->make($entity);
-
-        if (is_null($class = $wrapper->getEntityAttribute($type))) {
-            return new MorphTo(
-                $mapper, $entity, $id, null, $type, $name
-            );
-        }
-
-        // If we are not eager loading the relationship we will essentially treat this
-        // as a belongs-to style relationship since morph-to extends that class and
-        // we will pass in the appropriate values so that it behaves as expected.
-        else {
-            $class = Manager::getInstance()->getInverseMorphMap($class);
-            $relatedMapper = Manager::getInstance()->mapper($class);
-
-            $foreignKey = $relatedMapper->getEntityMap()->getKeyName();
-
-            return new MorphTo(
-                $relatedMapper, $entity, $id, $foreignKey, $type, $name
-            );
-        }
-    }
-
-    /**
-     * Define a one-to-many relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string|null $foreignKey
-     * @param string|null $localKey
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\HasMany
-     */
-    public function hasMany($entity, $related, $foreignKey = null, $localKey = null)
-    {
-        $foreignKey = $foreignKey ?: $this->getForeignKey();
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        $localKey = $localKey ?: $this->getKeyName();
-
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addManyRelation($relation);
-        $this->addForeignRelation($relation);
-
-        return new HasMany($relatedMapper, $entity, $foreignKey, $localKey);
-    }
-
-    /**
-     * Define a has-many-through relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string      $through
-     * @param string|null $firstKey
-     * @param string|null $secondKey
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\HasManyThrough
-     */
-    public function hasManyThrough($entity, $related, $through, $firstKey = null, $secondKey = null)
-    {
-        $relatedMapper = Manager::getInstance()->mapper($related);
-        $throughMapper = Manager::getInstance()->mapper($through);
-
-        $firstKey = $firstKey ?: $this->getForeignKey();
-
-        $throughMap = $throughMapper->getEntityMap();
-
-        $secondKey = $secondKey ?: $throughMap->getForeignKey();
-
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addManyRelation($relation);
-        $this->addForeignRelation($relation);
-
-        return new HasManyThrough($relatedMapper, $entity, $throughMap, $firstKey, $secondKey);
-    }
-
-    /**
-     * Define a polymorphic one-to-many relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string      $name
-     * @param string|null $type
-     * @param string|null $id
-     * @param string|null $localKey
-     *
-     * @return \Analogue\ORM\Relationships\MorphMany
-     */
-    public function morphMany($entity, $related, $name, $type = null, $id = null, $localKey = null)
-    {
-        // Here we will gather up the morph type and ID for the relationship so that we
-        // can properly query the intermediate table of a relation. Finally, we will
-        // get the table and create the relationship instances for the developers.
-        list($type, $id) = $this->getMorphs($name, $type, $id);
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        $table = $relatedMapper->getEntityMap()->getTable();
-
-        $localKey = $localKey ?: $this->getKeyName();
-
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addManyRelation($relation);
-        $this->addForeignRelation($relation);
-
-        return new MorphMany($relatedMapper, $entity, /*$table.'.'.*/$type, /*$table.'.'.*/$id, $localKey);
-    }
-
-    /**
-     * Define a many-to-many relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $relatedClass
-     * @param string|null $table
-     * @param string|null $foreignKey
-     * @param string|null $otherKey
-     * @param string|null $relation
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\BelongsToMany
-     */
-    public function belongsToMany($entity, $related, $table = null, $foreignKey = null, $otherKey = null)
-    {
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addManyRelation($relation);
-        $this->addForeignRelation($relation);
-        $this->addPivotRelation($relation);
-
-        // First, we'll need to determine the foreign key and "other key" for the
-        // relationship. Once we have determined the keys we'll make the query
-        // instances as well as the relationship instances we need for this.
-        $foreignKey = $foreignKey ?: $this->getForeignKey();
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        $relatedMap = $relatedMapper->getEntityMap();
-
-        $otherKey = $otherKey ?: $relatedMap->getForeignKey();
-
-        // If no table name was provided, we can guess it by concatenating the two
-        // models using underscores in alphabetical order. The two model names
-        // are transformed to snake case from their default CamelCase also.
-        if (is_null($table)) {
-            $table = $this->joiningTable($relatedMap);
-        }
-
-        return new BelongsToMany($relatedMapper, $entity, $table, $foreignKey, $otherKey, $relation);
-    }
-
-    /**
-     * Define a polymorphic many-to-many relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string      $name
-     * @param string|null $table
-     * @param string|null $foreignKey
-     * @param string|null $otherKey
-     * @param bool        $inverse
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\MorphToMany
-     */
-    public function morphToMany($entity, $related, $name, $table = null, $foreignKey = null, $otherKey = null, $inverse = false)
-    {
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addManyRelation($relation);
-        $this->addForeignRelation($relation);
-        $this->addPivotRelation($relation);
-
-        // First, we will need to determine the foreign key and "other key" for the
-        // relationship. Once we have determined the keys we will make the query
-        // instances, as well as the relationship instances we need for these.
-        $foreignKey = $foreignKey ?: $name.'_id';
-
-        $relatedMapper = Manager::getInstance()->mapper($related);
-
-        $otherKey = $otherKey ?: $relatedMapper->getEntityMap()->getForeignKey();
-
-        $table = $table ?: str_plural($name);
-
-        return new MorphToMany($relatedMapper, $entity, $name, $table, $foreignKey, $otherKey, $caller, $inverse);
-    }
-
-    /**
-     * Define a polymorphic, inverse many-to-many relationship.
-     *
-     * @param mixed       $entity
-     * @param string      $related
-     * @param string      $name
-     * @param string|null $table
-     * @param string|null $foreignKey
-     * @param string|null $otherKey
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\MorphToMany
-     */
-    public function morphedByMany($entity, $related, $name, $table = null, $foreignKey = null, $otherKey = null)
-    {
-        // Add the relation to the definition in map
-        list(, $caller) = debug_backtrace(false);
-        $relation = $caller['function'];
-        $this->relatedClasses[$relation] = $related;
-
-        $this->addManyRelation($relation);
-        $this->addForeignRelation($relation);
-
-        $foreignKey = $foreignKey ?: $this->getForeignKey();
-
-        // For the inverse of the polymorphic many-to-many relations, we will change
-        // the way we determine the foreign and other keys, as it is the opposite
-        // of the morph-to-many method since we're figuring out these inverses.
-        $otherKey = $otherKey ?: $name.'_id';
-
-        return $this->morphToMany($entity, $related, $name, $table, $foreignKey, $otherKey, true);
-    }
-
-    /**
-     * Get the joining table name for a many-to-many relation.
-     *
-     * @param EntityMap $relatedMap
-     *
-     * @return string
-     */
-    public function joiningTable($relatedMap)
-    {
-        // The joining table name, by convention, is simply the snake cased models
-        // sorted alphabetically and concatenated with an underscore, so we can
-        // just sort the models and join them together to get the table name.
-        $base = $this->getTable();
-
-        $related = $relatedMap->getTable();
-
-        $tables = [$related, $base];
-
-        // Now that we have the model names in an array we can just sort them and
-        // use the implode function to join them together with an underscores,
-        // which is typically used by convention within the database system.
-        sort($tables);
-
-        return strtolower(implode('_', $tables));
-    }
-
-    /**
-     * Get the polymorphic relationship columns.
-     *
-     * @param string $name
-     * @param string $type
-     * @param string $id
-     *
-     * @return string[]
-     */
-    protected function getMorphs($name, $type, $id)
-    {
-        $type = $type ?: $name.'_type';
-
-        $id = $id ?: $name.'_id';
-
-        return [$type, $id];
-    }
-
-    /**
-     * Get the class name for polymorphic relations.
-     *
-     * @return string
-     */
-    public function getMorphClass()
-    {
-        $morphClass = Manager::getInstance()->getMorphMap($this->getClass());
-
-        return $this->morphClass ?: $morphClass;
-    }
-
-    /**
-     * Create a new Entity Collection instance.
-     *
-     * @param array $entities
-     *
-     * @return \Analogue\ORM\EntityCollection
-     */
-    public function newCollection(array $entities = [])
-    {
-        $collection = new EntityCollection($entities, $this);
-
-        return $collection->keyBy($this->getKeyName());
-    }
-
-    /**
-     * Process EntityMap parsing at initialization time.
-     *
-     * @return void
-     */
-    public function initialize()
-    {
-        $userMethods = $this->getCustomMethods();
-
-        // Parse EntityMap for method based relationship
-        if (count($userMethods) > 0) {
-            $this->relationships = $this->parseMethodsForRelationship($userMethods);
-        }
-
-        // Parse EntityMap for dynamic relationships
-        if (count($this->dynamicRelationships) > 0) {
-            $this->relationships = $this->relationships + $this->getDynamicRelationships();
-        }
-    }
-
-    /**
-     * Parse every relationships on the EntityMap and sort
-     * them by type.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        if (count($this->relationships > 0)) {
-            $this->sortRelationshipsByType();
-        }
-    }
-
-    /**
-     * Get Methods that has been added in the child class.
-     *
-     * @return array
-     */
-    protected function getCustomMethods()
-    {
-        $mapMethods = get_class_methods($this);
-
-        $parentsMethods = get_class_methods('Analogue\ORM\EntityMap');
-
-        return array_diff($mapMethods, $parentsMethods);
-    }
-
-    /**
-     * Parse user's class methods for relationships.
-     *
-     * @param array $customMethods
-     *
-     * @return array
-     */
-    protected function parseMethodsForRelationship(array $customMethods)
-    {
-        $relationships = [];
-
-        $class = new ReflectionClass(get_class($this));
-
-        // Get the mapped Entity class, as we will detect relationships
-        // methods by testing that the first argument is type-hinted to
-        // the same class as the mapped Entity.
-        $entityClass = $this->getClass();
-
-        foreach ($customMethods as $methodName) {
-            $method = $class->getMethod($methodName);
-
-            if ($method->getNumberOfParameters() > 0) {
-                $params = $method->getParameters();
-
-                if ($params[0]->getClass() && ($params[0]->getClass()->name == $entityClass || is_subclass_of($entityClass, $params[0]->getClass()->name))) {
-                    $relationships[] = $methodName;
-                }
-            }
-        }
-
-        return $relationships;
-    }
-
-    /**
-     * Sort Relationships methods by type.
-     *
-     * TODO : replace this by direclty setting these value
-     * in the corresponding methods, so we won't need
-     * the correpondancy tabble
-     *
-     * @return void
-     */
-    protected function sortRelationshipsByType()
-    {
-        $entityClass = $this->getClass();
-
-        // Instantiate a dummy entity which we will pass to relationship methods.
-        $entity = unserialize(sprintf('O:%d:"%s":0:{}', strlen($entityClass), $entityClass));
-
-        foreach ($this->relationships as $relation) {
-            $this->$relation($entity);
-        }
-    }
-
-    /**
-     * Override this method for custom entity instantiation.
-     *
-     * @return null
-     */
-    public function activator()
-    {
-    }
-
-    /**
-     * Magic call to dynamic relationships.
-     *
-     * @param string $method
-     * @param array  $parameters
-     *
-     * @throws Exception
-     *
-     * @return mixed
-     */
-    public function __call($method, $parameters)
-    {
-        if (!array_key_exists($method, $this->dynamicRelationships)) {
-            throw new Exception(get_class($this)." has no method $method");
-        }
-
-        // Add $this to parameters so the closure can call relationship method on the map.
-        $parameters[] = $this;
-
-        return  call_user_func_array([$this->dynamicRelationships[$method], $parameters]);
-    }
+	/**
+	 * The mapping driver to use with this entity.
+	 *
+	 * @var string
+	 */
+	protected $driver = 'illuminate';
+
+	/**
+	 * The Database Connection name for the model.
+	 *
+	 * @var string
+	 */
+	protected $connection;
+
+	/**
+	 * The table associated with the entity.
+	 *
+	 * @var string|null
+	 */
+	protected $table = null;
+
+	/**
+	 * The primary key for the model.
+	 *
+	 * @var string
+	 */
+	protected $primaryKey = 'id';
+
+	/**
+	 * Name of the entity's array property that should
+	 * contain the attributes.
+	 * If set to null, analogue will only hydrate object's properties.
+	 *
+	 * @var string|null
+	 */
+	protected $arrayName = 'attributes';
+
+	/**
+	 * Array containing the list of database columns to be mapped
+	 * in the attributes array of the entity.
+	 *
+	 * @var array
+	 */
+	protected $attributes = [];
+
+	/**
+	 * Array containing the list of database columns to be mapped
+	 * to the entity's class properties.
+	 *
+	 * @var array
+	 */
+	protected $properties = [];
+
+	/**
+	 * The Custom Domain Class to use with this mapping.
+	 *
+	 * @var string|null
+	 */
+	protected $class = null;
+
+	/**
+	 * Embedded Value Objects.
+	 *
+	 * @var array
+	 */
+	protected $embeddables = [];
+
+	/**
+	 * Determine the relationships method used on the entity.
+	 * If not set, mapper will autodetect them.
+	 *
+	 * @var array
+	 */
+	private $relationships = [];
+
+	/**
+	 * Relationships that should be treated as collection.
+	 *
+	 * @var array
+	 */
+	private $manyRelations = [];
+
+	/**
+	 * Relationships that should be treated as single entity.
+	 *
+	 * @var array
+	 */
+	private $singleRelations = [];
+
+	/**
+	 * Relationships for which the key is stored in the Entity itself.
+	 *
+	 * @var array
+	 */
+	private $localRelations = [];
+
+	/**
+	 * List of local keys associated to local relation methods.
+	 *
+	 * @var array
+	 */
+	private $localForeignKeys = [];
+
+	/**
+	 * Relationships for which the key is stored in the Related Entity.
+	 *
+	 * @var array
+	 */
+	private $foreignRelations = [];
+
+	/**
+	 * Relationships which use a pivot record.
+	 *
+	 * @var array
+	 */
+	private $pivotRelations = [];
+
+	/**
+	 * Polymorphic relationships.
+	 *
+	 * @var array
+	 */
+	private $polymorphicRelations = [];
+
+	/**
+	 * Dynamic relationships.
+	 *
+	 * @var array
+	 */
+	private $dynamicRelationships = [];
+
+	/**
+	 * Targetted class for the relationship method. value is set to `null` for
+	 * polymorphic relations.
+	 *
+	 * @var array
+	 */
+	private $relatedClasses = [];
+
+	/**
+	 * Some relation methods like embedded objects, or HasOne and MorphOne,
+	 * will never have a proxy loaded on them.
+	 *
+	 * @var array
+	 */
+	private $nonProxyRelationships = [];
+
+	/**
+	 * Relation methods that are embedded objects.
+	 *
+	 * @var array
+	 */
+	private $embeddedRelations = [];
+
+	/**
+	 * The number of models to return for pagination.
+	 *
+	 * @var int
+	 */
+	protected $perPage = 15;
+
+	/**
+	 * The relations to eager load on every query.
+	 *
+	 * @var array
+	 */
+	protected $with = [];
+
+	/**
+	 * The class name to be used in polymorphic relations.
+	 *
+	 * @var string
+	 */
+	protected $morphClass;
+
+	/**
+	 * Sequence name, to be used with postgreSql
+	 * defaults to %table_name%_id_seq.
+	 *
+	 * @var string|null
+	 */
+	protected $sequence = null;
+
+	/**
+	 * Indicates if the entity should be timestamped.
+	 *
+	 * @var bool
+	 */
+	public $timestamps = false;
+
+	/**
+	 * The name of the "created at" column.
+	 *
+	 * @var string
+	 */
+	protected $createdAtColumn = 'created_at';
+
+	/**
+	 * The name of the "updated at" column.
+	 *
+	 * @var string
+	 */
+	protected $updatedAtColumn = 'updated_at';
+
+	/**
+	 * Indicates if the entity uses softdeletes.
+	 *
+	 * @var bool
+	 */
+	public $softDeletes = false;
+
+	/**
+	 * The name of the "deleted at" column.
+	 *
+	 * @var string
+	 */
+	protected $deletedAtColumn = 'deleted_at';
+
+	/**
+	 * The date format to use with the current database connection.
+	 *
+	 * @var string
+	 */
+	protected $dateFormat;
+
+	/**
+	 * Set this property to true if the entity should be instantiated
+	 * using the IoC Container.
+	 *
+	 * @var bool
+	 */
+	protected $dependencyInjection = false;
+
+	/**
+	 * Set the usage of inheritance, possible values are :
+	 * "single_table"
+	 * null.
+	 *
+	 * @var string | null
+	 */
+	protected $inheritanceType = null;
+
+	/**
+	 * Discriminator column name.
+	 *
+	 * @var string
+	 */
+	protected $discriminatorColumn = 'type';
+
+	/**
+	 * Allow using a string to define which entity type should be instantiated.
+	 * If not set, analogue will uses entity's FQDN.
+	 *
+	 * @var array
+	 */
+	protected $discriminatorColumnMap = [];
+
+	/**
+	 * Return Domain class attributes, useful when mapping to a Plain PHP Object.
+	 *
+	 * @return array
+	 */
+	public function getAttributes() : array
+	{
+		return $this->attributes;
+	}
+
+	/**
+	 * Set the domain class attributes.
+	 *
+	 * @param array $attributeNames
+	 */
+	public function setAttributes(array $attributeNames)
+	{
+		$this->attributes = $attributeNames;
+	}
+
+	/**
+	 * Return true if the Entity has an 'attributes' array property.
+	 *
+	 * @return bool
+	 */
+	public function usesAttributesArray() : bool
+	{
+		if ($this->arrayName === null) {
+			return false;
+		}
+		if ($this->attributes === null) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Return the name of the Entity's attributes property.
+	 *
+	 * @return string|null
+	 */
+	public function getAttributesArrayName()
+	{
+		return $this->arrayName;
+	}
+
+	/**
+	 * Get all the attribute names for the class, including relationships, embeddables and primary key.
+	 *
+	 * @return array
+	 */
+	public function getCompiledAttributes() : array
+	{
+		$key = $this->getKeyName();
+
+		$embeddables = array_keys($this->getEmbeddables());
+
+		$relationships = $this->getRelationships();
+
+		$attributes = $this->getAttributes();
+
+		return array_merge([$key], $embeddables, $relationships, $attributes);
+	}
+
+	/**
+	 * Set the date format to use with the current database connection.
+	 *
+	 * @param string $format
+	 */
+	public function setDateFormat($format)
+	{
+		$this->dateFormat = $format;
+	}
+
+	/**
+	 * Get the date format to use with the current database connection.
+	 *
+	 *  @return string
+	 */
+	public function getDateFormat() : string
+	{
+		return $this->dateFormat;
+	}
+
+	/**
+	 * Set the Driver for this mapping.
+	 *
+	 * @param string $driver
+	 */
+	public function setDriver($driver)
+	{
+		$this->driver = $driver;
+	}
+
+	/**
+	 * Get the Driver for this mapping.
+	 *
+	 * @return string
+	 */
+	public function getDriver() : string
+	{
+		return $this->driver;
+	}
+
+	/**
+	 * Set the db connection to use on the table.
+	 *
+	 * @param $connection
+	 */
+	public function setConnection($connection)
+	{
+		$this->connection = $connection;
+	}
+
+	/**
+	 * Get the Database connection the Entity is stored on.
+	 *
+	 * @return string | null
+	 */
+	public function getConnection()
+	{
+		return $this->connection;
+	}
+
+	/**
+	 * Get the table associated with the entity.
+	 *
+	 * @return string
+	 */
+	public function getTable() : string
+	{
+		if (!is_null($this->table)) {
+			return $this->table;
+		}
+
+		return str_replace('\\', '', snake_case(str_plural(class_basename($this->getClass()))));
+	}
+
+	/**
+	 * Set the database table name.
+	 *
+	 * @param string $table
+	 */
+	public function setTable($table)
+	{
+		$this->table = $table;
+	}
+
+	/**
+	 * Get the pgSql sequence name.
+	 *
+	 * @return string
+	 */
+	public function getSequence()
+	{
+		if (!is_null($this->sequence)) {
+			return $this->sequence;
+		} else {
+			return $this->getTable().'_id_seq';
+		}
+	}
+
+	/**
+	 * Get the custom entity class.
+	 *
+	 * @return string namespaced class name
+	 */
+	public function getClass() : string
+	{
+		return isset($this->class) ? $this->class : null;
+	}
+
+	/**
+	 * Set the custom entity class.
+	 *
+	 * @param string $class namespaced class name
+	 */
+	public function setClass($class)
+	{
+		$this->class = $class;
+	}
+
+	/**
+	 * Get the embedded Value Objects.
+	 *
+	 * @return array
+	 */
+	public function getEmbeddables() : array
+	{
+		return $this->embeddables;
+	}
+
+	/**
+	 * Return attributes that should be mapped to class properties.
+	 *
+	 * @return array
+	 */
+	public function getProperties() : array
+	{
+		return $this->properties;
+	}
+
+	/**
+	 * Return the array property in which will be mapped all attributes
+	 * that are not mapped to class properties.
+	 *
+	 * @return string
+	 */
+	public function getAttributesPropertyName() : string
+	{
+	}
+
+	/**
+	 * Set the embedded Value Objects.
+	 *
+	 * @param array $embeddables
+	 */
+	public function setEmbeddables(array $embeddables)
+	{
+		$this->embeddables = $embeddables;
+	}
+
+	/**
+	 * Get the relationships to map on a custom domain
+	 * class.
+	 *
+	 * @return array
+	 */
+	public function getRelationships() : array
+	{
+		return $this->relationships;
+	}
+
+	/**
+	 * Return all relationships that are not embedded objects.
+	 *
+	 * @return array
+	 */
+	public function getNonEmbeddedRelationships() : array
+	{
+		return array_diff($this->relationships, $this->embeddedRelations);
+	}
+
+	/**
+	 * Get the relationships that will not have a proxy
+	 * set on them.
+	 *
+	 * @return array
+	 */
+	public function getRelationshipsWithoutProxy() : array
+	{
+		return $this->nonProxyRelationships;
+	}
+
+	/**
+	 * Relationships of the Entity type.
+	 *
+	 * @return array
+	 */
+	public function getSingleRelationships() : array
+	{
+		return $this->singleRelations;
+	}
+
+	/**
+	 * Relationships of type Collection.
+	 *
+	 * @return array
+	 */
+	public function getManyRelationships() : array
+	{
+		return $this->manyRelations;
+	}
+
+	/**
+	 * Relationships with foreign key in the mapped entity record.
+	 *
+	 * @return array
+	 */
+	public function getLocalRelationships() : array
+	{
+		return $this->localRelations;
+	}
+
+	/**
+	 * Return the local keys associated to the relationship.
+	 *
+	 * @param string $relation
+	 *
+	 * @return string | array | null
+	 */
+	public function getLocalKeys($relation)
+	{
+		return isset($this->localForeignKeys[$relation]) ? $this->localForeignKeys[$relation] : null;
+	}
+
+	/**
+	 * Relationships with foreign key in the related Entity record.
+	 *
+	 * @return array
+	 */
+	public function getForeignRelationships() : array
+	{
+		return $this->foreignRelations;
+	}
+
+	/**
+	 * Relationships which keys are stored in a pivot record.
+	 *
+	 * @return array
+	 */
+	public function getPivotRelationships() : array
+	{
+		return $this->pivotRelations;
+	}
+
+	/**
+	 * Return an array containing all embedded relationships.
+	 *
+	 * @return array
+	 */
+	public function getEmbeddedRelationships() : array
+	{
+		return $this->embeddedRelations;
+	}
+
+	/**
+	 * Return true if the relationship method is polymorphic.
+	 *
+	 * @param string $relation
+	 *
+	 * @return bool
+	 */
+	public function isPolymorphic($relation) : bool
+	{
+		return in_array($relation, $this->polymorphicRelations);
+	}
+
+	/**
+	 * Get the targetted type for a relationship. Return null if polymorphic.
+	 *
+	 * @param string $relation
+	 *
+	 * @return string | null
+	 */
+	public function getTargettedClass($relation)
+	{
+		if (!array_key_exists($relation, $this->relatedClasses)) {
+			return;
+		}
+
+		return $this->relatedClasses[$relation];
+	}
+
+	/**
+	 * Add a Dynamic Relationship method at runtime. This has to be done
+	 * by hooking the 'initializing' event, before entityMap is initialized.
+	 *
+	 * @param string   $name         Relation name
+	 * @param \Closure $relationship
+	 *
+	 * @return void
+	 */
+	public function addRelationshipMethod($name, \Closure $relationship)
+	{
+		$this->dynamicRelationships[$name] = $relationship;
+	}
+
+	/**
+	 * Get the dynamic relationship method names.
+	 *
+	 * @return array
+	 */
+	public function getDynamicRelationships() : array
+	{
+		return array_keys($this->dynamicRelationships);
+	}
+
+	/**
+	 * Get the relationships that have to be eager loaded
+	 * on each request.
+	 *
+	 * @return array
+	 */
+	public function getEagerloadedRelationships() : array
+	{
+		return $this->with;
+	}
+
+	/**
+	 * Get the primary key attribute for the entity.
+	 *
+	 * @return string
+	 */
+	public function getKeyName() : string
+	{
+		return $this->primaryKey;
+	}
+
+	/**
+	 * Set the primary key for the entity.
+	 *
+	 * @param $key
+	 *
+	 * @return void
+	 */
+	public function setKeyName($key)
+	{
+		$this->primaryKey = $key;
+	}
+
+	/**
+	 * Get the table qualified key name.
+	 *
+	 * @return string
+	 */
+	public function getQualifiedKeyName() : string
+	{
+		return $this->getTable().'.'.$this->getKeyName();
+	}
+
+	/**
+	 * Get the number of models to return per page.
+	 *
+	 * @return int
+	 */
+	public function getPerPage() : int
+	{
+		return $this->perPage;
+	}
+
+	/**
+	 * Set the number of models to return per page.
+	 *
+	 * @param int $perPage
+	 *
+	 * @return void
+	 */
+	public function setPerPage($perPage)
+	{
+		$this->perPage = $perPage;
+	}
+
+	/**
+	 * Determine if the entity uses get.
+	 *
+	 * @return bool
+	 */
+	public function usesTimestamps() : bool
+	{
+		return $this->timestamps;
+	}
+
+	/**
+	 * Determine if the entity uses soft deletes.
+	 *
+	 * @return bool
+	 */
+	public function usesSoftDeletes() : bool
+	{
+		return $this->softDeletes;
+	}
+
+	/**
+	 * Get the 'created_at' column name.
+	 *
+	 * @return string
+	 */
+	public function getCreatedAtColumn() : string
+	{
+		return $this->createdAtColumn;
+	}
+
+	/**
+	 * Get the 'updated_at' column name.
+	 *
+	 * @return string
+	 */
+	public function getUpdatedAtColumn() : string
+	{
+		return $this->updatedAtColumn;
+	}
+
+	/**
+	 * Get the deleted_at column.
+	 *
+	 * @return string
+	 */
+	public function getQualifiedDeletedAtColumn() : string
+	{
+		return $this->deletedAtColumn;
+	}
+
+	/**
+	 * Get the default foreign key name for the model.
+	 *
+	 * @return string
+	 */
+	public function getForeignKey() : string
+	{
+		return snake_case(class_basename($this->getClass())).'_id';
+	}
+
+	/**
+	 * Return the inheritance type used by the entity.
+	 *
+	 * @return string|null
+	 */
+	public function getInheritanceType()
+	{
+		return $this->inheritanceType;
+	}
+
+	/**
+	 * Return the discriminator column name on the entity that's
+	 * used for table inheritance.
+	 *
+	 * @return string
+	 */
+	public function getDiscriminatorColumn() : string
+	{
+		return $this->discriminatorColumn;
+	}
+
+	/**
+	 * Return the mapping of discriminator column values to
+	 * entity class names that are used for table inheritance.
+	 *
+	 * @return array
+	 */
+	public function getDiscriminatorColumnMap() : array
+	{
+		return $this->discriminatorColumnMap;
+	}
+
+	/**
+	 * Return true if the entity should be instanciated using
+	 * the IoC Container.
+	 *
+	 * @return bool
+	 */
+	public function useDependencyInjection() : bool
+	{
+		return $this->dependencyInjection;
+	}
+
+	/**
+	 * Add a single relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addSingleRelation($relation)
+	{
+		if (!in_array($relation, $this->singleRelations)) {
+			$this->singleRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a foreign relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addForeignRelation($relation)
+	{
+		if (!in_array($relation, $this->foreignRelations)) {
+			$this->foreignRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a polymorphic relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addPolymorphicRelation($relation)
+	{
+		if (!in_array($relation, $this->polymorphicRelations)) {
+			$this->polymorphicRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a non proxy relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addNonProxyRelation($relation)
+	{
+		if (!in_array($relation, $this->nonProxyRelationships)) {
+			$this->nonProxyRelationships[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a local relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addLocalRelation($relation)
+	{
+		if (!in_array($relation, $this->localRelations)) {
+			$this->localRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a many relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addManyRelation($relation)
+	{
+		if (!in_array($relation, $this->manyRelations)) {
+			$this->manyRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a pivot relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addPivotRelation($relation)
+	{
+		if (!in_array($relation, $this->pivotRelations)) {
+			$this->pivotRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add an embedded relation.
+	 *
+	 * @param string $relation
+	 */
+	protected function addEmbeddedRelation($relation)
+	{
+		if (!in_array($relation, $this->embeddedRelations)) {
+			$this->embeddedRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Define an Embedded Object.
+	 *
+	 * @param mixed  $entity
+	 * @param string $related
+	 *
+	 * @return EmbedsOne
+	 */
+	public function embedsOne($parent, string $relatedClass, $relation = null) : EmbedsOne
+	{
+		if(is_null($relation)) {
+			list(, $caller) = debug_backtrace(false);
+			$relation = $caller['function'];
+		}
+
+		$this->addEmbeddedRelation($relation);
+		$this->addNonProxyRelation($relation);
+
+		return new EmbedsOne($parent, $relatedClass, $relation);
+	}
+
+	/**
+	 * Define an Embedded Collection.
+	 *
+	 * @param mixed  $entity
+	 * @param string $related
+	 *
+	 * @return EmbedsOne
+	 */
+	public function embedsMany($parent, string $relatedClass, $relation = null) : EmbedsMany
+	{
+		if(is_null($relation)) {
+			list(, $caller) = debug_backtrace(false);
+			$relation = $caller['function'];
+		}
+
+		$this->addEmbeddedRelation($relation);
+		$this->addNonProxyRelation($relation);
+
+		return new EmbedsMany($parent, $relatedClass, $relation);
+	}
+
+	/**
+	 * Define a one-to-one relationship.
+	 *
+	 * @param mixed  $entity
+	 * @param string $related    entity class
+	 * @param string $foreignKey
+	 * @param string $localKey
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\HasOne
+	 */
+	public function hasOne($entity, $related, $foreignKey = null, $localKey = null)
+	{
+		$foreignKey = $foreignKey ?: $this->getForeignKey();
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		$relatedMap = $relatedMapper->getEntityMap();
+
+		$localKey = $localKey ?: $this->getKeyName();
+
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addSingleRelation($relation);
+		$this->addForeignRelation($relation);
+		$this->addNonProxyRelation($relation);
+
+		// This relationship will always be eager loaded, as proxying it would
+		// mean having an object that doesn't actually exists.
+		if (!in_array($relation, $this->with)) {
+			$this->with[] = $relation;
+		}
+
+		return new HasOne($relatedMapper, $entity, /*$relatedMap->getTable().'.'*/$foreignKey, $localKey);
+	}
+
+	/**
+	 * Define a polymorphic one-to-one relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string      $name
+	 * @param string|null $type
+	 * @param string|null $id
+	 * @param string|null $localKey
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\MorphOne
+	 */
+	public function morphOne($entity, $related, $name, $type = null, $id = null, $localKey = null)
+	{
+		list($type, $id) = $this->getMorphs($name, $type, $id);
+
+		$localKey = $localKey ?: $this->getKeyName();
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		//$table = $relatedMapper->getEntityMap()->getTable();
+
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addSingleRelation($relation);
+		$this->addForeignRelation($relation);
+		$this->addNonProxyRelation($relation);
+
+		// This relationship will always be eager loaded, as proxying it would
+		// mean having an object that doesn't actually exists.
+		if (!in_array($relation, $this->with)) {
+			$this->with[] = $relation;
+		}
+
+		return new MorphOne($relatedMapper, $entity, /*$table.'.'.*/$type, /*$table.'.'.*/$id, $localKey);
+	}
+
+	/**
+	 * Define an inverse one-to-one or many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string|null $foreignKey
+	 * @param string|null $otherKey
+	 * @param string|null $relation
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\BelongsTo
+	 */
+	public function belongsTo($entity, $related, $foreignKey = null, $otherKey = null)
+	{
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addSingleRelation($relation);
+		$this->addLocalRelation($relation);
+
+		// If no foreign key was supplied, we can use a backtrace to guess the proper
+		// foreign key name by using the name of the relationship function, which
+		// when combined with an "_id" should conventionally match the columns.
+		if (is_null($foreignKey)) {
+			$foreignKey = snake_case($relation).'_id';
+		}
+
+		$this->localForeignKeys[$relation] = $foreignKey;
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		$otherKey = $otherKey ?: $relatedMapper->getEntityMap()->getKeyName();
+
+		return new BelongsTo($relatedMapper, $entity, $foreignKey, $otherKey, $relation);
+	}
+
+	/**
+	 * Define a polymorphic, inverse one-to-one or many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string|null $name
+	 * @param string|null $type
+	 * @param string|null $id
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\MorphTo
+	 */
+	public function morphTo($entity, $name = null, $type = null, $id = null)
+	{
+		// If no name is provided, we will use the backtrace to get the function name
+		// since that is most likely the name of the polymorphic interface. We can
+		// use that to get both the class and foreign key that will be utilized.
+		if (is_null($name)) {
+			list(, $caller) = debug_backtrace(false);
+
+			$name = snake_case($caller['function']);
+		}
+		$this->addSingleRelation($name);
+		$this->addLocalRelation($name);
+		$this->addPolymorphicRelation($name);
+
+		$this->relatedClass[$name] = null;
+
+		list($type, $id) = $this->getMorphs($name, $type, $id);
+
+		// Store the foreign key in the entity map.
+		// We might want to store the (key, type) as we might need it
+		// to build a MorphTo proxy
+		$this->localForeignKeys[$name] = [
+			'id'   => $id,
+			'type' => $type,
+		];
+
+		$mapper = Manager::getInstance()->mapper(get_class($entity));
+
+		// If the type value is null it is probably safe to assume we're eager loading
+		// the relationship. When that is the case we will pass in a dummy query as
+		// there are multiple types in the morph and we can't use single queries.
+		$factory = new Factory();
+		$wrapper = $factory->make($entity);
+
+		if (is_null($class = $wrapper->getEntityAttribute($type))) {
+			return new MorphTo(
+				$mapper, $entity, $id, null, $type, $name
+			);
+		}
+
+		// If we are not eager loading the relationship we will essentially treat this
+		// as a belongs-to style relationship since morph-to extends that class and
+		// we will pass in the appropriate values so that it behaves as expected.
+		else {
+			$class = Manager::getInstance()->getInverseMorphMap($class);
+			$relatedMapper = Manager::getInstance()->mapper($class);
+
+			$foreignKey = $relatedMapper->getEntityMap()->getKeyName();
+
+			return new MorphTo(
+				$relatedMapper, $entity, $id, $foreignKey, $type, $name
+			);
+		}
+	}
+
+	/**
+	 * Define a one-to-many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string|null $foreignKey
+	 * @param string|null $localKey
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\HasMany
+	 */
+	public function hasMany($entity, $related, $foreignKey = null, $localKey = null)
+	{
+		$foreignKey = $foreignKey ?: $this->getForeignKey();
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		$localKey = $localKey ?: $this->getKeyName();
+
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addManyRelation($relation);
+		$this->addForeignRelation($relation);
+
+		return new HasMany($relatedMapper, $entity, $foreignKey, $localKey);
+	}
+
+	/**
+	 * Define a has-many-through relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string      $through
+	 * @param string|null $firstKey
+	 * @param string|null $secondKey
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\HasManyThrough
+	 */
+	public function hasManyThrough($entity, $related, $through, $firstKey = null, $secondKey = null)
+	{
+		$relatedMapper = Manager::getInstance()->mapper($related);
+		$throughMapper = Manager::getInstance()->mapper($through);
+
+		$firstKey = $firstKey ?: $this->getForeignKey();
+
+		$throughMap = $throughMapper->getEntityMap();
+
+		$secondKey = $secondKey ?: $throughMap->getForeignKey();
+
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addManyRelation($relation);
+		$this->addForeignRelation($relation);
+
+		return new HasManyThrough($relatedMapper, $entity, $throughMap, $firstKey, $secondKey);
+	}
+
+	/**
+	 * Define a polymorphic one-to-many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string      $name
+	 * @param string|null $type
+	 * @param string|null $id
+	 * @param string|null $localKey
+	 *
+	 * @return \Analogue\ORM\Relationships\MorphMany
+	 */
+	public function morphMany($entity, $related, $name, $type = null, $id = null, $localKey = null)
+	{
+		// Here we will gather up the morph type and ID for the relationship so that we
+		// can properly query the intermediate table of a relation. Finally, we will
+		// get the table and create the relationship instances for the developers.
+		list($type, $id) = $this->getMorphs($name, $type, $id);
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		$table = $relatedMapper->getEntityMap()->getTable();
+
+		$localKey = $localKey ?: $this->getKeyName();
+
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addManyRelation($relation);
+		$this->addForeignRelation($relation);
+
+		return new MorphMany($relatedMapper, $entity, /*$table.'.'.*/$type, /*$table.'.'.*/$id, $localKey);
+	}
+
+	/**
+	 * Define a many-to-many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $relatedClass
+	 * @param string|null $table
+	 * @param string|null $foreignKey
+	 * @param string|null $otherKey
+	 * @param string|null $relation
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\BelongsToMany
+	 */
+	public function belongsToMany($entity, $related, $table = null, $foreignKey = null, $otherKey = null)
+	{
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addManyRelation($relation);
+		$this->addForeignRelation($relation);
+		$this->addPivotRelation($relation);
+
+		// First, we'll need to determine the foreign key and "other key" for the
+		// relationship. Once we have determined the keys we'll make the query
+		// instances as well as the relationship instances we need for this.
+		$foreignKey = $foreignKey ?: $this->getForeignKey();
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		$relatedMap = $relatedMapper->getEntityMap();
+
+		$otherKey = $otherKey ?: $relatedMap->getForeignKey();
+
+		// If no table name was provided, we can guess it by concatenating the two
+		// models using underscores in alphabetical order. The two model names
+		// are transformed to snake case from their default CamelCase also.
+		if (is_null($table)) {
+			$table = $this->joiningTable($relatedMap);
+		}
+
+		return new BelongsToMany($relatedMapper, $entity, $table, $foreignKey, $otherKey, $relation);
+	}
+
+	/**
+	 * Define a polymorphic many-to-many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string      $name
+	 * @param string|null $table
+	 * @param string|null $foreignKey
+	 * @param string|null $otherKey
+	 * @param bool        $inverse
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\MorphToMany
+	 */
+	public function morphToMany($entity, $related, $name, $table = null, $foreignKey = null, $otherKey = null, $inverse = false)
+	{
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addManyRelation($relation);
+		$this->addForeignRelation($relation);
+		$this->addPivotRelation($relation);
+
+		// First, we will need to determine the foreign key and "other key" for the
+		// relationship. Once we have determined the keys we will make the query
+		// instances, as well as the relationship instances we need for these.
+		$foreignKey = $foreignKey ?: $name.'_id';
+
+		$relatedMapper = Manager::getInstance()->mapper($related);
+
+		$otherKey = $otherKey ?: $relatedMapper->getEntityMap()->getForeignKey();
+
+		$table = $table ?: str_plural($name);
+
+		return new MorphToMany($relatedMapper, $entity, $name, $table, $foreignKey, $otherKey, $caller, $inverse);
+	}
+
+	/**
+	 * Define a polymorphic, inverse many-to-many relationship.
+	 *
+	 * @param mixed       $entity
+	 * @param string      $related
+	 * @param string      $name
+	 * @param string|null $table
+	 * @param string|null $foreignKey
+	 * @param string|null $otherKey
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\MorphToMany
+	 */
+	public function morphedByMany($entity, $related, $name, $table = null, $foreignKey = null, $otherKey = null)
+	{
+		// Add the relation to the definition in map
+		list(, $caller) = debug_backtrace(false);
+		$relation = $caller['function'];
+		$this->relatedClasses[$relation] = $related;
+
+		$this->addManyRelation($relation);
+		$this->addForeignRelation($relation);
+
+		$foreignKey = $foreignKey ?: $this->getForeignKey();
+
+		// For the inverse of the polymorphic many-to-many relations, we will change
+		// the way we determine the foreign and other keys, as it is the opposite
+		// of the morph-to-many method since we're figuring out these inverses.
+		$otherKey = $otherKey ?: $name.'_id';
+
+		return $this->morphToMany($entity, $related, $name, $table, $foreignKey, $otherKey, true);
+	}
+
+	/**
+	 * Get the joining table name for a many-to-many relation.
+	 *
+	 * @param EntityMap $relatedMap
+	 *
+	 * @return string
+	 */
+	public function joiningTable($relatedMap)
+	{
+		// The joining table name, by convention, is simply the snake cased models
+		// sorted alphabetically and concatenated with an underscore, so we can
+		// just sort the models and join them together to get the table name.
+		$base = $this->getTable();
+
+		$related = $relatedMap->getTable();
+
+		$tables = [$related, $base];
+
+		// Now that we have the model names in an array we can just sort them and
+		// use the implode function to join them together with an underscores,
+		// which is typically used by convention within the database system.
+		sort($tables);
+
+		return strtolower(implode('_', $tables));
+	}
+
+	/**
+	 * Get the polymorphic relationship columns.
+	 *
+	 * @param string $name
+	 * @param string $type
+	 * @param string $id
+	 *
+	 * @return string[]
+	 */
+	protected function getMorphs($name, $type, $id)
+	{
+		$type = $type ?: $name.'_type';
+
+		$id = $id ?: $name.'_id';
+
+		return [$type, $id];
+	}
+
+	/**
+	 * Get the class name for polymorphic relations.
+	 *
+	 * @return string
+	 */
+	public function getMorphClass()
+	{
+		$morphClass = Manager::getInstance()->getMorphMap($this->getClass());
+
+		return $this->morphClass ?: $morphClass;
+	}
+
+	/**
+	 * Create a new Entity Collection instance.
+	 *
+	 * @param array $entities
+	 *
+	 * @return \Analogue\ORM\EntityCollection
+	 */
+	public function newCollection(array $entities = [])
+	{
+		$collection = new EntityCollection($entities, $this);
+
+		return $collection->keyBy($this->getKeyName());
+	}
+
+	/**
+	 * Process EntityMap parsing at initialization time.
+	 *
+	 * @return void
+	 */
+	public function initialize()
+	{
+		$userMethods = $this->getCustomMethods();
+
+		// Parse EntityMap for method based relationship
+		if (count($userMethods) > 0) {
+			$this->relationships = $this->parseMethodsForRelationship($userMethods);
+		}
+
+		// Parse EntityMap for dynamic relationships
+		if (count($this->dynamicRelationships) > 0) {
+			$this->relationships = $this->relationships + $this->getDynamicRelationships();
+		}
+	}
+
+	/**
+	 * Parse every relationships on the EntityMap and sort
+	 * them by type.
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		if (count($this->relationships > 0)) {
+			$this->sortRelationshipsByType();
+		}
+	}
+
+	/**
+	 * Get Methods that has been added in the child class.
+	 *
+	 * @return array
+	 */
+	protected function getCustomMethods()
+	{
+		$mapMethods = get_class_methods($this);
+
+		$parentsMethods = get_class_methods('Analogue\ORM\EntityMap');
+
+		return array_diff($mapMethods, $parentsMethods);
+	}
+
+	/**
+	 * Parse user's class methods for relationships.
+	 *
+	 * @param array $customMethods
+	 *
+	 * @return array
+	 */
+	protected function parseMethodsForRelationship(array $customMethods)
+	{
+		$relationships = [];
+
+		$class = new ReflectionClass(get_class($this));
+
+		// Get the mapped Entity class, as we will detect relationships
+		// methods by testing that the first argument is type-hinted to
+		// the same class as the mapped Entity.
+		$entityClass = $this->getClass();
+
+		foreach ($customMethods as $methodName) {
+			$method = $class->getMethod($methodName);
+
+			if ($method->getNumberOfParameters() > 0) {
+				$params = $method->getParameters();
+
+				if ($params[0]->getClass() && ($params[0]->getClass()->name == $entityClass || is_subclass_of($entityClass, $params[0]->getClass()->name))) {
+					$relationships[] = $methodName;
+				}
+			}
+		}
+
+		return $relationships;
+	}
+
+	/**
+	 * Sort Relationships methods by type.
+	 *
+	 * TODO : replace this by direclty setting these value
+	 * in the corresponding methods, so we won't need
+	 * the correpondancy tabble
+	 *
+	 * @return void
+	 */
+	protected function sortRelationshipsByType()
+	{
+		$entityClass = $this->getClass();
+
+		// Instantiate a dummy entity which we will pass to relationship methods.
+		$entity = unserialize(sprintf('O:%d:"%s":0:{}', strlen($entityClass), $entityClass));
+
+		foreach ($this->relationships as $relation) {
+			$this->$relation($entity);
+		}
+	}
+
+	/**
+	 * Override this method for custom entity instantiation.
+	 *
+	 * @return null
+	 */
+	public function activator()
+	{
+	}
+
+	/**
+	 * Magic call to dynamic relationships.
+	 *
+	 * @param string $method
+	 * @param array  $parameters
+	 *
+	 * @throws Exception
+	 *
+	 * @return mixed
+	 */
+	public function __call($method, $parameters)
+	{
+		if (!array_key_exists($method, $this->dynamicRelationships)) {
+			throw new Exception(get_class($this)." has no method $method");
+		}
+
+		// Add $this to parameters so the closure can call relationship method on the map.
+		$parameters[] = $this;
+
+		return  call_user_func_array([$this->dynamicRelationships[$method], $parameters]);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -935,7 +935,7 @@ 
      */
     public function embedsOne($parent, string $relatedClass, $relation = null) : EmbedsOne
     {
-        if(is_null($relation)) {
+        if (is_null($relation)) {
             list(, $caller) = debug_backtrace(false);
             $relation = $caller['function'];
         }
@@ -956,7 +956,7 @@ 
      */
     public function embedsMany($parent, string $relatedClass, $relation = null) : EmbedsMany
     {
-        if(is_null($relation)) {
+        if (is_null($relation)) {
             list(, $caller) = debug_backtrace(false);
             $relation = $caller['function'];
         }

src/Relationships/EmbeddedRelationship.php

Doc Comments +2 added lines, -3 removed lines

@@ -154,7 +154,6 @@ 
      * Get attribute name from the parent, if a map has been
      * defined.
      *
-     * @param srring $attributeKey
      *
      * @return string
      */
@@ -217,7 +216,7 @@ 
     /**
      * Return parent mapper.
      *
-     * @return Analogue\ORM\System\Mapper
+     * @return \Analogue\ORM\System\Mapper
      */
     protected function getParentMapper()
     {
@@ -227,7 +226,7 @@ 
     /**
      * Return embedded relationship mapper.
      *
-     * @return Analogue\ORM\System\Mapper
+     * @return \Analogue\ORM\System\Mapper
      */
     protected function getRelatedMapper()
     {

Indentation +224 added lines, -224 removed lines

@@ -9,228 +9,228 @@
 
 abstract class EmbeddedRelationship
 {
-    /**
-     * The class that embeds the current relation.
-     *
-     * @var string
-     */
-    protected $parentClass;
-
-    /**
-     * The class of the embedded relation.
-     *
-     * @var string
-     */
-    protected $relatedClass;
-
-    /**
-     * The relation attribute on the parent object.
-     *
-     * @var string
-     */
-    protected $relation;
-
-    /**
-     * If set to true, embedded Object's attributes will
-     * be stored as a serialized array in a JSON Column.
-     *
-     * @var bool
-     */
-    protected $asArray = false;
-
-    /**
-     * Prefix on which the object's attributes are saved into
-     * the parent's table. defaults to "<relatedClass>_".
-     *
-     * @var string
-     */
-    protected $prefix;
-
-    /**
-     * Attributes Map allow the calling EntityMap to overrides attributes
-     * on the embedded relation.
-     *
-     * @var array
-     */
-    protected $columnMap = [];
-
-    /**
-     * Wrapper factory.
-     *
-     * @var \Analogue\ORM\System\Wrappers\Factory
-     */
-    protected $factory;
-
-    public function __construct($parent, string $relatedClass, string $relation)
-    {
-        $this->parentClass = get_class($parent);
-        $this->relatedClass = $relatedClass;
-        $this->relation = $relation;
-        $this->prefix = $relation.'_';
-        $this->factory = new Factory();
-    }
-
-    /**
-     * Switch the 'store as array' feature.
-     *
-     * @param bool $storeAsArray
-     *
-     * @return static
-     */
-    public function asArray(bool $storeAsArray = true)
-    {
-        $this->asArray = $storeAsArray;
-
-        return $this;
-    }
-
-    /**
-     * Set the column map for the embedded relation.
-     *
-     * @param array $columns
-     *
-     * @return static
-     */
-    public function setColumnMap(array $columns)
-    {
-        $this->columnMap = $columns;
-
-        return $this;
-    }
-
-    /**
-     * Set parent's attribute prefix.
-     *
-     * @param string $prefix
-     *
-     * @return static
-     */
-    public function setPrefix(string $prefix)
-    {
-        $this->prefix = $prefix;
-
-        return $this;
-    }
-
-    /**
-     * Return parent's attribute prefix.
-     *
-     * @return string
-     */
-    public function getPrefix() : string
-    {
-        return $this->prefix;
-    }
-
-    /**
-     * Get the embedded object's attributes that will be
-     * hydrated using parent's entity attributes.
-     *
-     * @return array
-     */
-    protected function getEmbeddedObjectAttributes() : array
-    {
-        $entityMap = $this->getRelatedMapper()->getEntityMap();
-
-        $attributes = $entityMap->getAttributes();
-        $properties = $entityMap->getProperties();
-
-        return array_merge($attributes, $properties);
-    }
-
-    /**
-     * Get the corresponding attribute on parent's attributes.
-     *
-     * @param string $key
-     *
-     * @return string
-     */
-    protected function getParentAttributeKey($key) : string
-    {
-        return $this->getPrefixedAttributeKey($this->getMappedParentAttribute($key));
-    }
-
-    /**
-     * Get attribute name from the parent, if a map has been
-     * defined.
-     *
-     * @param srring $attributeKey
-     *
-     * @return string
-     */
-    protected function getMappedParentAttribute(string $key) : string
-    {
-        if (array_key_exists($key, $this->columnMap)) {
-            return $this->columnMap[$key];
-        } else {
-            return $key;
-        }
-    }
-
-    /**
-     * Return the name of the attribute with key.
-     *
-     * @param string $attributeKey
-     *
-     * @return string
-     */
-    protected function getPrefixedAttributeKey(string $attributeKey) : string
-    {
-        return $this->prefix.$attributeKey;
-    }
-
-    /**
-     * Transform attributes into embedded object(s), and
-     * match it into the given resultset.
-     *
-     * @return array
-     */
-    abstract public function match(array $results) : array;
-
-    /**
-     * Build an embedded object instance.
-     *
-     * @param array $attributes
-     *
-     * @return mixed
-     */
-    protected function buildEmbeddedObject(array $attributes)
-    {
-        $resultBuilder = new ResultBuilder($this->getRelatedMapper());
-
-        // TODO : find a way to support eager load within an embedded
-        // object.
-        $eagerLoads = [];
-
-        return $resultBuilder->build([$attributes], $eagerLoads)[0];
-    }
-
-    /**
-     * Transform embedded object into db column(s).
-     *
-     * @param mixed $object
-     *
-     * @return array $columns
-     */
-    abstract public function normalize($object) : array;
-
-    /**
-     * Return parent mapper.
-     *
-     * @return Analogue\ORM\System\Mapper
-     */
-    protected function getParentMapper()
-    {
-        return Manager::getInstance()->mapper($this->parentClass);
-    }
-
-    /**
-     * Return embedded relationship mapper.
-     *
-     * @return Analogue\ORM\System\Mapper
-     */
-    protected function getRelatedMapper()
-    {
-        return Manager::getInstance()->mapper($this->relatedClass);
-    }
+	/**
+	 * The class that embeds the current relation.
+	 *
+	 * @var string
+	 */
+	protected $parentClass;
+
+	/**
+	 * The class of the embedded relation.
+	 *
+	 * @var string
+	 */
+	protected $relatedClass;
+
+	/**
+	 * The relation attribute on the parent object.
+	 *
+	 * @var string
+	 */
+	protected $relation;
+
+	/**
+	 * If set to true, embedded Object's attributes will
+	 * be stored as a serialized array in a JSON Column.
+	 *
+	 * @var bool
+	 */
+	protected $asArray = false;
+
+	/**
+	 * Prefix on which the object's attributes are saved into
+	 * the parent's table. defaults to "<relatedClass>_".
+	 *
+	 * @var string
+	 */
+	protected $prefix;
+
+	/**
+	 * Attributes Map allow the calling EntityMap to overrides attributes
+	 * on the embedded relation.
+	 *
+	 * @var array
+	 */
+	protected $columnMap = [];
+
+	/**
+	 * Wrapper factory.
+	 *
+	 * @var \Analogue\ORM\System\Wrappers\Factory
+	 */
+	protected $factory;
+
+	public function __construct($parent, string $relatedClass, string $relation)
+	{
+		$this->parentClass = get_class($parent);
+		$this->relatedClass = $relatedClass;
+		$this->relation = $relation;
+		$this->prefix = $relation.'_';
+		$this->factory = new Factory();
+	}
+
+	/**
+	 * Switch the 'store as array' feature.
+	 *
+	 * @param bool $storeAsArray
+	 *
+	 * @return static
+	 */
+	public function asArray(bool $storeAsArray = true)
+	{
+		$this->asArray = $storeAsArray;
+
+		return $this;
+	}
+
+	/**
+	 * Set the column map for the embedded relation.
+	 *
+	 * @param array $columns
+	 *
+	 * @return static
+	 */
+	public function setColumnMap(array $columns)
+	{
+		$this->columnMap = $columns;
+
+		return $this;
+	}
+
+	/**
+	 * Set parent's attribute prefix.
+	 *
+	 * @param string $prefix
+	 *
+	 * @return static
+	 */
+	public function setPrefix(string $prefix)
+	{
+		$this->prefix = $prefix;
+
+		return $this;
+	}
+
+	/**
+	 * Return parent's attribute prefix.
+	 *
+	 * @return string
+	 */
+	public function getPrefix() : string
+	{
+		return $this->prefix;
+	}
+
+	/**
+	 * Get the embedded object's attributes that will be
+	 * hydrated using parent's entity attributes.
+	 *
+	 * @return array
+	 */
+	protected function getEmbeddedObjectAttributes() : array
+	{
+		$entityMap = $this->getRelatedMapper()->getEntityMap();
+
+		$attributes = $entityMap->getAttributes();
+		$properties = $entityMap->getProperties();
+
+		return array_merge($attributes, $properties);
+	}
+
+	/**
+	 * Get the corresponding attribute on parent's attributes.
+	 *
+	 * @param string $key
+	 *
+	 * @return string
+	 */
+	protected function getParentAttributeKey($key) : string
+	{
+		return $this->getPrefixedAttributeKey($this->getMappedParentAttribute($key));
+	}
+
+	/**
+	 * Get attribute name from the parent, if a map has been
+	 * defined.
+	 *
+	 * @param srring $attributeKey
+	 *
+	 * @return string
+	 */
+	protected function getMappedParentAttribute(string $key) : string
+	{
+		if (array_key_exists($key, $this->columnMap)) {
+			return $this->columnMap[$key];
+		} else {
+			return $key;
+		}
+	}
+
+	/**
+	 * Return the name of the attribute with key.
+	 *
+	 * @param string $attributeKey
+	 *
+	 * @return string
+	 */
+	protected function getPrefixedAttributeKey(string $attributeKey) : string
+	{
+		return $this->prefix.$attributeKey;
+	}
+
+	/**
+	 * Transform attributes into embedded object(s), and
+	 * match it into the given resultset.
+	 *
+	 * @return array
+	 */
+	abstract public function match(array $results) : array;
+
+	/**
+	 * Build an embedded object instance.
+	 *
+	 * @param array $attributes
+	 *
+	 * @return mixed
+	 */
+	protected function buildEmbeddedObject(array $attributes)
+	{
+		$resultBuilder = new ResultBuilder($this->getRelatedMapper());
+
+		// TODO : find a way to support eager load within an embedded
+		// object.
+		$eagerLoads = [];
+
+		return $resultBuilder->build([$attributes], $eagerLoads)[0];
+	}
+
+	/**
+	 * Transform embedded object into db column(s).
+	 *
+	 * @param mixed $object
+	 *
+	 * @return array $columns
+	 */
+	abstract public function normalize($object) : array;
+
+	/**
+	 * Return parent mapper.
+	 *
+	 * @return Analogue\ORM\System\Mapper
+	 */
+	protected function getParentMapper()
+	{
+		return Manager::getInstance()->mapper($this->parentClass);
+	}
+
+	/**
+	 * Return embedded relationship mapper.
+	 *
+	 * @return Analogue\ORM\System\Mapper
+	 */
+	protected function getRelatedMapper()
+	{
+		return Manager::getInstance()->mapper($this->relatedClass);
+	}
 }

src/Relationships/EmbedsMany.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
     /**
      * Transform embedded object into db column(s).
      *
-     * @param mixed $object
+     * @param mixed $objects
      *
      * @return array $columns
      */
@@ -86,7 +86,7 @@ 
     /**
      * Normalize object an array containing raw attributes
      * 
-     * @param  mixed  $object 
+     * @param  mixed  $objects 
      * @return array
      */
     protected function normalizeAsArray($objects) : array

Indentation +100 added lines, -100 removed lines

@@ -7,108 +7,108 @@
 
 class EmbedsMany extends EmbedsOne
 {
-    /**
-     * Match a single database row's attributes to a single
-     * object, and return the updated attributes.
-     *
-     * @param array $attributes
-     *
-     * @return array
-     */
-    public function matchSingleResult(array $attributes) : array
-    {
-        $column = $this->relation;
-
-        if (!$this->asArray) {
-            throw new MappingException("column '$column' should be of type array or json");
-        }
-
-        return $this->matchAsArray($attributes);
-    }
-
-    /**
-     * Match array attribute from parent to an embedded object,
-     * and return the updated attributes.
-     *
-     * @param array $attributes
-     *
-     * @return array
-     */
-    protected function matchAsArray(array $attributes) : array
-    {
-        // Extract the attributes with the key of the relation,
-        // which should be an array.
-        $key = $this->relation;
-
-        if (!array_key_exists($key, $attributes) && !is_array($key)) {
-            throw new MappingException("'$key' column should be an array");
-        }
-
-        $attributes[$key] = $this->buildEmbeddedCollection($attributes[$key]);
-
-        return $attributes;
-    }
-
-    /**
-     * Build an embedded collection and returns it.
-     *
-     * @param array $rows
-     *
-     * @return Collection
-     */
-    protected function buildEmbeddedCollection($rows) : Collection
-    {
-        $items = [];
-
-        foreach ($rows as $attributes) {
-            $items[] = $this->buildEmbeddedObject($attributes);
-        }
-
-        return collect($items);
-    }
-
-    /**
-     * Transform embedded object into db column(s).
-     *
-     * @param mixed $object
-     *
-     * @return array $columns
-     */
-    public function normalize($objects) : array
-    {
-    	if(! $this->asArray) {
-    		throw new MappingException("Cannot normalize an embedsMany relation as row columns");
-    	}
-
-    	return $this->normalizeAsArray($objects);
-    }
-
-    /**
-     * Normalize object an array containing raw attributes
-     * 
-     * @param  mixed  $object 
-     * @return array
-     */
-    protected function normalizeAsArray($objects) : array
-    {
-    	$key = $this->relation;
-
-    	if(! is_array($objects) && ! $objects instanceof Collection) {
-    		throw new MappingException("column '$key' should be of type array or collection");
-    	}
-
-    	if($objects instanceof Collection ) {
-    		$objects = $objects->all();
-    	}
+	/**
+	 * Match a single database row's attributes to a single
+	 * object, and return the updated attributes.
+	 *
+	 * @param array $attributes
+	 *
+	 * @return array
+	 */
+	public function matchSingleResult(array $attributes) : array
+	{
+		$column = $this->relation;
+
+		if (!$this->asArray) {
+			throw new MappingException("column '$column' should be of type array or json");
+		}
+
+		return $this->matchAsArray($attributes);
+	}
+
+	/**
+	 * Match array attribute from parent to an embedded object,
+	 * and return the updated attributes.
+	 *
+	 * @param array $attributes
+	 *
+	 * @return array
+	 */
+	protected function matchAsArray(array $attributes) : array
+	{
+		// Extract the attributes with the key of the relation,
+		// which should be an array.
+		$key = $this->relation;
+
+		if (!array_key_exists($key, $attributes) && !is_array($key)) {
+			throw new MappingException("'$key' column should be an array");
+		}
+
+		$attributes[$key] = $this->buildEmbeddedCollection($attributes[$key]);
+
+		return $attributes;
+	}
+
+	/**
+	 * Build an embedded collection and returns it.
+	 *
+	 * @param array $rows
+	 *
+	 * @return Collection
+	 */
+	protected function buildEmbeddedCollection($rows) : Collection
+	{
+		$items = [];
+
+		foreach ($rows as $attributes) {
+			$items[] = $this->buildEmbeddedObject($attributes);
+		}
+
+		return collect($items);
+	}
+
+	/**
+	 * Transform embedded object into db column(s).
+	 *
+	 * @param mixed $object
+	 *
+	 * @return array $columns
+	 */
+	public function normalize($objects) : array
+	{
+		if(! $this->asArray) {
+			throw new MappingException("Cannot normalize an embedsMany relation as row columns");
+		}
+
+		return $this->normalizeAsArray($objects);
+	}
+
+	/**
+	 * Normalize object an array containing raw attributes
+	 * 
+	 * @param  mixed  $object 
+	 * @return array
+	 */
+	protected function normalizeAsArray($objects) : array
+	{
+		$key = $this->relation;
+
+		if(! is_array($objects) && ! $objects instanceof Collection) {
+			throw new MappingException("column '$key' should be of type array or collection");
+		}
+
+		if($objects instanceof Collection ) {
+			$objects = $objects->all();
+		}
     	
-    	$normalizedObjects = [];
+		$normalizedObjects = [];
 
-    	foreach($objects as $object) {
-    		$wrapper = $this->factory->make($object);	
-    		$normalizedObjects[] = $wrapper->getEntityAttributes();
-    	}
+		foreach($objects as $object) {
+			$wrapper = $this->factory->make($object);	
+			$normalizedObjects[] = $wrapper->getEntityAttributes();
+		}
         
 
-        return [$key => $normalizedObjects];
-    }
+		return [$key => $normalizedObjects];
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -76,7 +76,7 @@ 
      */
     public function normalize($objects) : array
     {
-    	if(! $this->asArray) {
+    	if (!$this->asArray) {
     		throw new MappingException("Cannot normalize an embedsMany relation as row columns");
     	}
 
@@ -93,17 +93,17 @@ 
     {
     	$key = $this->relation;
 
-    	if(! is_array($objects) && ! $objects instanceof Collection) {
+    	if (!is_array($objects) && !$objects instanceof Collection) {
     		throw new MappingException("column '$key' should be of type array or collection");
     	}
 
-    	if($objects instanceof Collection ) {
+    	if ($objects instanceof Collection) {
     		$objects = $objects->all();
     	}
     	
     	$normalizedObjects = [];
 
-    	foreach($objects as $object) {
+    	foreach ($objects as $object) {
     		$wrapper = $this->factory->make($object);	
     		$normalizedObjects[] = $wrapper->getEntityAttributes();
     	}

src/System/Query.php

Indentation +673 added lines, -673 removed lines

@@ -20,677 +20,677 @@
  */
 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 = ['*']) : Collection
-    {
-        return $this->getEntities($columns);
-    }
-
-    /**
-     * Find an entity by its primary key.
-     *
-     * @param string|int $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);
-
-        // Pass result set to the mapper and return the EntityCollection
-        return $this->mapper->map($results, $this->getEagerLoads());
-
-        // 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 self($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 self($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 = ['*']) : Collection
+	{
+		return $this->getEntities($columns);
+	}
+
+	/**
+	 * Find an entity by its primary key.
+	 *
+	 * @param string|int $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);
+
+		// Pass result set to the mapper and return the EntityCollection
+		return $this->mapper->map($results, $this->getEagerLoads());
+
+		// 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 self($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 self($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;
+	}
 }

src/System/Wrappers/ObjectWrapper.php

Indentation +221 added lines, -221 removed lines

@@ -10,226 +10,226 @@
  */
 class ObjectWrapper extends Wrapper
 {
-    /**
-     * Internal Representation of analogue's entity attributes.
-     *
-     * @var array
-     */
-    protected $attributes = [];
-
-    /**
-     * Object properties that are not a part of the entity attributes,
-     * but which are needed to correctly hydrate the Object.
-     *
-     * @var array
-     */
-    protected $unmanagedProperties = [];
-
-    /**
-     * The hydrator for the wrapped object.
-     *
-     * @var HydratorInterface
-     */
-    protected $hydrator;
-
-    /**
-     * Object Wrapper constructor.
-     *
-     * @param mixed                  $object
-     * @param Analogue\ORM\EntityMap $entityMap
-     *
-     * @return void
-     */
-    public function __construct($entity, $entityMap, HydratorInterface $hydrator)
-    {
-        $this->hydrator = $hydrator;
-        parent::__construct($entity, $entityMap);
-        $this->attributes = $this->dehydrate($entity);
-    }
-
-    /**
-     * Returns the wrapped entity.
-     *
-     * @return mixed
-     */
-    public function getObject()
-    {
-        $this->hydrate();
-
-        return $this->entity;
-    }
-
-    /**
-     * Extract entity attributes / properties to an array of attributes.
-     *
-     * @param mixed $entity
-     *
-     * @return array
-     */
-    protected function dehydrate($entity) : array
-    {
-        $properties = $this->hydrator->extract($entity);
-
-        $this->unmanagedProperties = array_except($properties, $this->getManagedProperties());
-
-        return $this->attributesFromProperties($properties);
-    }
-
-    /**
-     * Hydrate object's properties/attribute from the internal array representation.
-     *
-     * @return mixed
-     */
-    public function hydrate()
-    {
-        $properties = $this->propertiesFromAttributes($this->attributes) + $this->unmanagedProperties;
+	/**
+	 * Internal Representation of analogue's entity attributes.
+	 *
+	 * @var array
+	 */
+	protected $attributes = [];
+
+	/**
+	 * Object properties that are not a part of the entity attributes,
+	 * but which are needed to correctly hydrate the Object.
+	 *
+	 * @var array
+	 */
+	protected $unmanagedProperties = [];
+
+	/**
+	 * The hydrator for the wrapped object.
+	 *
+	 * @var HydratorInterface
+	 */
+	protected $hydrator;
+
+	/**
+	 * Object Wrapper constructor.
+	 *
+	 * @param mixed                  $object
+	 * @param Analogue\ORM\EntityMap $entityMap
+	 *
+	 * @return void
+	 */
+	public function __construct($entity, $entityMap, HydratorInterface $hydrator)
+	{
+		$this->hydrator = $hydrator;
+		parent::__construct($entity, $entityMap);
+		$this->attributes = $this->dehydrate($entity);
+	}
+
+	/**
+	 * Returns the wrapped entity.
+	 *
+	 * @return mixed
+	 */
+	public function getObject()
+	{
+		$this->hydrate();
+
+		return $this->entity;
+	}
+
+	/**
+	 * Extract entity attributes / properties to an array of attributes.
+	 *
+	 * @param mixed $entity
+	 *
+	 * @return array
+	 */
+	protected function dehydrate($entity) : array
+	{
+		$properties = $this->hydrator->extract($entity);
+
+		$this->unmanagedProperties = array_except($properties, $this->getManagedProperties());
+
+		return $this->attributesFromProperties($properties);
+	}
+
+	/**
+	 * Hydrate object's properties/attribute from the internal array representation.
+	 *
+	 * @return mixed
+	 */
+	public function hydrate()
+	{
+		$properties = $this->propertiesFromAttributes($this->attributes) + $this->unmanagedProperties;
         
-        $this->hydrator->hydrate($properties, $this->entity);
-    }
-
-    /**
-     * Return properties that will be extracted from the entity.
-     *
-     * @return array
-     */
-    protected function getManagedProperties() : array
-    {
-        $properties = $this->entityMap->getProperties();
-
-        $attributesName = $this->entityMap->getAttributesArrayName();
-
-        return $attributesName == null ? $properties : array_merge($properties, [$attributesName]);
-    }
-
-    /**
-     * Convert object's properties to analogue's internal attributes representation.
-     *
-     * @param array $properties
-     *
-     * @return array
-     */
-    protected function attributesFromProperties(array $properties) : array
-    {
-        // First, we'll only keep the entities that are part of the Entity's
-        // attributes
-        $managedProperties = $this->getManagedProperties();
-
-        $properties = array_only($properties, $managedProperties);
-
-        // If the entity does not uses the attributes array to store
-        // part of its attributes, we'll directly return the properties
-        if (!$this->entityMap->usesAttributesArray()) {
-            return $properties;
-        }
-
-        $arrayName = $this->entityMap->getAttributesArrayName();
-
-        if (!array_key_exists($arrayName, $properties)) {
-            throw new MappingException("Property $arrayName not set on object of type ".$this->getEntityClass());
-        }
-
-        if (!is_array($properties[$arrayName])) {
-            throw new MappingException("Property $arrayName should be an array.");
-        }
-
-        $attributes = $properties[$arrayName];
-
-        unset($properties[$arrayName]);
-
-        return $properties + $attributes;
-    }
-
-    /**
-     * Convert internal representation of attributes to an array of properties
-     * that can hydrate the actual object.
-     *
-     * @param array $attributes
-     *
-     * @return array
-     */
-    protected function propertiesFromAttributes(array $attributes) : array
-    {
-        $attributes = $this->attributes;
-
-        // Get all managed properties
-        $propertyNames = $this->entityMap->getProperties();
-
-        $propertyAttributes = array_only($attributes, $propertyNames);
-        $attributesArray = array_except($attributes, $propertyNames);
-
-        $attributesArrayName = $this->entityMap->getAttributesArrayName();
-
-        if ($attributesArrayName) {
-            $propertyAttributes[$attributesArrayName] = $attributesArray;
-        }
-
-        return $propertyAttributes;
-    }
-
-    /**
-     * Method used by the mapper to set the object
-     * attribute raw values (hydration).
-     *
-     * @param array $attributes
-     *
-     * @return void
-     */
-    public function setEntityAttributes(array $attributes)
-    {
-        $this->attributes = $attributes;
-    }
-
-    /**
-     * Method used by the mapper to get the
-     * raw object's values.
-     *
-     * @return array
-     */
-    public function getEntityAttributes() : array
-    {
-        return $this->attributes;
-    }
-
-    /**
-     * Method used by the mapper to set raw
-     * key-value pair.
-     *
-     * @param string $key
-     * @param string $value
-     *
-     * @return void
-     */
-    public function setEntityAttribute($key, $value)
-    {
-        $this->attributes[$key] = $value;
-    }
-
-    /**
-     * Method used by the mapper to get single
-     * key-value pair.
-     *
-     * @param string $key
-     *
-     * @return mixed|null
-     */
-    public function getEntityAttribute($key)
-    {
-        if ($this->hasAttribute($key)) {
-            return $this->attributes[$key];
-        } else {
-            return;
-        }
-    }
-
-    /**
-     * Test if a given attribute exists.
-     *
-     * @param string $key
-     *
-     * @return bool
-     */
-    public function hasAttribute($key) : bool
-    {
-        return array_key_exists($key, $this->attributes) ? true : false;
-    }
+		$this->hydrator->hydrate($properties, $this->entity);
+	}
+
+	/**
+	 * Return properties that will be extracted from the entity.
+	 *
+	 * @return array
+	 */
+	protected function getManagedProperties() : array
+	{
+		$properties = $this->entityMap->getProperties();
+
+		$attributesName = $this->entityMap->getAttributesArrayName();
+
+		return $attributesName == null ? $properties : array_merge($properties, [$attributesName]);
+	}
+
+	/**
+	 * Convert object's properties to analogue's internal attributes representation.
+	 *
+	 * @param array $properties
+	 *
+	 * @return array
+	 */
+	protected function attributesFromProperties(array $properties) : array
+	{
+		// First, we'll only keep the entities that are part of the Entity's
+		// attributes
+		$managedProperties = $this->getManagedProperties();
+
+		$properties = array_only($properties, $managedProperties);
+
+		// If the entity does not uses the attributes array to store
+		// part of its attributes, we'll directly return the properties
+		if (!$this->entityMap->usesAttributesArray()) {
+			return $properties;
+		}
+
+		$arrayName = $this->entityMap->getAttributesArrayName();
+
+		if (!array_key_exists($arrayName, $properties)) {
+			throw new MappingException("Property $arrayName not set on object of type ".$this->getEntityClass());
+		}
+
+		if (!is_array($properties[$arrayName])) {
+			throw new MappingException("Property $arrayName should be an array.");
+		}
+
+		$attributes = $properties[$arrayName];
+
+		unset($properties[$arrayName]);
+
+		return $properties + $attributes;
+	}
+
+	/**
+	 * Convert internal representation of attributes to an array of properties
+	 * that can hydrate the actual object.
+	 *
+	 * @param array $attributes
+	 *
+	 * @return array
+	 */
+	protected function propertiesFromAttributes(array $attributes) : array
+	{
+		$attributes = $this->attributes;
+
+		// Get all managed properties
+		$propertyNames = $this->entityMap->getProperties();
+
+		$propertyAttributes = array_only($attributes, $propertyNames);
+		$attributesArray = array_except($attributes, $propertyNames);
+
+		$attributesArrayName = $this->entityMap->getAttributesArrayName();
+
+		if ($attributesArrayName) {
+			$propertyAttributes[$attributesArrayName] = $attributesArray;
+		}
+
+		return $propertyAttributes;
+	}
+
+	/**
+	 * Method used by the mapper to set the object
+	 * attribute raw values (hydration).
+	 *
+	 * @param array $attributes
+	 *
+	 * @return void
+	 */
+	public function setEntityAttributes(array $attributes)
+	{
+		$this->attributes = $attributes;
+	}
+
+	/**
+	 * Method used by the mapper to get the
+	 * raw object's values.
+	 *
+	 * @return array
+	 */
+	public function getEntityAttributes() : array
+	{
+		return $this->attributes;
+	}
+
+	/**
+	 * Method used by the mapper to set raw
+	 * key-value pair.
+	 *
+	 * @param string $key
+	 * @param string $value
+	 *
+	 * @return void
+	 */
+	public function setEntityAttribute($key, $value)
+	{
+		$this->attributes[$key] = $value;
+	}
+
+	/**
+	 * Method used by the mapper to get single
+	 * key-value pair.
+	 *
+	 * @param string $key
+	 *
+	 * @return mixed|null
+	 */
+	public function getEntityAttribute($key)
+	{
+		if ($this->hasAttribute($key)) {
+			return $this->attributes[$key];
+		} else {
+			return;
+		}
+	}
+
+	/**
+	 * Test if a given attribute exists.
+	 *
+	 * @param string $key
+	 *
+	 * @return bool
+	 */
+	public function hasAttribute($key) : bool
+	{
+		return array_key_exists($key, $this->attributes) ? true : false;
+	}
 }

src/System/Wrappers/Wrapper.php

Indentation +236 added lines, -236 removed lines

@@ -10,240 +10,240 @@
  */
 abstract class Wrapper implements InternallyMappable
 {
-    /**
-     * Original Entity Object.
-     *
-     * @var mixed
-     */
-    protected $entity;
-
-    /**
-     * Corresponding EntityMap.
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $entityMap;
-
-    /**
-     * @var \Analogue\ORM\System\Proxirs\ProxyFactory
-     */
-    protected $proxyFactory;
-
-    /**
-     * Wrapper constructor.
-     *
-     * @param $entity
-     * @param $entityMap
-     */
-    public function __construct($entity, $entityMap)
-    {
-        $this->entity = $entity;
-        $this->entityMap = $entityMap;
-        $this->proxyFactory = new ProxyFactory();
-    }
-
-    /**
-     * Return the wrapped entity class.
-     *
-     * @return mixed
-     */
-    public function getEntityClass()
-    {
-        return get_class($this->entity);
-    }
-
-    /**
-     * Return the entity's primary key valuye.
-     *
-     * @return string
-     */
-    public function getEntityKey()
-    {
-        return $this->getEntityAttribute($this->entityMap->getKeyName());
-    }
-
-    /**
-     * Return the Entity class/primary key couple,
-     * which is used for internall operations.
-     *
-     * @return string
-     */
-    public function getEntityHash()
-    {
-        return $this->getEntityClass().'.'.$this->getEntityKey();
-    }
-
-    /**
-     * Returns the wrapped entity.
-     *
-     * @return mixed
-     */
-    public function getObject()
-    {
-        return $this->entity;
-    }
-
-    /**
-     * Returns the wrapped entity's map.
-     *
-     * @return mixed
-     */
-    public function getMap()
-    {
-        return $this->entityMap;
-    }
-
-    /**
-     * Set the lazyloading proxies on the wrapped entity objet.
-     *
-     * @param array $relations list of relations to be lazy loaded
-     *
-     * @return void
-     */
-    public function setProxies(array $relations = null)
-    {
-        $attributes = $this->getEntityAttributes();
-        $proxies = [];
-
-        //if (is_null($relations)) {
-            $relations = $this->getRelationsToProxy();
-        //}
-        //dump($relations);
-        // Before calling the relationship methods, we'll set the relationship
-        // method to null, to avoid hydration error on class properties
-        foreach ($relations as $relation) {
-            $this->setEntityAttribute($relation, null);
-        }
-
-        foreach ($relations as $relation) {
-
-            // First, we check that the relation has not been already
-            // set, in which case, we'll just pass.
-            if (array_key_exists($relation, $attributes) && !is_null($attributes[$relation])) {
-                continue;
-            }
-
-            // If the key is handled locally and we know it not to be set,
-            // we'll set the relationship to null
-            if (!$this->relationNeedsProxy($relation, $attributes)) {
-                $proxies[$relation] = null;
-            } else {
-                $targetClass = $this->getClassToProxy($relation, $attributes);
-                $proxies[$relation] = $this->proxyFactory->make($this->getObject(), $relation, $targetClass);
-            }
-        }
-
-        foreach ($proxies as $key => $value) {
-            $this->setEntityAttribute($key, $value);
-        }
-
-    }
-
-    /**
-     * Get Target class to proxy for a one to one.
-     *
-     * @param string $relation
-     * @param array  $attributes
-     *
-     * @return string
-     */
-    protected function getClassToProxy($relation, array $attributes)
-    {
-        if ($this->entityMap->isPolymorphic($relation)) {
-            $localTypeAttribute = $this->entityMap->getLocalKeys($relation)['type'];
-
-            return $attributes[$localTypeAttribute];
-        }
-
-        return $this->entityMap->getTargettedClass($relation);
-    }
-
-    /**
-     * Determine which relations we have to build proxy for, by parsing
-     * attributes and finding methods that aren't set.
-     *
-     * @return array
-     */
-    protected function getRelationsToProxy()
-    {
-        $proxies = [];
-        $attributes = $this->getEntityAttributes();
-
-        foreach ($this->entityMap->getRelationships() as $relation) {
-            if (!array_key_exists($relation, $attributes)) {
-                $proxies[] = $relation;
-            }
-        }
-
-        return $proxies;
-    }
-
-    /**
-     * Determine if the relation needs a proxy or not.
-     *
-     * @param string $relation
-     * @param array  $attributes
-     *
-     * @return bool
-     */
-    protected function relationNeedsProxy($relation, $attributes)
-    {
-        if (in_array($relation, $this->entityMap->getRelationshipsWithoutProxy())) {
-            return false;
-        }
-
-        $localKey = $this->entityMap->getLocalKeys($relation);
-
-        if (is_null($localKey)) {
-            return true;
-        }
-
-        if (is_array($localKey)) {
-            $localKey = $localKey['id'];
-        }
-
-        if (!isset($attributes[$localKey])) {
-            return false;
-        }
-
-        if (is_null($attributes[$localKey])) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param string $key
-     * @param string $value
-     *
-     * @return mixed
-     */
-    abstract public function setEntityAttribute($key, $value);
-
-    /**
-     * @param string $key
-     *
-     * @return mixed
-     */
-    abstract public function getEntityAttribute($key);
-
-    /**
-     * @param array $attributes
-     *
-     * @return mixed
-     */
-    abstract public function setEntityAttributes(array $attributes);
-
-    /**
-     * @return mixed
-     */
-    abstract public function getEntityAttributes();
-
-    /**
-     * @param string $key
-     *
-     * @return mixed
-     */
-    abstract public function hasAttribute($key);
+	/**
+	 * Original Entity Object.
+	 *
+	 * @var mixed
+	 */
+	protected $entity;
+
+	/**
+	 * Corresponding EntityMap.
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $entityMap;
+
+	/**
+	 * @var \Analogue\ORM\System\Proxirs\ProxyFactory
+	 */
+	protected $proxyFactory;
+
+	/**
+	 * Wrapper constructor.
+	 *
+	 * @param $entity
+	 * @param $entityMap
+	 */
+	public function __construct($entity, $entityMap)
+	{
+		$this->entity = $entity;
+		$this->entityMap = $entityMap;
+		$this->proxyFactory = new ProxyFactory();
+	}
+
+	/**
+	 * Return the wrapped entity class.
+	 *
+	 * @return mixed
+	 */
+	public function getEntityClass()
+	{
+		return get_class($this->entity);
+	}
+
+	/**
+	 * Return the entity's primary key valuye.
+	 *
+	 * @return string
+	 */
+	public function getEntityKey()
+	{
+		return $this->getEntityAttribute($this->entityMap->getKeyName());
+	}
+
+	/**
+	 * Return the Entity class/primary key couple,
+	 * which is used for internall operations.
+	 *
+	 * @return string
+	 */
+	public function getEntityHash()
+	{
+		return $this->getEntityClass().'.'.$this->getEntityKey();
+	}
+
+	/**
+	 * Returns the wrapped entity.
+	 *
+	 * @return mixed
+	 */
+	public function getObject()
+	{
+		return $this->entity;
+	}
+
+	/**
+	 * Returns the wrapped entity's map.
+	 *
+	 * @return mixed
+	 */
+	public function getMap()
+	{
+		return $this->entityMap;
+	}
+
+	/**
+	 * Set the lazyloading proxies on the wrapped entity objet.
+	 *
+	 * @param array $relations list of relations to be lazy loaded
+	 *
+	 * @return void
+	 */
+	public function setProxies(array $relations = null)
+	{
+		$attributes = $this->getEntityAttributes();
+		$proxies = [];
+
+		//if (is_null($relations)) {
+			$relations = $this->getRelationsToProxy();
+		//}
+		//dump($relations);
+		// Before calling the relationship methods, we'll set the relationship
+		// method to null, to avoid hydration error on class properties
+		foreach ($relations as $relation) {
+			$this->setEntityAttribute($relation, null);
+		}
+
+		foreach ($relations as $relation) {
+
+			// First, we check that the relation has not been already
+			// set, in which case, we'll just pass.
+			if (array_key_exists($relation, $attributes) && !is_null($attributes[$relation])) {
+				continue;
+			}
+
+			// If the key is handled locally and we know it not to be set,
+			// we'll set the relationship to null
+			if (!$this->relationNeedsProxy($relation, $attributes)) {
+				$proxies[$relation] = null;
+			} else {
+				$targetClass = $this->getClassToProxy($relation, $attributes);
+				$proxies[$relation] = $this->proxyFactory->make($this->getObject(), $relation, $targetClass);
+			}
+		}
+
+		foreach ($proxies as $key => $value) {
+			$this->setEntityAttribute($key, $value);
+		}
+
+	}
+
+	/**
+	 * Get Target class to proxy for a one to one.
+	 *
+	 * @param string $relation
+	 * @param array  $attributes
+	 *
+	 * @return string
+	 */
+	protected function getClassToProxy($relation, array $attributes)
+	{
+		if ($this->entityMap->isPolymorphic($relation)) {
+			$localTypeAttribute = $this->entityMap->getLocalKeys($relation)['type'];
+
+			return $attributes[$localTypeAttribute];
+		}
+
+		return $this->entityMap->getTargettedClass($relation);
+	}
+
+	/**
+	 * Determine which relations we have to build proxy for, by parsing
+	 * attributes and finding methods that aren't set.
+	 *
+	 * @return array
+	 */
+	protected function getRelationsToProxy()
+	{
+		$proxies = [];
+		$attributes = $this->getEntityAttributes();
+
+		foreach ($this->entityMap->getRelationships() as $relation) {
+			if (!array_key_exists($relation, $attributes)) {
+				$proxies[] = $relation;
+			}
+		}
+
+		return $proxies;
+	}
+
+	/**
+	 * Determine if the relation needs a proxy or not.
+	 *
+	 * @param string $relation
+	 * @param array  $attributes
+	 *
+	 * @return bool
+	 */
+	protected function relationNeedsProxy($relation, $attributes)
+	{
+		if (in_array($relation, $this->entityMap->getRelationshipsWithoutProxy())) {
+			return false;
+		}
+
+		$localKey = $this->entityMap->getLocalKeys($relation);
+
+		if (is_null($localKey)) {
+			return true;
+		}
+
+		if (is_array($localKey)) {
+			$localKey = $localKey['id'];
+		}
+
+		if (!isset($attributes[$localKey])) {
+			return false;
+		}
+
+		if (is_null($attributes[$localKey])) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param string $key
+	 * @param string $value
+	 *
+	 * @return mixed
+	 */
+	abstract public function setEntityAttribute($key, $value);
+
+	/**
+	 * @param string $key
+	 *
+	 * @return mixed
+	 */
+	abstract public function getEntityAttribute($key);
+
+	/**
+	 * @param array $attributes
+	 *
+	 * @return mixed
+	 */
+	abstract public function setEntityAttributes(array $attributes);
+
+	/**
+	 * @return mixed
+	 */
+	abstract public function getEntityAttributes();
+
+	/**
+	 * @param string $key
+	 *
+	 * @return mixed
+	 */
+	abstract public function hasAttribute($key);
 }

src/System/Mapper.php

Indentation +630 added lines, -630 removed lines

@@ -25,634 +25,634 @@
  */
 class Mapper
 {
-    /**
-     * The Manager instance.
-     *
-     * @var \Analogue\ORM\System\Manager
-     */
-    protected $manager;
-
-    /**
-     * Instance of EntityMapper Object.
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $entityMap;
-
-    /**
-     * The instance of db adapter.
-     *
-     * @var \Analogue\ORM\Drivers\DBAdapter
-     */
-    protected $adapter;
-
-    /**
-     * Event dispatcher instance.
-     *
-     * @var \Illuminate\Contracts\Events\Dispatcher
-     */
-    protected $dispatcher;
-
-    /**
-     * Entity Cache.
-     *
-     * @var \Analogue\ORM\System\EntityCache
-     */
-    protected $cache;
-
-    /**
-     * Global scopes.
-     *
-     * @var array
-     */
-    protected $globalScopes = [];
-
-    /**
-     * Custom Commands.
-     *
-     * @var array
-     */
-    protected $customCommands = [];
-
-    /**
-     * @param EntityMap  $entityMap
-     * @param DBAdapter  $adapter
-     * @param Dispatcher $dispatcher
-     * @param Manager    $manager
-     */
-    public function __construct(EntityMap $entityMap, DBAdapter $adapter, Dispatcher $dispatcher, Manager $manager)
-    {
-        $this->entityMap = $entityMap;
-
-        $this->adapter = $adapter;
-
-        $this->dispatcher = $dispatcher;
-
-        $this->manager = $manager;
-
-        $this->cache = new EntityCache($entityMap);
-    }
-
-    /**
-     * Map results to a Collection.
-     *
-     * @param array|Collection $results
-     *
-     * @return Collection
-     */
-    public function map($results, array $eagerLoads = []) : Collection
-    {
-        $builder = new ResultBuilder($this);
-
-        if ($results instanceof collection) {
-            // Get underlying collection array
-            $results = $results->all();
-        }
-
-        if (!is_array($results)) {
-            throw new InvalidArgumentException("'results' should be an array or collection.");
-        }
-
-        // First, we'll cast every single result to array
-        $results = array_map(function ($item) {
-            return (array) $item;
-        }, $results);
-
-        // Then, we'll cache every single results as raw attributes, before
-        // adding relationships, which will be cached when the relationship's
-        // query takes place.
-        $this->getEntityCache()->add($results);
-
-        $entities = $builder->build($results, $eagerLoads);
-
-        return $this->entityMap->newCollection($entities);
-    }
-
-    /**
-     * Return all records for a mapped object.
-     *
-     * @return EntityCollection
-     */
-    public function all()
-    {
-        return $this->query()->get();
-    }
-
-    /**
-     * Persist an entity or an entity collection into the database.
-     *
-     * @param Mappable|\Traversable|array $entity
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return Mappable|\Traversable|array
-     */
-    public function store($entity)
-    {
-        if ($this->manager->isTraversable($entity)) {
-            return $this->storeCollection($entity);
-        } else {
-            return $this->storeEntity($entity);
-        }
-    }
-
-    /**
-     * Store an entity collection inside a single DB Transaction.
-     *
-     * @param \Traversable|array $entities
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return \Traversable|array
-     */
-    protected function storeCollection($entities)
-    {
-        $this->adapter->beginTransaction();
-
-        foreach ($entities as $entity) {
-            $this->storeEntity($entity);
-        }
-
-        $this->adapter->commit();
-
-        return $entities;
-    }
-
-    /**
-     * Store a single entity into the database.
-     *
-     * @param Mappable $entity
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Entity
-     */
-    protected function storeEntity($entity)
-    {   
-        $this->checkEntityType($entity);
-
-        $store = new Store($this->aggregate($entity), $this->newQueryBuilder());
-
-        return $store->execute();
-    }
-
-    /**
-     * Check that the entity correspond to the current mapper.
-     *
-     * @param mixed $entity
-     *
-     * @throws InvalidArgumentException
-     *
-     * @return void
-     */
-    protected function checkEntityType($entity)
-    {
-        if (get_class($entity) != $this->entityMap->getClass() && !is_subclass_of($entity, $this->entityMap->getClass())) {
-            $expected = $this->entityMap->getClass();
-            $actual = get_class($entity);
-            throw new InvalidArgumentException("Expected : $expected, got $actual.");
-        }
-    }
-
-    /**
-     * Convert an entity into an aggregate root.
-     *
-     * @param mixed $entity
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\System\Aggregate
-     */
-    protected function aggregate($entity)
-    {
-        return new Aggregate($entity);
-    }
-
-    /**
-     * Get a the Underlying QueryAdapter.
-     *
-     * @return \Analogue\ORM\Drivers\QueryAdapter
-     */
-    public function newQueryBuilder()
-    {
-        return $this->adapter->getQuery();
-    }
-
-    /**
-     * Delete an entity or an entity collection from the database.
-     *
-     * @param  Mappable|\Traversable|array
-     *
-     * @throws MappingException
-     * @throws \InvalidArgumentException
-     *
-     * @return \Traversable|array
-     */
-    public function delete($entity)
-    {
-        if ($this->manager->isTraversable($entity)) {
-            return $this->deleteCollection($entity);
-        } else {
-            $this->deleteEntity($entity);
-        }
-    }
-
-    /**
-     * Delete an Entity Collection inside a single db transaction.
-     *
-     * @param \Traversable|array $entities
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return \Traversable|array
-     */
-    protected function deleteCollection($entities)
-    {
-        $this->adapter->beginTransaction();
-
-        foreach ($entities as $entity) {
-            $this->deleteEntity($entity);
-        }
-
-        $this->adapter->commit();
-
-        return $entities;
-    }
-
-    /**
-     * Delete a single entity from the database.
-     *
-     * @param Mappable $entity
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return void
-     */
-    protected function deleteEntity($entity)
-    {
-        $this->checkEntityType($entity);
-
-        $delete = new Delete($this->aggregate($entity), $this->newQueryBuilder());
-
-        $delete->execute();
-    }
-
-    /**
-     * Return the entity map for this mapper.
-     *
-     * @return EntityMap
-     */
-    public function getEntityMap()
-    {
-        return $this->entityMap;
-    }
-
-    /**
-     * Get the entity cache for the current mapper.
-     *
-     * @return EntityCache $entityCache
-     */
-    public function getEntityCache()
-    {
-        return $this->cache;
-    }
-
-    /**
-     * Fire the given event for the entity.
-     *
-     * @param string               $event
-     * @param \Analogue\ORM\Entity $entity
-     * @param bool                 $halt
-     *
-     * @throws InvalidArgumentException
-     *
-     * @return mixed
-     */
-    public function fireEvent($event, $entity, $halt = true)
-    {
-        if ($entity instanceof Wrapper) {
-            throw new InvalidArgumentException('Fired Event with invalid Entity Object');
-        }
-
-        $event = "analogue.{$event}.".$this->entityMap->getClass();
-
-        $method = $halt ? 'until' : 'fire';
-
-        return $this->dispatcher->$method($event, $entity);
-    }
-
-    /**
-     * Register an entity event with the dispatcher.
-     *
-     * @param string   $event
-     * @param \Closure $callback
-     *
-     * @return void
-     */
-    public function registerEvent($event, $callback)
-    {
-        $name = $this->entityMap->getClass();
-
-        $this->dispatcher->listen("analogue.{$event}.{$name}", $callback);
-    }
-
-    /**
-     * Add a global scope to this mapper query builder.
-     *
-     * @param ScopeInterface $scope
-     *
-     * @return void
-     */
-    public function addGlobalScope(ScopeInterface $scope)
-    {
-        $this->globalScopes[get_class($scope)] = $scope;
-    }
-
-    /**
-     * Determine if the mapper has a global scope.
-     *
-     * @param \Analogue\ORM\System\ScopeInterface $scope
-     *
-     * @return bool
-     */
-    public function hasGlobalScope($scope)
-    {
-        return !is_null($this->getGlobalScope($scope));
-    }
-
-    /**
-     * Get a global scope registered with the modal.
-     *
-     * @param \Analogue\ORM\System\ScopeInterface $scope
-     *
-     * @return \Analogue\ORM\System\ScopeInterface|null
-     */
-    public function getGlobalScope($scope)
-    {
-        return array_first($this->globalScopes, function ($key, $value) use ($scope) {
-            return $scope instanceof $value;
-        });
-    }
-
-    /**
-     * Get a new query instance without a given scope.
-     *
-     * @param \Analogue\ORM\System\ScopeInterface $scope
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function newQueryWithoutScope($scope)
-    {
-        $this->getGlobalScope($scope)->remove($query = $this->getQuery(), $this);
-
-        return $query;
-    }
-
-    /**
-     * Get the Analogue Query Builder for this instance.
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function getQuery()
-    {
-        $query = new Query($this, $this->adapter);
-
-        return $this->applyGlobalScopes($query);
-    }
-
-    /**
-     * Apply all of the global scopes to an Analogue Query builder.
-     *
-     * @param Query $query
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function applyGlobalScopes($query)
-    {
-        foreach ($this->getGlobalScopes() as $scope) {
-            $scope->apply($query, $this);
-        }
-
-        return $query;
-    }
-
-    /**
-     * Get the global scopes for this class instance.
-     *
-     * @return \Analogue\ORM\System\ScopeInterface
-     */
-    public function getGlobalScopes()
-    {
-        return $this->globalScopes;
-    }
-
-    /**
-     * Add a dynamic method that extends the mapper/repository.
-     *
-     * @param string $command
-     */
-    public function addCustomCommand($command)
-    {
-        $name = lcfirst(class_basename($command));
-
-        $this->customCommands[$name] = $command;
-    }
-
-    /**
-     * Create a new instance of the mapped entity class.
-     *
-     * @return mixed
-     */
-    public function newInstance()
-    {
-        $class = $this->entityMap->getClass();
-
-        if ($this->entityMap->useDependencyInjection()) {
-            return $this->newInstanceUsingDependencyInjection($class);
-        }
-
-        return $this->newInstanceUsingInstantiator($class);
-    }
-
-    /**
-     * Return a new object instance using dependency injection.
-     *
-     * @param string $class
-     *
-     * @return mixed
-     */
-    protected function newInstanceUsingDependencyInjection($class)
-    {
-        if (!class_exists(Container::class)) {
-            throw new ErrorException("Illuminate\Container\Container is required to use Dependency Injection");
-        }
-
-        return Container::getInstance()->make($class);
-    }
-
-    /**
-     * Return a new object instance using doctrine's instantiator.
-     *
-     * @param string $class
-     *
-     * @return mixed
-     */
-    protected function newInstanceUsingInstantiator($class)
-    {
-        $instantiator = new \Doctrine\Instantiator\Instantiator();
-
-        return $instantiator->instantiate($class);
-    }
-
-    /**
-     * Get an unscoped Analogue Query Builder for this instance.
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function globalQuery()
-    {
-        return $this->newQueryWithoutScopes();
-    }
-
-    /**
-     * Get a new query builder that doesn't have any global scopes.
-     *
-     * @return Query
-     */
-    public function newQueryWithoutScopes()
-    {
-        return $this->removeGlobalScopes($this->getQuery());
-    }
-
-    /**
-     * Remove all of the global scopes from an Analogue Query builder.
-     *
-     * @param Query $query
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function removeGlobalScopes($query)
-    {
-        foreach ($this->getGlobalScopes() as $scope) {
-            $scope->remove($query, $this);
-        }
-
-        return $query;
-    }
-
-    /**
-     * Return the manager instance.
-     *
-     * @return \Analogue\ORM\System\Manager
-     */
-    public function getManager()
-    {
-        return $this->manager;
-    }
-
-    /**
-     * Dynamically handle calls to custom commands, or Redirects to query().
-     *
-     * @param string $method
-     * @param array  $parameters
-     *
-     * @throws \Exception
-     *
-     * @return mixed
-     */
-    public function __call($method, $parameters)
-    {
-        // Check if method is a custom command on the mapper
-        if ($this->hasCustomCommand($method)) {
-            if (count($parameters) == 0) {
-                throw new \Exception("$method must at least have 1 argument");
-            }
-
-            return $this->executeCustomCommand($method, $parameters[0]);
-        }
-
-        // Redirect call on a new query instance
-        return call_user_func_array([$this->query(), $method], $parameters);
-    }
-
-    /**
-     * Check if this mapper supports this command.
-     *
-     * @param string $command
-     *
-     * @return bool
-     */
-    public function hasCustomCommand($command)
-    {
-        return in_array($command, $this->getCustomCommands());
-    }
-
-    /**
-     * Get all the custom commands registered on this mapper.
-     *
-     * @return array
-     */
-    public function getCustomCommands()
-    {
-        return array_keys($this->customCommands);
-    }
-
-    /**
-     * Execute a custom command on an Entity.
-     *
-     * @param string                 $command
-     * @param mixed|Collection|array $entity
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return mixed
-     */
-    public function executeCustomCommand($command, $entity)
-    {
-        $commandClass = $this->customCommands[$command];
-
-        if ($this->manager->isTraversable($entity)) {
-            foreach ($entity as $instance) {
-                $this->executeSingleCustomCommand($commandClass, $instance);
-            }
-        } else {
-            return $this->executeSingleCustomCommand($commandClass, $entity);
-        }
-    }
-
-    /**
-     * Execute a single command instance.
-     *
-     * @param string $commandClass
-     * @param mixed  $entity
-     *
-     * @throws \InvalidArgumentException
-     * @throws MappingException
-     *
-     * @return mixed
-     */
-    protected function executeSingleCustomCommand($commandClass, $entity)
-    {
-        $this->checkEntityType($entity);
-
-        $instance = new $commandClass($this->aggregate($entity), $this->newQueryBuilder());
-
-        return $instance->execute();
-    }
-
-    /**
-     * Get the Analogue Query Builder for this instance.
-     *
-     * @return \Analogue\ORM\System\Query
-     */
-    public function query()
-    {
-        return $this->getQuery();
-    }
+	/**
+	 * The Manager instance.
+	 *
+	 * @var \Analogue\ORM\System\Manager
+	 */
+	protected $manager;
+
+	/**
+	 * Instance of EntityMapper Object.
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $entityMap;
+
+	/**
+	 * The instance of db adapter.
+	 *
+	 * @var \Analogue\ORM\Drivers\DBAdapter
+	 */
+	protected $adapter;
+
+	/**
+	 * Event dispatcher instance.
+	 *
+	 * @var \Illuminate\Contracts\Events\Dispatcher
+	 */
+	protected $dispatcher;
+
+	/**
+	 * Entity Cache.
+	 *
+	 * @var \Analogue\ORM\System\EntityCache
+	 */
+	protected $cache;
+
+	/**
+	 * Global scopes.
+	 *
+	 * @var array
+	 */
+	protected $globalScopes = [];
+
+	/**
+	 * Custom Commands.
+	 *
+	 * @var array
+	 */
+	protected $customCommands = [];
+
+	/**
+	 * @param EntityMap  $entityMap
+	 * @param DBAdapter  $adapter
+	 * @param Dispatcher $dispatcher
+	 * @param Manager    $manager
+	 */
+	public function __construct(EntityMap $entityMap, DBAdapter $adapter, Dispatcher $dispatcher, Manager $manager)
+	{
+		$this->entityMap = $entityMap;
+
+		$this->adapter = $adapter;
+
+		$this->dispatcher = $dispatcher;
+
+		$this->manager = $manager;
+
+		$this->cache = new EntityCache($entityMap);
+	}
+
+	/**
+	 * Map results to a Collection.
+	 *
+	 * @param array|Collection $results
+	 *
+	 * @return Collection
+	 */
+	public function map($results, array $eagerLoads = []) : Collection
+	{
+		$builder = new ResultBuilder($this);
+
+		if ($results instanceof collection) {
+			// Get underlying collection array
+			$results = $results->all();
+		}
+
+		if (!is_array($results)) {
+			throw new InvalidArgumentException("'results' should be an array or collection.");
+		}
+
+		// First, we'll cast every single result to array
+		$results = array_map(function ($item) {
+			return (array) $item;
+		}, $results);
+
+		// Then, we'll cache every single results as raw attributes, before
+		// adding relationships, which will be cached when the relationship's
+		// query takes place.
+		$this->getEntityCache()->add($results);
+
+		$entities = $builder->build($results, $eagerLoads);
+
+		return $this->entityMap->newCollection($entities);
+	}
+
+	/**
+	 * Return all records for a mapped object.
+	 *
+	 * @return EntityCollection
+	 */
+	public function all()
+	{
+		return $this->query()->get();
+	}
+
+	/**
+	 * Persist an entity or an entity collection into the database.
+	 *
+	 * @param Mappable|\Traversable|array $entity
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return Mappable|\Traversable|array
+	 */
+	public function store($entity)
+	{
+		if ($this->manager->isTraversable($entity)) {
+			return $this->storeCollection($entity);
+		} else {
+			return $this->storeEntity($entity);
+		}
+	}
+
+	/**
+	 * Store an entity collection inside a single DB Transaction.
+	 *
+	 * @param \Traversable|array $entities
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return \Traversable|array
+	 */
+	protected function storeCollection($entities)
+	{
+		$this->adapter->beginTransaction();
+
+		foreach ($entities as $entity) {
+			$this->storeEntity($entity);
+		}
+
+		$this->adapter->commit();
+
+		return $entities;
+	}
+
+	/**
+	 * Store a single entity into the database.
+	 *
+	 * @param Mappable $entity
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Entity
+	 */
+	protected function storeEntity($entity)
+	{   
+		$this->checkEntityType($entity);
+
+		$store = new Store($this->aggregate($entity), $this->newQueryBuilder());
+
+		return $store->execute();
+	}
+
+	/**
+	 * Check that the entity correspond to the current mapper.
+	 *
+	 * @param mixed $entity
+	 *
+	 * @throws InvalidArgumentException
+	 *
+	 * @return void
+	 */
+	protected function checkEntityType($entity)
+	{
+		if (get_class($entity) != $this->entityMap->getClass() && !is_subclass_of($entity, $this->entityMap->getClass())) {
+			$expected = $this->entityMap->getClass();
+			$actual = get_class($entity);
+			throw new InvalidArgumentException("Expected : $expected, got $actual.");
+		}
+	}
+
+	/**
+	 * Convert an entity into an aggregate root.
+	 *
+	 * @param mixed $entity
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\System\Aggregate
+	 */
+	protected function aggregate($entity)
+	{
+		return new Aggregate($entity);
+	}
+
+	/**
+	 * Get a the Underlying QueryAdapter.
+	 *
+	 * @return \Analogue\ORM\Drivers\QueryAdapter
+	 */
+	public function newQueryBuilder()
+	{
+		return $this->adapter->getQuery();
+	}
+
+	/**
+	 * Delete an entity or an entity collection from the database.
+	 *
+	 * @param  Mappable|\Traversable|array
+	 *
+	 * @throws MappingException
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return \Traversable|array
+	 */
+	public function delete($entity)
+	{
+		if ($this->manager->isTraversable($entity)) {
+			return $this->deleteCollection($entity);
+		} else {
+			$this->deleteEntity($entity);
+		}
+	}
+
+	/**
+	 * Delete an Entity Collection inside a single db transaction.
+	 *
+	 * @param \Traversable|array $entities
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return \Traversable|array
+	 */
+	protected function deleteCollection($entities)
+	{
+		$this->adapter->beginTransaction();
+
+		foreach ($entities as $entity) {
+			$this->deleteEntity($entity);
+		}
+
+		$this->adapter->commit();
+
+		return $entities;
+	}
+
+	/**
+	 * Delete a single entity from the database.
+	 *
+	 * @param Mappable $entity
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return void
+	 */
+	protected function deleteEntity($entity)
+	{
+		$this->checkEntityType($entity);
+
+		$delete = new Delete($this->aggregate($entity), $this->newQueryBuilder());
+
+		$delete->execute();
+	}
+
+	/**
+	 * Return the entity map for this mapper.
+	 *
+	 * @return EntityMap
+	 */
+	public function getEntityMap()
+	{
+		return $this->entityMap;
+	}
+
+	/**
+	 * Get the entity cache for the current mapper.
+	 *
+	 * @return EntityCache $entityCache
+	 */
+	public function getEntityCache()
+	{
+		return $this->cache;
+	}
+
+	/**
+	 * Fire the given event for the entity.
+	 *
+	 * @param string               $event
+	 * @param \Analogue\ORM\Entity $entity
+	 * @param bool                 $halt
+	 *
+	 * @throws InvalidArgumentException
+	 *
+	 * @return mixed
+	 */
+	public function fireEvent($event, $entity, $halt = true)
+	{
+		if ($entity instanceof Wrapper) {
+			throw new InvalidArgumentException('Fired Event with invalid Entity Object');
+		}
+
+		$event = "analogue.{$event}.".$this->entityMap->getClass();
+
+		$method = $halt ? 'until' : 'fire';
+
+		return $this->dispatcher->$method($event, $entity);
+	}
+
+	/**
+	 * Register an entity event with the dispatcher.
+	 *
+	 * @param string   $event
+	 * @param \Closure $callback
+	 *
+	 * @return void
+	 */
+	public function registerEvent($event, $callback)
+	{
+		$name = $this->entityMap->getClass();
+
+		$this->dispatcher->listen("analogue.{$event}.{$name}", $callback);
+	}
+
+	/**
+	 * Add a global scope to this mapper query builder.
+	 *
+	 * @param ScopeInterface $scope
+	 *
+	 * @return void
+	 */
+	public function addGlobalScope(ScopeInterface $scope)
+	{
+		$this->globalScopes[get_class($scope)] = $scope;
+	}
+
+	/**
+	 * Determine if the mapper has a global scope.
+	 *
+	 * @param \Analogue\ORM\System\ScopeInterface $scope
+	 *
+	 * @return bool
+	 */
+	public function hasGlobalScope($scope)
+	{
+		return !is_null($this->getGlobalScope($scope));
+	}
+
+	/**
+	 * Get a global scope registered with the modal.
+	 *
+	 * @param \Analogue\ORM\System\ScopeInterface $scope
+	 *
+	 * @return \Analogue\ORM\System\ScopeInterface|null
+	 */
+	public function getGlobalScope($scope)
+	{
+		return array_first($this->globalScopes, function ($key, $value) use ($scope) {
+			return $scope instanceof $value;
+		});
+	}
+
+	/**
+	 * Get a new query instance without a given scope.
+	 *
+	 * @param \Analogue\ORM\System\ScopeInterface $scope
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function newQueryWithoutScope($scope)
+	{
+		$this->getGlobalScope($scope)->remove($query = $this->getQuery(), $this);
+
+		return $query;
+	}
+
+	/**
+	 * Get the Analogue Query Builder for this instance.
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function getQuery()
+	{
+		$query = new Query($this, $this->adapter);
+
+		return $this->applyGlobalScopes($query);
+	}
+
+	/**
+	 * Apply all of the global scopes to an Analogue Query builder.
+	 *
+	 * @param Query $query
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function applyGlobalScopes($query)
+	{
+		foreach ($this->getGlobalScopes() as $scope) {
+			$scope->apply($query, $this);
+		}
+
+		return $query;
+	}
+
+	/**
+	 * Get the global scopes for this class instance.
+	 *
+	 * @return \Analogue\ORM\System\ScopeInterface
+	 */
+	public function getGlobalScopes()
+	{
+		return $this->globalScopes;
+	}
+
+	/**
+	 * Add a dynamic method that extends the mapper/repository.
+	 *
+	 * @param string $command
+	 */
+	public function addCustomCommand($command)
+	{
+		$name = lcfirst(class_basename($command));
+
+		$this->customCommands[$name] = $command;
+	}
+
+	/**
+	 * Create a new instance of the mapped entity class.
+	 *
+	 * @return mixed
+	 */
+	public function newInstance()
+	{
+		$class = $this->entityMap->getClass();
+
+		if ($this->entityMap->useDependencyInjection()) {
+			return $this->newInstanceUsingDependencyInjection($class);
+		}
+
+		return $this->newInstanceUsingInstantiator($class);
+	}
+
+	/**
+	 * Return a new object instance using dependency injection.
+	 *
+	 * @param string $class
+	 *
+	 * @return mixed
+	 */
+	protected function newInstanceUsingDependencyInjection($class)
+	{
+		if (!class_exists(Container::class)) {
+			throw new ErrorException("Illuminate\Container\Container is required to use Dependency Injection");
+		}
+
+		return Container::getInstance()->make($class);
+	}
+
+	/**
+	 * Return a new object instance using doctrine's instantiator.
+	 *
+	 * @param string $class
+	 *
+	 * @return mixed
+	 */
+	protected function newInstanceUsingInstantiator($class)
+	{
+		$instantiator = new \Doctrine\Instantiator\Instantiator();
+
+		return $instantiator->instantiate($class);
+	}
+
+	/**
+	 * Get an unscoped Analogue Query Builder for this instance.
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function globalQuery()
+	{
+		return $this->newQueryWithoutScopes();
+	}
+
+	/**
+	 * Get a new query builder that doesn't have any global scopes.
+	 *
+	 * @return Query
+	 */
+	public function newQueryWithoutScopes()
+	{
+		return $this->removeGlobalScopes($this->getQuery());
+	}
+
+	/**
+	 * Remove all of the global scopes from an Analogue Query builder.
+	 *
+	 * @param Query $query
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function removeGlobalScopes($query)
+	{
+		foreach ($this->getGlobalScopes() as $scope) {
+			$scope->remove($query, $this);
+		}
+
+		return $query;
+	}
+
+	/**
+	 * Return the manager instance.
+	 *
+	 * @return \Analogue\ORM\System\Manager
+	 */
+	public function getManager()
+	{
+		return $this->manager;
+	}
+
+	/**
+	 * Dynamically handle calls to custom commands, or Redirects to query().
+	 *
+	 * @param string $method
+	 * @param array  $parameters
+	 *
+	 * @throws \Exception
+	 *
+	 * @return mixed
+	 */
+	public function __call($method, $parameters)
+	{
+		// Check if method is a custom command on the mapper
+		if ($this->hasCustomCommand($method)) {
+			if (count($parameters) == 0) {
+				throw new \Exception("$method must at least have 1 argument");
+			}
+
+			return $this->executeCustomCommand($method, $parameters[0]);
+		}
+
+		// Redirect call on a new query instance
+		return call_user_func_array([$this->query(), $method], $parameters);
+	}
+
+	/**
+	 * Check if this mapper supports this command.
+	 *
+	 * @param string $command
+	 *
+	 * @return bool
+	 */
+	public function hasCustomCommand($command)
+	{
+		return in_array($command, $this->getCustomCommands());
+	}
+
+	/**
+	 * Get all the custom commands registered on this mapper.
+	 *
+	 * @return array
+	 */
+	public function getCustomCommands()
+	{
+		return array_keys($this->customCommands);
+	}
+
+	/**
+	 * Execute a custom command on an Entity.
+	 *
+	 * @param string                 $command
+	 * @param mixed|Collection|array $entity
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return mixed
+	 */
+	public function executeCustomCommand($command, $entity)
+	{
+		$commandClass = $this->customCommands[$command];
+
+		if ($this->manager->isTraversable($entity)) {
+			foreach ($entity as $instance) {
+				$this->executeSingleCustomCommand($commandClass, $instance);
+			}
+		} else {
+			return $this->executeSingleCustomCommand($commandClass, $entity);
+		}
+	}
+
+	/**
+	 * Execute a single command instance.
+	 *
+	 * @param string $commandClass
+	 * @param mixed  $entity
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws MappingException
+	 *
+	 * @return mixed
+	 */
+	protected function executeSingleCustomCommand($commandClass, $entity)
+	{
+		$this->checkEntityType($entity);
+
+		$instance = new $commandClass($this->aggregate($entity), $this->newQueryBuilder());
+
+		return $instance->execute();
+	}
+
+	/**
+	 * Get the Analogue Query Builder for this instance.
+	 *
+	 * @return \Analogue\ORM\System\Query
+	 */
+	public function query()
+	{
+		return $this->getQuery();
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -114,7 +114,7 @@ 
         }
 
         // First, we'll cast every single result to array
-        $results = array_map(function ($item) {
+        $results = array_map(function($item) {
             return (array) $item;
         }, $results);
 
@@ -394,7 +394,7 @@ 
      */
     public function getGlobalScope($scope)
     {
-        return array_first($this->globalScopes, function ($key, $value) use ($scope) {
+        return array_first($this->globalScopes, function($key, $value) use ($scope) {
             return $scope instanceof $value;
         });
     }

src/System/Proxies/CollectionProxy.php

Indentation +1310 added lines, -1310 removed lines

@@ -9,1314 +9,1314 @@
 
 class CollectionProxy extends EntityCollection implements ProxyInterface
 {
-    /**
-     * Indicate if the relationship has been lazy loaded.
-     *
-     * @var bool
-     */
-    protected $relationshipLoaded = false;
-
-    protected $addedItems = [];
-
-    /**
-     * Create a new collection.
-     *
-     * @param mixed  $entity
-     * @param string $relation
-     *
-     * @return void
-     */
-    public function __construct($entity, $relation)
-    {
-        $this->parentEntity = $entity;
-        $this->relationshipMethod = $relation;
-    }
-
-    /**
-     * Return Items that has been added without lady loading
-     * the underlying collection.
-     *
-     * @return array
-     */
-    public function getAddedItems()
-    {
-        return $this->addedItems;
-    }
-
-    /**
-     * Force initialization of the proxy.
-     *
-     * @return bool true if the proxy could be initialized
-     */
-    public function initializeProxy() : bool
-    {
-        if ($this->isProxyInitialized()) {
-            return true;
-        }
-
-        $relation = $this->relationshipMethod;
-        $entity = $this->parentEntity;
-
-        $entityMap = Manager::getMapper($entity)->getEntityMap();
-
-        $this->items = $entityMap->$relation($entity)->getResults($relation)->all() + $this->addedItems;
-
-        $this->relationshipLoaded = true;
-
-        return true;
-    }
-
-    /**
-     * Retrieves current initialization status of the proxy.
-     *
-     * @return bool
-     */
-    public function isProxyInitialized() : bool
-    {
-        return $this->relationshipLoaded;
-    }
-
-    /**
-     * Get all of the items in the collection.
-     *
-     * @return array
-     */
-    public function all()
-    {
-        $this->initializeProxy();
-
-        return parent::all();
-    }
-
-    /**
-     * Get the average value of a given key.
-     *
-     * @param callable|string|null $callback
-     *
-     * @return mixed
-     */
-    public function avg($callback = null)
-    {
-        $this->initializeProxy();
-
-        return parent::avg($callback);
-    }
-
-    /**
-     * Get the median of a given key.
-     *
-     * @param null $key
-     *
-     * @return mixed|null
-     */
-    public function median($key = null)
-    {
-        $this->initializeProxy();
-
-        return parent::median($key);
-    }
-
-    /**
-     * Get the mode of a given key.
-     *
-     * @param mixed $key
-     *
-     * @return array
-     */
-    public function mode($key = null)
-    {
-        $this->initializeProxy();
-
-        return parent::mode($key);
-    }
-
-    /**
-     * Collapse the collection of items into a single array.
-     *
-     * @return static
-     */
-    public function collapse()
-    {
-        $this->initializeProxy();
-
-        return parent::collapse();
-    }
-
-    /**
-     * Determine if an item exists in the collection.
-     *
-     * @param mixed $key
-     * @param mixed $value
-     *
-     * @return bool
-     */
-    public function contains($key, $operator = null, $value = null)
-    {
-        $this->initializeProxy();
-
-        return parent::contains($key, $operator, $value);
-    }
-
-    /**
-     * Determine if an item exists in the collection using strict comparison.
-     *
-     * @param mixed $key
-     * @param mixed $value
-     *
-     * @return bool
-     */
-    public function containsStrict($key, $value = null)
-    {
-        $this->initializeProxy();
-
-        return parent::containsStrict($key, $value);
-    }
-
-    /**
-     * Get the items in the collection that are not present in the given items.
-     *
-     * @param mixed $items
-     *
-     * @return static
-     */
-    public function diff($items)
-    {
-        $this->initializeProxy();
-
-        return parent::diff($items);
-    }
-
-    /**
-     * Get the items in the collection whose keys are not present in the given items.
-     *
-     * @param mixed $items
-     *
-     * @return static
-     */
-    public function diffKeys($items)
-    {
-        $this->initializeProxy();
-
-        return parent::diffKeys($items);
-    }
-
-    /**
-     * Execute a callback over each item.
-     *
-     * @param callable $callback
-     *
-     * @return $this
-     */
-    public function each(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::each($callback);
-    }
-
-    /**
-     * Create a new collection consisting of every n-th element.
-     *
-     * @param int $step
-     * @param int $offset
-     *
-     * @return static
-     */
-    public function every($key, $operator = null, $value = null)
-    {
-        $this->initializeProxy();
-
-        return parent::every($key, $operator, $value);
-    }
-
-    /**
-     * Get all items except for those with the specified keys.
-     *
-     * @param mixed $keys
-     *
-     * @return static
-     */
-    public function except($keys)
-    {
-        $this->initializeProxy();
-
-        return parent::except($keys);
-    }
-
-    /**
-     * Run a filter over each of the items.
-     *
-     * @param callable|null $callback
-     *
-     * @return static
-     */
-    public function filter(callable $callback = null)
-    {
-        $this->initializeProxy();
-
-        return parent::filter($callback);
-    }
-
-    /**
-     * Filter items by the given key value pair.
-     *
-     * @param string $key
-     * @param mixed  $operator
-     * @param mixed  $value
-     *
-     * @return static
-     */
-    public function where($key, $operator, $value = null)
-    {
-        $this->initializeProxy();
-
-        return parent::where($key, $operator, $value);
-    }
-
-    /**
-     * Filter items by the given key value pair using strict comparison.
-     *
-     * @param string $key
-     * @param mixed  $value
-     *
-     * @return static
-     */
-    public function whereStrict($key, $value)
-    {
-        $this->initializeProxy();
-
-        return parent::whereStrict($key, $value);
-    }
-
-    /**
-     * Filter items by the given key value pair.
-     *
-     * @param string $key
-     * @param mixed  $values
-     * @param bool   $strict
-     *
-     * @return static
-     */
-    public function whereIn($key, $values, $strict = false)
-    {
-        $this->initializeProxy();
-
-        return parent::whereIn($key, $values, $strict);
-    }
-
-    /**
-     * Filter items by the given key value pair using strict comparison.
-     *
-     * @param string $key
-     * @param mixed  $values
-     *
-     * @return static
-     */
-    public function whereInStrict($key, $values)
-    {
-        $this->initializeProxy();
-
-        return parent::whereInStrict($key, $values);
-    }
-
-    /**
-     * Get the first item from the collection.
-     *
-     * @param callable|null $callback
-     * @param mixed         $default
-     *
-     * @return mixed
-     */
-    public function first(callable $callback = null, $default = null)
-    {
-        // TODO Consider partial loading
-        $this->initializeProxy();
-
-        return parent::first($callback, $default);
-    }
-
-    /**
-     * Get a flattened array of the items in the collection.
-     *
-     * @param int $depth
-     *
-     * @return static
-     */
-    public function flatten($depth = INF)
-    {
-        $this->initializeProxy();
-
-        return parent::flatten($depth);
-    }
-
-    /**
-     * Flip the items in the collection.
-     *
-     * @return static
-     */
-    public function flip()
-    {
-        $this->initializeProxy();
-
-        return parent::flip();
-    }
-
-    /**
-     * Remove an item from the collection by key.
-     *
-     * @param string|array $keys
-     *
-     * @return $this
-     */
-    public function forget($keys)
-    {
-        // TODO, we could consider these as
-        // 'pending deletion', the same way that
-        // we treat added items
-        $this->initializeProxy();
-
-        return parent::forget($keys);
-    }
-
-    /**
-     * Get an item from the collection by key.
-     *
-     * @param mixed $key
-     * @param mixed $default
-     *
-     * @return mixed
-     */
-    public function get($key, $default = null)
-    {
-        // TODO : We could also consider partial loading
-        // here
-        $this->initializeProxy();
-
-        return parent::get($key, $default);
-    }
-
-    /**
-     * Group an associative array by a field or using a callback.
-     *
-     * @param callable|string $groupBy
-     * @param bool            $preserveKeys
-     *
-     * @return static
-     */
-    public function groupBy($groupBy, $preserveKeys = false)
-    {
-        $this->initializeProxy();
-
-        return parent::groupBy($groupBy, $preserveKeys);
-    }
-
-    /**
-     * Key an associative array by a field or using a callback.
-     *
-     * @param callable|string $keyBy
-     *
-     * @return static
-     */
-    public function keyBy($keyBy)
-    {
-        $this->initializeProxy();
-
-        return parent::keyBy($keyBy);
-    }
-
-    /**
-     * Determine if an item exists in the collection by key.
-     *
-     * @param mixed $key
-     *
-     * @return bool
-     */
-    public function has($key)
-    {
-        // TODO : we could do automagic here by directly
-        // calling the database if the collection hasn't
-        // been initialized yet.
-        // Potential issue is that several calls to this
-        // could cause a lot queries vs a single get query.
-        $this->initializeProxy();
-
-        return parent::has($key);
-    }
-
-    /**
-     * Concatenate values of a given key as a string.
-     *
-     * @param string $value
-     * @param string $glue
-     *
-     * @return string
-     */
-    public function implode($value, $glue = null)
-    {
-        $this->initializeProxy();
-
-        return parent::implode($value, $glue);
-    }
-
-    /**
-     * Intersect the collection with the given items.
-     *
-     * @param mixed $items
-     *
-     * @return static
-     */
-    public function intersect($items)
-    {
-        $this->initializeProxy();
-
-        return parent::intersect($items);
-    }
-
-    /**
-     * Determine if the collection is empty or not.
-     *
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        $this->initializeProxy();
-
-        return parent::isEmpty();
-    }
-
-    /**
-     * Get the keys of the collection items.
-     *
-     * @return static
-     */
-    public function keys()
-    {
-        $this->initializeProxy();
-
-        return parent::keys();
-    }
-
-    /**
-     * Get the last item from the collection.
-     *
-     * @param callable|null $callback
-     * @param mixed         $default
-     *
-     * @return mixed
-     */
-    public function last(callable $callback = null, $default = null)
-    {
-        // TODO : we could do partial loading there as well
-        $this->initializeProxy();
-
-        return parent::last($callback, $default);
-    }
-
-    /**
-     * Get the values of a given key.
-     *
-     * @param string      $value
-     * @param string|null $key
-     *
-     * @return static
-     */
-    public function pluck($value, $key = null)
-    {
-        // TODO : automagic call to QB if not initialized
-        $this->initializeProxy();
-
-        return parent::pluck($value, $key);
-    }
-
-    /**
-     * Run a map over each of the items.
-     *
-     * @param callable $callback
-     *
-     * @return static
-     */
-    public function map(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::map($callback);
-    }
-
-    /**
-     * Run an associative map over each of the items.
-     *
-     * The callback should return an associative array with a single key/value pair.
-     *
-     * @param callable $callback
-     *
-     * @return static
-     */
-    public function mapWithKeys(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::mapWithKeys($callback);
-    }
-
-    /**
-     * Map a collection and flatten the result by a single level.
-     *
-     * @param callable $callback
-     *
-     * @return static
-     */
-    public function flatMap(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::flatMap($callback);
-    }
-
-    /**
-     * Get the max value of a given key.
-     *
-     * @param callable|string|null $callback
-     *
-     * @return mixed
-     */
-    public function max($callback = null)
-    {
-        $this->initializeProxy();
-
-        return parent::max($callback);
-    }
-
-    /**
-     * Merge the collection with the given items.
-     *
-     * @param mixed $items
-     *
-     * @return static
-     */
-    public function merge($items)
-    {
-        // TODO : Check if the EntityCollection
-        // returns a native Collection, as it
-        // is what we want here
-        $this->initializeProxy();
-
-        return parent::merge($items);
-    }
-
-    /**
-     * Create a collection by using this collection for keys and another for its values.
-     *
-     * @param mixed $values
-     *
-     * @return static
-     */
-    public function combine($values)
-    {
-        // TODO : Check if the EntityCollection
-        // returns a native Collection, as it
-        // is what we want here
-        $this->initializeProxy();
-
-        return parent::combine($values);
-    }
-
-    /**
-     * Union the collection with the given items.
-     *
-     * @param mixed $items
-     *
-     * @return static
-     */
-    public function union($items)
-    {
-        // TODO : Check if the EntityCollection
-        // returns a native Collection, as it
-        // is what we want here
-        $this->initializeProxy();
-
-        return parent::union($items);
-    }
-
-    /**
-     * Get the min value of a given key.
-     *
-     * @param callable|string|null $callback
-     *
-     * @return mixed
-     */
-    public function min($callback = null)
-    {
-        // TODO : we could rely on the QB
-        // for thos, if initialization has not
-        // take place yet
-        $this->initializeProxy();
-
-        return parent::min($callback);
-    }
-
-    /**
-     * Create a new collection consisting of every n-th element.
-     *
-     * @param int $step
-     * @param int $offset
-     *
-     * @return static
-     */
-    public function nth($step, $offset = 0)
-    {
-        $this->initializeProxy();
-
-        return parent::nth($step, $offset);
-    }
-
-    /**
-     * Get the items with the specified keys.
-     *
-     * @param mixed $keys
-     *
-     * @return static
-     */
-    public function only($keys)
-    {
-        // TODO : we could rely on the QB if
-        // the collection hasn't been initialized yet
-        $this->initializeProxy();
-
-        return parent::only($keys);
-    }
-
-    /**
-     * "Paginate" the collection by slicing it into a smaller collection.
-     *
-     * @param int $page
-     * @param int $perPage
-     *
-     * @return static
-     */
-    public function forPage($page, $perPage)
-    {
-        // TODO : check possibility of partial loading
-        // if not initialized
-        $this->initializeProxy();
-
-        return parent::forPage($page, $perPage);
-    }
-
-    /**
-     * Partition the collection into two arrays using the given callback or key.
-     *
-     * @param callable|string $callback
-     *
-     * @return static
-     */
-    public function partition($callback)
-    {
-        $this->initializeProxy();
-
-        return parent::partition($callback);
-    }
-
-    /**
-     * Pass the collection to the given callback and return the result.
-     *
-     * @param callable $callback
-     *
-     * @return mixed
-     */
-    public function pipe(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::pipe($callback);
-    }
-
-    /**
-     * Get and remove the last item from the collection.
-     *
-     * @return mixed
-     */
-    public function pop()
-    {
-        $this->initializeProxy();
-
-        return parent::pop();
-    }
-
-    /**
-     * Push an item onto the beginning of the collection.
-     *
-     * @param mixed $value
-     * @param mixed $key
-     *
-     * @return $this
-     */
-    public function prepend($value, $key = null)
-    {
-        // TODO : partial adding of values.
-        // we could have a $prepended , and $pushed arrays
-        // which we would combine at full initialization
-
-        $this->initializeProxy();
-
-        return parent::prepend($value, $key);
-    }
-
-    /**
-     * Push an item onto the end of the collection.
-     *
-     * @param mixed $value
-     *
-     * @return $this
-     */
-    public function push($value)
-    {
-        // TODO : partial adding of values.
-        // we could have a $prepended , and $pushed arrays
-        // which we would combine at full initialization
-
-        $this->initializeProxy();
-
-        return parent::push($value);
-    }
-
-    /**
-     * Get and remove an item from the collection.
-     *
-     * @param mixed $key
-     * @param mixed $default
-     *
-     * @return mixed
-     */
-    public function pull($key, $default = null)
-    {
-        // TODO : QB query if the collection
-        // hasn't been initialized yet
-
-        $this->initializeProxy();
-
-        return parent::pull($key, $default);
-    }
-
-    /**
-     * Put an item in the collection by key.
-     *
-     * @param mixed $key
-     * @param mixed $value
-     *
-     * @return $this
-     */
-    public function put($key, $value)
-    {
-        // TODO : Partial loading ?
-
-        $this->initializeProxy();
-
-        return parent::put($key, $value);
-    }
-
-    /**
-     * Get one or more items randomly from the collection.
-     *
-     * @param int $amount
-     *
-     * @throws \InvalidArgumentException
-     *
-     * @return mixed
-     */
-    public function random($amount = 1)
-    {
-        // TODO : we could optimize this by only
-        // fetching the keys from the database
-        // and performing partial loading
-
-        $this->initializeProxy();
-
-        return parent::random($amount);
-    }
-
-    /**
-     * Reduce the collection to a single value.
-     *
-     * @param callable $callback
-     * @param mixed    $initial
-     *
-     * @return mixed
-     */
-    public function reduce(callable $callback, $initial = null)
-    {
-        $this->initializeProxy();
-
-        return parent::reduce($callback, $initial);
-    }
-
-    /**
-     * Create a collection of all elements that do not pass a given truth test.
-     *
-     * @param callable|mixed $callback
-     *
-     * @return static
-     */
-    public function reject($callback)
-    {
-        $this->initializeProxy();
-
-        return parent::reject($callback);
-    }
-
-    /**
-     * Reverse items order.
-     *
-     * @return static
-     */
-    public function reverse()
-    {
-        $this->initializeProxy();
-
-        return parent::reverse();
-    }
-
-    /**
-     * Search the collection for a given value and return the corresponding key if successful.
-     *
-     * @param mixed $value
-     * @param bool  $strict
-     *
-     * @return mixed
-     */
-    public function search($value, $strict = false)
-    {
-        $this->initializeProxy();
-
-        return parent::search($value, $strict);
-    }
-
-    /**
-     * Get and remove the first item from the collection.
-     *
-     * @return mixed
-     */
-    public function shift()
-    {
-        // Todo : Partial Removing
-        // we could have a pending removal array
-        $this->initializeProxy();
-
-        return parent::shift();
-    }
-
-    /**
-     * Shuffle the items in the collection.
-     *
-     * @param int $seed
-     *
-     * @return static
-     */
-    public function shuffle($seed = null)
-    {
-        $this->initializeProxy();
-
-        return parent::shuffle($seed);
-    }
-
-    /**
-     * Slice the underlying collection array.
-     *
-     * @param int $offset
-     * @param int $length
-     *
-     * @return static
-     */
-    public function slice($offset, $length = null)
-    {
-        $this->initializeProxy();
-
-        return parent::slice($offset, $length);
-    }
-
-    /**
-     * Split a collection into a certain number of groups.
-     *
-     * @param int $numberOfGroups
-     *
-     * @return static
-     */
-    public function split($numberOfGroups)
-    {
-        $this->initializeProxy();
-
-        return parent::split($numberOfGroups);
-    }
-
-    /**
-     * Chunk the underlying collection array.
-     *
-     * @param int $size
-     *
-     * @return static
-     */
-    public function chunk($size)
-    {
-        // TODO : partial loading ?
-        $this->initializeProxy();
-
-        return parent::chunk($size);
-    }
-
-    /**
-     * Sort through each item with a callback.
-     *
-     * @param callable|null $callback
-     *
-     * @return static
-     */
-    public function sort(callable $callback = null)
-    {
-        $this->initializeProxy();
-
-        return parent::sort($callback);
-    }
-
-    /**
-     * Sort the collection using the given callback.
-     *
-     * @param callable|string $callback
-     * @param int             $options
-     * @param bool            $descending
-     *
-     * @return static
-     */
-    public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
-    {
-        $this->initializeProxy();
-
-        return parent::sort($callback, $options, $descending);
-    }
-
-    /**
-     * Splice a portion of the underlying collection array.
-     *
-     * @param int      $offset
-     * @param int|null $length
-     * @param mixed    $replacement
-     *
-     * @return static
-     */
-    public function splice($offset, $length = null, $replacement = [])
-    {
-        $this->initializeProxy();
-
-        return parent::splice($offset, $length, $replacement);
-    }
-
-    /**
-     * Get the sum of the given values.
-     *
-     * @param callable|string|null $callback
-     *
-     * @return mixed
-     */
-    public function sum($callback = null)
-    {
-        $this->initializeProxy();
-
-        return parent::sum($callback);
-    }
-
-    /**
-     * Take the first or last {$limit} items.
-     *
-     * @param int $limit
-     *
-     * @return static
-     */
-    public function take($limit)
-    {
-        // TODO: partial loading
-        $this->initializeProxy();
-
-        return parent::take($limit);
-    }
-
-    /**
-     * Pass the collection to the given callback and then return it.
-     *
-     * @param callable $callback
-     *
-     * @return $this
-     */
-    public function tap(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::tap($this);
-    }
-
-    /**
-     * Transform each item in the collection using a callback.
-     *
-     * @param callable $callback
-     *
-     * @return $this
-     */
-    public function transform(callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::transform($callback);
-    }
-
-    /**
-     * Return only unique items from the collection array.
-     *
-     * @param string|callable|null $key
-     * @param bool                 $strict
-     *
-     * @return static
-     */
-    public function unique($key = null, $strict = false)
-    {
-        $this->initializeProxy();
-
-        return parent::unique($key, $strict);
-    }
-
-    /**
-     * Reset the keys on the underlying array.
-     *
-     * @return static
-     */
-    public function values()
-    {
-        $this->initializeProxy();
-
-        return parent::values();
-    }
-
-    /**
-     * Apply the callback if the value is truthy.
-     *
-     * @param  bool  $value
-     * @param  callable  $callback
-     * @return mixed
-     */
-    public function when($value, callable $callback)
-    {
-        $this->initializeProxy();
-
-        return parent::when($value, $callback);
-    }
-
-    /**
-     * Zip the collection together with one or more arrays.
-     *
-     * e.g. new Collection([1, 2, 3])->zip([4, 5, 6]);
-     *      => [[1, 4], [2, 5], [3, 6]]
-     *
-     * @param mixed ...$items
-     *
-     * @return static
-     */
-    public function zip($items)
-    {
-        $this->initializeProxy();
-
-        return parent::zip($items);
-    }
-
-    /**
-     * Get the collection of items as a plain array.
-     *
-     * @return array
-     */
-    public function toArray()
-    {
-        // If this is called on all subsequent proxy,
-        // this would eventually trigger all lazy loading,
-        // which is NOT what we would expect...
-        // TODO : must think of this.
-        $this->initializeProxy();
-
-        return parent::toArray();
-    }
-
-    /**
-     * Convert the object into something JSON serializable.
-     *
-     * @return array
-     */
-    public function jsonSerialize()
-    {
-        // If this is called on all subsequent proxy,
-        // this would eventually trigger all lazy loading,
-        // which is NOT what we would expect...
-        // TODO : must think of this.
-        $this->initializeProxy();
-
-        return parent::jsonSerialize();
-    }
-
-    /**
-     * Get the collection of items as JSON.
-     *
-     * @param int $options
-     *
-     * @return string
-     */
-    public function toJson($options = 0)
-    {
-        // If this is called on all subsequent proxy,
-        // this would eventually trigger all lazy loading,
-        // which is NOT what we would expect...
-        // TODO : must think of this.
-        $this->initializeProxy();
-
-        return parent::toJson($options);
-    }
-
-    /**
-     * Get an iterator for the items.
-     *
-     * @return \ArrayIterator
-     */
-    public function getIterator()
-    {
-        $this->initializeProxy();
-
-        return parent::getIterator();
-    }
-
-    /**
-     * Get a CachingIterator instance.
-     *
-     * @param int $flags
-     *
-     * @return \CachingIterator
-     */
-    public function getCachingIterator($flags = CachingIterator::CALL_TOSTRING)
-    {
-        $this->initializeProxy();
-
-        return parent::getCachingIterator($flags);
-    }
-
-    /**
-     * Count the number of items in the collection.
-     *
-     * @return int
-     */
-    public function count()
-    {
-        // TODO rely on QB if not initialized
-        $this->initializeProxy();
-
-        return parent::count();
-    }
-
-    /**
-     * Get a base Support collection instance from this collection.
-     *
-     * @return \Illuminate\Support\Collection
-     */
-    public function toBase()
-    {
-        $this->initializeProxy();
-
-        return parent::toBase();
-    }
-
-    /**
-     * Determine if an item exists at an offset.
-     *
-     * @param mixed $key
-     *
-     * @return bool
-     */
-    public function offsetExists($key)
-    {
-        // TODO rely on QB if no collection
-        // initialized
-        $this->initializeProxy();
-
-        return parent::offsetExists($key);
-    }
-
-    /**
-     * Get an item at a given offset.
-     *
-     * @param mixed $key
-     *
-     * @return mixed
-     */
-    public function offsetGet($key)
-    {
-        // TODO rely on partial init if no collection
-        // initialized
-        $this->initializeProxy();
-
-        return parent::offsetGet($key);
-    }
-
-    /**
-     * Set the item at a given offset.
-     *
-     * @param mixed $key
-     * @param mixed $value
-     *
-     * @return void
-     */
-    public function offsetSet($key, $value)
-    {
-        // TODO : think of the use of it into a ProxyCollection
-        // context
-        $this->initializeProxy();
-
-        return parent::offsetSet($key, $value);
-    }
-
-    /**
-     * Unset the item at a given offset.
-     *
-     * @param string $key
-     *
-     * @return void
-     */
-    public function offsetUnset($key)
-    {
-        // TODO : think of the use of it into a ProxyCollection
-        // context
-        $this->initializeProxy();
-
-        return parent::offsetUnset($key);
-    }
-
-    /**
-     * Dynamically access collection proxies.
-     *
-     * @param string $key
-     *
-     * @throws \Exception
-     *
-     * @return mixed
-     */
-    public function __get($key)
-    {
-        parent::__get($key);
-    }
-
-    /**
-     * Dynamically handle calls to the class.
-     *
-     * @param string $method
-     * @param array  $parameters
-     *
-     * @throws \BadMethodCallException
-     *
-     * @return mixed
-     */
-    public function __call($method, $parameters)
-    {
-        $this->initializeProxy();
-
-        return parent::__call($method, $parameters);
-    }
+	/**
+	 * Indicate if the relationship has been lazy loaded.
+	 *
+	 * @var bool
+	 */
+	protected $relationshipLoaded = false;
+
+	protected $addedItems = [];
+
+	/**
+	 * Create a new collection.
+	 *
+	 * @param mixed  $entity
+	 * @param string $relation
+	 *
+	 * @return void
+	 */
+	public function __construct($entity, $relation)
+	{
+		$this->parentEntity = $entity;
+		$this->relationshipMethod = $relation;
+	}
+
+	/**
+	 * Return Items that has been added without lady loading
+	 * the underlying collection.
+	 *
+	 * @return array
+	 */
+	public function getAddedItems()
+	{
+		return $this->addedItems;
+	}
+
+	/**
+	 * Force initialization of the proxy.
+	 *
+	 * @return bool true if the proxy could be initialized
+	 */
+	public function initializeProxy() : bool
+	{
+		if ($this->isProxyInitialized()) {
+			return true;
+		}
+
+		$relation = $this->relationshipMethod;
+		$entity = $this->parentEntity;
+
+		$entityMap = Manager::getMapper($entity)->getEntityMap();
+
+		$this->items = $entityMap->$relation($entity)->getResults($relation)->all() + $this->addedItems;
+
+		$this->relationshipLoaded = true;
+
+		return true;
+	}
+
+	/**
+	 * Retrieves current initialization status of the proxy.
+	 *
+	 * @return bool
+	 */
+	public function isProxyInitialized() : bool
+	{
+		return $this->relationshipLoaded;
+	}
+
+	/**
+	 * Get all of the items in the collection.
+	 *
+	 * @return array
+	 */
+	public function all()
+	{
+		$this->initializeProxy();
+
+		return parent::all();
+	}
+
+	/**
+	 * Get the average value of a given key.
+	 *
+	 * @param callable|string|null $callback
+	 *
+	 * @return mixed
+	 */
+	public function avg($callback = null)
+	{
+		$this->initializeProxy();
+
+		return parent::avg($callback);
+	}
+
+	/**
+	 * Get the median of a given key.
+	 *
+	 * @param null $key
+	 *
+	 * @return mixed|null
+	 */
+	public function median($key = null)
+	{
+		$this->initializeProxy();
+
+		return parent::median($key);
+	}
+
+	/**
+	 * Get the mode of a given key.
+	 *
+	 * @param mixed $key
+	 *
+	 * @return array
+	 */
+	public function mode($key = null)
+	{
+		$this->initializeProxy();
+
+		return parent::mode($key);
+	}
+
+	/**
+	 * Collapse the collection of items into a single array.
+	 *
+	 * @return static
+	 */
+	public function collapse()
+	{
+		$this->initializeProxy();
+
+		return parent::collapse();
+	}
+
+	/**
+	 * Determine if an item exists in the collection.
+	 *
+	 * @param mixed $key
+	 * @param mixed $value
+	 *
+	 * @return bool
+	 */
+	public function contains($key, $operator = null, $value = null)
+	{
+		$this->initializeProxy();
+
+		return parent::contains($key, $operator, $value);
+	}
+
+	/**
+	 * Determine if an item exists in the collection using strict comparison.
+	 *
+	 * @param mixed $key
+	 * @param mixed $value
+	 *
+	 * @return bool
+	 */
+	public function containsStrict($key, $value = null)
+	{
+		$this->initializeProxy();
+
+		return parent::containsStrict($key, $value);
+	}
+
+	/**
+	 * Get the items in the collection that are not present in the given items.
+	 *
+	 * @param mixed $items
+	 *
+	 * @return static
+	 */
+	public function diff($items)
+	{
+		$this->initializeProxy();
+
+		return parent::diff($items);
+	}
+
+	/**
+	 * Get the items in the collection whose keys are not present in the given items.
+	 *
+	 * @param mixed $items
+	 *
+	 * @return static
+	 */
+	public function diffKeys($items)
+	{
+		$this->initializeProxy();
+
+		return parent::diffKeys($items);
+	}
+
+	/**
+	 * Execute a callback over each item.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return $this
+	 */
+	public function each(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::each($callback);
+	}
+
+	/**
+	 * Create a new collection consisting of every n-th element.
+	 *
+	 * @param int $step
+	 * @param int $offset
+	 *
+	 * @return static
+	 */
+	public function every($key, $operator = null, $value = null)
+	{
+		$this->initializeProxy();
+
+		return parent::every($key, $operator, $value);
+	}
+
+	/**
+	 * Get all items except for those with the specified keys.
+	 *
+	 * @param mixed $keys
+	 *
+	 * @return static
+	 */
+	public function except($keys)
+	{
+		$this->initializeProxy();
+
+		return parent::except($keys);
+	}
+
+	/**
+	 * Run a filter over each of the items.
+	 *
+	 * @param callable|null $callback
+	 *
+	 * @return static
+	 */
+	public function filter(callable $callback = null)
+	{
+		$this->initializeProxy();
+
+		return parent::filter($callback);
+	}
+
+	/**
+	 * Filter items by the given key value pair.
+	 *
+	 * @param string $key
+	 * @param mixed  $operator
+	 * @param mixed  $value
+	 *
+	 * @return static
+	 */
+	public function where($key, $operator, $value = null)
+	{
+		$this->initializeProxy();
+
+		return parent::where($key, $operator, $value);
+	}
+
+	/**
+	 * Filter items by the given key value pair using strict comparison.
+	 *
+	 * @param string $key
+	 * @param mixed  $value
+	 *
+	 * @return static
+	 */
+	public function whereStrict($key, $value)
+	{
+		$this->initializeProxy();
+
+		return parent::whereStrict($key, $value);
+	}
+
+	/**
+	 * Filter items by the given key value pair.
+	 *
+	 * @param string $key
+	 * @param mixed  $values
+	 * @param bool   $strict
+	 *
+	 * @return static
+	 */
+	public function whereIn($key, $values, $strict = false)
+	{
+		$this->initializeProxy();
+
+		return parent::whereIn($key, $values, $strict);
+	}
+
+	/**
+	 * Filter items by the given key value pair using strict comparison.
+	 *
+	 * @param string $key
+	 * @param mixed  $values
+	 *
+	 * @return static
+	 */
+	public function whereInStrict($key, $values)
+	{
+		$this->initializeProxy();
+
+		return parent::whereInStrict($key, $values);
+	}
+
+	/**
+	 * Get the first item from the collection.
+	 *
+	 * @param callable|null $callback
+	 * @param mixed         $default
+	 *
+	 * @return mixed
+	 */
+	public function first(callable $callback = null, $default = null)
+	{
+		// TODO Consider partial loading
+		$this->initializeProxy();
+
+		return parent::first($callback, $default);
+	}
+
+	/**
+	 * Get a flattened array of the items in the collection.
+	 *
+	 * @param int $depth
+	 *
+	 * @return static
+	 */
+	public function flatten($depth = INF)
+	{
+		$this->initializeProxy();
+
+		return parent::flatten($depth);
+	}
+
+	/**
+	 * Flip the items in the collection.
+	 *
+	 * @return static
+	 */
+	public function flip()
+	{
+		$this->initializeProxy();
+
+		return parent::flip();
+	}
+
+	/**
+	 * Remove an item from the collection by key.
+	 *
+	 * @param string|array $keys
+	 *
+	 * @return $this
+	 */
+	public function forget($keys)
+	{
+		// TODO, we could consider these as
+		// 'pending deletion', the same way that
+		// we treat added items
+		$this->initializeProxy();
+
+		return parent::forget($keys);
+	}
+
+	/**
+	 * Get an item from the collection by key.
+	 *
+	 * @param mixed $key
+	 * @param mixed $default
+	 *
+	 * @return mixed
+	 */
+	public function get($key, $default = null)
+	{
+		// TODO : We could also consider partial loading
+		// here
+		$this->initializeProxy();
+
+		return parent::get($key, $default);
+	}
+
+	/**
+	 * Group an associative array by a field or using a callback.
+	 *
+	 * @param callable|string $groupBy
+	 * @param bool            $preserveKeys
+	 *
+	 * @return static
+	 */
+	public function groupBy($groupBy, $preserveKeys = false)
+	{
+		$this->initializeProxy();
+
+		return parent::groupBy($groupBy, $preserveKeys);
+	}
+
+	/**
+	 * Key an associative array by a field or using a callback.
+	 *
+	 * @param callable|string $keyBy
+	 *
+	 * @return static
+	 */
+	public function keyBy($keyBy)
+	{
+		$this->initializeProxy();
+
+		return parent::keyBy($keyBy);
+	}
+
+	/**
+	 * Determine if an item exists in the collection by key.
+	 *
+	 * @param mixed $key
+	 *
+	 * @return bool
+	 */
+	public function has($key)
+	{
+		// TODO : we could do automagic here by directly
+		// calling the database if the collection hasn't
+		// been initialized yet.
+		// Potential issue is that several calls to this
+		// could cause a lot queries vs a single get query.
+		$this->initializeProxy();
+
+		return parent::has($key);
+	}
+
+	/**
+	 * Concatenate values of a given key as a string.
+	 *
+	 * @param string $value
+	 * @param string $glue
+	 *
+	 * @return string
+	 */
+	public function implode($value, $glue = null)
+	{
+		$this->initializeProxy();
+
+		return parent::implode($value, $glue);
+	}
+
+	/**
+	 * Intersect the collection with the given items.
+	 *
+	 * @param mixed $items
+	 *
+	 * @return static
+	 */
+	public function intersect($items)
+	{
+		$this->initializeProxy();
+
+		return parent::intersect($items);
+	}
+
+	/**
+	 * Determine if the collection is empty or not.
+	 *
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		$this->initializeProxy();
+
+		return parent::isEmpty();
+	}
+
+	/**
+	 * Get the keys of the collection items.
+	 *
+	 * @return static
+	 */
+	public function keys()
+	{
+		$this->initializeProxy();
+
+		return parent::keys();
+	}
+
+	/**
+	 * Get the last item from the collection.
+	 *
+	 * @param callable|null $callback
+	 * @param mixed         $default
+	 *
+	 * @return mixed
+	 */
+	public function last(callable $callback = null, $default = null)
+	{
+		// TODO : we could do partial loading there as well
+		$this->initializeProxy();
+
+		return parent::last($callback, $default);
+	}
+
+	/**
+	 * Get the values of a given key.
+	 *
+	 * @param string      $value
+	 * @param string|null $key
+	 *
+	 * @return static
+	 */
+	public function pluck($value, $key = null)
+	{
+		// TODO : automagic call to QB if not initialized
+		$this->initializeProxy();
+
+		return parent::pluck($value, $key);
+	}
+
+	/**
+	 * Run a map over each of the items.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return static
+	 */
+	public function map(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::map($callback);
+	}
+
+	/**
+	 * Run an associative map over each of the items.
+	 *
+	 * The callback should return an associative array with a single key/value pair.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return static
+	 */
+	public function mapWithKeys(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::mapWithKeys($callback);
+	}
+
+	/**
+	 * Map a collection and flatten the result by a single level.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return static
+	 */
+	public function flatMap(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::flatMap($callback);
+	}
+
+	/**
+	 * Get the max value of a given key.
+	 *
+	 * @param callable|string|null $callback
+	 *
+	 * @return mixed
+	 */
+	public function max($callback = null)
+	{
+		$this->initializeProxy();
+
+		return parent::max($callback);
+	}
+
+	/**
+	 * Merge the collection with the given items.
+	 *
+	 * @param mixed $items
+	 *
+	 * @return static
+	 */
+	public function merge($items)
+	{
+		// TODO : Check if the EntityCollection
+		// returns a native Collection, as it
+		// is what we want here
+		$this->initializeProxy();
+
+		return parent::merge($items);
+	}
+
+	/**
+	 * Create a collection by using this collection for keys and another for its values.
+	 *
+	 * @param mixed $values
+	 *
+	 * @return static
+	 */
+	public function combine($values)
+	{
+		// TODO : Check if the EntityCollection
+		// returns a native Collection, as it
+		// is what we want here
+		$this->initializeProxy();
+
+		return parent::combine($values);
+	}
+
+	/**
+	 * Union the collection with the given items.
+	 *
+	 * @param mixed $items
+	 *
+	 * @return static
+	 */
+	public function union($items)
+	{
+		// TODO : Check if the EntityCollection
+		// returns a native Collection, as it
+		// is what we want here
+		$this->initializeProxy();
+
+		return parent::union($items);
+	}
+
+	/**
+	 * Get the min value of a given key.
+	 *
+	 * @param callable|string|null $callback
+	 *
+	 * @return mixed
+	 */
+	public function min($callback = null)
+	{
+		// TODO : we could rely on the QB
+		// for thos, if initialization has not
+		// take place yet
+		$this->initializeProxy();
+
+		return parent::min($callback);
+	}
+
+	/**
+	 * Create a new collection consisting of every n-th element.
+	 *
+	 * @param int $step
+	 * @param int $offset
+	 *
+	 * @return static
+	 */
+	public function nth($step, $offset = 0)
+	{
+		$this->initializeProxy();
+
+		return parent::nth($step, $offset);
+	}
+
+	/**
+	 * Get the items with the specified keys.
+	 *
+	 * @param mixed $keys
+	 *
+	 * @return static
+	 */
+	public function only($keys)
+	{
+		// TODO : we could rely on the QB if
+		// the collection hasn't been initialized yet
+		$this->initializeProxy();
+
+		return parent::only($keys);
+	}
+
+	/**
+	 * "Paginate" the collection by slicing it into a smaller collection.
+	 *
+	 * @param int $page
+	 * @param int $perPage
+	 *
+	 * @return static
+	 */
+	public function forPage($page, $perPage)
+	{
+		// TODO : check possibility of partial loading
+		// if not initialized
+		$this->initializeProxy();
+
+		return parent::forPage($page, $perPage);
+	}
+
+	/**
+	 * Partition the collection into two arrays using the given callback or key.
+	 *
+	 * @param callable|string $callback
+	 *
+	 * @return static
+	 */
+	public function partition($callback)
+	{
+		$this->initializeProxy();
+
+		return parent::partition($callback);
+	}
+
+	/**
+	 * Pass the collection to the given callback and return the result.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return mixed
+	 */
+	public function pipe(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::pipe($callback);
+	}
+
+	/**
+	 * Get and remove the last item from the collection.
+	 *
+	 * @return mixed
+	 */
+	public function pop()
+	{
+		$this->initializeProxy();
+
+		return parent::pop();
+	}
+
+	/**
+	 * Push an item onto the beginning of the collection.
+	 *
+	 * @param mixed $value
+	 * @param mixed $key
+	 *
+	 * @return $this
+	 */
+	public function prepend($value, $key = null)
+	{
+		// TODO : partial adding of values.
+		// we could have a $prepended , and $pushed arrays
+		// which we would combine at full initialization
+
+		$this->initializeProxy();
+
+		return parent::prepend($value, $key);
+	}
+
+	/**
+	 * Push an item onto the end of the collection.
+	 *
+	 * @param mixed $value
+	 *
+	 * @return $this
+	 */
+	public function push($value)
+	{
+		// TODO : partial adding of values.
+		// we could have a $prepended , and $pushed arrays
+		// which we would combine at full initialization
+
+		$this->initializeProxy();
+
+		return parent::push($value);
+	}
+
+	/**
+	 * Get and remove an item from the collection.
+	 *
+	 * @param mixed $key
+	 * @param mixed $default
+	 *
+	 * @return mixed
+	 */
+	public function pull($key, $default = null)
+	{
+		// TODO : QB query if the collection
+		// hasn't been initialized yet
+
+		$this->initializeProxy();
+
+		return parent::pull($key, $default);
+	}
+
+	/**
+	 * Put an item in the collection by key.
+	 *
+	 * @param mixed $key
+	 * @param mixed $value
+	 *
+	 * @return $this
+	 */
+	public function put($key, $value)
+	{
+		// TODO : Partial loading ?
+
+		$this->initializeProxy();
+
+		return parent::put($key, $value);
+	}
+
+	/**
+	 * Get one or more items randomly from the collection.
+	 *
+	 * @param int $amount
+	 *
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return mixed
+	 */
+	public function random($amount = 1)
+	{
+		// TODO : we could optimize this by only
+		// fetching the keys from the database
+		// and performing partial loading
+
+		$this->initializeProxy();
+
+		return parent::random($amount);
+	}
+
+	/**
+	 * Reduce the collection to a single value.
+	 *
+	 * @param callable $callback
+	 * @param mixed    $initial
+	 *
+	 * @return mixed
+	 */
+	public function reduce(callable $callback, $initial = null)
+	{
+		$this->initializeProxy();
+
+		return parent::reduce($callback, $initial);
+	}
+
+	/**
+	 * Create a collection of all elements that do not pass a given truth test.
+	 *
+	 * @param callable|mixed $callback
+	 *
+	 * @return static
+	 */
+	public function reject($callback)
+	{
+		$this->initializeProxy();
+
+		return parent::reject($callback);
+	}
+
+	/**
+	 * Reverse items order.
+	 *
+	 * @return static
+	 */
+	public function reverse()
+	{
+		$this->initializeProxy();
+
+		return parent::reverse();
+	}
+
+	/**
+	 * Search the collection for a given value and return the corresponding key if successful.
+	 *
+	 * @param mixed $value
+	 * @param bool  $strict
+	 *
+	 * @return mixed
+	 */
+	public function search($value, $strict = false)
+	{
+		$this->initializeProxy();
+
+		return parent::search($value, $strict);
+	}
+
+	/**
+	 * Get and remove the first item from the collection.
+	 *
+	 * @return mixed
+	 */
+	public function shift()
+	{
+		// Todo : Partial Removing
+		// we could have a pending removal array
+		$this->initializeProxy();
+
+		return parent::shift();
+	}
+
+	/**
+	 * Shuffle the items in the collection.
+	 *
+	 * @param int $seed
+	 *
+	 * @return static
+	 */
+	public function shuffle($seed = null)
+	{
+		$this->initializeProxy();
+
+		return parent::shuffle($seed);
+	}
+
+	/**
+	 * Slice the underlying collection array.
+	 *
+	 * @param int $offset
+	 * @param int $length
+	 *
+	 * @return static
+	 */
+	public function slice($offset, $length = null)
+	{
+		$this->initializeProxy();
+
+		return parent::slice($offset, $length);
+	}
+
+	/**
+	 * Split a collection into a certain number of groups.
+	 *
+	 * @param int $numberOfGroups
+	 *
+	 * @return static
+	 */
+	public function split($numberOfGroups)
+	{
+		$this->initializeProxy();
+
+		return parent::split($numberOfGroups);
+	}
+
+	/**
+	 * Chunk the underlying collection array.
+	 *
+	 * @param int $size
+	 *
+	 * @return static
+	 */
+	public function chunk($size)
+	{
+		// TODO : partial loading ?
+		$this->initializeProxy();
+
+		return parent::chunk($size);
+	}
+
+	/**
+	 * Sort through each item with a callback.
+	 *
+	 * @param callable|null $callback
+	 *
+	 * @return static
+	 */
+	public function sort(callable $callback = null)
+	{
+		$this->initializeProxy();
+
+		return parent::sort($callback);
+	}
+
+	/**
+	 * Sort the collection using the given callback.
+	 *
+	 * @param callable|string $callback
+	 * @param int             $options
+	 * @param bool            $descending
+	 *
+	 * @return static
+	 */
+	public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
+	{
+		$this->initializeProxy();
+
+		return parent::sort($callback, $options, $descending);
+	}
+
+	/**
+	 * Splice a portion of the underlying collection array.
+	 *
+	 * @param int      $offset
+	 * @param int|null $length
+	 * @param mixed    $replacement
+	 *
+	 * @return static
+	 */
+	public function splice($offset, $length = null, $replacement = [])
+	{
+		$this->initializeProxy();
+
+		return parent::splice($offset, $length, $replacement);
+	}
+
+	/**
+	 * Get the sum of the given values.
+	 *
+	 * @param callable|string|null $callback
+	 *
+	 * @return mixed
+	 */
+	public function sum($callback = null)
+	{
+		$this->initializeProxy();
+
+		return parent::sum($callback);
+	}
+
+	/**
+	 * Take the first or last {$limit} items.
+	 *
+	 * @param int $limit
+	 *
+	 * @return static
+	 */
+	public function take($limit)
+	{
+		// TODO: partial loading
+		$this->initializeProxy();
+
+		return parent::take($limit);
+	}
+
+	/**
+	 * Pass the collection to the given callback and then return it.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return $this
+	 */
+	public function tap(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::tap($this);
+	}
+
+	/**
+	 * Transform each item in the collection using a callback.
+	 *
+	 * @param callable $callback
+	 *
+	 * @return $this
+	 */
+	public function transform(callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::transform($callback);
+	}
+
+	/**
+	 * Return only unique items from the collection array.
+	 *
+	 * @param string|callable|null $key
+	 * @param bool                 $strict
+	 *
+	 * @return static
+	 */
+	public function unique($key = null, $strict = false)
+	{
+		$this->initializeProxy();
+
+		return parent::unique($key, $strict);
+	}
+
+	/**
+	 * Reset the keys on the underlying array.
+	 *
+	 * @return static
+	 */
+	public function values()
+	{
+		$this->initializeProxy();
+
+		return parent::values();
+	}
+
+	/**
+	 * Apply the callback if the value is truthy.
+	 *
+	 * @param  bool  $value
+	 * @param  callable  $callback
+	 * @return mixed
+	 */
+	public function when($value, callable $callback)
+	{
+		$this->initializeProxy();
+
+		return parent::when($value, $callback);
+	}
+
+	/**
+	 * Zip the collection together with one or more arrays.
+	 *
+	 * e.g. new Collection([1, 2, 3])->zip([4, 5, 6]);
+	 *      => [[1, 4], [2, 5], [3, 6]]
+	 *
+	 * @param mixed ...$items
+	 *
+	 * @return static
+	 */
+	public function zip($items)
+	{
+		$this->initializeProxy();
+
+		return parent::zip($items);
+	}
+
+	/**
+	 * Get the collection of items as a plain array.
+	 *
+	 * @return array
+	 */
+	public function toArray()
+	{
+		// If this is called on all subsequent proxy,
+		// this would eventually trigger all lazy loading,
+		// which is NOT what we would expect...
+		// TODO : must think of this.
+		$this->initializeProxy();
+
+		return parent::toArray();
+	}
+
+	/**
+	 * Convert the object into something JSON serializable.
+	 *
+	 * @return array
+	 */
+	public function jsonSerialize()
+	{
+		// If this is called on all subsequent proxy,
+		// this would eventually trigger all lazy loading,
+		// which is NOT what we would expect...
+		// TODO : must think of this.
+		$this->initializeProxy();
+
+		return parent::jsonSerialize();
+	}
+
+	/**
+	 * Get the collection of items as JSON.
+	 *
+	 * @param int $options
+	 *
+	 * @return string
+	 */
+	public function toJson($options = 0)
+	{
+		// If this is called on all subsequent proxy,
+		// this would eventually trigger all lazy loading,
+		// which is NOT what we would expect...
+		// TODO : must think of this.
+		$this->initializeProxy();
+
+		return parent::toJson($options);
+	}
+
+	/**
+	 * Get an iterator for the items.
+	 *
+	 * @return \ArrayIterator
+	 */
+	public function getIterator()
+	{
+		$this->initializeProxy();
+
+		return parent::getIterator();
+	}
+
+	/**
+	 * Get a CachingIterator instance.
+	 *
+	 * @param int $flags
+	 *
+	 * @return \CachingIterator
+	 */
+	public function getCachingIterator($flags = CachingIterator::CALL_TOSTRING)
+	{
+		$this->initializeProxy();
+
+		return parent::getCachingIterator($flags);
+	}
+
+	/**
+	 * Count the number of items in the collection.
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		// TODO rely on QB if not initialized
+		$this->initializeProxy();
+
+		return parent::count();
+	}
+
+	/**
+	 * Get a base Support collection instance from this collection.
+	 *
+	 * @return \Illuminate\Support\Collection
+	 */
+	public function toBase()
+	{
+		$this->initializeProxy();
+
+		return parent::toBase();
+	}
+
+	/**
+	 * Determine if an item exists at an offset.
+	 *
+	 * @param mixed $key
+	 *
+	 * @return bool
+	 */
+	public function offsetExists($key)
+	{
+		// TODO rely on QB if no collection
+		// initialized
+		$this->initializeProxy();
+
+		return parent::offsetExists($key);
+	}
+
+	/**
+	 * Get an item at a given offset.
+	 *
+	 * @param mixed $key
+	 *
+	 * @return mixed
+	 */
+	public function offsetGet($key)
+	{
+		// TODO rely on partial init if no collection
+		// initialized
+		$this->initializeProxy();
+
+		return parent::offsetGet($key);
+	}
+
+	/**
+	 * Set the item at a given offset.
+	 *
+	 * @param mixed $key
+	 * @param mixed $value
+	 *
+	 * @return void
+	 */
+	public function offsetSet($key, $value)
+	{
+		// TODO : think of the use of it into a ProxyCollection
+		// context
+		$this->initializeProxy();
+
+		return parent::offsetSet($key, $value);
+	}
+
+	/**
+	 * Unset the item at a given offset.
+	 *
+	 * @param string $key
+	 *
+	 * @return void
+	 */
+	public function offsetUnset($key)
+	{
+		// TODO : think of the use of it into a ProxyCollection
+		// context
+		$this->initializeProxy();
+
+		return parent::offsetUnset($key);
+	}
+
+	/**
+	 * Dynamically access collection proxies.
+	 *
+	 * @param string $key
+	 *
+	 * @throws \Exception
+	 *
+	 * @return mixed
+	 */
+	public function __get($key)
+	{
+		parent::__get($key);
+	}
+
+	/**
+	 * Dynamically handle calls to the class.
+	 *
+	 * @param string $method
+	 * @param array  $parameters
+	 *
+	 * @throws \BadMethodCallException
+	 *
+	 * @return mixed
+	 */
+	public function __call($method, $parameters)
+	{
+		$this->initializeProxy();
+
+		return parent::__call($method, $parameters);
+	}
 }

src/System/Proxies/ProxyFactory.php

Indentation +43 added lines, -43 removed lines

@@ -14,47 +14,47 @@
  */
 class ProxyFactory
 {
-    public function make($entity, $relation, $class)
-    {
-        $entityMap = Manager::getMapper($entity)->getEntityMap();
-
-        $singleRelations = $entityMap->getSingleRelationships();
-        $manyRelations = $entityMap->getManyRelationships();
-
-        if (in_array($relation, $singleRelations)) {
-            return $this->makeEntityProxy($entity, $relation, $class);
-        }
-
-        if (in_array($relation, $manyRelations)) {
-            return new CollectionProxy($entity, $relation);
-        }
-
-        throw new MappingException("Could not identify relation '$relation'");
-    }
-
-    /**
-     * Create an instance of a proxy object, extending the actual
-     * related class.
-     *
-     * @param mixed  $entity   parent object
-     * @param string $relation the name of the relationship method
-     * @param string $class    the class name of the related object
-     *
-     * @return mixed
-     */
-    protected function makeEntityProxy($entity, $relation, $class)
-    {
-        $factory = new LazyLoadingValueHolderFactory();
-
-        $initializer = function (&$wrappedObject, LazyLoadingInterface $proxy, $method, array $parameters, &$initializer) use ($entity, $relation) {
-            $entityMap = Manager::getMapper($entity)->getEntityMap();
-
-            $wrappedObject = $entityMap->$relation($entity)->getResults($relation);
-
-            $initializer = null; // disable initialization
-            return true; // confirm that initialization occurred correctly
-        };
-
-        return $factory->createProxy($class, $initializer);
-    }
+	public function make($entity, $relation, $class)
+	{
+		$entityMap = Manager::getMapper($entity)->getEntityMap();
+
+		$singleRelations = $entityMap->getSingleRelationships();
+		$manyRelations = $entityMap->getManyRelationships();
+
+		if (in_array($relation, $singleRelations)) {
+			return $this->makeEntityProxy($entity, $relation, $class);
+		}
+
+		if (in_array($relation, $manyRelations)) {
+			return new CollectionProxy($entity, $relation);
+		}
+
+		throw new MappingException("Could not identify relation '$relation'");
+	}
+
+	/**
+	 * Create an instance of a proxy object, extending the actual
+	 * related class.
+	 *
+	 * @param mixed  $entity   parent object
+	 * @param string $relation the name of the relationship method
+	 * @param string $class    the class name of the related object
+	 *
+	 * @return mixed
+	 */
+	protected function makeEntityProxy($entity, $relation, $class)
+	{
+		$factory = new LazyLoadingValueHolderFactory();
+
+		$initializer = function (&$wrappedObject, LazyLoadingInterface $proxy, $method, array $parameters, &$initializer) use ($entity, $relation) {
+			$entityMap = Manager::getMapper($entity)->getEntityMap();
+
+			$wrappedObject = $entityMap->$relation($entity)->getResults($relation);
+
+			$initializer = null; // disable initialization
+			return true; // confirm that initialization occurred correctly
+		};
+
+		return $factory->createProxy($class, $initializer);
+	}
 }