ManiaLib 1.0b1 API Reference

Source for file ResponseEngine.class.php

Documentation is available at ResponseEngine.class.php

  1. <?php
  2. /**
  3.  * @author Maxime Raoust
  4.  * @copyright 2009-2010 NADEO
  5.  * @package ManiaLib
  6.  * @subpackage MVC
  7.  */
  8.  
  9. /**
  10.  * Response engine
  11.  * Allows to pass values between filters, controllers and views
  12.  * @package ManiaLib
  13.  * @subpackage MVC
  14.  * @todo doc
  15.  */
  16. class ResponseEngine
  17. {
  18.     /**
  19.      * @ignore
  20.      */
  21.     private static $instance;
  22.  
  23.     /**#@+
  24.      * @ignore 
  25.      */
  26.     private $vars = array();
  27.     private $body = '';
  28.     private $views = array();
  29.     /**#@-*/
  30.     /**
  31.      * @var DialogHelper 
  32.      * @ignore
  33.      */
  34.     public $dialog;
  35.  
  36.     /**
  37.      * Gets the instance
  38.      * @return ResponseEngine 
  39.      */
  40.     public static function getInstance()
  41.     {
  42.         if (!self::$instance)
  43.         {
  44.             $class = __CLASS__;
  45.             self::$instance = new $class;
  46.         }
  47.         return self::$instance;
  48.     }
  49.  
  50.     /**
  51.      * @ignore
  52.      */
  53.     private function __construct() {}
  54.  
  55.     /**
  56.      * @ignore
  57.      */
  58.     public function __set($name, $value)
  59.     {
  60.         $this->vars[$name] = $value;
  61.     }
  62.     
  63.     /**
  64.      * @ignore
  65.      */
  66.     public function __get($name)
  67.     {
  68.         if(array_key_exists($name, $this->vars))
  69.         {
  70.             return $this->vars[$name];
  71.         }
  72.         else
  73.         {
  74.             return null;
  75.         }
  76.     }
  77.     
  78.     /**
  79.      * @todo doc
  80.      */
  81.     public function get($name, $default=null)
  82.     {
  83.         if(array_key_exists($name, $this->vars))
  84.         {
  85.             return $this->vars[$name];
  86.         }
  87.         else
  88.         {
  89.             return $default;
  90.         }
  91.     }
  92.     
  93.     /**
  94.      * @todo doc
  95.      */
  96.     public function registerDialog(DialogHelper $dialog)
  97.     {
  98.         if($this->dialog)
  99.         {
  100.             throw new DialogAlreadyRegistered;
  101.         }
  102.         $this->dialog = $dialog;
  103.     }
  104.     
  105.     /**
  106.      * @todo doc
  107.      */
  108.     public function registerView($controllerName, $actionName)
  109.     {
  110.         $this->views[] = array($controllerName, $actionName);
  111.     }
  112.     
  113.     /**
  114.      * @todo doc
  115.      */
  116.     public function resetViews()
  117.     {
  118.         $this->views = array();
  119.     }
  120.     
  121.     /**
  122.      * @todo doc
  123.      */
  124.     public function appendBody($content)
  125.     {
  126.         $this->body .= $content;
  127.     }
  128.     
  129.     /**
  130.      * @ignore
  131.      */
  132.     public function render()
  133.     {
  134.         View::render('header');
  135.         if($this->dialog)
  136.         {
  137.             View::render($this->dialog->controller, $this->dialog->action);
  138.             Manialink::disableLinks();
  139.         }
  140.         foreach($this->views as $view)
  141.         {
  142.             View::render($view[0], $view[1]);
  143.         }
  144.         View::render('footer');
  145.         
  146.         header('Content-Type: text/xml; charset=utf-8');
  147.         echo $this->body;
  148.     }
  149. }
  150.  
  151. /**
  152.  * @package ManiaLib
  153.  * @subpackage MVC
  154.  * @ignore
  155.  */
  156. class ResponseEngineException extends MVCException {}
  157.  
  158. /**
  159.  * @package ManiaLib
  160.  * @subpackage MVC
  161.  * @ignore
  162.  */
  163. class DialogAlreadyRegistered extends ResponseEngineException {}
  164.  
  165. ?>