libraries/Template.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * hold PMA\libraries\Template class
   5  *
   6  * @package PMA\libraries
   7  */
   8 namespace PMA\libraries;
   9
  10 /**
  11  * Class Template
  12  *
  13  * Handle front end templating
  14  *
  15  * @package PMA\libraries
  16  */
  17 class Template
  18 {
  19     /**
  20      * Name of the template
  21      */
  22     protected $name = null;
  23
  24     /**
  25      * Data associated with the template
  26      */
  27     protected $data;
  28
  29     /**
  30      * Helper functions for the template
  31      */
  32     protected $helperFunctions;
  33
  34     const BASE_PATH = 'templates/';
  35
  36     /**
  37      * Template constructor
  38      *
  39      * @param string $name            Template name
  40      * @param array  $data            Variables to be provided to the template
  41      * @param array  $helperFunctions Helper functions to be used by template
  42      */
  43     protected function __construct($name, $data = array(), $helperFunctions = array())
  44     {
  45         $this->name = $name;
  46         $this->data = $data;
  47         $this->helperFunctions = $helperFunctions;
  48     }
  49
  50     /**
  51      * Template getter
  52      *
  53      * @param string $name            Template name
  54      * @param array  $data            Variables to be provided to the template
  55      * @param array  $helperFunctions Helper functions to be used by template
  56      *
  57      * @return Template
  58      */
  59     public static function get($name, $data = array(), $helperFunctions = array())
  60     {
  61         return new Template($name, $data, $helperFunctions);
  62     }
  63
  64     /**
  65      * Adds more entries to the data for this template
  66      *
  67      * @param array|string $data  containing data array or data key
  68      * @param string       $value containing data value
  69      */
  70     public function set($data, $value = null)
  71     {
  72         if(is_array($data) && ! $value) {
  73             $this->data = array_merge(
  74                 $this->data,
  75                 $data
  76             );
  77         } else if (is_string($data)) {
  78             $this->data[$data] = $value;
  79         }
  80     }
  81
  82     /**
  83      * Adds a function for use by the template
  84      *
  85      * @param string   $funcName function name
  86      * @param callable $funcDef  function definition
  87      */
  88     public function setHelper($funcName, $funcDef)
  89     {
  90         if (! isset($this->helperFunctions[$funcName])) {
  91             $this->helperFunctions[$funcName] = $funcDef;
  92         } else {
  93             throw new \LogicException(
  94                 'The function "' . $funcName . '" is already associated with the template.'
  95             );
  96         }
  97     }
  98
  99     /**
 100      * Removes a function
 101      *
 102      * @param string $funcName function name
 103      */
 104     public function removeHelper($funcName)
 105     {
 106         if (isset($this->helperFunctions[$funcName])) {
 107             unset($this->helperFunctions[$funcName]);
 108         } else {
 109             throw new \LogicException(
 110                 'The function "' . $funcName . '" is not associated with the template.'
 111             );
 112         }
 113     }
 114
 115     /**
 116      * Magic call to locally inaccessible but associated helper functions
 117      *
 118      * @param string $funcName  function name
 119      * @param array  $arguments function arguments
 120      */
 121     public function __call($funcName, $arguments)
 122     {
 123         if (isset($this->helperFunctions[$funcName])) {
 124             return call_user_func_array($this->helperFunctions[$funcName], $arguments);
 125         } else {
 126             throw new \LogicException(
 127                 'The function "' . $funcName . '" is not associated with the template.'
 128             );
 129         }
 130     }
 131
 132     /**
 133      * Render template
 134      *
 135      * @param array $data            Variables to be provided to the template
 136      * @param array $helperFunctions Helper functions to be used by template
 137      *
 138      * @return string
 139      */
 140     public function render($data = array(), $helperFunctions = array())
 141     {
 142         $template = static::BASE_PATH . $this->name . '.phtml';
 143         try {
 144             $this->set($data);
 145             $this->helperFunctions = array_merge(
 146                 $this->helperFunctions,
 147                 $helperFunctions
 148             );
 149             extract($this->data);
 150             ob_start();
 151             if (@file_exists($template)) {
 152                 include $template;
 153             } else {
 154                 throw new \LogicException(
 155                     'The template "' . $template . '" not found.'
 156                 );
 157             }
 158             $content = ob_get_clean();
 159
 160             return $content;
 161         } catch (\LogicException $e) {
 162             ob_end_clean();
 163             throw new \LogicException($e->getMessage());
 164         }
 165     }
 166 }