espocrm-base/application/Espo/ORM/Entity.php

<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014  Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
 * Website: http://www.espocrm.com
 *
 * EspoCRM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
 ************************************************************************/ 

namespace Espo\ORM;

abstract class Entity implements IEntity
{
	public $id = null;
	
	private $isNew = false;

	/**
	 * Entity name.
	 * @var string
	 */
	protected $entityName;
	
	/**
	 * @var array Defenition of fields.
	 * @todo make protected
	 */	
	public $fields = array();
	
	/**
	 * @var array Defenition of relations.
	 * @todo make protected
	 */	
	public $relations = array();	
	
	/**
	 * @var array Field-Value pairs.
	 */
	protected $valuesContainer = array();
	
	/**
	 * @var array Field-Value pairs of initial values (fetched from DB).
	 */
	protected $fetchedValuesContainer = array();
	
	/**
	 * @var EntityManager Entity Manager.
	 */
	protected $entityManager;
	
	protected $isFetched = false;
	
	public function __construct($defs = array(), EntityManager $entityManager = null)
	{
		if (empty($this->entityName)) {
			$classNames = explode('\\', get_class($this));
			$this->entityName = end($classNames);
		}
		
		$this->entityManager = $entityManager;
		
		if (!empty($defs['fields'])) {
			$this->fields = $defs['fields'];
		}
		
		if (!empty($defs['relations'])) {
			$this->relations = $defs['relations'];
		}		
	}	
	
	public function clear($name = null)
	{
		if (is_null($name)) {
			$this->reset();
		}
		unset($this->valuesContainer[$name]);
	}
		
	public function reset()
	{
		$this->valuesContainer = array();
	}
	
	protected function setValue($name, $value)
	{
		$this->valuesContainer[$name] = $value;
	}	
	
	public function set($p1, $p2 = null)
	{
		if (is_array($p1)) {
			if ($p2 === null) {
				$p2 = false;
			}
			$this->populateFromArray($p1, $p2);
		} else {
			$name = $p1;
			$value = $p2;
			if ($name == 'id') {
				$this->id = $value;
			}
			if ($this->hasField($name)) {
				$method = 'set' . ucfirst($name);
				if (method_exists($this, $method)) {
					$this->$method($value);
				} else {
					$this->valuesContainer[$name] = $value;
				}
			}
		}
	}
	
	public function get($name, $params = array())
	{
		if ($name == 'id') {
			return $this->id;
		}
		$method = 'get' . ucfirst($name);
		if (method_exists($this, $method)) {
			return $this->$method();		
		}
		
		if (isset($this->valuesContainer[$name])) {
			return $this->valuesContainer[$name];
		}
		
		if (!empty($this->relations[$name])) {
			$value = $this->entityManager->getRepository($this->entityName)->findRelated($this, $name, $params);
			return $value;
		}
		
		return null;
	}
	
	public function has($name)
	{
		if ($name == 'id') {
			return isset($this->id);
		}
		if (array_key_exists($name, $this->valuesContainer)) {
			return true;
		}
		return false;
	}	
	
	public function populateFromArray(array $arr, $onlyAccessible = true, $reset = false)
	{
		if ($reset) {
			$this->reset();
		}
	
		foreach ($this->fields as $field => $fieldDefs) {
			if (array_key_exists($field, $arr)) {
				if ($field == 'id') {
					$this->id = $arr[$field]; 
					continue;
				}
				if ($onlyAccessible) {
					if (isset($fieldDefs['notAccessible']) && $fieldDefs['notAccessible'] == true) {
						continue;
					}
				}
				
				$value = $arr[$field];
				
				if (!is_null($value)) {
					switch ($fieldDefs['type']) {
						case self::VARCHAR:						
							break;
						case self::BOOL:
							$value = ($value === 'true' || $value === '1' || $value === true);
							break;
						case self::INT:
							$value = intval($value);
							break;
						case self::FLOAT:
							$value = floatval($value);
							break;
						case self::JSON_ARRAY:
							$value = is_string($value) ? json_decode($value) : $value;
							if (!is_array($value)) {
								$value = null;
							}
							break;
						default:
							break;
					}
				}
				
				$method = 'set' . ucfirst($field);
				if (method_exists($this, $method)) {
					$this->$method($value);
				} else {
					$this->valuesContainer[$field] = $value;
				}
			}
		}
	}
	
	public function isNew()
	{
		return $this->isNew;
	}
	
	public function setIsNew($isNew)
	{
		$this->isNew = $isNew;
	}	
		
	public function getEntityName()
	{
		return $this->entityName;
	}	
	
	public function hasField($fieldName)
	{
		return isset($this->fields[$fieldName]);
	}	
	
	public function hasRelation($relationName)
	{
		return isset($this->relations[$relationName]);
	}
	
	public function toArray()
	{		
		$arr = array();
		if (isset($this->id)) {
			$arr['id'] = $this->id;
		}
		foreach ($this->fields as $field => $defs) {		
			if ($field == 'id') {
				continue;
			}
			if ($this->has($field)) {
				$arr[$field] = $this->get($field);
			}

		}		
		return $arr;
	}
	
	public function getFields()
	{
		return $this->fields;
	}
	
	public function getRelations()
	{
		return $this->relations;
	}
	
	public function isFetched()
	{
		return $this->isFetched;
	}
	
	public function isFieldChanged($fieldName)
	{
		return $this->get($fieldName) != $this->getFetched($fieldName);
	}
	
	public function getFetched($fieldName)
	{
		if (isset($this->fetchedValuesContainer[$fieldName])) {
			return $this->fetchedValuesContainer[$fieldName];
		}
		return null;
	}
	
	public function resetFetchedValues()
	{
		$this->fetchedValuesContainer = array();
	}
	
	public function setAsFetched()
	{
		$this->isFetched = true;
		$this->fetchedValuesContainer = $this->valuesContainer;
	}
	
	public function populateDefaults()
	{
		foreach ($this->fields as $field => $defs) {
			if (array_key_exists('default', $defs)) {
				$this->valuesContainer[$field] = $defs['default'];
			}
		}
	}
}