analogueorm / analogue

src/EntityMap.php

Doc Comments +1 added lines, -1 removed lines

@@ -621,7 +621,7 @@
      *
      * @throws MappingException
      *
-     * @return mixed
+     * @return null|Collection
      */
     public function getEmptyValueForRelationship(string $relation)
     {

Indentation +1678 added lines, -1678 removed lines

@@ -26,1682 +26,1682 @@
  */
 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
-     */
-    protected $table;
-
-    /**
-     * The primary key for the model. If the model is an Embedded Value object
-     * primary key is set to null.
-     *
-     * @var string|null
-     */
-    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
-     */
-    protected $class;
-
-    /**
-     * The event map for the entity.
-     *
-     * @var array
-     */
-    protected $events = [];
-
-    /**
-     * Embedded Value Objects.
-     *
-     * @deprecated 5.5 (use embedsOne() or embedsMany() relationships instead)
-     *
-     * @var array
-     */
-    protected $embeddables = [];
-
-    /**
-     * Determine the relationships method used on the entity.
-     * If not set, mapper will autodetect them.
-     *
-     * @var array
-     */
-    protected $relationships = [];
-
-    /**
-     * Relationships that should be treated as collection.
-     *
-     * @var array
-     */
-    protected $manyRelations = [];
-
-    /**
-     * Relationships that should be treated as single entity.
-     *
-     * @var array
-     */
-    protected $singleRelations = [];
-
-    /**
-     * Relationships for which the key is stored in the Entity itself.
-     *
-     * @var array
-     */
-    protected $localRelations = [];
-
-    /**
-     * List of local keys associated to local relation methods.
-     *
-     * @var array
-     */
-    protected $localForeignKeys = [];
-
-    /**
-     * Relationships for which the key is stored in the Related Entity.
-     *
-     * @var array
-     */
-    protected $foreignRelations = [];
-
-    /**
-     * Relationships which use a pivot record.
-     *
-     * @var array
-     */
-    protected $pivotRelations = [];
-
-    /**
-     * Polymorphic relationships.
-     *
-     * @var array
-     */
-    protected $polymorphicRelations = [];
-
-    /**
-     * Dynamic relationships.
-     *
-     * @var array
-     */
-    protected $dynamicRelationships = [];
-
-    /**
-     * Targeted class for the relationship method. value is set to `null` for
-     * polymorphic relations.
-     *
-     * @var array
-     */
-    protected $relatedClasses = [];
-
-    /**
-     * Some relation methods like embedded objects, or HasOne and MorphOne,
-     * will never have a proxy loaded on them.
-     *
-     * @var array
-     */
-    protected $nonProxyRelationships = [];
-
-    /**
-     * Relation methods that are embedded objects.
-     *
-     * @var array
-     */
-    protected $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;
-
-    /**
-     * Indicates if the entity should be timestamped.
-     *
-     * @var bool
-     */
-    public $timestamps = false;
-
-    /**
-     * The name of the "created at" attribute.
-     *
-     * @var string
-     */
-    protected $createdAtColumn = 'created_at';
-
-    /**
-     * The name of the "updated at" attribute.
-     *
-     * @var string
-     */
-    protected $updatedAtColumn = 'updated_at';
-
-    /**
-     * Indicates if the entity uses softdeletes.
-     *
-     * @var bool
-     */
-    public $softDeletes = false;
-
-    /**
-     * The name of the "deleted at" attribute.
-     *
-     * @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
-     */
-    protected $inheritanceType;
-
-    /**
-     * 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 FQCN.
-     *
-     * @var array
-     */
-    protected $discriminatorColumnMap = [];
-
-    /**
-     * Indicate if the entity map has been booted.
-     *
-     * @var bool
-     */
-    private $isBooted = false;
-
-    /**
-     * 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(string $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(string $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 string $connection
-     */
-    public function setConnection(string $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 (isset($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(string $table)
-    {
-        $this->table = $table;
-    }
-
-    /**
-     * Get the custom entity class.
-     *
-     * @return string|null
-     */
-    public function getClass()
-    {
-        return $this->class ?: null;
-    }
-
-    /**
-     * Set the custom entity class.
-     *
-     * @param string $class The FQCN
-     */
-    public function setClass(string $class)
-    {
-        $this->class = $class;
-    }
-
-    /**
-     * Get the embedded Value Objects.
-     *
-     * @deprecated 5.5
-     *
-     * @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 get_parent_class(__CLASS__) !== false
-            ? array_unique(array_merge($this->properties, parent::getProperties()))
-            : $this->properties;
-    }
-
-    /**
-     * Return event map for the Entity.
-     *
-     * @return array
-     */
-    public function getEvents() : array
-    {
-        return $this->events;
-    }
-
-    /**
-     * 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.
-     *
-     * @deprecated 5.5
-     *
-     * @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;
-    }
-
-    /**
-     * Return true if relationship is single.
-     *
-     * @param string $relation
-     *
-     * @return bool
-     */
-    public function isSingleRelationship(string $relation): bool
-    {
-        return in_array($relation, $this->singleRelations);
-    }
-
-    /**
-     * Relationships of type Collection.
-     *
-     * @return array
-     */
-    public function getManyRelationships(): array
-    {
-        return $this->manyRelations;
-    }
-
-    /**
-     * Return true if relationship is single.
-     *
-     * @param string $relation
-     *
-     * @return bool
-     */
-    public function isManyRelationship(string $relation): bool
-    {
-        return in_array($relation, $this->manyRelations);
-    }
-
-    /**
-     * Return empty value for a given relationship.
-     *
-     * @param string $relation
-     *
-     * @throws MappingException
-     *
-     * @return mixed
-     */
-    public function getEmptyValueForRelationship(string $relation)
-    {
-        if ($this->isSingleRelationship($relation)) {
-            return;
-        }
-
-        if ($this->isManyRelationship($relation)) {
-            return new Collection();
-        }
-
-        throw new MappingException("Cannot determine default value of $relation");
-    }
-
-    /**
-     * Return empty value for a local foreign key.
-     *
-     * @param string $relation
-     *
-     * @return mixed
-     */
-    public function getEmptyValueForLocalKey(string $relation)
-    {
-        if ($this->isPolymorphic($relation)) {
-            $key = $this->localForeignKeys[$relation];
-
-            return [
-                $key['type'] => null,
-                $key['id']   => null,
-            ];
-        }
-
-        if ($this->isManyRelationship($relation)) {
-            return [];
-        }
-    }
-
-    /**
-     * 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 targeted 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 $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|null
-     */
-    public function getKeyName()
-    {
-        return $this->primaryKey;
-    }
-
-    /**
-     * Set the primary key for the entity.
-     *
-     * @param string $key
-     *
-     * @return void
-     */
-    public function setKeyName(string $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(int $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 instantiated 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(string $relation)
-    {
-        if (!in_array($relation, $this->singleRelations)) {
-            $this->singleRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a foreign relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addForeignRelation(string $relation)
-    {
-        if (!in_array($relation, $this->foreignRelations)) {
-            $this->foreignRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a polymorphic relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addPolymorphicRelation(string $relation)
-    {
-        if (!in_array($relation, $this->polymorphicRelations)) {
-            $this->polymorphicRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a non proxy relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addNonProxyRelation(string $relation)
-    {
-        if (!in_array($relation, $this->nonProxyRelationships)) {
-            $this->nonProxyRelationships[] = $relation;
-        }
-    }
-
-    /**
-     * Add a local relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addLocalRelation(string $relation)
-    {
-        if (!in_array($relation, $this->localRelations)) {
-            $this->localRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a many relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addManyRelation(string $relation)
-    {
-        if (!in_array($relation, $this->manyRelations)) {
-            $this->manyRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add a pivot relation method name once.
-     *
-     * @param string $relation
-     */
-    protected function addPivotRelation(string $relation)
-    {
-        if (!in_array($relation, $this->pivotRelations)) {
-            $this->pivotRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Add an embedded relation.
-     *
-     * @param string $relation
-     */
-    protected function addEmbeddedRelation(string $relation)
-    {
-        if (!in_array($relation, $this->embeddedRelations)) {
-            $this->embeddedRelations[] = $relation;
-        }
-    }
-
-    /**
-     * Define an Embedded Object.
-     *
-     * @param mixed  $parent
-     * @param string $relatedClass
-     * @param string $relation
-     *
-     * @return EmbedsOne
-     */
-    public function embedsOne($parent, string $relatedClass, string $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  $parent
-     * @param string $relatedClass
-     * @param string $relation
-     *
-     * @return EmbedsMany
-     */
-    public function embedsMany($parent, string $relatedClass, string $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, string $related, string $foreignKey = null, string $localKey = null): HasOne
-    {
-        $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,
-        string $related,
-        string $name,
-        string $type = null,
-        string $id = null,
-        string $localKey = null
-    ): MorphOne {
-        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
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\BelongsTo
-     */
-    public function belongsTo($entity, string $related, string $foreignKey = null, string $otherKey = null): BelongsTo
-    {
-        // 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, string $name = null, string $type = null, string $id = null): MorphTo
-    {
-        // 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, string $related, string $foreignKey = null, string $localKey = null): HasMany
-    {
-        $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,
-        string $related,
-        string $through,
-        string $firstKey = null,
-        string $secondKey = null
-    ): HasManyThrough {
-        $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,
-        string $related,
-        string $name,
-        string $type = null,
-        string $id = null,
-        string $localKey = null
-    ): MorphMany {
-        // 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      $related
-     * @param string|null $table
-     * @param string|null $foreignKey
-     * @param string|null $otherKey
-     *
-     * @throws MappingException
-     *
-     * @return \Analogue\ORM\Relationships\BelongsToMany
-     */
-    public function belongsToMany(
-        $entity,
-        string $related,
-        string $table = null,
-        string $foreignKey = null,
-        string $otherKey = null
-    ): BelongsToMany {
-        // 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,
-        string $related,
-        string $name,
-        string $table = null,
-        string $foreignKey = null,
-        string $otherKey = null,
-        bool $inverse = false
-    ): MorphToMany {
-        // 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,
-        string $related,
-        string $name,
-        string $table = null,
-        string $foreignKey = null,
-        string $otherKey = null
-    ): MorphToMany {
-        // 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(self $relatedMap): string
-    {
-        // 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(string $name, string $type = null, string $id = null): array
-    {
-        return [
-            $type ?: $name.'_type',
-            $id ?: $name.'_id',
-        ];
-    }
-
-    /**
-     * Get the class name for polymorphic relations.
-     *
-     * @return string
-     */
-    public function getMorphClass(): string
-    {
-        $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 = []): EntityCollection
-    {
-        return new EntityCollection($entities);
-    }
-
-    /**
-     * 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();
-        }
-
-        $this->isBooted = true;
-    }
-
-    /**
-     * Return true if entity map has been booted.
-     *
-     * @return bool
-     */
-    public function isBooted(): bool
-    {
-        return $this->isBooted;
-    }
-
-    /**
-     * Get Methods that has been added in the child class.
-     *
-     * @return array
-     */
-    protected function getCustomMethods(): array
-    {
-        $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): array
-    {
-        $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 directly setting these value
-     * in the corresponding methods, so we won't need
-     * the correspondency table
-     *
-     * @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
-     *
-     * @deprecated 5.5
-     */
-    public function activator()
-    {
-    }
-
-    /**
-     * Magic call to dynamic relationships.
-     *
-     * @param string $method
-     * @param array  $parameters
-     *
-     * @throws Exception
-     *
-     * @return mixed
-     */
-    public function __call(string $method, array $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
+	 */
+	protected $table;
+
+	/**
+	 * The primary key for the model. If the model is an Embedded Value object
+	 * primary key is set to null.
+	 *
+	 * @var string|null
+	 */
+	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
+	 */
+	protected $class;
+
+	/**
+	 * The event map for the entity.
+	 *
+	 * @var array
+	 */
+	protected $events = [];
+
+	/**
+	 * Embedded Value Objects.
+	 *
+	 * @deprecated 5.5 (use embedsOne() or embedsMany() relationships instead)
+	 *
+	 * @var array
+	 */
+	protected $embeddables = [];
+
+	/**
+	 * Determine the relationships method used on the entity.
+	 * If not set, mapper will autodetect them.
+	 *
+	 * @var array
+	 */
+	protected $relationships = [];
+
+	/**
+	 * Relationships that should be treated as collection.
+	 *
+	 * @var array
+	 */
+	protected $manyRelations = [];
+
+	/**
+	 * Relationships that should be treated as single entity.
+	 *
+	 * @var array
+	 */
+	protected $singleRelations = [];
+
+	/**
+	 * Relationships for which the key is stored in the Entity itself.
+	 *
+	 * @var array
+	 */
+	protected $localRelations = [];
+
+	/**
+	 * List of local keys associated to local relation methods.
+	 *
+	 * @var array
+	 */
+	protected $localForeignKeys = [];
+
+	/**
+	 * Relationships for which the key is stored in the Related Entity.
+	 *
+	 * @var array
+	 */
+	protected $foreignRelations = [];
+
+	/**
+	 * Relationships which use a pivot record.
+	 *
+	 * @var array
+	 */
+	protected $pivotRelations = [];
+
+	/**
+	 * Polymorphic relationships.
+	 *
+	 * @var array
+	 */
+	protected $polymorphicRelations = [];
+
+	/**
+	 * Dynamic relationships.
+	 *
+	 * @var array
+	 */
+	protected $dynamicRelationships = [];
+
+	/**
+	 * Targeted class for the relationship method. value is set to `null` for
+	 * polymorphic relations.
+	 *
+	 * @var array
+	 */
+	protected $relatedClasses = [];
+
+	/**
+	 * Some relation methods like embedded objects, or HasOne and MorphOne,
+	 * will never have a proxy loaded on them.
+	 *
+	 * @var array
+	 */
+	protected $nonProxyRelationships = [];
+
+	/**
+	 * Relation methods that are embedded objects.
+	 *
+	 * @var array
+	 */
+	protected $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;
+
+	/**
+	 * Indicates if the entity should be timestamped.
+	 *
+	 * @var bool
+	 */
+	public $timestamps = false;
+
+	/**
+	 * The name of the "created at" attribute.
+	 *
+	 * @var string
+	 */
+	protected $createdAtColumn = 'created_at';
+
+	/**
+	 * The name of the "updated at" attribute.
+	 *
+	 * @var string
+	 */
+	protected $updatedAtColumn = 'updated_at';
+
+	/**
+	 * Indicates if the entity uses softdeletes.
+	 *
+	 * @var bool
+	 */
+	public $softDeletes = false;
+
+	/**
+	 * The name of the "deleted at" attribute.
+	 *
+	 * @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
+	 */
+	protected $inheritanceType;
+
+	/**
+	 * 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 FQCN.
+	 *
+	 * @var array
+	 */
+	protected $discriminatorColumnMap = [];
+
+	/**
+	 * Indicate if the entity map has been booted.
+	 *
+	 * @var bool
+	 */
+	private $isBooted = false;
+
+	/**
+	 * 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(string $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(string $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 string $connection
+	 */
+	public function setConnection(string $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 (isset($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(string $table)
+	{
+		$this->table = $table;
+	}
+
+	/**
+	 * Get the custom entity class.
+	 *
+	 * @return string|null
+	 */
+	public function getClass()
+	{
+		return $this->class ?: null;
+	}
+
+	/**
+	 * Set the custom entity class.
+	 *
+	 * @param string $class The FQCN
+	 */
+	public function setClass(string $class)
+	{
+		$this->class = $class;
+	}
+
+	/**
+	 * Get the embedded Value Objects.
+	 *
+	 * @deprecated 5.5
+	 *
+	 * @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 get_parent_class(__CLASS__) !== false
+			? array_unique(array_merge($this->properties, parent::getProperties()))
+			: $this->properties;
+	}
+
+	/**
+	 * Return event map for the Entity.
+	 *
+	 * @return array
+	 */
+	public function getEvents() : array
+	{
+		return $this->events;
+	}
+
+	/**
+	 * 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.
+	 *
+	 * @deprecated 5.5
+	 *
+	 * @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;
+	}
+
+	/**
+	 * Return true if relationship is single.
+	 *
+	 * @param string $relation
+	 *
+	 * @return bool
+	 */
+	public function isSingleRelationship(string $relation): bool
+	{
+		return in_array($relation, $this->singleRelations);
+	}
+
+	/**
+	 * Relationships of type Collection.
+	 *
+	 * @return array
+	 */
+	public function getManyRelationships(): array
+	{
+		return $this->manyRelations;
+	}
+
+	/**
+	 * Return true if relationship is single.
+	 *
+	 * @param string $relation
+	 *
+	 * @return bool
+	 */
+	public function isManyRelationship(string $relation): bool
+	{
+		return in_array($relation, $this->manyRelations);
+	}
+
+	/**
+	 * Return empty value for a given relationship.
+	 *
+	 * @param string $relation
+	 *
+	 * @throws MappingException
+	 *
+	 * @return mixed
+	 */
+	public function getEmptyValueForRelationship(string $relation)
+	{
+		if ($this->isSingleRelationship($relation)) {
+			return;
+		}
+
+		if ($this->isManyRelationship($relation)) {
+			return new Collection();
+		}
+
+		throw new MappingException("Cannot determine default value of $relation");
+	}
+
+	/**
+	 * Return empty value for a local foreign key.
+	 *
+	 * @param string $relation
+	 *
+	 * @return mixed
+	 */
+	public function getEmptyValueForLocalKey(string $relation)
+	{
+		if ($this->isPolymorphic($relation)) {
+			$key = $this->localForeignKeys[$relation];
+
+			return [
+				$key['type'] => null,
+				$key['id']   => null,
+			];
+		}
+
+		if ($this->isManyRelationship($relation)) {
+			return [];
+		}
+	}
+
+	/**
+	 * 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 targeted 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 $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|null
+	 */
+	public function getKeyName()
+	{
+		return $this->primaryKey;
+	}
+
+	/**
+	 * Set the primary key for the entity.
+	 *
+	 * @param string $key
+	 *
+	 * @return void
+	 */
+	public function setKeyName(string $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(int $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 instantiated 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(string $relation)
+	{
+		if (!in_array($relation, $this->singleRelations)) {
+			$this->singleRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a foreign relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addForeignRelation(string $relation)
+	{
+		if (!in_array($relation, $this->foreignRelations)) {
+			$this->foreignRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a polymorphic relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addPolymorphicRelation(string $relation)
+	{
+		if (!in_array($relation, $this->polymorphicRelations)) {
+			$this->polymorphicRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a non proxy relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addNonProxyRelation(string $relation)
+	{
+		if (!in_array($relation, $this->nonProxyRelationships)) {
+			$this->nonProxyRelationships[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a local relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addLocalRelation(string $relation)
+	{
+		if (!in_array($relation, $this->localRelations)) {
+			$this->localRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a many relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addManyRelation(string $relation)
+	{
+		if (!in_array($relation, $this->manyRelations)) {
+			$this->manyRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add a pivot relation method name once.
+	 *
+	 * @param string $relation
+	 */
+	protected function addPivotRelation(string $relation)
+	{
+		if (!in_array($relation, $this->pivotRelations)) {
+			$this->pivotRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Add an embedded relation.
+	 *
+	 * @param string $relation
+	 */
+	protected function addEmbeddedRelation(string $relation)
+	{
+		if (!in_array($relation, $this->embeddedRelations)) {
+			$this->embeddedRelations[] = $relation;
+		}
+	}
+
+	/**
+	 * Define an Embedded Object.
+	 *
+	 * @param mixed  $parent
+	 * @param string $relatedClass
+	 * @param string $relation
+	 *
+	 * @return EmbedsOne
+	 */
+	public function embedsOne($parent, string $relatedClass, string $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  $parent
+	 * @param string $relatedClass
+	 * @param string $relation
+	 *
+	 * @return EmbedsMany
+	 */
+	public function embedsMany($parent, string $relatedClass, string $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, string $related, string $foreignKey = null, string $localKey = null): HasOne
+	{
+		$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,
+		string $related,
+		string $name,
+		string $type = null,
+		string $id = null,
+		string $localKey = null
+	): MorphOne {
+		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
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\BelongsTo
+	 */
+	public function belongsTo($entity, string $related, string $foreignKey = null, string $otherKey = null): BelongsTo
+	{
+		// 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, string $name = null, string $type = null, string $id = null): MorphTo
+	{
+		// 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, string $related, string $foreignKey = null, string $localKey = null): HasMany
+	{
+		$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,
+		string $related,
+		string $through,
+		string $firstKey = null,
+		string $secondKey = null
+	): HasManyThrough {
+		$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,
+		string $related,
+		string $name,
+		string $type = null,
+		string $id = null,
+		string $localKey = null
+	): MorphMany {
+		// 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      $related
+	 * @param string|null $table
+	 * @param string|null $foreignKey
+	 * @param string|null $otherKey
+	 *
+	 * @throws MappingException
+	 *
+	 * @return \Analogue\ORM\Relationships\BelongsToMany
+	 */
+	public function belongsToMany(
+		$entity,
+		string $related,
+		string $table = null,
+		string $foreignKey = null,
+		string $otherKey = null
+	): BelongsToMany {
+		// 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,
+		string $related,
+		string $name,
+		string $table = null,
+		string $foreignKey = null,
+		string $otherKey = null,
+		bool $inverse = false
+	): MorphToMany {
+		// 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,
+		string $related,
+		string $name,
+		string $table = null,
+		string $foreignKey = null,
+		string $otherKey = null
+	): MorphToMany {
+		// 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(self $relatedMap): string
+	{
+		// 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(string $name, string $type = null, string $id = null): array
+	{
+		return [
+			$type ?: $name.'_type',
+			$id ?: $name.'_id',
+		];
+	}
+
+	/**
+	 * Get the class name for polymorphic relations.
+	 *
+	 * @return string
+	 */
+	public function getMorphClass(): string
+	{
+		$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 = []): EntityCollection
+	{
+		return new EntityCollection($entities);
+	}
+
+	/**
+	 * 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();
+		}
+
+		$this->isBooted = true;
+	}
+
+	/**
+	 * Return true if entity map has been booted.
+	 *
+	 * @return bool
+	 */
+	public function isBooted(): bool
+	{
+		return $this->isBooted;
+	}
+
+	/**
+	 * Get Methods that has been added in the child class.
+	 *
+	 * @return array
+	 */
+	protected function getCustomMethods(): array
+	{
+		$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): array
+	{
+		$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 directly setting these value
+	 * in the corresponding methods, so we won't need
+	 * the correspondency table
+	 *
+	 * @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
+	 *
+	 * @deprecated 5.5
+	 */
+	public function activator()
+	{
+	}
+
+	/**
+	 * Magic call to dynamic relationships.
+	 *
+	 * @param string $method
+	 * @param array  $parameters
+	 *
+	 * @throws Exception
+	 *
+	 * @return mixed
+	 */
+	public function __call(string $method, array $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);
+	}
 }

src/System/Wrappers/Factory.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
      *
      * @throws \Analogue\ORM\Exceptions\MappingException
      *
-     * @return Wrapper
+     * @return ObjectWrapper
      */
     public function make($object)
     {

Indentation +26 added lines, -26 removed lines

@@ -7,34 +7,34 @@
 
 class Factory
 {
-    /**
-     * Build the wrapper corresponding to the object's type.
-     *
-     * @param mixed $object
-     *
-     * @throws \Analogue\ORM\Exceptions\MappingException
-     *
-     * @return Wrapper
-     */
-    public function make($object)
-    {
-        $manager = Manager::getInstance();
+	/**
+	 * Build the wrapper corresponding to the object's type.
+	 *
+	 * @param mixed $object
+	 *
+	 * @throws \Analogue\ORM\Exceptions\MappingException
+	 *
+	 * @return Wrapper
+	 */
+	public function make($object)
+	{
+		$manager = Manager::getInstance();
 
-        // Instantiate hydrator. We'll need to optimize this and allow pre-generation
-        // of these hydrator, and get it, ideally, from the entityMap or the Mapper class,
-        // so it's only instantiated once
-        $config = new Configuration(get_class($object));
+		// Instantiate hydrator. We'll need to optimize this and allow pre-generation
+		// of these hydrator, and get it, ideally, from the entityMap or the Mapper class,
+		// so it's only instantiated once
+		$config = new Configuration(get_class($object));
 
-        $hydratorClass = $config->createFactory()->getHydratorClass();
-        $hydrator = new $hydratorClass();
+		$hydratorClass = $config->createFactory()->getHydratorClass();
+		$hydrator = new $hydratorClass();
 
-        if ($manager->isValueObject($object)) {
-            $entityMap = $manager->getValueMap($object);
-        } else {
-            $entityMap = $manager->mapper($object)->getEntityMap();
-        }
+		if ($manager->isValueObject($object)) {
+			$entityMap = $manager->getValueMap($object);
+		} else {
+			$entityMap = $manager->mapper($object)->getEntityMap();
+		}
 
-        // Build Wrapper
-        return new ObjectWrapper($object, $entityMap, $hydrator);
-    }
+		// Build Wrapper
+		return new ObjectWrapper($object, $entityMap, $hydrator);
+	}
 }

src/System/Wrappers/ObjectWrapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
     /**
      * Returns the wrapped entity's map.
      *
-     * @return mixed
+     * @return EntityMap
      */
     public function getMap()
     {

Indentation +416 added lines, -416 removed lines

@@ -13,420 +13,420 @@
  */
 class ObjectWrapper implements InternallyMappable
 {
-    /**
-     * Original Entity Object.
-     *
-     * @var mixed
-     */
-    protected $entity;
-
-    /**
-     * Corresponding EntityMap.
-     *
-     * @var \Analogue\ORM\EntityMap
-     */
-    protected $entityMap;
-
-    /**
-     * @var \Analogue\ORM\System\Proxies\ProxyFactory
-     */
-    protected $proxyFactory;
-
-    /**
-     * Internal Representation of analogue's entity attributes.
-     *
-     * @var array
-     */
-    protected $attributes = [];
-
-    /**
-     * All properties on the original object.
-     *
-     * @var array
-     */
-    protected $properties = [];
-
-    /**
-     * 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;
-
-    /**
-     * Set to true if the object's attributes have been modified since last
-     * hydration.
-     *
-     * @var bool
-     */
-    protected $touched = false;
-
-    /**
-     * Object Wrapper constructor.
-     *
-     * @param mixed                   $entity
-     * @param \Analogue\ORM\EntityMap $entityMap
-     * @param HydratorInterface       $hydrator
-     */
-    public function __construct($entity, $entityMap, HydratorInterface $hydrator)
-    {
-        $this->hydrator = $hydrator;
-        $this->entity = $entity;
-        $this->entityMap = $entityMap;
-        $this->proxyFactory = new ProxyFactory();
-        $this->attributes = $this->dehydrate($entity);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getEntityClass(): string
-    {
-        return get_class($this->entity);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getEntityKeyName(): string
-    {
-        return $this->entityMap->getKeyName();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getEntityKeyValue()
-    {
-        return $this->getEntityAttribute($this->entityMap->getKeyName());
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getEntityHash(): string
-    {
-        return $this->getEntityClass().'.'.$this->getEntityKeyValue();
-    }
-
-    /**
-     * Returns the wrapped entity's map.
-     *
-     * @return mixed
-     */
-    public function getMap()
-    {
-        return $this->entityMap;
-    }
-
-    /**
-     * Get hydrated object.
-     *
-     * @return mixed
-     */
-    public function unwrap()
-    {
-        if ($this->touched) {
-            $this->hydrate();
-        }
-
-        return $this->entity;
-    }
-
-    /**
-     * Returns the wrapped entity.
-     *
-     * @return mixed
-     */
-    public function getObject()
-    {
-        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->properties = $properties;
-
-        $this->unmanagedProperties = array_except($properties, $this->getManagedProperties());
-
-        return $this->attributesFromProperties($properties);
-    }
-
-    /**
-     * Hydrate object's properties/attribute from the internal array representation.
-     *
-     * @return void
-     */
-    protected function hydrate()
-    {
-        $properties = $this->propertiesFromAttributes() + $this->unmanagedProperties;
-
-        // In some case, attributes will miss some properties, so we'll just complete the hydration
-        // set with the original object properties
-        $missingProperties = array_diff_key($this->properties, $properties);
-
-        foreach (array_keys($missingProperties) as $missingKey) {
-            $properties[$missingKey] = $this->properties[$missingKey];
-        }
-
-        $this->hydrator->hydrate($properties, $this->entity);
-
-        $this->touched = false;
-    }
-
-    /**
-     * 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
-     *
-     * @throws MappingException
-     *
-     * @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.
-     *
-     * @return array
-     */
-    protected function propertiesFromAttributes(): array
-    {
-        // Get all managed properties
-        $propertyNames = $this->entityMap->getProperties();
-
-        $propertyAttributes = array_only($this->attributes, $propertyNames);
-        $attributesArray = array_except($this->attributes, $propertyNames);
-
-        $attributesArrayName = $this->entityMap->getAttributesArrayName();
-
-        if ($attributesArrayName) {
-            $propertyAttributes[$attributesArrayName] = $attributesArray;
-        }
-
-        return $propertyAttributes;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setEntityAttributes(array $attributes)
-    {
-        $this->attributes = $attributes;
-        $this->touched = true;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getEntityAttributes(): array
-    {
-        return $this->attributes;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setEntityAttribute(string $key, $value)
-    {
-        $this->attributes[$key] = $value;
-
-        $this->touched = true;
-
-        $this->hydrate();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getEntityAttribute(string $key)
-    {
-        if ($this->hasAttribute($key)) {
-            return $this->attributes[$key];
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function hasAttribute(string $key): bool
-    {
-        return array_key_exists($key, $this->attributes);
-    }
-
-    /**
-     * Set the lazy loading 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 = [];
-
-        $relations = $this->getRelationsToProxy();
-
-        // 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 value
-            if (!$this->relationNeedsProxy($relation, $attributes)) {
-                $proxies[$relation] = $this->entityMap->getEmptyValueForRelationship($relation);
-            } 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->getNonEmbeddedRelationships() as $relation) {
-            //foreach ($this->entityMap->getRelationships() as $relation) {
-
-            if (!array_key_exists($relation, $attributes) || is_null($attributes[$relation])) {
-                $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]) || is_null($attributes[$localKey])) {
-            return false;
-        }
-
-        return true;
-    }
+	/**
+	 * Original Entity Object.
+	 *
+	 * @var mixed
+	 */
+	protected $entity;
+
+	/**
+	 * Corresponding EntityMap.
+	 *
+	 * @var \Analogue\ORM\EntityMap
+	 */
+	protected $entityMap;
+
+	/**
+	 * @var \Analogue\ORM\System\Proxies\ProxyFactory
+	 */
+	protected $proxyFactory;
+
+	/**
+	 * Internal Representation of analogue's entity attributes.
+	 *
+	 * @var array
+	 */
+	protected $attributes = [];
+
+	/**
+	 * All properties on the original object.
+	 *
+	 * @var array
+	 */
+	protected $properties = [];
+
+	/**
+	 * 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;
+
+	/**
+	 * Set to true if the object's attributes have been modified since last
+	 * hydration.
+	 *
+	 * @var bool
+	 */
+	protected $touched = false;
+
+	/**
+	 * Object Wrapper constructor.
+	 *
+	 * @param mixed                   $entity
+	 * @param \Analogue\ORM\EntityMap $entityMap
+	 * @param HydratorInterface       $hydrator
+	 */
+	public function __construct($entity, $entityMap, HydratorInterface $hydrator)
+	{
+		$this->hydrator = $hydrator;
+		$this->entity = $entity;
+		$this->entityMap = $entityMap;
+		$this->proxyFactory = new ProxyFactory();
+		$this->attributes = $this->dehydrate($entity);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getEntityClass(): string
+	{
+		return get_class($this->entity);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getEntityKeyName(): string
+	{
+		return $this->entityMap->getKeyName();
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getEntityKeyValue()
+	{
+		return $this->getEntityAttribute($this->entityMap->getKeyName());
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getEntityHash(): string
+	{
+		return $this->getEntityClass().'.'.$this->getEntityKeyValue();
+	}
+
+	/**
+	 * Returns the wrapped entity's map.
+	 *
+	 * @return mixed
+	 */
+	public function getMap()
+	{
+		return $this->entityMap;
+	}
+
+	/**
+	 * Get hydrated object.
+	 *
+	 * @return mixed
+	 */
+	public function unwrap()
+	{
+		if ($this->touched) {
+			$this->hydrate();
+		}
+
+		return $this->entity;
+	}
+
+	/**
+	 * Returns the wrapped entity.
+	 *
+	 * @return mixed
+	 */
+	public function getObject()
+	{
+		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->properties = $properties;
+
+		$this->unmanagedProperties = array_except($properties, $this->getManagedProperties());
+
+		return $this->attributesFromProperties($properties);
+	}
+
+	/**
+	 * Hydrate object's properties/attribute from the internal array representation.
+	 *
+	 * @return void
+	 */
+	protected function hydrate()
+	{
+		$properties = $this->propertiesFromAttributes() + $this->unmanagedProperties;
+
+		// In some case, attributes will miss some properties, so we'll just complete the hydration
+		// set with the original object properties
+		$missingProperties = array_diff_key($this->properties, $properties);
+
+		foreach (array_keys($missingProperties) as $missingKey) {
+			$properties[$missingKey] = $this->properties[$missingKey];
+		}
+
+		$this->hydrator->hydrate($properties, $this->entity);
+
+		$this->touched = false;
+	}
+
+	/**
+	 * 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
+	 *
+	 * @throws MappingException
+	 *
+	 * @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.
+	 *
+	 * @return array
+	 */
+	protected function propertiesFromAttributes(): array
+	{
+		// Get all managed properties
+		$propertyNames = $this->entityMap->getProperties();
+
+		$propertyAttributes = array_only($this->attributes, $propertyNames);
+		$attributesArray = array_except($this->attributes, $propertyNames);
+
+		$attributesArrayName = $this->entityMap->getAttributesArrayName();
+
+		if ($attributesArrayName) {
+			$propertyAttributes[$attributesArrayName] = $attributesArray;
+		}
+
+		return $propertyAttributes;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setEntityAttributes(array $attributes)
+	{
+		$this->attributes = $attributes;
+		$this->touched = true;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getEntityAttributes(): array
+	{
+		return $this->attributes;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setEntityAttribute(string $key, $value)
+	{
+		$this->attributes[$key] = $value;
+
+		$this->touched = true;
+
+		$this->hydrate();
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getEntityAttribute(string $key)
+	{
+		if ($this->hasAttribute($key)) {
+			return $this->attributes[$key];
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function hasAttribute(string $key): bool
+	{
+		return array_key_exists($key, $this->attributes);
+	}
+
+	/**
+	 * Set the lazy loading 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 = [];
+
+		$relations = $this->getRelationsToProxy();
+
+		// 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 value
+			if (!$this->relationNeedsProxy($relation, $attributes)) {
+				$proxies[$relation] = $this->entityMap->getEmptyValueForRelationship($relation);
+			} 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->getNonEmbeddedRelationships() as $relation) {
+			//foreach ($this->entityMap->getRelationships() as $relation) {
+
+			if (!array_key_exists($relation, $attributes) || is_null($attributes[$relation])) {
+				$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]) || is_null($attributes[$localKey])) {
+			return false;
+		}
+
+		return true;
+	}
 }

src/Events/Event.php

Indentation +15 added lines, -15 removed lines

@@ -4,20 +4,20 @@
 
 abstract class Event
 {
-    /**
-     * Entity.
-     *
-     * @var mixed
-     */
-    public $entity;
+	/**
+	 * Entity.
+	 *
+	 * @var mixed
+	 */
+	public $entity;
 
-    /**
-     * Event constructor.
-     *
-     * @param mixed $entity
-     */
-    public function __construct($entity)
-    {
-        $this->entity = $entity;
-    }
+	/**
+	 * Event constructor.
+	 *
+	 * @param mixed $entity
+	 */
+	public function __construct($entity)
+	{
+		$this->entity = $entity;
+	}
 }

src/Events/Initialized.php

Indentation +15 added lines, -15 removed lines

@@ -6,20 +6,20 @@
 
 class Initialized
 {
-    /**
-     * Mapper instance.
-     *
-     * @var Mapper
-     */
-    public $mapper;
+	/**
+	 * Mapper instance.
+	 *
+	 * @var Mapper
+	 */
+	public $mapper;
 
-    /**
-     * Initialized constructor.
-     *
-     * @param Mapper $mapper
-     */
-    public function __construct(Mapper $mapper)
-    {
-        $this->mapper = $mapper;
-    }
+	/**
+	 * Initialized constructor.
+	 *
+	 * @param Mapper $mapper
+	 */
+	public function __construct(Mapper $mapper)
+	{
+		$this->mapper = $mapper;
+	}
 }

src/Mappable.php

Indentation +12 added lines, -12 removed lines

@@ -7,17 +7,17 @@
  */
 interface Mappable
 {
-    /**
-     * Set the object attribute raw values (hydration).
-     *
-     * @param array $attributes
-     */
-    public function setEntityAttributes(array $attributes);
+	/**
+	 * Set the object attribute raw values (hydration).
+	 *
+	 * @param array $attributes
+	 */
+	public function setEntityAttributes(array $attributes);
 
-    /**
-     * Get the raw object's values.
-     *
-     * @return array
-     */
-    public function getEntityAttributes();
+	/**
+	 * Get the raw object's values.
+	 *
+	 * @return array
+	 */
+	public function getEntityAttributes();
 }

src/Drivers/CapsuleConnectionProvider.php

Indentation +26 added lines, -26 removed lines

@@ -7,32 +7,32 @@
 
 class CapsuleConnectionProvider
 {
-    /**
-     * Capsule manager.
-     *
-     * @var Capsule
-     */
-    protected $capsule;
+	/**
+	 * Capsule manager.
+	 *
+	 * @var Capsule
+	 */
+	protected $capsule;
 
-    /**
-     * CapsuleConnectionProvider constructor.
-     *
-     * @param Capsule $capsule
-     */
-    public function __construct(Capsule $capsule)
-    {
-        $this->capsule = $capsule;
-    }
+	/**
+	 * CapsuleConnectionProvider constructor.
+	 *
+	 * @param Capsule $capsule
+	 */
+	public function __construct(Capsule $capsule)
+	{
+		$this->capsule = $capsule;
+	}
 
-    /**
-     * Get a Database connection object.
-     *
-     * @param string $name
-     *
-     * @return \Illuminate\Database\Connection
-     */
-    public function connection(string $name = null): Connection
-    {
-        return $this->capsule->getConnection($name);
-    }
+	/**
+	 * Get a Database connection object.
+	 *
+	 * @param string $name
+	 *
+	 * @return \Illuminate\Database\Connection
+	 */
+	public function connection(string $name = null): Connection
+	{
+		return $this->capsule->getConnection($name);
+	}
 }

src/Drivers/IlluminateConnectionProvider.php

Indentation +26 added lines, -26 removed lines

@@ -7,32 +7,32 @@
 
 class IlluminateConnectionProvider
 {
-    /**
-     * Database manager.
-     *
-     * @var DatabaseManager
-     */
-    protected $db;
+	/**
+	 * Database manager.
+	 *
+	 * @var DatabaseManager
+	 */
+	protected $db;
 
-    /**
-     * IlluminateConnectionProvider constructor.
-     *
-     * @param DatabaseManager $db
-     */
-    public function __construct(DatabaseManager $db)
-    {
-        $this->db = $db;
-    }
+	/**
+	 * IlluminateConnectionProvider constructor.
+	 *
+	 * @param DatabaseManager $db
+	 */
+	public function __construct(DatabaseManager $db)
+	{
+		$this->db = $db;
+	}
 
-    /**
-     * Get a Database connection object.
-     *
-     * @param string $name
-     *
-     * @return \Illuminate\Database\Connection
-     */
-    public function connection(string $name = null): Connection
-    {
-        return $this->db->connection($name);
-    }
+	/**
+	 * Get a Database connection object.
+	 *
+	 * @param string $name
+	 *
+	 * @return \Illuminate\Database\Connection
+	 */
+	public function connection(string $name = null): Connection
+	{
+		return $this->db->connection($name);
+	}
 }

src/Drivers/IlluminateDBAdapter.php

Indentation +59 added lines, -59 removed lines

@@ -10,72 +10,72 @@
  */
 class IlluminateDBAdapter implements DBAdapter
 {
-    /**
-     * Database connection.
-     *
-     * @var Connection
-     */
-    protected $connection;
+	/**
+	 * Database connection.
+	 *
+	 * @var Connection
+	 */
+	protected $connection;
 
-    /**
-     * IlluminateDBAdapter constructor.
-     *
-     * @param Connection $connection
-     */
-    public function __construct(Connection $connection)
-    {
-        $this->connection = $connection;
-    }
+	/**
+	 * IlluminateDBAdapter constructor.
+	 *
+	 * @param Connection $connection
+	 */
+	public function __construct(Connection $connection)
+	{
+		$this->connection = $connection;
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getQuery()
-    {
-        $connection = $this->connection;
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getQuery()
+	{
+		$connection = $this->connection;
 
-        $grammar = $connection->getQueryGrammar();
+		$grammar = $connection->getQueryGrammar();
 
-        return new IlluminateQueryBuilder($connection, $grammar, $connection->getPostProcessor());
-    }
+		return new IlluminateQueryBuilder($connection, $grammar, $connection->getPostProcessor());
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getDateFormat(): string
-    {
-        return $this->connection->getQueryGrammar()->getDateFormat();
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getDateFormat(): string
+	{
+		return $this->connection->getQueryGrammar()->getDateFormat();
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function beginTransaction()
-    {
-        $this->connection->beginTransaction();
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function beginTransaction()
+	{
+		$this->connection->beginTransaction();
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function commit()
-    {
-        $this->connection->commit();
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function commit()
+	{
+		$this->connection->commit();
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function rollback()
-    {
-        $this->connection->rollBack();
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function rollback()
+	{
+		$this->connection->rollBack();
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function fromDatabase(array $rows): array
-    {
-        return $rows;
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function fromDatabase(array $rows): array
+	{
+		return $rows;
+	}
 }