[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/Smarty/libs/ -> SmartyBC.class.php (summary)

Project:     Smarty: the PHP compiling template engine File:        SmartyBC.class.php This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

Author: Monte Ohrt
Author: Uwe Tews
Author: Rodney Rehm
Copyright: 2008 New Digital Group, Inc.
File Size: 460 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SmartyBC:: (36 methods):
  __construct()
  assign_by_ref()
  append_by_ref()
  clear_assign()
  register_function()
  unregister_function()
  register_object()
  unregister_object()
  register_block()
  unregister_block()
  register_compiler_function()
  unregister_compiler_function()
  register_modifier()
  unregister_modifier()
  register_resource()
  unregister_resource()
  register_prefilter()
  unregister_prefilter()
  register_postfilter()
  unregister_postfilter()
  register_outputfilter()
  unregister_outputfilter()
  load_filter()
  clear_cache()
  clear_all_cache()
  is_cached()
  clear_all_assign()
  clear_compiled_tpl()
  template_exists()
  get_template_vars()
  get_config_vars()
  config_load()
  get_registered_object()
  clear_config()
  trigger_error()
  smarty_php_tag()


Class: SmartyBC  - X-Ref

Smarty Backward Compatability Wrapper Class

__construct(array $options=array()   X-Ref
Initialize new SmartyBC object

param: array $options options to set during initialization, e.g. array( 'forceCompile' => false )

assign_by_ref($tpl_var, &$value)   X-Ref
wrapper for assign_by_ref

param: string $tpl_var the template variable name
param: mixed  &$value  the referenced value to assign

append_by_ref($tpl_var, &$value, $merge = false)   X-Ref
wrapper for append_by_ref

param: string  $tpl_var the template variable name
param: mixed   &$value  the referenced value to append
param: boolean $merge   flag if array elements shall be merged

clear_assign($tpl_var)   X-Ref
clear the given assigned template variable.

param: string $tpl_var the template variable to clear

register_function($function, $function_impl, $cacheable=true, $cache_attrs=null)   X-Ref
Registers custom function to be used in templates

param: string $function      the name of the template function
param: string $function_impl the name of the PHP function to register
param: bool   $cacheable
param: mixed  $cache_attrs

unregister_function($function)   X-Ref
Unregisters custom function

param: string $function name of template function

register_object($object, $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_functs list of methods that are block format

unregister_object($object)   X-Ref
Unregisters object

param: string $object name of template object

register_block($block, $block_impl, $cacheable=true, $cache_attrs=null)   X-Ref
Registers block function to be used in templates

param: string $block      name of template block
param: string $block_impl PHP function to register
param: bool   $cacheable
param: mixed  $cache_attrs

unregister_block($block)   X-Ref
Unregisters block function

param: string $block name of template function

register_compiler_function($function, $function_impl, $cacheable=true)   X-Ref
Registers compiler function

param: string $function      name of template function
param: string $function_impl name of PHP function to register
param: bool   $cacheable

unregister_compiler_function($function)   X-Ref
Unregisters compiler function

param: string $function name of template function

register_modifier($modifier, $modifier_impl)   X-Ref
Registers modifier to be used in templates

param: string $modifier name of template modifier
param: string $modifier_impl name of PHP function to register

unregister_modifier($modifier)   X-Ref
Unregisters modifier

param: string $modifier name of template modifier

register_resource($type, $functions)   X-Ref
Registers a resource to fetch a template

param: string $type      name of resource
param: array  $functions array of functions to handle resource

unregister_resource($type)   X-Ref
Unregisters a resource

param: string $type name of resource

register_prefilter($function)   X-Ref
Registers a prefilter function to apply
to a template before compiling

param: callable $function

unregister_prefilter($function)   X-Ref
Unregisters a prefilter function

param: callable $function

register_postfilter($function)   X-Ref
Registers a postfilter function to apply
to a compiled template after compilation

param: callable $function

unregister_postfilter($function)   X-Ref
Unregisters a postfilter function

param: callable $function

register_outputfilter($function)   X-Ref
Registers an output filter function to apply
to a template output

param: callable $function

unregister_outputfilter($function)   X-Ref
Unregisters an outputfilter function

param: callable $function

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

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

clear_cache($tpl_file = null, $cache_id = null, $compile_id = null, $exp_time = null)   X-Ref
clear cached content for the given template and cache id

param: string $tpl_file   name of template file
param: string $cache_id   name of cache_id
param: string $compile_id name of compile_id
param: string $exp_time   expiration time
return: boolean

clear_all_cache($exp_time = null)   X-Ref
clear the entire contents of cache (all templates)

param: string $exp_time expire time
return: boolean

is_cached($tpl_file, $cache_id = null, $compile_id = null)   X-Ref
test to see if valid cache exists for this template

param: string $tpl_file name of template file
param: string $cache_id
param: string $compile_id
return: boolean

clear_all_assign()   X-Ref
clear all the assigned template variables.


clear_compiled_tpl($tpl_file = null, $compile_id = null, $exp_time = null)   X-Ref
clears compiled version of specified template resource,
or all compiled template files if one is not specified.
This function is for advanced use only, not normally needed.

param: string $tpl_file
param: string $compile_id
param: string $exp_time
return: boolean results of {@link smarty_core_rm_auto()}

template_exists($tpl_file)   X-Ref
Checks whether requested template exists.

param: string $tpl_file
return: boolean

get_template_vars($name=null)   X-Ref
Returns an array containing template variables

param: string $name
return: array

get_config_vars($name=null)   X-Ref
Returns an array containing config variables

param: string $name
return: array

config_load($file, $section = null, $scope = 'global')   X-Ref
load configuration values

param: string $file
param: string $section
param: string $scope

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

param: string $name
return: object

clear_config($var = null)   X-Ref
clear configuration values

param: string $var

trigger_error($error_msg, $error_type = E_USER_WARNING)   X-Ref
trigger Smarty error

param: string $error_msg
param: integer $error_type

smarty_php_tag($params, $content, $template, &$repeat)   X-Ref
Smarty {php}{/php} block function

param: array   $params   parameter list
param: string  $content  contents of the block
param: object  $template template object
param: boolean &$repeat  repeat flag
return: string content re-formatted



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