<?php
include_once 'engine/dao.php';

/**
* Abstraktne mängumootori objekt.
* 
* Abstraktne ülemklass kõigile mängumootori objektidele, millega rakenduse kõrgemad kihid 
* peavad kokku puutuma, ehk siis kõigile mootori ja presentatsiooniloogika vahelises 
* "liideses" osalevatele objektidele.
* 
* @abstract
* @package GameEngine
* @access private
*/
class GameEntity extends DAO {
    
	/**
	* Universaalne identifikaator, sõltumata alamklassi tüübist.
	* @var mixed
	* @access public
	*/
	var $id;
	
	/**
	* Objekti nimi.
	* @var string
	* @access public
	*/
	var $name;
	
	/**
	* Mängu identifikaator.
	* @var integer
	*/
    var $game_id;
	
	/**
	* Kasutaja identifikaator.
	* @var integer
	*/
    var $user_id;
	
	/**
	* Omanik-objekt. Alluvussuhet realiseeriv viide teisele objektile. Harilikult on selleks "Game"
	* @var GameEntity
	*/
    var $owner;
	
	/**
	* Konstruktor
	* 
	*/
	function GameEntity(&$game) {
		$this->set_owner($game);
		$this->init();
	}
	
	function init() {
	}
	
	/**
	* Määrab omaniku. Üldjuhul pole vaja eraldi välja kutsuda.
	* @access private
	* @param GameEntity $game Omanik-objekt.
	*/
	function set_owner(&$game) {
		$this->owner = $game;
	    if (is_object($game) and is_subclass_of($game, 'gameentity') ) {
			//echo 'gameentity';
			$this->user_id = $game->user_id;
			$this->game_id = $game->game_id;
		}
		//$this->game_specifier = " AND user_id = '{$this->user_id}' AND game_id = '{$this->game_id}' ";
	}
	
	/**
	* Määrab objekti identiteedi ja initsialiseerib objekti.
	* 
	* See funktsioon defineeritakse järglasklasside poolt uuesti, et initsialiseerida objekt,
	* kus juures peaks väljakutsutama ka see meetod siin.
	* 
	* Teeb andmebaasi päringud ja hakkab esindama antud identifikaatorile vastavat objekti.
	* Kui seda ei leitud, väljastab false.
	* 
	* @access public
	* @param value $id Objekti identifikaator
	* @return boolean
	*/
	function set_id($id) {
		$this->id = $id;
		//return 0; //security - abstract class anyway
		//kui mõni järglasklass ei implementeeri
		return 1; //kui ei implementeeri, pole ka ju oluline
	}
	
	function id() {
		return $this->id;
	}
	
	/**
	* See funktsioon defineeritakse järglasklasside poolt uuesti.
	* @abstract
	* @access public
	*/
    function get_items() {
	    
		//näiteks
	    $arr['0'] = 'esimene';
	    $arr['1'] = 'teine';
	    $arr['2'] = 'kolmas';
	    return $arr;
    }
}


?>