wMind/mind3rd/API/classes/MindEntity.php

<?php
    /**
     * This file is part of TheWebMind 3rd generation.
     * 
     * @author Felipe Nascimento de Moura <felipenmoura@gmail.com>
     * @license licenses/mind3rd.license
     */
	/**
	 * A facade to deal with attributes/properties and methods
	 * related to an entity.
	 *
	 * @author felipe
	 */
	class MindEntity {

		public  $name;
		public  $pks= Array();
		public  $relevance= 0;
		public  $properties= Array();
		public  $relations= Array();
		public  $linkTable= false;
		private $refTo= Array();
		private $refBy= Array();
		public  $selfRef= false;

		/**
		 * Creates a default primary key to the entity.
		 * 
		 * @param boolean $unique
		 * @return MindEntity 
		 */
		public function addAutoPk($unique=false)
		{
			GLOBAL $_MIND;
			$pkPrefix= $_MIND->defaults['pk_prefix'];
			$propName= $pkPrefix.$this->name;
			
			$pk= new MindProperty();
			$pk ->setAsKey()
				->setName($propName)
				->setDefault(AUTOINCREMENT_DEFVAL)
				->setRequired(true)
				->setType('int')
				->setUnique($unique);
			$this->addProperty($pk);
			return $this;
		}
		
		/**
		 * Sets the entity as a self referred entity.
		 * It uses the $how to know if it is a multiple or a single reference.
		 * 
		 * @param mixed $how 0, 1 or n
		 * @return MindEntity 
		 */
		public function setSelfReferred($how)
		{
			$this->selfRef= $how;
			return $this;
		}
		
		/**
		 * Gets the array of entities which are referred by this entity.
		 * @return Array
		 */
		public function &getRefTo()
		{
			return $this->refTo;
		}
		
		/**
		 * Gets the array of the entities which point to this entity.
		 * @return Array
		 */
		public function &getRefBy()
		{
			return $this->refBy;
		}
		
		/**
		 * Verifies if the entity has a hardKey, or only weakKeys.
		 * @return boolean
		 */
		public function hasHardKey()
		{
			foreach($this->pks as &$pk)
			{
				if($pk->key === true)
					return true;
			}
			return false;
		}
		
		/**
		 * Verifies if the definition describes an entity or not
		 *
		 * @param string $definition
		 * @return boolean
		 */
		public static function isEntity($definition)
		{
			return strpos($definition, ":")? false: true;
		}

		/**
		 * Adds a property to the current entity
		 *
		 * @global $_MIND
		 * @param MindProperty $property
		 * @return MindEntity
		 */
		public function addProperty(MindProperty $property)
		{
			GLOBAL $_MIND;
			$this->properties[$property->name]= $property;
			if($property->key)
				$this->pks[$property->name]= $property;
			return $this;
		}

		/**
		 * Verifies if the current entity has a specified property
		 * 
		 * @param string $propName
		 * @return boolean
		 */
		public function hasProperty($propName)
		{
			return isset($this->properties[$propName]);
		}
		
		/**
		 * Removes a property from the current entity
		 * 
		 * @param string $propName
		 * @return boolean
		 */
		public function removeProperty($propName)
		{
			if(isset($this->properties[$propName]))
				unset($this->properties[$propName]);
		}
		
		/**
		 * Defines another entity pointed/refered by this entity
		 * @param MindEntity $ref
		 * @return MindEntity
		 */
		public function addRefTo(MindEntity &$ref)
		{
			$this->refTo[$ref->name]= &$ref;
			return $this;
		}
		
		/**
		 * Removes a reference TO
		 * @param string $refName
		 * @return MindEntity 
		 */
		public function removeRefTo($refName)
		{
			unset($this->refTo[$refName]);
			return $this;
		}

		/**
		 * Specifies that another entity is pointing to this one
		 * @param MindEntity $ref
		 * @return MindEntity
		 */
		public function addRefBy(MindEntity &$ref)
		{
			$this->refBy[$ref->name]= &$ref;
			return $this;
		}
		
		/**
		 * Removes a reference BY
		 * @param string $refName 
		 * @return MindEntity
		 */
		public function removeRefBy($refName)
		{
			unset($this->refBy[$refName]);
			return $this;
		}

		/**
		 * Adds a reference to the current entity
		 *
		 * @param MindRelation $rel
		 * @return MindEntity
		 */
		public function addRef(MindRelation &$rel)
		{
			$this->relations[$rel->name]= &$rel;
			if($rel->focus->name == $this->name)
			{
				if($rel->max == QUANTIFIER_MAX_MAX)
				{
					$this->relevance++;
					$this->addRefBy($rel->rel);
				}else
					$this->addRefTo($rel->rel);
			}else{
					if($rel->max == QUANTIFIER_MAX_MIN)
					{
						$this->relevance++;
						$this->addRefBy($rel->focus);
					}else
						$this->addRefTo($rel->focus);
				 }
			return $this;
		}

		/**
		 * Constructor. It receives the name of the new entity
		 * @param string $word
		 */
		public function MindEntity($word)
		{
			$this->name= (string)$word;
		}
	}