Source for file Renderer.php

Documentation is available at Renderer.php

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

Documentation generated on Fri, 11 Nov 2011 03:59:00 +0900 by phpDocumentor 1.4.3