Class Smarty_CMS

Description

Extends the Smarty class for content.

  • since: 0.1

Located in /class.Smarty_CMS.php (line 33)

SmartyBC
   |
   --Smarty_CMS
Variable Summary
mixed $id
mixed $params
Method Summary
static object &get_instance ()
static void _dflt_plugin ( $params,  $smarty)
Smarty_CMS __construct (array 0)
mixed clearCache (mixed $template_name, [int $cache_id = null], [int $compile_id = null], [mixed $exp_time = null], [mixed $type = null])
void createTemplate ( $template, [ $cache_id = null], [ $compile_id = null], [ $parent = null], [ $do_clone = true])
boolean defaultPluginHandler (string $name, string $type, string $template,  &$callback,  &$script,  &$cachable, string $callback, string $script)
html errorConsole ( $e)
mixed fetch ([mixed $template = null], [int $cache_id = null], [ $compile_id = null], [mixed $parent = null], [boolean $display = false], [boolean $merge_tpl_vars = true], [boolean $no_output_filter = false])
mixed isCached ([ $template = null], [int $cache_id = null], [int $compile_id = null], [mixed $parent = null], mixed $template_name)
boolean is_registered (string $name)
string loadPlugin (string $plugin_name, [bool $check = true])
Smarty_Internal_Templatebase registerPlugin (string $type, string $tag, callback $callback, [boolean $cacheable = true], [array $cache_attr = null])
void set_global_cacheid (int $id)
void _dummyDfltPluginHandler ( $name,  $type,  $template,  &$callback,  &$script,  &$cachable)
Variables
mixed $id (line 35)
  • access: public
mixed $params (line 36)
  • access: public
Methods
static method get_instance (line 280)

get_instance method

  • access: public
static object &get_instance ()
static method _dflt_plugin (line 191)

_dflt_plugin

  • access: public
static void _dflt_plugin ( $params,  $smarty)
  • $params
  • $smarty
Constructor __construct (line 45)

Constructor

  • access: public
Smarty_CMS __construct (array 0)
  • array 0: The hash of CMSMS config settings
clearCache (line 363)

clearCache method NOTE: Overwrites parent

  • access: public
mixed clearCache (mixed $template_name, [int $cache_id = null], [int $compile_id = null], [mixed $exp_time = null], [mixed $type = null])
  • mixed $template_name
  • int $cache_id
  • int $compile_id
  • mixed $exp_time
  • mixed $type
createTemplate (line 336)
  • access: public
void createTemplate ( $template, [ $cache_id = null], [ $compile_id = null], [ $parent = null], [ $do_clone = true])
  • $template
  • $cache_id
  • $compile_id
  • $parent
  • $do_clone
defaultPluginHandler (line 223)

defaultPluginHandler NOTE: Registered in constructor

  • return: true on success, false on failure
  • access: public
boolean defaultPluginHandler (string $name, string $type, string $template,  &$callback,  &$script,  &$cachable, string $callback, string $script)
  • string $name
  • string $type
  • string $template
  • string $callback
  • string $script
  • &$callback
  • &$script
  • &$cachable
errorConsole (line 406)

Error console

  • author: Stikki
  • access: public
html errorConsole ( $e)
  • object Exception $e
fetch (line 319)

fetch method NOTE: Overwrites parent

  • access: public
mixed fetch ([mixed $template = null], [int $cache_id = null], [ $compile_id = null], [mixed $parent = null], [boolean $display = false], [boolean $merge_tpl_vars = true], [boolean $no_output_filter = false])
  • mixed $template
  • int $cache_id
  • mixed $parent
  • boolean $display
  • boolean $merge_tpl_vars
  • boolean $no_output_filter
  • $compile_id
isCached (line 386)

isCached method NOTE: Overwrites parent

  • access: public
mixed isCached ([ $template = null], [int $cache_id = null], [int $compile_id = null], [mixed $parent = null], mixed $template_name)
  • mixed $template_name
  • int $cache_id
  • int $compile_id
  • mixed $parent
  • $template
is_registered (line 269)

Test if a smarty plugin with the specified name already exists.

  • access: public
boolean is_registered (string $name)
  • string $name: the plugin name
loadPlugin (line 445)

Takes unknown classes and loads plugin files for them class name format: Smarty_PluginType_PluginName plugin filename format: plugintype.pluginname.php

Note: this method overrides the one in the smarty base class and provides more testing.

  • return: |boolean filepath of loaded file or false
  • access: public
string loadPlugin (string $plugin_name, [bool $check = true])
  • string $plugin_name: class plugin name to load
  • bool $check: check if already loaded
registerPlugin (line 177)

Registers plugin to be used in templates

  • return: current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining
  • throws: SmartyException when the plugin tag is invalid
  • access: public
Smarty_Internal_Templatebase registerPlugin (string $type, string $tag, callback $callback, [boolean $cacheable = true], [array $cache_attr = null])
  • string $type: plugin type
  • string $tag: name of template tag
  • callback $callback: PHP callback to register
  • boolean $cacheable: if true (default) this fuction is cachable
  • array $cache_attr: caching attributes if any
set_global_cacheid (line 295)

get_instance method

  • access: public
void set_global_cacheid (int $id)
  • int $id
_dummyDfltPluginHandler (line 202)

Dummy default plugin handler for smarty.

  • access: public
void _dummyDfltPluginHandler ( $name,  $type,  $template,  &$callback,  &$script,  &$cachable)
  • $name
  • $type
  • $template
  • &$callback
  • &$script
  • &$cachable

Documentation generated on Sun, 12 Aug 2012 08:38:30 -0600 by phpDocumentor 1.3.2