Created generic building queue

Updated ORM

Signed-off-by: Gregory PLANCHAT <g.planchat@gmail.com>

includes/application/code/community/Legacies/Empire/Model/BuilderAbstract.php

@@ -0,0 +1,161 @@
+<?php
+
+abstract class Legacies_Empire_Model_BuilderAbstract
+    implements Countable, Serializable, Iterator
+{
+    /**
+     * Planet instance
+     * @var Legacies_Empire_Model_Planet
+     */
+    protected $_currentPlanet = null;
+
+    /**
+     * User instance
+     * @var Legacies_Empire_Model_User
+     */
+    protected $_currentUser = null;
+
+    /**
+     * construction queue
+     * @var array
+     */
+    private $_queue = null;
+
+    /**
+     * construction queue
+     * @var array
+     */
+    protected $_itemClass = 'Legacies_Empire_Model_Builder_Item';
+
+    /**
+     * construction queue
+     * @var array
+     */
+    protected $_index = 0;
+
+    /**
+     *
+     * @param Legacies_Empire_Model_Planet $currentPlanet
+     * @param Legacies_Empire_Model_User $currentUser
+     */
+    public function __construct(Legacies_Empire_Model_Planet $currentPlanet, Legacies_Empire_Model_User $currentUser)
+    {
+        $this->_currentPlanet = $currentPlanet;
+        $this->_currentUser = $currentUser;
+    }
+
+    abstract protected function _initItem();
+
+    public function enqueue()
+    {
+        $params = func_get_args();
+        $item = call_user_func_array(array($this, '_initItem'), $params);
+        $item->setIndex($this->_index);
+        $queue[$this->_index++] = $item;
+
+        return $this;
+    }
+
+    public function dequeue($itemIndex)
+    {
+        unset($itemIndex);
+
+        return $this;
+    }
+
+    protected function getItem($itemIndex)
+    {
+        if (isset($this->_queue[$itemIndex])) {
+            return $this->_queue[$itemIndex];
+        }
+
+        return null;
+    }
+
+    protected function _serializeQueue()
+    {
+        $serialize = array();
+        foreach ($this->_queue as $item) {
+            $serialize[] = $item->getAllDatas();
+        }
+        return serialize($serialize);
+    }
+
+    protected function _unserializeQueue($serialized)
+    {
+        $this->clearQueue();
+        $reflection = new ReflectionClass($this->_itemClass);
+
+        $unserialized = unserialize($serialized);
+        foreach ($unserialized as $itemData) {
+            $this->_enqueue($reflection->newInstance($itemData));
+        }
+        return $this;
+    }
+
+    public function __toString()
+    {
+        return $this->_serializeQueue();
+    }
+
+    public function getQueue()
+    {
+        return $this->_queue;
+    }
+
+    abstract public function enqueue($item);
+    abstract public function dequeue($item);
+
+    public function clearQueue()
+    {
+        $this->_queue = array();
+    }
+
+
+    /**
+     * Check if an item type is actually buildable on the current
+     * planet, depending on the technology and buildings requirements.
+     *
+     * @param int $typeId
+     * @return bool
+     */
+    public function checkAvailability($typeId)
+    {
+        $types = Legacies_Empire_Model_Game_Types::getSingleton();
+        $requirements = Legacies_Empire_Model_Game_Requirements::getSingleton();
+
+        if (!isset($requirements[$typeId]) || empty($requirements[$typeId])) {
+            return true;
+        }
+
+        foreach ($requirements[$typeId] as $requirement => $level) {
+            if ($types->is($requirement, Legacies_Empire::TYPE_BUILDING) && $this->_currentPlanet->hasElement($requirement, $level)) {
+                continue;
+            } else if ($types->is($requirement, Legacies_Empire::TYPE_RESEARCH) && $this->_currentUser->hasElement($requirement, $level)) {
+                continue;
+            } else if ($types->is($requirement, Legacies_Empire::TYPE_DEFENSE) && $this->_currentPlanet->hasElement($requirement, $level)) {
+                continue;
+            } else if ($types->is($requirement, Legacies_Empire::TYPE_SHIP) && $this->_currentPlanet->hasElement($requirement, $level)) {
+                continue;
+            }
+            return false;
+        }
+
+        try {
+            // Dispatch event. Throw an exception to break the avaliability.
+            Legacies::dispatchEvent('builder.check-availability', array(
+                'type_id' => $typeId,
+                'builder' => $this,
+                'planet'  => $this->_currentPlanet,
+                'user'    => $this->_currentUser
+                ));
+        } catch (Legacies_Empire_Model_Builder_Break $e) {
+            return false;
+        }
+
+        return true;
+    }
+
+    abstract public function getResourcesNeeded($typeId, $level);
+    abstract public function getBuildingTime($typeId, $level);
+}