Source for file Ethna_Renderer.php

Documentation is available at Ethna_Renderer.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_Renderer.php
  5.  *
  6.  *  @author     Kazuhiro Hosoi <hosoi@gree.co.jp>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id$
  10.  */
  11.  
  12. // {{{ Ethna_Renderer
  13. /**
  14.  *  レンダラクラス（Mojaviのまね）
  15.  *
  16.  *  @author     Kazuhiro Hosoi <hosoi@gree.co.jp>
  17.  *  @access     public
  18.  *  @package    Ethna
  19.  */
  20. class Ethna_Renderer
  21. {
  22.     /**#@+
  23.      *  @access private
  24.      */
  25.  
  26.     /** @var    object  Ethna_Controller    controllerオブジェクト */
  27.     var $controller;
  28.  
  29.     /** @var    object  Ethna_Controller    controllerオブジェクト($controllerの省略形) */
  30.     var $ctl;
  31.  
  32.     /** @var    array   [appid]-ini.phpのレンダラ設定 */
  33.     var $config;
  34.  
  35.     /** @var    string  template directory  */
  36.     var $template_dir;
  37.  
  38.     /** @var    string  template engine */
  39.     var $engine;
  40.  
  41.     /** @var    string  template file */
  42.     var $template;
  43.  
  44.     /** @var    string  テンプレート変数 */
  45.     var $prop;
  46.     
  47.     /** @var    string  レンダラプラグイン(Ethna_Pluginとは関係なし) */
  48.     var $plugin_registry;
  49.     
  50.     /**
  51.      *  Ethna_Rendererクラスのコンストラクタ
  52.      *
  53.      *  @access public
  54.      */
  55.     function Ethna_Renderer(&$controller)
  56.     {
  57.         $this->controller =& $controller;
  58.         $this->ctl =& $this->controller;
  59.         $this->template_dir = null;
  60.         $this->engine = null;
  61.         $this->template = null;
  62.         $this->prop = array();
  63.         $this->plugin_registry = array();
  64.         $config = $this->ctl->getConfig();
  65.         $this->config = $config->get('renderer'); 
  66.     }
  67.  
  68.     /**
  69.      *  ビューを出力する
  70.      *
  71.      *  @param string   $template   テンプレート
  72.      *  @param  bool    $capture    true ならば出力を表示せずに返す
  73.      *
  74.      *  @access public
  75.      */
  76.     function perform($template = null, $capture = false)
  77.     {
  78.         if ($template == null && $this->template == null) {
  79.             return Ethna::raiseWarning('template is not defined');
  80.         }
  81.  
  82.         if ($template != null) {
  83.             $this->template = $template;
  84.         }
  85.  
  86.         // テンプレートの有無のチェック
  87.         if (is_readable($this->template_dir . $this->template) === false) {
  88.             return Ethna::raiseWarning("template is not found: " . $this->template);
  89.         }
  90.  
  91.         if ($capture === true) {
  92.             ob_start();
  93.             include_once $this->template_dir . $this->template;
  94.             $captured = ob_get_contents();
  95.             ob_end_clean();
  96.             return $captured;
  97.         } else {
  98.             include_once $this->template_dir . $this->template;
  99.             return true;
  100.         }
  101.     }
  102.  
  103.     /**
  104.      *  テンプレートエンジンを取得する
  105.      * 
  106.      *  @return object   Template Engine.
  107.      * 
  108.      *  @access public
  109.      */
  110.     function &getEngine()
  111.     {
  112.         return $this->engine;
  113.     }
  114.  
  115.     /**
  116.      *  テンプレートディレクトリを取得する
  117.      * 
  118.      *  @return string   Template Directory
  119.      * 
  120.      *  @access public
  121.      */
  122.     function getTemplateDir()
  123.     {
  124.         return $this->template_dir;
  125.     }
  126.  
  127.     /**
  128.      *  テンプレート変数を取得する
  129.      * 
  130.      *  @param string $name  変数名
  131.      * 
  132.      *  @return mixed    変数
  133.      * 
  134.      *  @access public
  135.      */
  136.     function &getProp($name)
  137.     {
  138.         if (isset($this->prop[$name])) {
  139.             return $this->prop[$name];
  140.         }
  141.  
  142.         return null;
  143.     }
  144.  
  145.     /**
  146.      *  テンプレート変数を削除する
  147.      * 
  148.      *  @param name    変数名
  149.      * 
  150.      *  @access public
  151.      */
  152.     function &removeProp($name)
  153.     {
  154.         if (isset($this->prop[$name])) {
  155.             unset($this->prop[$name]);
  156.         }
  157.     }
  158.  
  159.     /**
  160.      *  テンプレート変数に配列を割り当てる
  161.      * 
  162.      *  @param array $array 
  163.      * 
  164.      *  @access public
  165.      */
  166.     function setPropArray($array)
  167.     {
  168.         $this->prop = array_merge($this->prop, $array);
  169.     }
  170.  
  171.     /**
  172.      *  テンプレート変数に配列を参照として割り当てる
  173.      * 
  174.      *  @param array $array 
  175.      * 
  176.      *  @access public
  177.      */
  178.     function setPropArrayByRef(&$array)
  179.     {
  180.         $keys  = array_keys($array);
  181.         $count = sizeof($keys);
  182.  
  183.         for ($i = 0; $i < $count; $i++) {
  184.             $this->prop[$keys[$i]] =& $array[$keys[$i]];
  185.         }
  186.     }
  187.  
  188.     /**
  189.      * テンプレート変数を割り当てる
  190.      * 
  191.      * @param string $name 変数名
  192.      * @param mixed $value 値
  193.      * 
  194.      * @access public
  195.      */
  196.     function setProp($name, $value)
  197.     {
  198.         $this->prop[$name] = $value;
  199.     }
  200.  
  201.     /**
  202.      *  テンプレート変数に参照を割り当てる
  203.      * 
  204.      *  @param string $name 変数名
  205.      *  @param mixed $value 値
  206.      * 
  207.      *  @access public
  208.      */
  209.     function setPropByRef($name, &$value)
  210.     {
  211.         $this->prop[$name] =& $value;
  212.     }
  213.  
  214.     /**
  215.      *  テンプレートを割り当てる
  216.      * 
  217.      *  @param string $template テンプレート名
  218.      * 
  219.      *  @access public
  220.      */
  221.     function setTemplate($template)
  222.     {
  223.         $this->template = $template;
  224.     }
  225.  
  226.     /**
  227.      *  テンプレートディレクトリを割り当てる
  228.      * 
  229.      *  @param string $dir ディレクトリ名
  230.      * 
  231.      *  @access public
  232.      */
  233.     function setTemplateDir($dir)
  234.     {
  235.         $this->template_dir = $dir;
  236.  
  237.         if (substr($this->template_dir, -1) != '/') {
  238.             $this->template_dir .= '/';
  239.         }
  240.     }
  241.     
  242.     /**
  243.      *  テンプレートの有無をチェックする
  244.      * 
  245.      *  @param string $template テンプレート名
  246.      * 
  247.      *  @access public
  248.      */
  249.     function templateExists($template)
  250.     {
  251.         if (substr($this->template_dir, -1) != '/') {
  252.             $this->template_dir .= '/';
  253.         }
  254.  
  255.         return (is_readable($this->template_dir . $template));
  256.     }
  257.  
  258.     /**
  259.      *  プラグインをセットする
  260.      * 
  261.      *  @param string $name　プラグイン名 
  262.      *  @param string $type プラグインタイプ
  263.      *  @param string $plugin プラグイン本体
  264.      * 
  265.      *  @access public
  266.      */
  267.     function setPlugin($name, $type, $plugin)
  268.     {
  269.         $this->plugin_registry[$type][$name] = $plugin;
  270.     }
  271.  
  272.     // {{{ proxy methods (for B.C.)
  273.     /**
  274.      *  テンプレート変数を割り当てる(後方互換)
  275.      *
  276.      *  @access public
  277.      */
  278.     function assign($name, $value)
  279.     {
  280.         $this->setProp($name, $value);
  281.     }
  282.  
  283.     /**
  284.      *  テンプレート変数に参照を割り当てる(後方互換)
  285.      *
  286.      *  @access public
  287.      */
  288.     function assign_by_ref($name, &$value)
  289.     {
  290.         $this->setPropByRef($name, $value);
  291.     }
  292.  
  293.     /**
  294.      *  ビューを出力する
  295.      *
  296.      *  @access public
  297.      */
  298.     function display($template = null)
  299.     {
  300.         return $this->perform($template);
  301.     }
  302.     // }}}
  303. }
  304. // }}}
  305. ?>

Documentation generated on Fri, 11 Nov 2011 04:00:47 +0900 by phpDocumentor 1.4.3