phpDocumentor Smarty
plugins
[ class tree: Smarty ] [ index: Smarty ] [ all elements ]
Smarty
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Source for file core.load_plugins.php

Documentation is available at core.load_plugins.php

  1. <?php
  2. /**
  3.  * Smarty plugin
  4.  * @package Smarty
  5.  * @subpackage plugins
  6.  */
  7.  
  8. /**
  9.  * Load requested plugins
  10.  *
  11.  * @param array $plugins 
  12.  */
  13.  
  14. // $plugins
  15.  
  16. function smarty_core_load_plugins($params, &$smarty)
  17. {
  18.  
  19.     foreach ($params['plugins'] as $_plugin_info) {
  20.         list($_type, $_name, $_tpl_file, $_tpl_line, $_delayed_loading) = $_plugin_info;
  21.         $_plugin = &$smarty->_plugins[$_type][$_name];
  22.  
  23.         /*
  24.          * We do not load plugin more than once for each instance of Smarty.
  25.          * The following code checks for that. The plugin can also be
  26.          * registered dynamically at runtime, in which case template file
  27.          * and line number will be unknown, so we fill them in.
  28.          *
  29.          * The final element of the info array is a flag that indicates
  30.          * whether the dynamically registered plugin function has been
  31.          * checked for existence yet or not.
  32.          */
  33.         if (isset($_plugin)) {
  34.             if (empty($_plugin[3])) {
  35.                 if (!is_callable($_plugin[0])) {
  36.                     $smarty->_trigger_fatal_error("[plugin] $_type '$_name' is not implemented", $_tpl_file, $_tpl_line, __FILE__, __LINE__);
  37.                 } else {
  38.                     $_plugin[1] = $_tpl_file;
  39.                     $_plugin[2] = $_tpl_line;
  40.                     $_plugin[3] = true;
  41.                     if (!isset($_plugin[4])) $_plugin[4] = true; /* cacheable */
  42.                 }
  43.             }
  44.             continue;
  45.         } else if ($_type == 'insert') {
  46.             /*
  47.              * For backwards compatibility, we check for insert functions in
  48.              * the symbol table before trying to load them as a plugin.
  49.              */
  50.             $_plugin_func = 'insert_' . $_name;
  51.             if (function_exists($_plugin_func)) {
  52.                 $_plugin = array($_plugin_func, $_tpl_file, $_tpl_line, true, false);
  53.                 continue;
  54.             }
  55.         }
  56.  
  57.         $_plugin_file = $smarty->_get_plugin_filepath($_type, $_name);
  58.  
  59.         if (! $_found = ($_plugin_file != false)) {
  60.             $_message = "could not load plugin file '$_type.$_name.php'\n";
  61.         }
  62.  
  63.         /*
  64.          * If plugin file is found, it -must- provide the properly named
  65.          * plugin function. In case it doesn't, simply output the error and
  66.          * do not fall back on any other method.
  67.          */
  68.         if ($_found) {
  69.             include_once $_plugin_file;
  70.  
  71.             $_plugin_func = 'smarty_' . $_type . '_' . $_name;
  72.             if (!function_exists($_plugin_func)) {
  73.                 $smarty->_trigger_fatal_error("[plugin] function $_plugin_func() not found in $_plugin_file", $_tpl_file, $_tpl_line, __FILE__, __LINE__);
  74.                 continue;
  75.             }
  76.         }
  77.         /*
  78.          * In case of insert plugins, their code may be loaded later via
  79.          * 'script' attribute.
  80.          */
  81.         else if ($_type == 'insert' && $_delayed_loading) {
  82.             $_plugin_func = 'smarty_' . $_type . '_' . $_name;
  83.             $_found = true;
  84.         }
  85.  
  86.         /*
  87.          * Plugin specific processing and error checking.
  88.          */
  89.         if (!$_found) {
  90.             if ($_type == 'modifier') {
  91.                 /*
  92.                  * In case modifier falls back on using PHP functions
  93.                  * directly, we only allow those specified in the security
  94.                  * context.
  95.                  */
  96.                 if ($smarty->security && !in_array($_name, $smarty->security_settings['MODIFIER_FUNCS'])) {
  97.                     $_message = "(secure mode) modifier '$_name' is not allowed";
  98.                 } else {
  99.                     if (!function_exists($_name)) {
  100.                         $_message = "modifier '$_name' is not implemented";
  101.                     } else {
  102.                         $_plugin_func = $_name;
  103.                         $_found = true;
  104.                     }
  105.                 }
  106.             } else if ($_type == 'function') {
  107.                 /*
  108.                  * This is a catch-all situation.
  109.                  */
  110.                 $_message = "unknown tag - '$_name'";
  111.             }
  112.         }
  113.  
  114.         if ($_found) {
  115.             $smarty->_plugins[$_type][$_name] = array($_plugin_func, $_tpl_file, $_tpl_line, true, true);
  116.         } else {
  117.             // output error
  118.             $smarty->_trigger_fatal_error('[plugin] ' . $_message, $_tpl_file, $_tpl_line, __FILE__, __LINE__);
  119.         }
  120.     }
  121. }
  122.  
  123. /* vim: set expandtab: */
  124.  
  125. ?>
Documentation generated on Tue, 24 Oct 2006 09:21:56 -0500 by phpDocumentor 1.3.1