PageRenderTime 52ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/src/com/squattingsasquatches/lucidity/Server/smarty/sysplugins/smarty_internal_templatebase.php

https://github.com/SquattingSasquatches/Lucidity
PHP | 763 lines | 508 code | 31 blank | 224 comment | 152 complexity | 026826165e65150ae126018520347276 MD5 | raw file
    

  1. <?php

    2. 

  2. /**

    3. 

  3.  * Smarty Internal Plugin Smarty Template  Base

    4. 

  4.  *

    5. 

  5.  * This file contains the basic shared methodes for template handling

    6. 

  6.  *

    7. 

  7.  * @package Smarty

    8. 

  8.  * @subpackage Template

    9. 

  9.  * @author Uwe Tews

    10. 

  10.  */

    11. 

  11. 

    12. 

  12. /**

    13. 

  13.  * Class with shared template methodes

    14. 

  14.  *

    15. 

  15.  * @package Smarty

    16. 

  16.  * @subpackage Template

    17. 

  17.  */

    18. 

  18. abstract class Smarty_Internal_TemplateBase extends Smarty_Internal_Data {

    19. 

  19. 

    20. 

  20.     /**

    21. 

  21.      * fetches a rendered Smarty template

    22. 

  22.      *

    23. 

  23.      * @param string $template          the resource handle of the template file or template object

    24. 

  24.      * @param mixed  $cache_id          cache id to be used with this template

    25. 

  25.      * @param mixed  $compile_id        compile id to be used with this template

    26. 

  26.      * @param object $parent            next higher level of Smarty variables

    27. 

  27.      * @param bool   $display           true: display, false: fetch

    28. 

  28.      * @param bool   $merge_tpl_vars    if true parent template variables merged in to local scope

    29. 

  29.      * @param bool   $no_output_filter  if true do not run output filter

    30. 

  30.      * @return string rendered template output

    31. 

  31.      */

    32. 

  32.     public function fetch($template = null, $cache_id = null, $compile_id = null, $parent = null, $display = false, $merge_tpl_vars = true, $no_output_filter = false)

    33. 

  33.     {

    34. 

  34.         if ($template === null && $this instanceof $this->template_class) {

    35. 

  35.             $template = $this;

    36. 

  36.         }

    37. 

  37.         if (!empty($cache_id) && is_object($cache_id)) {

    38. 

  38.             $parent = $cache_id;

    39. 

  39.             $cache_id = null;

    40. 

  40.         }

    41. 

  41.         if ($parent === null && ($this instanceof Smarty || is_string($template))) {

    42. 

  42.             $parent = $this;

    43. 

  43.         }

    44. 

  44.         // create template object if necessary

    45. 

  45.         $_template = ($template instanceof $this->template_class)

    46. 

  46.             ? $template

    47. 

  47.             : $this->smarty->createTemplate($template, $cache_id, $compile_id, $parent, false);

    48. 

  48.         // if called by Smarty object make sure we use current caching status

    49. 

  49.         if ($this instanceof Smarty) {

    50. 

  50.             $_template->caching = $this->caching;

    51. 

  51.         }

    52. 

  52.         // merge all variable scopes into template

    53. 

  53.         if ($merge_tpl_vars) {

    54. 

  54.             // save local variables

    55. 

  55.             $save_tpl_vars = $_template->tpl_vars;

    56. 

  56.             $save_config_vars = $_template->config_vars;

    57. 

  57.             $ptr_array = array($_template);

    58. 

  58.             $ptr = $_template;

    59. 

  59.             while (isset($ptr->parent)) {

    60. 

  60.                 $ptr_array[] = $ptr = $ptr->parent;

    61. 

  61.             }

    62. 

  62.             $ptr_array = array_reverse($ptr_array);

    63. 

  63.             $parent_ptr = reset($ptr_array);

    64. 

  64.             $tpl_vars = $parent_ptr->tpl_vars;

    65. 

  65.             $config_vars = $parent_ptr->config_vars;

    66. 

  66.             while ($parent_ptr = next($ptr_array)) {

    67. 

  67.                 if (!empty($parent_ptr->tpl_vars)) {

    68. 

  68.                     $tpl_vars = array_merge($tpl_vars, $parent_ptr->tpl_vars);

    69. 

  69.                 }

    70. 

  70.                 if (!empty($parent_ptr->config_vars)) {

    71. 

  71.                     $config_vars = array_merge($config_vars, $parent_ptr->config_vars);

    72. 

  72.                 }

    73. 

  73.             }

    74. 

  74.             if (!empty(Smarty::$global_tpl_vars)) {

    75. 

  75.                 $tpl_vars = array_merge(Smarty::$global_tpl_vars, $tpl_vars);

    76. 

  76.             }

    77. 

  77.             $_template->tpl_vars = $tpl_vars;

    78. 

  78.             $_template->config_vars = $config_vars;

    79. 

  79.         }

    80. 

  80.         // dummy local smarty variable

    81. 

  81.         if (!isset($_template->tpl_vars['smarty'])) {

    82. 

  82.             $_template->tpl_vars['smarty'] = new Smarty_Variable;

    83. 

  83.         }

    84. 

  84.         if (isset($this->smarty->error_reporting)) {

    85. 

  85.             $_smarty_old_error_level = error_reporting($this->smarty->error_reporting);

    86. 

  86.         }

    87. 

  87.         // check URL debugging control

    88. 

  88.         if (!$this->smarty->debugging && $this->smarty->debugging_ctrl == 'URL') {

    89. 

  89.             if (isset($_SERVER['QUERY_STRING'])) {

    90. 

  90.                 $_query_string = $_SERVER['QUERY_STRING'];

    91. 

  91.             } else {

    92. 

  92.                 $_query_string = '';

    93. 

  93.             }

    94. 

  94.             if (false !== strpos($_query_string, $this->smarty->smarty_debug_id)) {

    95. 

  95.                 if (false !== strpos($_query_string, $this->smarty->smarty_debug_id . '=on')) {

    96. 

  96.                     // enable debugging for this browser session

    97. 

  97.                     setcookie('SMARTY_DEBUG', true);

    98. 

  98.                     $this->smarty->debugging = true;

    99. 

  99.                 } elseif (false !== strpos($_query_string, $this->smarty->smarty_debug_id . '=off')) {

    100. 

  100.                     // disable debugging for this browser session

    101. 

  101.                     setcookie('SMARTY_DEBUG', false);

    102. 

  102.                     $this->smarty->debugging = false;

    103. 

  103.                 } else {

    104. 

  104.                     // enable debugging for this page

    105. 

  105.                     $this->smarty->debugging = true;

    106. 

  106.                 }

    107. 

  107.             } else {

    108. 

  108.                 if (isset($_COOKIE['SMARTY_DEBUG'])) {

    109. 

  109.                     $this->smarty->debugging = true;

    110. 

  110.                 }

    111. 

  111.             }

    112. 

  112.         }

    113. 

  113.         // must reset merge template date

    114. 

  114.         $_template->smarty->merged_templates_func = array();

    115. 

  115.         // get rendered template

    116. 

  116.         // disable caching for evaluated code

    117. 

  117.         if ($_template->source->recompiled) {

    118. 

  118.             $_template->caching = false;

    119. 

  119.         }

    120. 

  120.         // checks if template exists

    121. 

  121.         if (!$_template->source->exists) {

    122. 

  122.             if ($_template->parent instanceof Smarty_Internal_Template) {

    123. 

  123.                 $parent_resource = " in '{$_template->parent->template_resource}'";

    124. 

  124.             } else {

    125. 

  125.                 $parent_resource = '';

    126. 

  126.             }

    127. 

  127.             throw new SmartyException("Unable to load template {$_template->source->type} '{$_template->source->name}'{$parent_resource}");

    128. 

  128.         }

    129. 

  129.         // read from cache or render

    130. 

  130.         if (!($_template->caching == Smarty::CACHING_LIFETIME_CURRENT || $_template->caching == Smarty::CACHING_LIFETIME_SAVED) || !$_template->cached->valid) {

    131. 

  131.             // render template (not loaded and not in cache)

    132. 

  132.             if (!$_template->source->uncompiled) {

    133. 

  133.                 $_smarty_tpl = $_template;

    134. 

  134.                 if ($_template->source->recompiled) {

    135. 

  135.                     if ($this->smarty->debugging) {

    136. 

  136.                         Smarty_Internal_Debug::start_compile($_template);

    137. 

  137.                     }

    138. 

  138.                     $code = $_template->compiler->compileTemplate($_template);

    139. 

  139.                     if ($this->smarty->debugging) {

    140. 

  140.                         Smarty_Internal_Debug::end_compile($_template);

    141. 

  141.                     }

    142. 

  142.                     if ($this->smarty->debugging) {

    143. 

  143.                         Smarty_Internal_Debug::start_render($_template);

    144. 

  144.                     }

    145. 

  145.                     try {

    146. 

  146.                         ob_start();

    147. 

  147.                         eval("?>" . $code);

    148. 

  148.                         unset($code);

    149. 

  149.                     } catch (Exception $e) {

    150. 

  150.                         ob_get_clean();

    151. 

  151.                         throw $e;

    152. 

  152.                     }

    153. 

  153.                 } else {

    154. 

  154.                     if (!$_template->compiled->exists || ($_template->smarty->force_compile && !$_template->compiled->isCompiled)) {

    155. 

  155.                         $_template->compileTemplateSource();

    156. 

  156.                     }

    157. 

  157.                     if ($this->smarty->debugging) {

    158. 

  158.                         Smarty_Internal_Debug::start_render($_template);

    159. 

  159.                     }

    160. 

  160.                     if (!$_template->compiled->loaded) {

    161. 

  161.                         include($_template->compiled->filepath);

    162. 

  162.                         if ($_template->mustCompile) {

    163. 

  163.                             // recompile and load again

    164. 

  164.                             $_template->compileTemplateSource();

    165. 

  165.                             include($_template->compiled->filepath);

    166. 

  166.                         }

    167. 

  167.                         $_template->compiled->loaded = true;

    168. 

  168.                     } else {

    169. 

  169.                         $_template->decodeProperties($_template->compiled->_properties, false);

    170. 

  170.                     }

    171. 

  171.                     try {

    172. 

  172.                         ob_start();

    173. 

  173.                         if (empty($_template->properties['unifunc']) || !is_callable($_template->properties['unifunc'])) {

    174. 

  174.                             throw new SmartyException("Invalid compiled template for '{$_template->template_resource}'");

    175. 

  175.                         }

    176. 

  176.                         $_template->properties['unifunc']($_template);

    177. 

  177.                         if (isset($_template->_capture_stack[0])) {

    178. 

  178.                             $_template->capture_error();

    179. 

  179.                         }

    180. 

  180.                     } catch (Exception $e) {

    181. 

  181.                         ob_get_clean();

    182. 

  182.                         throw $e;

    183. 

  183.                     }

    184. 

  184.                 }

    185. 

  185.             } else {

    186. 

  186.                 if ($_template->source->uncompiled) {

    187. 

  187.                     if ($this->smarty->debugging) {

    188. 

  188.                         Smarty_Internal_Debug::start_render($_template);

    189. 

  189.                     }

    190. 

  190.                     try {

    191. 

  191.                         ob_start();

    192. 

  192.                         $_template->source->renderUncompiled($_template);

    193. 

  193.                     } catch (Exception $e) {

    194. 

  194.                         ob_get_clean();

    195. 

  195.                         throw $e;

    196. 

  196.                     }

    197. 

  197.                 } else {

    198. 

  198.                     throw new SmartyException("Resource '$_template->source->type' must have 'renderUncompiled' method");

    199. 

  199.                 }

    200. 

  200.             }

    201. 

  201.             $_output = ob_get_clean();

    202. 

  202.             if (!$_template->source->recompiled && empty($_template->properties['file_dependency'][$_template->source->uid])) {

    203. 

  203.                 $_template->properties['file_dependency'][$_template->source->uid] = array($_template->source->filepath, $_template->source->timestamp, $_template->source->type);

    204. 

  204.             }

    205. 

  205.             if ($_template->parent instanceof Smarty_Internal_Template) {

    206. 

  206.                 $_template->parent->properties['file_dependency'] = array_merge($_template->parent->properties['file_dependency'], $_template->properties['file_dependency']);

    207. 

  207.                 foreach ($_template->required_plugins as $code => $tmp1) {

    208. 

  208.                     foreach ($tmp1 as $name => $tmp) {

    209. 

  209.                         foreach ($tmp as $type => $data) {

    210. 

  210.                             $_template->parent->required_plugins[$code][$name][$type] = $data;

    211. 

  211.                         }

    212. 

  212.                     }

    213. 

  213.                 }

    214. 

  214.             }

    215. 

  215.             if ($this->smarty->debugging) {

    216. 

  216.                 Smarty_Internal_Debug::end_render($_template);

    217. 

  217.             }

    218. 

  218.             // write to cache when nessecary

    219. 

  219.             if (!$_template->source->recompiled && ($_template->caching == Smarty::CACHING_LIFETIME_SAVED || $_template->caching == Smarty::CACHING_LIFETIME_CURRENT)) {

    220. 

  220.                 if ($this->smarty->debugging) {

    221. 

  221.                     Smarty_Internal_Debug::start_cache($_template);

    222. 

  222.                 }

    223. 

  223.                 $_template->properties['has_nocache_code'] = false;

    224. 

  224.                 // get text between non-cached items

    225. 

  225.                 $cache_split = preg_split("!/\*%%SmartyNocache:{$_template->properties['nocache_hash']}%%\*\/(.+?)/\*/%%SmartyNocache:{$_template->properties['nocache_hash']}%%\*/!s", $_output);

    226. 

  226.                 // get non-cached items

    227. 

  227.                 preg_match_all("!/\*%%SmartyNocache:{$_template->properties['nocache_hash']}%%\*\/(.+?)/\*/%%SmartyNocache:{$_template->properties['nocache_hash']}%%\*/!s", $_output, $cache_parts);

    228. 

  228.                 $output = '';

    229. 

  229.                 // loop over items, stitch back together

    230. 

  230.                 foreach ($cache_split as $curr_idx => $curr_split) {

    231. 

  231.                     // escape PHP tags in template content

    232. 

  232.                     $output .= preg_replace('/(<%|%>|<\?php|<\?|\?>)/', '<?php echo \'$1\'; ?>', $curr_split);

    233. 

  233.                     if (isset($cache_parts[0][$curr_idx])) {

    234. 

  234.                         $_template->properties['has_nocache_code'] = true;

    235. 

  235.                         // remove nocache tags from cache output

    236. 

  236.                         $output .= preg_replace("!/\*/?%%SmartyNocache:{$_template->properties['nocache_hash']}%%\*/!", '', $cache_parts[0][$curr_idx]);

    237. 

  237.                     }

    238. 

  238.                 }

    239. 

  239.                 if (!$no_output_filter && (isset($this->smarty->autoload_filters['output']) || isset($this->smarty->registered_filters['output']))) {

    240. 

  240.                     $output = Smarty_Internal_Filter_Handler::runFilter('output', $output, $_template);

    241. 

  241.                 }

    242. 

  242.                 // rendering (must be done before writing cache file because of {function} nocache handling)

    243. 

  243.                 $_smarty_tpl = $_template;

    244. 

  244.                 try {

    245. 

  245.                     ob_start();

    246. 

  246.                     eval("?>" . $output);

    247. 

  247.                     $_output = ob_get_clean();

    248. 

  248.                 } catch (Exception $e) {

    249. 

  249.                     ob_get_clean();

    250. 

  250.                     throw $e;

    251. 

  251.                 }

    252. 

  252.                 // write cache file content

    253. 

  253.                 $_template->writeCachedContent($output);

    254. 

  254.                 if ($this->smarty->debugging) {

    255. 

  255.                     Smarty_Internal_Debug::end_cache($_template);

    256. 

  256.                 }

    257. 

  257.             } else {

    258. 

  258.                 // var_dump('renderTemplate', $_template->has_nocache_code, $_template->template_resource, $_template->properties['nocache_hash'], $_template->parent->properties['nocache_hash'], $_output);

    259. 

  259.                 if (!empty($_template->properties['nocache_hash']) && !empty($_template->parent->properties['nocache_hash'])) {

    260. 

  260.                     // replace nocache_hash

    261. 

  261.                     $_output = preg_replace("/{$_template->properties['nocache_hash']}/", $_template->parent->properties['nocache_hash'], $_output);

    262. 

  262.                     $_template->parent->has_nocache_code = $_template->parent->has_nocache_code || $_template->has_nocache_code;

    263. 

  263.                 }

    264. 

  264.             }

    265. 

  265.         } else {

    266. 

  266.             if ($this->smarty->debugging) {

    267. 

  267.                 Smarty_Internal_Debug::start_cache($_template);

    268. 

  268.             }

    269. 

  269.             try {

    270. 

  270.                 ob_start();

    271. 

  271.                 $_template->properties['unifunc']($_template);

    272. 

  272.                 if (isset($_template->_capture_stack[0])) {

    273. 

  273.                     $_template->capture_error();

    274. 

  274.                 }

    275. 

  275.                 $_output = ob_get_clean();

    276. 

  276.             } catch (Exception $e) {

    277. 

  277.                 ob_get_clean();

    278. 

  278.                 throw $e;

    279. 

  279.             }

    280. 

  280.             if ($this->smarty->debugging) {

    281. 

  281.                 Smarty_Internal_Debug::end_cache($_template);

    282. 

  282.             }

    283. 

  283.         }

    284. 

  284.         if ((!$this->caching || $_template->source->recompiled) && !$no_output_filter && (isset($this->smarty->autoload_filters['output']) || isset($this->smarty->registered_filters['output']))) {

    285. 

  285.             $_output = Smarty_Internal_Filter_Handler::runFilter('output', $_output, $_template);

    286. 

  286.         }

    287. 

  287.         if (isset($this->error_reporting)) {

    288. 

  288.             error_reporting($_smarty_old_error_level);

    289. 

  289.         }

    290. 

  290.         // display or fetch

    291. 

  291.         if ($display) {

    292. 

  292.             if ($this->caching && $this->cache_modified_check) {

    293. 

  293.                 $_isCached = $_template->isCached() && !$_template->has_nocache_code;

    294. 

  294.                 $_last_modified_date = @substr($_SERVER['HTTP_IF_MODIFIED_SINCE'], 0, strpos($_SERVER['HTTP_IF_MODIFIED_SINCE'], 'GMT') + 3);

    295. 

  295.                 if ($_isCached && $_template->cached->timestamp <= strtotime($_last_modified_date)) {

    296. 

  296.                     switch (PHP_SAPI) {

    297. 

  297.                         case 'cgi':         // php-cgi < 5.3

    298. 

  298.                         case 'cgi-fcgi':    // php-cgi >= 5.3

    299. 

  299.                         case 'fpm-fcgi':    // php-fpm >= 5.3.3

    300. 

  300.                             header('Status: 304 Not Modified');

    301. 

  301.                             break;

    302. 

  302. 

    303. 

  303.                         case 'cli':

    304. 

  304.                             if (/* ^phpunit */!empty($_SERVER['SMARTY_PHPUNIT_DISABLE_HEADERS'])/* phpunit$ */) {

    305. 

  305.                                 $_SERVER['SMARTY_PHPUNIT_HEADERS'][] = '304 Not Modified';

    306. 

  306.                             }

    307. 

  307.                             break;

    308. 

  308. 

    309. 

  309.                         default:

    310. 

  310.                             header('HTTP/1.1 304 Not Modified');

    311. 

  311.                             break;

    312. 

  312.                     }

    313. 

  313.                 } else {

    314. 

  314.                     switch (PHP_SAPI) {

    315. 

  315.                         case 'cli':

    316. 

  316.                             if (/* ^phpunit */!empty($_SERVER['SMARTY_PHPUNIT_DISABLE_HEADERS'])/* phpunit$ */) {

    317. 

  317.                                 $_SERVER['SMARTY_PHPUNIT_HEADERS'][] = 'Last-Modified: ' . gmdate('D, d M Y H:i:s', $_template->cached->timestamp) . ' GMT';

    318. 

  318.                             }

    319. 

  319.                             break;

    320. 

  320. 

    321. 

  321.                         default:

    322. 

  322.                             header('Last-Modified: ' . gmdate('D, d M Y H:i:s', $_template->cached->timestamp) . ' GMT');

    323. 

  323.                             break;

    324. 

  324.                     }

    325. 

  325.                     echo $_output;

    326. 

  326.                 }

    327. 

  327.             } else {

    328. 

  328.                 echo $_output;

    329. 

  329.             }

    330. 

  330.             // debug output

    331. 

  331.             if ($this->smarty->debugging) {

    332. 

  332.                 Smarty_Internal_Debug::display_debug($this);

    333. 

  333.             }

    334. 

  334.             if ($merge_tpl_vars) {

    335. 

  335.                 // restore local variables

    336. 

  336.                 $_template->tpl_vars = $save_tpl_vars;

    337. 

  337.                 $_template->config_vars =  $save_config_vars;

    338. 

  338.             }

    339. 

  339.             return;

    340. 

  340.         } else {

    341. 

  341.             if ($merge_tpl_vars) {

    342. 

  342.                 // restore local variables

    343. 

  343.                 $_template->tpl_vars = $save_tpl_vars;

    344. 

  344.                 $_template->config_vars =  $save_config_vars;

    345. 

  345.             }

    346. 

  346.             // return fetched content

    347. 

  347.             return $_output;

    348. 

  348.         }

    349. 

  349.     }

    350. 

  350. 

    351. 

  351.     /**

    352. 

  352.      * displays a Smarty template

    353. 

  353.      *

    354. 

  354.      * @param string $template   the resource handle of the template file or template object

    355. 

  355.      * @param mixed  $cache_id   cache id to be used with this template

    356. 

  356.      * @param mixed  $compile_id compile id to be used with this template

    357. 

  357.      * @param object $parent     next higher level of Smarty variables

    358. 

  358.      */

    359. 

  359.     public function display($template = null, $cache_id = null, $compile_id = null, $parent = null)

    360. 

  360.     {

    361. 

  361.         // display template

    362. 

  362.         $this->fetch($template, $cache_id, $compile_id, $parent, true);

    363. 

  363.     }

    364. 

  364. 

    365. 

  365.     /**

    366. 

  366.      * test if cache is valid

    367. 

  367.      *

    368. 

  368.      * @param string|object $template   the resource handle of the template file or template object

    369. 

  369.      * @param mixed         $cache_id   cache id to be used with this template

    370. 

  370.      * @param mixed         $compile_id compile id to be used with this template

    371. 

  371.      * @param object        $parent     next higher level of Smarty variables

    372. 

  372.      * @return boolean cache status

    373. 

  373.      */

    374. 

  374.     public function isCached($template = null, $cache_id = null, $compile_id = null, $parent = null)

    375. 

  375.     {

    376. 

  376.         if ($template === null && $this instanceof $this->template_class) {

    377. 

  377.             return $this->cached->valid;

    378. 

  378.         }

    379. 

  379.         if (!($template instanceof $this->template_class)) {

    380. 

  380.             if ($parent === null) {

    381. 

  381.                 $parent = $this;

    382. 

  382.             }

    383. 

  383.             $template = $this->smarty->createTemplate($template, $cache_id, $compile_id, $parent, false);

    384. 

  384.         }

    385. 

  385.         // return cache status of template

    386. 

  386.         return $template->cached->valid;

    387. 

  387.     }

    388. 

  388. 

    389. 

  389.     /**

    390. 

  390.      * creates a data object

    391. 

  391.      *

    392. 

  392.      * @param object $parent next higher level of Smarty variables

    393. 

  393.      * @returns Smarty_Data data object

    394. 

  394.      */

    395. 

  395.     public function createData($parent = null)

    396. 

  396.     {

    397. 

  397.         return new Smarty_Data($parent, $this);

    398. 

  398.     }

    399. 

  399. 

    400. 

  400.     /**

    401. 

  401.      * Registers plugin to be used in templates

    402. 

  402.      *

    403. 

  403.      * @param string   $type       plugin type

    404. 

  404.      * @param string   $tag        name of template tag

    405. 

  405.      * @param callback $callback   PHP callback to register

    406. 

  406.      * @param boolean  $cacheable  if true (default) this fuction is cachable

    407. 

  407.      * @param array    $cache_attr caching attributes if any

    408. 

  408.      * @throws SmartyException when the plugin tag is invalid

    409. 

  409.      */

    410. 

  410.     public function registerPlugin($type, $tag, $callback, $cacheable = true, $cache_attr = null)

    411. 

  411.     {

    412. 

  412.         if (isset($this->smarty->registered_plugins[$type][$tag])) {

    413. 

  413.             throw new SmartyException("Plugin tag \"{$tag}\" already registered");

    414. 

  414.         } elseif (!is_callable($callback)) {

    415. 

  415.             throw new SmartyException("Plugin \"{$tag}\" not callable");

    416. 

  416.         } else {

    417. 

  417.             $this->smarty->registered_plugins[$type][$tag] = array($callback, (bool) $cacheable, (array) $cache_attr);

    418. 

  418.         }

    419. 

  419.     }

    420. 

  420. 

    421. 

  421.     /**

    422. 

  422.      * Unregister Plugin

    423. 

  423.      *

    424. 

  424.      * @param string $type of plugin

    425. 

  425.      * @param string $tag name of plugin

    426. 

  426.      */

    427. 

  427.     public function unregisterPlugin($type, $tag)

    428. 

  428.     {

    429. 

  429.         if (isset($this->smarty->registered_plugins[$type][$tag])) {

    430. 

  430.             unset($this->smarty->registered_plugins[$type][$tag]);

    431. 

  431.         }

    432. 

  432.     }

    433. 

  433. 

    434. 

  434.     /**

    435. 

  435.      * Registers a resource to fetch a template

    436. 

  436.      *

    437. 

  437.      * @param string $type name of resource type

    438. 

  438.      * @param Smarty_Resource|array $callback or instance of Smarty_Resource, or array of callbacks to handle resource (deprecated)

    439. 

  439.      */

    440. 

  440.     public function registerResource($type, $callback)

    441. 

  441.     {

    442. 

  442.         $this->smarty->registered_resources[$type] = $callback instanceof Smarty_Resource ? $callback : array($callback, false);

    443. 

  443.     }

    444. 

  444. 

    445. 

  445.     /**

    446. 

  446.      * Unregisters a resource

    447. 

  447.      *

    448. 

  448.      * @param string $type name of resource type

    449. 

  449.      */

    450. 

  450.     public function unregisterResource($type)

    451. 

  451.     {

    452. 

  452.         if (isset($this->smarty->registered_resources[$type])) {

    453. 

  453.             unset($this->smarty->registered_resources[$type]);

    454. 

  454.         }

    455. 

  455.     }

    456. 

  456. 

    457. 

  457.     /**

    458. 

  458.      * Registers a cache resource to cache a template's output

    459. 

  459.      *

    460. 

  460.      * @param string               $type     name of cache resource type

    461. 

  461.      * @param Smarty_CacheResource $callback instance of Smarty_CacheResource to handle output caching

    462. 

  462.      */

    463. 

  463.     public function registerCacheResource($type, Smarty_CacheResource $callback)

    464. 

  464.     {

    465. 

  465.         $this->smarty->registered_cache_resources[$type] = $callback;

    466. 

  466.     }

    467. 

  467. 

    468. 

  468.     /**

    469. 

  469.      * Unregisters a cache resource

    470. 

  470.      *

    471. 

  471.      * @param string $type name of cache resource type

    472. 

  472.      */

    473. 

  473.     public function unregisterCacheResource($type)

    474. 

  474.     {

    475. 

  475.         if (isset($this->smarty->registered_cache_resources[$type])) {

    476. 

  476.             unset($this->smarty->registered_cache_resources[$type]);

    477. 

  477.         }

    478. 

  478.     }

    479. 

  479. 

    480. 

  480.     /**

    481. 

  481.      * Registers object to be used in templates

    482. 

  482.      *

    483. 

  483.      * @param string  $object        name of template object

    484. 

  484.      * @param object  $object_impl   the referenced PHP object to register

    485. 

  485.      * @param array   $allowed       list of allowed methods (empty = all)

    486. 

  486.      * @param boolean $smarty_args   smarty argument format, else traditional

    487. 

  487.      * @param array   $block_methods list of block-methods

    488. 

  488.      * @param array $block_functs list of methods that are block format

    489. 

  489.      * @throws SmartyException if any of the methods in $allowed or $block_methods are invalid

    490. 

  490.      */

    491. 

  491.     public function registerObject($object_name, $object_impl, $allowed = array(), $smarty_args = true, $block_methods = array())

    492. 

  492.     {

    493. 

  493.         // test if allowed methodes callable

    494. 

  494.         if (!empty($allowed)) {

    495. 

  495.             foreach ((array) $allowed as $method) {

    496. 

  496.                 if (!is_callable(array($object_impl, $method))) {

    497. 

  497.                     throw new SmartyException("Undefined method '$method' in registered object");

    498. 

  498.                 }

    499. 

  499.             }

    500. 

  500.         }

    501. 

  501.         // test if block methodes callable

    502. 

  502.         if (!empty($block_methods)) {

    503. 

  503.             foreach ((array) $block_methods as $method) {

    504. 

  504.                 if (!is_callable(array($object_impl, $method))) {

    505. 

  505.                     throw new SmartyException("Undefined method '$method' in registered object");

    506. 

  506.                 }

    507. 

  507.             }

    508. 

  508.         }

    509. 

  509.         // register the object

    510. 

  510.         $this->smarty->registered_objects[$object_name] =

    511. 

  511.             array($object_impl, (array) $allowed, (boolean) $smarty_args, (array) $block_methods);

    512. 

  512.     }

    513. 

  513. 

    514. 

  514.     /**

    515. 

  515.      * return a reference to a registered object

    516. 

  516.      *

    517. 

  517.      * @param string $name object name

    518. 

  518.      * @return object

    519. 

  519.      * @throws SmartyException if no such object is found

    520. 

  520.      */

    521. 

  521.     public function getRegisteredObject($name)

    522. 

  522.     {

    523. 

  523.         if (!isset($this->smarty->registered_objects[$name])) {

    524. 

  524.             throw new SmartyException("'$name' is not a registered object");

    525. 

  525.         }

    526. 

  526.         if (!is_object($this->smarty->registered_objects[$name][0])) {

    527. 

  527.             throw new SmartyException("registered '$name' is not an object");

    528. 

  528.         }

    529. 

  529.         return $this->smarty->registered_objects[$name][0];

    530. 

  530.     }

    531. 

  531. 

    532. 

  532.     /**

    533. 

  533.      * unregister an object

    534. 

  534.      *

    535. 

  535.      * @param string $name object name

    536. 

  536.      * @throws SmartyException if no such object is found

    537. 

  537.      */

    538. 

  538.     public function unregisterObject($name)

    539. 

  539.     {

    540. 

  540.         unset($this->smarty->registered_objects[$name]);

    541. 

  541.         return;

    542. 

  542.     }

    543. 

  543. 

    544. 

  544.     /**

    545. 

  545.      * Registers static classes to be used in templates

    546. 

  546.      *

    547. 

  547.      * @param string $class name of template class

    548. 

  548.      * @param string $class_impl the referenced PHP class to register

    549. 

  549.      * @throws SmartyException if $class_impl does not refer to an existing class

    550. 

  550.      */

    551. 

  551.     public function registerClass($class_name, $class_impl)

    552. 

  552.     {

    553. 

  553.         // test if exists

    554. 

  554.         if (!class_exists($class_impl)) {

    555. 

  555.             throw new SmartyException("Undefined class '$class_impl' in register template class");

    556. 

  556.         }

    557. 

  557.         // register the class

    558. 

  558.         $this->smarty->registered_classes[$class_name] = $class_impl;

    559. 

  559.     }

    560. 

  560. 

    561. 

  561.     /**

    562. 

  562.      * Registers a default plugin handler

    563. 

  563.      *

    564. 

  564.      * @param callable $callback class/method name

    565. 

  565.      * @throws SmartyException if $callback is not callable

    566. 

  566.      */

    567. 

  567.     public function registerDefaultPluginHandler($callback)

    568. 

  568.     {

    569. 

  569.         if (is_callable($callback)) {

    570. 

  570.             $this->smarty->default_plugin_handler_func = $callback;

    571. 

  571.         } else {

    572. 

  572.             throw new SmartyException("Default plugin handler '$callback' not callable");

    573. 

  573.         }

    574. 

  574.     }

    575. 

  575. 

    576. 

  576.     /**

    577. 

  577.      * Registers a default template handler

    578. 

  578.      *

    579. 

  579.      * @param callable $callback class/method name

    580. 

  580.      * @throws SmartyException if $callback is not callable

    581. 

  581.      */

    582. 

  582.     public function registerDefaultTemplateHandler($callback)

    583. 

  583.     {

    584. 

  584.         if (is_callable($callback)) {

    585. 

  585.             $this->smarty->default_template_handler_func = $callback;

    586. 

  586.         } else {

    587. 

  587.             throw new SmartyException("Default template handler '$callback' not callable");

    588. 

  588.         }

    589. 

  589.     }

    590. 

  590. 

    591. 

  591.     /**

    592. 

  592.      * Registers a default template handler

    593. 

  593.      *

    594. 

  594.      * @param callable $callback class/method name

    595. 

  595.      * @throws SmartyException if $callback is not callable

    596. 

  596.      */

    597. 

  597.     public function registerDefaultConfigHandler($callback)

    598. 

  598.     {

    599. 

  599.         if (is_callable($callback)) {

    600. 

  600.             $this->smarty->default_config_handler_func = $callback;

    601. 

  601.         } else {

    602. 

  602.             throw new SmartyException("Default config handler '$callback' not callable");

    603. 

  603.         }

    604. 

  604.     }

    605. 

  605. 

    606. 

  606.     /**

    607. 

  607.      * Registers a filter function

    608. 

  608.      *

    609. 

  609.      * @param string $type filter type

    610. 

  610.      * @param callback $callback

    611. 

  611.      */

    612. 

  612.     public function registerFilter($type, $callback)

    613. 

  613.     {

    614. 

  614.         $this->smarty->registered_filters[$type][$this->_get_filter_name($callback)] = $callback;

    615. 

  615.     }

    616. 

  616. 

    617. 

  617.     /**

    618. 

  618.      * Unregisters a filter function

    619. 

  619.      *

    620. 

  620.      * @param string $type filter type

    621. 

  621.      * @param callback $callback

    622. 

  622.      */

    623. 

  623.     public function unregisterFilter($type, $callback)

    624. 

  624.     {

    625. 

  625.         $name = $this->_get_filter_name($callback);

    626. 

  626.         if (isset($this->smarty->registered_filters[$type][$name])) {

    627. 

  627.             unset($this->smarty->registered_filters[$type][$name]);

    628. 

  628.         }

    629. 

  629.     }

    630. 

  630. 

    631. 

  631.     /**

    632. 

  632.      * Return internal filter name

    633. 

  633.      *

    634. 

  634.      * @param callback $function_name

    635. 

  635.      */

    636. 

  636.     public function _get_filter_name($function_name)

    637. 

  637.     {

    638. 

  638.         if (is_array($function_name)) {

    639. 

  639.             $_class_name = (is_object($function_name[0]) ?

    640. 

  640.                             get_class($function_name[0]) : $function_name[0]);

    641. 

  641.             return $_class_name . '_' . $function_name[1];

    642. 

  642.         } else {

    643. 

  643.             return $function_name;

    644. 

  644.         }

    645. 

  645.     }

    646. 

  646. 

    647. 

  647.     /**

    648. 

  648.      * load a filter of specified type and name

    649. 

  649.      *

    650. 

  650.      * @param string $type filter type

    651. 

  651.      * @param string $name filter name

    652. 

  652.      * @return bool

    653. 

  653.      */

    654. 

  654.     public function loadFilter($type, $name)

    655. 

  655.     {

    656. 

  656.         $_plugin = "smarty_{$type}filter_{$name}";

    657. 

  657.         $_filter_name = $_plugin;

    658. 

  658.         if ($this->smarty->loadPlugin($_plugin)) {

    659. 

  659.             if (class_exists($_plugin, false)) {

    660. 

  660.                 $_plugin = array($_plugin, 'execute');

    661. 

  661.             }

    662. 

  662.             if (is_callable($_plugin)) {

    663. 

  663.                 $this->smarty->registered_filters[$type][$_filter_name] = $_plugin;

    664. 

  664.                 return true;

    665. 

  665.             }

    666. 

  666.         }

    667. 

  667.         throw new SmartyException("{$type}filter \"{$name}\" not callable");

    668. 

  668.         return false;

    669. 

  669.     }

    670. 

  670. 

    671. 

  671.     /**

    672. 

  672.      * unload a filter of specified type and name

    673. 

  673.      *

    674. 

  674.      * @param string $type filter type

    675. 

  675.      * @param string $name filter name

    676. 

  676.      * @return bool

    677. 

  677.      */

    678. 

  678.     public function unloadFilter($type, $name)

    679. 

  679.     {

    680. 

  680.         $_filter_name = "smarty_{$type}filter_{$name}";

    681. 

  681.         if (isset($this->smarty->registered_filters[$type][$_filter_name])) {

    682. 

  682.             unset ($this->smarty->registered_filters[$type][$_filter_name]);

    683. 

  683.             return true;

    684. 

  684.         } else {

    685. 

  685.             return false;

    686. 

  686.         }

    687. 

  687.     }

    688. 

  688. 

    689. 

  689.     /**

    690. 

  690.      * preg_replace callback to convert camelcase getter/setter to underscore property names

    691. 

  691.      *

    692. 

  692.      * @param string $match match string

    693. 

  693.      * @return string  replacemant

    694. 

  694.      */

    695. 

  695.     private function replaceCamelcase($match) {

    696. 

  696.         return "_" . strtolower($match[1]);

    697. 

  697.     }

    698. 

  698. 

    699. 

  699.     /**

    700. 

  700.      * Handle unknown class methods

    701. 

  701.      *

    702. 

  702.      * @param string $name unknown method-name

    703. 

  703.      * @param array  $args argument array

    704. 

  704.      */

    705. 

  705.     public function __call($name, $args)

    706. 

  706.     {

    707. 

  707.         static $_prefixes = array('set' => true, 'get' => true);

    708. 

  708.         static $_resolved_property_name = array();

    709. 

  709.         static $_resolved_property_source = array();

    710. 

  710. 

    711. 

  711.         // method of Smarty object?

    712. 

  712.         if (method_exists($this->smarty, $name)) {

    713. 

  713.             return call_user_func_array(array($this->smarty, $name), $args);

    714. 

  714.         }

    715. 

  715.         // see if this is a set/get for a property

    716. 

  716.         $first3 = strtolower(substr($name, 0, 3));

    717. 

  717.         if (isset($_prefixes[$first3]) && isset($name[3]) && $name[3] !== '_') {

    718. 

  718.             if (isset($_resolved_property_name[$name])) {

    719. 

  719.                 $property_name = $_resolved_property_name[$name];

    720. 

  720.             } else {

    721. 

  721.                 // try to keep case correct for future PHP 6.0 case-sensitive class methods

    722. 

  722.                 // lcfirst() not available < PHP 5.3.0, so improvise

    723. 

  723.                 $property_name = strtolower(substr($name, 3, 1)) . substr($name, 4);

    724. 

  724.                 // convert camel case to underscored name

    725. 

  725.                 $property_name = preg_replace_callback('/([A-Z])/', array($this,'replaceCamelcase'), $property_name);

    726. 

  726.                 $_resolved_property_name[$name] = $property_name;

    727. 

  727.             }

    728. 

  728.             if (isset($_resolved_property_source[$property_name])) {

    729. 

  729.                 $_is_this = $_resolved_property_source[$property_name];

    730. 

  730.             } else {

    731. 

  731.                 $_is_this = null;

    732. 

  732.                 if (property_exists($this, $property_name)) {

    733. 

  733.                     $_is_this = true;

    734. 

  734.                 } else if (property_exists($this->smarty, $property_name)) {

    735. 

  735.                     $_is_this = false;

    736. 

  736.                 }

    737. 

  737.                 $_resolved_property_source[$property_name] = $_is_this;

    738. 

  738.             }

    739. 

  739.             if ($_is_this) {

    740. 

  740.                 if ($first3 == 'get')

    741. 

  741.                     return $this->$property_name;

    742. 

  742.                 else

    743. 

  743.                     return $this->$property_name = $args[0];

    744. 

  744.             } else if ($_is_this === false) {

    745. 

  745.                 if ($first3 == 'get')

    746. 

  746.                     return $this->smarty->$property_name;

    747. 

  747.                 else

    748. 

  748.                     return $this->smarty->$property_name = $args[0];

    749. 

  749.             } else {

    750. 

  750.                 throw new SmartyException("property '$property_name' does not exist.");

    751. 

  751.                 return false;

    752. 

  752.             }

    753. 

  753.         }

    754. 

  754.         if ($name == 'Smarty') {

    755. 

  755.             throw new SmartyException("PHP5 requires you to call __construct() instead of Smarty()");

    756. 

  756.         }

    757. 

  757.         // must be unknown

    758. 

  758.         throw new SmartyException("Call of unknown method '$name'.");

    759. 

  759.     }

    760. 

  760. 

    761. 

  761. }

    762. 

  762. 

    763. 

  763. ?>
    764.