Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • Smarty
  • SmartyBC

Interfaces

  • SmartyCompilerException
  • SmartyException

Functions

  • smarty_php_tag
  • smartyAutoload
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class SmartyBC

Smarty Backward Compatability Wrapper Class

Smarty_Internal_Data
Extended by Smarty_Internal_TemplateBase
Extended by Smarty
Extended by SmartyBC
Package: Smarty
Copyright: 2008 New Digital Group, Inc.
Author: Monte Ohrt
Author: Uwe Tews
Author: Rodney Rehm
Located at plugins/smarty/smarty_source/SmartyBC.class.php
Methods summary
public
# __construct( array $options = array() )

Initialize new SmartyBC object

Initialize new SmartyBC object

Parameters

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

Overrides

Smarty::__construct()
public
# assign_by_ref( string $tpl_var, mixed & $value )

wrapper for assign_by_ref

wrapper for assign_by_ref

Parameters

$tpl_var
the template variable name
$value
$value the referenced value to assign
public
# append_by_ref( string $tpl_var, mixed & $value, boolean $merge = false )

wrapper for append_by_ref

wrapper for append_by_ref

Parameters

$tpl_var
the template variable name
$value
$value the referenced value to append
$merge
flag if array elements shall be merged
public
# clear_assign( string $tpl_var )

clear the given assigned template variable.

clear the given assigned template variable.

Parameters

$tpl_var
the template variable to clear
public
# register_function( string $function, string $function_impl, boolean $cacheable = true, mixed $cache_attrs = null )

Registers custom function to be used in templates

Registers custom function to be used in templates

Parameters

$function
the name of the template function
$function_impl
the name of the PHP function to register
$cacheable
$cache_attrs
public
# unregister_function( string $function )

Unregisters custom function

Unregisters custom function

Parameters

$function
name of template function
public
# register_object( string $object, object $object_impl, array $allowed = array(), boolean $smarty_args = true, array $block_methods = array() )

Registers object to be used in templates

Registers object to be used in templates

Parameters

$object
name of template object
$object_impl
the referenced PHP object to register
$allowed
list of allowed methods (empty = all)
$smarty_args
smarty argument format, else traditional
$block_methods
list of methods that are block format

Throws

SmartyException
public
# unregister_object( string $object )

Unregisters object

Unregisters object

Parameters

$object
name of template object
public
# register_block( string $block, string $block_impl, boolean $cacheable = true, mixed $cache_attrs = null )

Registers block function to be used in templates

Registers block function to be used in templates

Parameters

$block
name of template block
$block_impl
PHP function to register
$cacheable
$cache_attrs
public
# unregister_block( string $block )

Unregisters block function

Unregisters block function

Parameters

$block
name of template function
public
# register_compiler_function( string $function, string $function_impl, boolean $cacheable = true )

Registers compiler function

Registers compiler function

Parameters

$function
name of template function
$function_impl
name of PHP function to register
$cacheable
public
# unregister_compiler_function( string $function )

Unregisters compiler function

Unregisters compiler function

Parameters

$function
name of template function
public
# register_modifier( string $modifier, string $modifier_impl )

Registers modifier to be used in templates

Registers modifier to be used in templates

Parameters

$modifier
name of template modifier
$modifier_impl
name of PHP function to register
public
# unregister_modifier( string $modifier )

Unregisters modifier

Unregisters modifier

Parameters

$modifier
name of template modifier
public
# register_resource( string $type, array $functions )

Registers a resource to fetch a template

Registers a resource to fetch a template

Parameters

$type
name of resource
$functions
array of functions to handle resource
public
# unregister_resource( string $type )

Unregisters a resource

Unregisters a resource

Parameters

$type
name of resource
public
# register_prefilter( callable $function )

Registers a prefilter function to apply to a template before compiling

Registers a prefilter function to apply to a template before compiling

Parameters

$function
public
# unregister_prefilter( callable $function )

Unregisters a prefilter function

Unregisters a prefilter function

Parameters

$function
public
# register_postfilter( callable $function )

Registers a postfilter function to apply to a compiled template after compilation

Registers a postfilter function to apply to a compiled template after compilation

Parameters

$function
public
# unregister_postfilter( callable $function )

Unregisters a postfilter function

Unregisters a postfilter function

Parameters

$function
public
# register_outputfilter( callable $function )

Registers an output filter function to apply to a template output

Registers an output filter function to apply to a template output

Parameters

$function
public
# unregister_outputfilter( callable $function )

Unregisters an outputfilter function

Unregisters an outputfilter function

Parameters

$function
public
# load_filter( string $type, string $name )

load a filter of specified type and name

load a filter of specified type and name

Parameters

$type
filter type
$name
filter name
public boolean
# clear_cache( string $tpl_file = null, string $cache_id = null, string $compile_id = null, string $exp_time = null )

clear cached content for the given template and cache id

clear cached content for the given template and cache id

Parameters

$tpl_file
name of template file
$cache_id
name of cache_id
$compile_id
name of compile_id
$exp_time
expiration time

Returns

boolean
public boolean
# clear_all_cache( string $exp_time = null )

clear the entire contents of cache (all templates)

clear the entire contents of cache (all templates)

Parameters

$exp_time
expire time

Returns

boolean
public boolean
# is_cached( string $tpl_file, string $cache_id = null, string $compile_id = null )

test to see if valid cache exists for this template

test to see if valid cache exists for this template

Parameters

$tpl_file
name of template file
$cache_id
$compile_id

Returns

boolean
public
# clear_all_assign( )

clear all the assigned template variables.

clear all the assigned template variables.
public boolean
# clear_compiled_tpl( string $tpl_file = null, string $compile_id = null, string $exp_time = null )

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.

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.

Parameters

$tpl_file
$compile_id
$exp_time

Returns

boolean
results of smarty_core_rm_auto()
public boolean
# template_exists( string $tpl_file )

Checks whether requested template exists.

Checks whether requested template exists.

Parameters

$tpl_file

Returns

boolean
public array
# get_template_vars( string $name = null )

Returns an array containing template variables

Returns an array containing template variables

Parameters

$name

Returns

array
public array
# get_config_vars( string $name = null )

Returns an array containing config variables

Returns an array containing config variables

Parameters

$name

Returns

array
public
# config_load( string $file, string $section = null, string $scope = 'global' )

load configuration values

load configuration values

Parameters

$file
$section
$scope
public object
# get_registered_object( string $name )

return a reference to a registered object

return a reference to a registered object

Parameters

$name

Returns

object
public
# clear_config( string $var = null )

clear configuration values

clear configuration values

Parameters

$var
public
# trigger_error( string $error_msg, integer $error_type = E_USER_WARNING )

trigger Smarty error

trigger Smarty error

Parameters

$error_msg
$error_type
Methods inherited from Smarty
__clone(), __destruct(), __get(), __set(), addAutoloadFilters(), addConfigDir(), addDefaultModifiers(), addPluginsDir(), addTemplateDir(), clearAllCache(), clearCache(), clearCompiledTemplate(), compileAllConfig(), compileAllTemplates(), createTemplate(), disableSecurity(), enableSecurity(), getAutoloadFilters(), getCacheDir(), getCompileDir(), getConfigDir(), getDebugTemplate(), getDefaultModifiers(), getGlobal(), getPluginsDir(), getTags(), getTemplateDir(), loadPlugin(), muteExpectedErrors(), mutingErrorHandler(), setAutoloadFilters(), setCacheDir(), setCompileDir(), setConfigDir(), setDebugTemplate(), setDefaultModifiers(), setPluginsDir(), setTemplateDir(), templateExists(), testInstall(), unmuteExpectedErrors()
Methods inherited from Smarty_Internal_TemplateBase
__call(), _get_filter_name(), createData(), display(), fetch(), getRegisteredObject(), isCached(), loadFilter(), registerCacheResource(), registerClass(), registerDefaultConfigHandler(), registerDefaultPluginHandler(), registerDefaultTemplateHandler(), registerFilter(), registerObject(), registerPlugin(), registerResource(), unloadFilter(), unregisterCacheResource(), unregisterFilter(), unregisterObject(), unregisterPlugin(), unregisterResource()
Methods inherited from Smarty_Internal_Data
append(), appendByRef(), assign(), assignByRef(), assignGlobal(), clearAllAssign(), clearAssign(), clearConfig(), configLoad(), getConfigVariable(), getConfigVars(), getStreamVariable(), getTemplateVars(), getVariable()
Constants inherited from Smarty
CACHING_LIFETIME_CURRENT, CACHING_LIFETIME_SAVED, CACHING_OFF, CLEAR_EXPIRED, COMPILECHECK_CACHEMISS, COMPILECHECK_OFF, COMPILECHECK_ON, FILTER_OUTPUT, FILTER_POST, FILTER_PRE, FILTER_VARIABLE, PHP_ALLOW, PHP_PASSTHRU, PHP_QUOTE, PHP_REMOVE, PLUGIN_BLOCK, PLUGIN_COMPILER, PLUGIN_FUNCTION, PLUGIN_MODIFIER, PLUGIN_MODIFIERCOMPILER, SCOPE_GLOBAL, SCOPE_LOCAL, SCOPE_PARENT, SCOPE_ROOT, SMARTY_VERSION
Properties summary
public string $_version

Smarty 2 BC

Smarty 2 BC
# Smarty::SMARTY_VERSION
Properties inherited from Smarty
$_CHARSET, $_DATE_FORMAT, $_IS_WINDOWS, $_MBSTRING, $_UTF8_MODIFIER, $_cacheresource_handlers, $_current_file, $_dir_perms, $_file_perms, $_is_file_cache, $_muted_directories, $_parserdebug, $_previous_error_handler, $_resource_handlers, $_smarty_vars, $_tag_stack, $allow_ambiguous_resources, $allow_php_templates, $auto_literal, $autoload_filters, $cache_id, $cache_lifetime, $cache_locking, $cache_modified_check, $caching, $caching_type, $compile_check, $compile_id, $compile_locking, $config_booleanize, $config_overwrite, $config_read_hidden, $debug_tpl, $debugging, $debugging_ctrl, $default_config_handler_func, $default_config_type, $default_modifiers, $default_plugin_handler_func, $default_resource_type, $default_template_handler_func, $direct_access_security, $error_reporting, $error_unassigned, $escape_html, $force_cache, $force_compile, $get_used_tags, $global_tpl_vars, $inheritance_merge_compiled_includes, $joined_config_dir, $joined_template_dir, $left_delimiter, $locking_timeout, $merge_compiled_includes, $merged_templates_func, $php_handling, $plugin_search_order, $properties, $registered_cache_resources, $registered_classes, $registered_filters, $registered_objects, $registered_plugins, $registered_resources, $right_delimiter, $security_class, $security_policy, $smarty, $smarty_debug_id, $start_time, $template_functions, $template_objects, $use_include_path, $use_sub_dirs
Properties inherited from Smarty_Internal_Data
$config_vars, $parent, $template_class, $tpl_vars
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen