[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/Smarty/libs/sysplugins/ -> smarty_internal_templatebase.php (summary)

Smarty Internal Plugin Smarty Template  Base This file contains the basic shared methodes for template handling

Author: Uwe Tews
File Size: 811 lines (36 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 24 functions

  fetch()
  display()
  isCached()
  createData()
  registerPlugin()
  unregisterPlugin()
  registerResource()
  unregisterResource()
  registerCacheResource()
  unregisterCacheResource()
  registerObject()
  getRegisteredObject()
  unregisterObject()
  registerClass()
  registerDefaultPluginHandler()
  registerDefaultTemplateHandler()
  registerDefaultConfigHandler()
  registerFilter()
  unregisterFilter()
  _get_filter_name()
  loadFilter()
  unloadFilter()
  replaceCamelcase()
  __call()

Functions
Functions that are not part of a class:

fetch($template = null, $cache_id = null, $compile_id = null, $parent = null, $display = false, $merge_tpl_vars = true, $no_output_filter = false)   X-Ref
fetches a rendered Smarty template

param: string $template          the resource handle of the template file or template object
param: mixed  $cache_id          cache id to be used with this template
param: mixed  $compile_id        compile id to be used with this template
param: object $parent            next higher level of Smarty variables
param: bool   $display           true: display, false: fetch
param: bool   $merge_tpl_vars    if true parent template variables merged in to local scope
param: bool   $no_output_filter  if true do not run output filter
return: string rendered template output

display($template = null, $cache_id = null, $compile_id = null, $parent = null)   X-Ref
displays a Smarty template

param: string $template   the resource handle of the template file or template object
param: mixed  $cache_id   cache id to be used with this template
param: mixed  $compile_id compile id to be used with this template
param: object $parent     next higher level of Smarty variables

isCached($template = null, $cache_id = null, $compile_id = null, $parent = null)   X-Ref
test if cache is valid

param: string|object $template   the resource handle of the template file or template object
param: mixed         $cache_id   cache id to be used with this template
param: mixed         $compile_id compile id to be used with this template
param: object        $parent     next higher level of Smarty variables
return: boolean cache status

createData($parent = null)   X-Ref
creates a data object

returns: Smarty_Data data object
param: object $parent next higher level of Smarty variables

registerPlugin($type, $tag, $callback, $cacheable = true, $cache_attr = null)   X-Ref
Registers plugin to be used in templates

param: string   $type       plugin type
param: string   $tag        name of template tag
param: callback $callback   PHP callback to register
param: boolean  $cacheable  if true (default) this fuction is cachable
param: array    $cache_attr caching attributes if any
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

unregisterPlugin($type, $tag)   X-Ref
Unregister Plugin

param: string $type of plugin
param: string $tag name of plugin
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerResource($type, $callback)   X-Ref
Registers a resource to fetch a template

param: string $type name of resource type
param: Smarty_Resource|array $callback or instance of Smarty_Resource, or array of callbacks to handle resource (deprecated)
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

unregisterResource($type)   X-Ref
Unregisters a resource

param: string $type name of resource type
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerCacheResource($type, Smarty_CacheResource $callback)   X-Ref
Registers a cache resource to cache a template's output

param: string               $type     name of cache resource type
param: Smarty_CacheResource $callback instance of Smarty_CacheResource to handle output caching
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

unregisterCacheResource($type)   X-Ref
Unregisters a cache resource

param: string $type name of cache resource type
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerObject($object_name, $object_impl, $allowed = array()   X-Ref
Registers object to be used in templates

param: string  $object        name of template object
param: object  $object_impl   the referenced PHP object to register
param: array   $allowed       list of allowed methods (empty = all)
param: boolean $smarty_args   smarty argument format, else traditional
param: array   $block_methods list of block-methods
param: array $block_functs list of methods that are block format
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

getRegisteredObject($name)   X-Ref
return a reference to a registered object

param: string $name object name
return: object

unregisterObject($name)   X-Ref
unregister an object

param: string $name object name
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerClass($class_name, $class_impl)   X-Ref
Registers static classes to be used in templates

param: string $class name of template class
param: string $class_impl the referenced PHP class to register
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerDefaultPluginHandler($callback)   X-Ref
Registers a default plugin handler

param: callable $callback class/method name
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerDefaultTemplateHandler($callback)   X-Ref
Registers a default template handler

param: callable $callback class/method name
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerDefaultConfigHandler($callback)   X-Ref
Registers a default template handler

param: callable $callback class/method name
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

registerFilter($type, $callback)   X-Ref
Registers a filter function

param: string $type filter type
param: callback $callback
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

unregisterFilter($type, $callback)   X-Ref
Unregisters a filter function

param: string $type filter type
param: callback $callback
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

_get_filter_name($function_name)   X-Ref
Return internal filter name

param: callback $function_name
return: string internal filter name

loadFilter($type, $name)   X-Ref
load a filter of specified type and name

param: string $type filter type
param: string $name filter name

unloadFilter($type, $name)   X-Ref
unload a filter of specified type and name

param: string $type filter type
param: string $name filter name
return: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

replaceCamelcase($match)   X-Ref
preg_replace callback to convert camelcase getter/setter to underscore property names

param: string $match match string
return: string replacemant

__call($name, $args)   X-Ref
Handle unknown class methods

param: string $name unknown method-name
param: array  $args argument array



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1