face-orm/face

<?php

namespace Face\Core;

use Face\Exception;
use Face\Util\ArrayUtils;

class EntityFaceElement
{

    const RELATION_BELONGS_TO = "belongsTo";
    const RELATION_HAS_ONE = "hasOne";
    const RELATION_HAS_MANY = "hasMany";
    const RELATION_HAS_MANY_THROUGH = "hasManyThrough";

    /**
     *
     * @var EntityFace
     */
    protected $parentFace;

    //entity properties
    protected $name;
    protected $propertyName;
    protected $setter;
    protected $getter;

    protected $defaultMap;


    protected $type;
    protected $entityName;
    protected $_class;

    protected $isIdentifier;

    ////////////////////////////
    // relation properties
    /**
     * @var string if it is an entity, it defines what kind of relation : hasOne|belongsTo|hasMany
     */
    protected $relation;
    /**
     * @var string name of the property referencing to this entity on the related entity (e.g helps to define how to set instance reference on the parent)
     */
    protected $relatedBy;



    ////////////////////////////
    // SQL properties
    /**
     * @var string
     */
    protected $sqlColumnName;
    protected $sqlIsPrimary;
    protected $sqlJoin;
    protected $sqlAutoIncrement;
    protected $sqlThrough;



    /**
     *
     * @param array $params array to construct the faceElement as described here :  TODO array description
     */
    function __construct($name = "", $params = array())
    {
        $this->name         =  $name;

        $this->propertyName =  ArrayUtils::getIfArrayKey($params, "propertyName", $name);
        $this->setter       =  ArrayUtils::getIfArrayKey($params, "setter");
        $this->getter       =  ArrayUtils::getIfArrayKey($params, "getter");

        $this->defaultMap   =  ArrayUtils::getIfArrayKey($params, "defaultMap");

        $this->type         =  isset($params["entity"])?"entity":"value";
        $this->entityName        =  ArrayUtils::getIfArrayKey($params, "entity");
        $this->isIdentifier =  ArrayUtils::getIfArrayKey($params, "identifier", false);

        if ($this->isEntity()) {
            $this->relation  =  ArrayUtils::getIfArrayKey($params, "relation", "hasMany");
            $this->relatedBy =  ArrayUtils::getIfArrayKey($params, "relatedBy");
            $this->sqlThrough=  ArrayUtils::getIfArrayKey($params['sql'], "throughTable");
        }

        $this->sqlColumnName =   ArrayUtils::getIfArrayKey($params['sql'], "columnName", $name);
        $this->sqlIsPrimary  =   ArrayUtils::getIfArrayKey($params['sql'], "isPrimary");
        $this->sqlJoin       =   ArrayUtils::getIfArrayKey($params['sql'], "join");
        $this->sqlAutoIncrement= ArrayUtils::getIfArrayKey($params['sql'], "autoIncrement", $this->isPrimary());
    }


    public function getName()
    {
        return $this->name;
    }


    public function getPropertyName()
    {
        return $this->propertyName;
    }

    public function setPropertyName($propertyName)
    {
        $this->propertyName = $propertyName;
    }

    public function getSetter()
    {
        return $this->setter;
    }

    public function hasSetter()
    {
        return null !== $this->setter;
    }

    public function setSetter($setter)
    {
        $this->setter = $setter;
    }

    public function getGetter()
    {
        return $this->getter;
    }

    public function hasGetter()
    {
        return null !== $this->getter;
    }

    public function setGetter($getter)
    {
        $this->getter = $getter;
    }

    public function getSqlThrough()
    {
        return $this->sqlThrough;
    }

    public function setSqlThrough($sqlThrough)
    {
        $this->sqlThrough = $sqlThrough;
    }


    public function getType()
    {
        return $this->type;
    }

    public function setType($type)
    {
        $this->type = $type;
    }

    /**
     * @return string
     * @throws Exception\FaceNameDoesntExistsException
     */
    public function getClass()
    {

        if($this->isEntity()) {

            if (null == $this->_class) {
                $this->_class = $this->parentFace->getFaceLoader()
                    ->getFaceForName($this->entityName)
                    ->getClass();
            }

        }

        return $this->_class;
    }


    public function isEntity()
    {
        return "entity"===$this->getType();
    }

    public function isValue()
    {
        return "value"===$this->getType();
    }

    public function isIdentifier()
    {
        return true===$this->isIdentifier;
    }

    public function setIsIdentifier($isIdentifier)
    {
        $this->isIdentifier = $isIdentifier;
    }

    /**
     * @return string
     */
    public function getSqlColumnName($escape = false)
    {

        if($escape){
            return '`' . $this->sqlColumnName . '`';
        }else{
            return $this->sqlColumnName;
        }

    }

    public function setSqlColumnName($sqlColumnName)
    {
        $this->sqlColumnName = $sqlColumnName;
    }

    public function isPrimary()
    {
        return $this->sqlIsPrimary;
    }

    public function setSqlIsPrimary($sqlIsPrimary)
    {
        $this->sqlIsPrimary = $sqlIsPrimary;
    }

    public function getSqlJoin()
    {
        return $this->sqlJoin;
    }

    public function setSqlJoin($sqlJoin)
    {
        $this->sqlJoin = $sqlJoin;
    }



    public function getSqlAutoIncrement()
    {
        return $this->sqlAutoIncrement;
    }

    public function setSqlAutoIncrement($sqlAutoIncrement)
    {
        $this->sqlAutoIncrement = $sqlAutoIncrement;
    }


    public function getRelation()
    {
        return $this->relation;
    }

    public function setRelation($relation)
    {
        $this->relation = $relation;
    }

    public function hasManyRelationship()
    {
        return $this->relation=="hasMany";
    }
    public function hasManyThroughRelationship()
    {
        return $this->relation=="hasManyThrough";
    }

    public function relationIsBelongsTo()
    {
        return self::RELATION_BELONGS_TO == $this->relation;
    }

    public function relationIsHas___()
    {
        return self::RELATION_HAS_MANY == $this->relation || self::RELATION_HAS_ONE == $this->relation || self::RELATION_HAS_MANY_THROUGH == $this->relation;
    }

    public function getRelatedBy()
    {
        return $this->relatedBy;
    }

    public function setRelatedBy($relatedBy)
    {
        $this->relatedBy = $relatedBy;
    }

    /**
     *
     * @return EntityFace the face this element belongs to
     */
    public function getParentFace()
    {
        return $this->parentFace;
    }

    public function setParentFace(EntityFace $parentFace)
    {
        $this->parentFace = $parentFace;
    }


    /**
     *
     * if this is a value type, it means it cant have a face
     * if this is an entity it will return the face matching with the class
     *
     * @return EntityFace the EntityFace or null
     */
    public function getFace()
    {
        if ($this->isEntity()) {
            $faceLoader = $this->parentFace->getFaceLoader();
            return call_user_func($this->getClass() . "::getEntityFace",$faceLoader);
        } else {
            throw new Exception("A value Element has no face. Only entity with an associed class can have a face. Call on " . $this->getName());
        }
    }
}