Class Smarty

This is the main Smarty class

Smarty

Package: Smarty
Copyright: 2016 New Digital Group, Inc.
Copyright: 2016 Uwe Tews
Author: Monte Ohrt
Author: Uwe Tews
Author: Rodney Rehm
Located at tpl/smarty/Smarty.class.php

Methods summary

`public`	# `__construct( )` Initialize new Smarty object Initialize new Smarty object Overrides `Smarty_Internal_Data::__construct`
`public boolean`	# `templateExists( string $resource_name )` Check if a template resource exists Check if a template resource exists Parameters `$resource_name` template name Returns boolean status
`public Smarty`	# `enableSecurity( string\|Smarty_Security $security_class = null )` Loads security class and enables security Loads security class and enables security Parameters `$security_class` if a string is used, it must be class-name Returns `Smarty` current Smarty instance for chaining Throws `SmartyException` when an invalid class name is provided
`public Smarty`	# `disableSecurity( )` Disable security Disable security Returns `Smarty` current Smarty instance for chaining
`public Smarty`	# `setTemplateDir( string\|array $template_dir, boolean $isConfig = false )` Set template directory Set template directory Parameters `$template_dir` directory(s) of template sources `$isConfig` true for config_dir Returns `Smarty` current Smarty instance for chaining
`public Smarty`	# `addTemplateDir( string\|array $template_dir, string $key = null, boolean $isConfig = false )` Add template directory(s) Add template directory(s) Parameters `$template_dir` directory(s) of template sources `$key` of the array element to assign the template dir to `$isConfig` true for config_dir Returns `Smarty` current Smarty instance for chaining
`public array`	# `getTemplateDir( mixed $index = null, boolean $isConfig = false )` Get template directories Get template directories Parameters `$index` index of directory to get, null to get all `$isConfig` true for config_dir Returns array list of template directories, or directory of $index
`public Smarty`	# `setConfigDir( $config_dir )` Set config directory Set config directory Parameters `$config_dir` Returns `Smarty` current Smarty instance for chaining
`public Smarty`	# `addConfigDir( string\|array $config_dir, mixed $key = null )` Add config directory(s) Add config directory(s) Parameters `$config_dir` directory(s) of config sources `$key` key of the array element to assign the config dir to Returns `Smarty` current Smarty instance for chaining
`public array`	# `getConfigDir( mixed $index = null )` Get config directory Get config directory Parameters `$index` index of directory to get, null to get all Returns array configuration directory
`public Smarty`	# `setPluginsDir( string\|array $plugins_dir )` Set plugins directory Set plugins directory Parameters `$plugins_dir` directory(s) of plugins Returns `Smarty` current Smarty instance for chaining
`public Smarty`	# `addPluginsDir( null\|array $plugins_dir )` Adds directory of plugin files Adds directory of plugin files Parameters `$plugins_dir` Returns `Smarty` current Smarty instance for chaining
`public array`	# `getPluginsDir( )` Get plugin directories Get plugin directories Returns array list of plugin directories
`public Smarty`	# `setCompileDir( string $compile_dir )` Parameters `$compile_dir` directory to store compiled templates in Returns `Smarty` current Smarty instance for chaining
`public string`	# `getCompileDir( )` Get compiled directory Get compiled directory Returns string path to compiled templates
`public Smarty`	# `setCacheDir( string $cache_dir )` Set cache directory Set cache directory Parameters `$cache_dir` directory to store cached templates in Returns `Smarty` current Smarty instance for chaining
`public string`	# `getCacheDir( )` Get cache directory Get cache directory Returns string path of cache directory
`public object`	# `createTemplate( string $template, mixed $cache_id = null, mixed $compile_id = null, object $parent = null, boolean $do_clone = true )` creates a template object creates a template object Parameters `$template` the resource handle of the template file `$cache_id` cache id to be used with this template `$compile_id` compile id to be used with this template `$parent` next higher level of Smarty variables `$do_clone` flag is Smarty object shall be cloned Returns object template object
`public string`	# `loadPlugin( string $plugin_name, boolean $check = true )` Takes unknown classes and loads plugin files for them class name format: Smarty_PluginType_PluginName plugin filename format: plugintype.pluginname.php Takes unknown classes and loads plugin files for them class name format: Smarty_PluginType_PluginName plugin filename format: plugintype.pluginname.php Parameters `$plugin_name` class plugin name to load `$check` check if already loaded Returns string \|boolean filepath of loaded file or false Throws `SmartyException`
`public string`	# `_getTemplateId( string $template_name, null\|mixed $cache_id = null, null\|mixed $compile_id = null, null $caching = null, Smarty_Internal_Template $template = null )` Get unique template id Get unique template id Parameters `$template_name` `$cache_id` `$compile_id` `$caching` `$template` Returns string
`public string`	# `_realpath( string $path, boolean $realpath = null )` Normalize path - remove /./ and /../ - make it absolute if required Normalize path - remove /./ and /../ - make it absolute if required Parameters `$path` file path `$realpath` if true - convert to absolute false - convert to relative null - keep as it is but remove /./ /../ Returns string
`public`	# `_clearTemplateCache( )` Empty template objects cache Empty template objects cache
`public`	# `setCompileCheck( boolean $compile_check )` Parameters `$compile_check`
`public`	# `setUseSubDirs( boolean $use_sub_dirs )` Parameters `$use_sub_dirs`
`public`	# `setErrorReporting( integer $error_reporting )` Parameters `$error_reporting`
`public`	# `setEscapeHtml( boolean $escape_html )` Parameters `$escape_html`
`public`	# `setAutoLiteral( boolean $auto_literal )` Parameters `$auto_literal`
`public`	# `setForceCompile( boolean $force_compile )` Parameters `$force_compile`
`public`	# `setMergeCompiledIncludes( boolean $merge_compiled_includes )` Parameters `$merge_compiled_includes`
`public`	# `setLeftDelimiter( string $left_delimiter )` Parameters `$left_delimiter`
`public`	# `setRightDelimiter( string $right_delimiter )` Parameters `$right_delimiter`
`public`	# `setDebugging( boolean $debugging )` Parameters `$debugging`
`public`	# `setConfigOverwrite( boolean $config_overwrite )` Parameters `$config_overwrite`
`public`	# `setConfigBooleanize( boolean $config_booleanize )` Parameters `$config_booleanize`
`public`	# `setConfigReadHidden( boolean $config_read_hidden )` Parameters `$config_read_hidden`
`public`	# `setCompileLocking( boolean $compile_locking )` Parameters `$compile_locking`
`public`	# `setDefaultResourceType( string $default_resource_type )` Parameters `$default_resource_type`
`public`	# `setCachingType( string $caching_type )` Parameters `$caching_type`
`public`	# `testInstall( null & $errors = null )` Test install Test install Parameters `$errors`
`public mixed`	# `__get( string $name )` <> Generic getter. Calls the appropriate getter function. Issues an E_USER_NOTICE if no valid getter is found. <> Generic getter. Calls the appropriate getter function. Issues an E_USER_NOTICE if no valid getter is found. Parameters `$name` property name Returns mixed
`public`	# `__set( string $name, mixed $value )` <> Generic setter. Calls the appropriate setter function. Issues an E_USER_NOTICE if no valid setter is found. <> Generic setter. Calls the appropriate setter function. Issues an E_USER_NOTICE if no valid setter is found. Parameters `$name` property name `$value` parameter passed to setter
`public static boolean\|`	# `mutingErrorHandler( integer $errno, $errstr, $errfile, $errline, $errcontext )` Error Handler to mute expected messages Error Handler to mute expected messages Parameters `$errno` Error level `$errstr` `$errfile` `$errline` `$errcontext` Returns boolean\| Link http://php.net/set_error_handler
`public static`	# `muteExpectedErrors( )` Enable error handler to mute expected messages Enable error handler to mute expected messages
`public static`	# `unmuteExpectedErrors( )` Disable error handler muting expected messages Disable error handler muting expected messages

Methods inherited from Smarty_Internal_TemplateBase

display(), fetch(), isCached(), loadFilter(), registerFilter(), registerObject(), registerPlugin(), setCacheId(), setCacheLifetime(), setCaching(), setCompileId()

Methods inherited from Smarty_Internal_Data

__call(), _mergeVars(), append(), appendByRef(), assign(), assignByRef(), assignGlobal(), getTemplateVars(), getVariable()

Magic methods summary

`public integer`	# `clearAllCache( integer $exp_time = null, string $type = null )` Parameters `$exp_time` `$type` Returns integer
`public integer`	# `clearCache( string $template_name, string $cache_id = null, string $compile_id = null, integer $exp_time = null, string $type = null )` Parameters `$template_name` `$cache_id` `$compile_id` `$exp_time` `$type` Returns integer
`public integer`	# `compileAllTemplates( string $extension = '.tpl', boolean $force_compile = false, integer $time_limit, integer $max_errors = null )` Parameters `$extension` `$force_compile` `$time_limit` `$max_errors` Returns integer
`public integer`	# `compileAllConfig( string $extension = '.conf', boolean $force_compile = false, integer $time_limit, integer $max_errors = null )` Parameters `$extension` `$force_compile` `$time_limit` `$max_errors` Returns integer
`public integer`	# `clearCompiledTemplate( $resource_name = null, $compile_id = null, $exp_time = null )` Parameters `$resource_name` `$compile_id` `$exp_time` Returns integer

Magic methods inherited from Smarty_Internal_Data

clearAllAssign(), clearAssign(), clearConfig(), configLoad(), getConfigVars(), getGlobal(), getStreamVariable()

Constants summary

`string`	`SMARTY_VERSION` smarty version smarty version	# `'3.1.30'`
`integer`	`SCOPE_LOCAL` define variable scopes define variable scopes	# `1`
`integer`	`SCOPE_PARENT`	# `2`
`integer`	`SCOPE_TPL_ROOT`	# `4`
`integer`	`SCOPE_ROOT`	# `8`
`integer`	`SCOPE_SMARTY`	# `16`
`integer`	`SCOPE_GLOBAL`	# `32`
`integer`	`CACHING_OFF` define caching modes define caching modes	# `0`
`integer`	`CACHING_LIFETIME_CURRENT`	# `1`
`integer`	`CACHING_LIFETIME_SAVED`	# `2`
`integer`	`CLEAR_EXPIRED` define constant for clearing cache files be saved expiration dates define constant for clearing cache files be saved expiration dates	# `-1`
`integer`	`COMPILECHECK_OFF` define compile check modes define compile check modes	# `0`
`integer`	`COMPILECHECK_ON`	# `1`
`integer`	`COMPILECHECK_CACHEMISS`	# `2`
`integer`	`DEBUG_OFF` define debug modes define debug modes	# `0`
`integer`	`DEBUG_ON`	# `1`
`integer`	`DEBUG_INDIVIDUAL`	# `2`
`integer`	`PHP_PASSTHRU` modes for handling of "" tags in templates. modes for handling of "" tags in templates.	# `0`
`integer`	`PHP_QUOTE`	# `1`
`integer`	`PHP_REMOVE`	# `2`
`integer`	`PHP_ALLOW`	# `3`
`string`	`FILTER_POST` filter types filter types	# `'post'`
`string`	`FILTER_PRE`	# `'pre'`
`string`	`FILTER_OUTPUT`	# `'output'`
`string`	`FILTER_VARIABLE`	# `'variable'`
`string`	`PLUGIN_FUNCTION` plugin types plugin types	# `'function'`
`string`	`PLUGIN_BLOCK`	# `'block'`
`string`	`PLUGIN_COMPILER`	# `'compiler'`
`string`	`PLUGIN_MODIFIER`	# `'modifier'`
`string`	`PLUGIN_MODIFIERCOMPILER`	# `'modifiercompiler'`
`integer`	`RESOURCE_CACHE_OFF` Resource caching modes (not used since 3.1.30) Resource caching modes (not used since 3.1.30)	# `0`
`integer`	`RESOURCE_CACHE_AUTOMATIC`	# `1`
`integer`	`RESOURCE_CACHE_TEMPLATE`	# `2`
`integer`	`RESOURCE_CACHE_ON`	# `4`

Properties summary

`public static array`	`$global_tpl_vars` assigned global tpl vars assigned global tpl vars	# `array()`
`public static`	`$_previous_error_handler` error handler returned by set_error_handler() in Smarty::muteExpectedErrors() error handler returned by set_error_handler() in Smarty::muteExpectedErrors()	# `null`
`public static array`	`$_muted_directories` contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors() contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors()	# `array()`
`public static`	`$_MBSTRING` Flag denoting if Multibyte String functions are available Flag denoting if Multibyte String functions are available	# `SMARTY_MBSTRING`
`public static`	`$_CHARSET` The character set to adhere to (e.g. "UTF-8") The character set to adhere to (e.g. "UTF-8")	# `SMARTY_RESOURCE_CHAR_SET`
`public static`	`$_DATE_FORMAT` The date format to be used internally (accepts date() and strftime()) The date format to be used internally (accepts date() and strftime())	# `SMARTY_RESOURCE_DATE_FORMAT`
`public static string`	`$_UTF8_MODIFIER` Flag denoting if PCRE should run in UTF-8 mode Flag denoting if PCRE should run in UTF-8 mode	# `'u'`
`public static boolean`	`$_IS_WINDOWS` Flag denoting if operating system is windows Flag denoting if operating system is windows	# `false`
`public boolean`	`$auto_literal` auto literal on delimiters with whitespace auto literal on delimiters with whitespace	# `true`
`public boolean`	`$error_unassigned` display error on not assigned variables display error on not assigned variables	# `false`
`public boolean`	`$use_include_path` look up relative file path in include_path look up relative file path in include_path	# `false`
`protected array`	`$template_dir` template directory template directory	# `array('./templates/')`
`protected array`	`$_processedTemplateDir` flags for normalized template directory entries flags for normalized template directory entries	# `array()`
`public boolean`	`$_templateDirNormalized` flag if template_dir is normalized flag if template_dir is normalized	# `false`
`public string`	`$_joined_template_dir` joined template directory string used in cache keys joined template directory string used in cache keys	# `null`
`protected array`	`$config_dir` config directory config directory	# `array('./configs/')`
`protected array`	`$_processedConfigDir` flags for normalized template directory entries flags for normalized template directory entries	# `array()`
`public boolean`	`$_configDirNormalized` flag if config_dir is normalized flag if config_dir is normalized	# `false`
`public string`	`$_joined_config_dir` joined config directory string used in cache keys joined config directory string used in cache keys	# `null`
`public callable`	`$default_template_handler_func` default template handler default template handler	# `null`
`public callable`	`$default_config_handler_func` default config handler default config handler	# `null`
`public callable`	`$default_plugin_handler_func` default plugin handler default plugin handler	# `null`
`protected string`	`$compile_dir` compile directory compile directory	# `'./templates_c/'`
`public boolean`	`$_compileDirNormalized` flag if template_dir is normalized flag if template_dir is normalized	# `false`
`protected array`	`$plugins_dir` plugins directory plugins directory	# `array()`
`public boolean`	`$_pluginsDirNormalized` flag if plugins_dir is normalized flag if plugins_dir is normalized	# `false`
`protected string`	`$cache_dir` cache directory cache directory	# `'./cache/'`
`public boolean`	`$_cacheDirNormalized` flag if template_dir is normalized flag if template_dir is normalized	# `false`
`public boolean`	`$force_compile` force template compiling? force template compiling?	# `false`
`public boolean`	`$compile_check` check template for modifications? check template for modifications?	# `true`
`public boolean`	`$use_sub_dirs` use sub dirs for compiled/cached files? use sub dirs for compiled/cached files?	# `false`
`public boolean`	`$allow_ambiguous_resources` allow ambiguous resources (that are made unique by the resource handler) allow ambiguous resources (that are made unique by the resource handler)	# `false`
`public boolean`	`$merge_compiled_includes` merge compiled includes merge compiled includes	# `false`
`public boolean`	`$force_cache` force cache file creation force cache file creation	# `false`
`public string`	`$left_delimiter` template left-delimiter template left-delimiter	# `"{"`
`public string`	`$right_delimiter` template right-delimiter template right-delimiter	# `"}"`
`public string`	`$security_class` class name This should be instance of Smarty_Security. class name This should be instance of Smarty_Security. See `Smarty_Security`	# `'Smarty_Security'`
`public Smarty_Security`	`$security_policy` implementation of security class implementation of security class	# `null`
`public integer`	`$php_handling` controls handling of PHP-blocks controls handling of PHP-blocks	# `Smarty::PHP_PASSTHRU`
`public boolean`	`$allow_php_templates` controls if the php template file resource is allowed controls if the php template file resource is allowed	# `false`
`public boolean`	`$debugging` debug mode Setting this to true enables the debug-console. debug mode Setting this to true enables the debug-console.	# `false`
`public string`	`$debugging_ctrl` This determines if debugging is enable-able from the browser. NONE => no debugging control allowed URL => enable debugging when SMARTY_DEBUG is found in the URL. This determines if debugging is enable-able from the browser. NONE => no debugging control allowed URL => enable debugging when SMARTY_DEBUG is found in the URL.	# `'NONE'`
`public string`	`$smarty_debug_id` Name of debugging URL-param. Only used when $debugging_ctrl is set to 'URL'. The name of the URL-parameter that activates debugging. Name of debugging URL-param. Only used when $debugging_ctrl is set to 'URL'. The name of the URL-parameter that activates debugging.	# `'SMARTY_DEBUG'`
`public string`	`$debug_tpl` Path of debug template. Path of debug template.	# `null`
`public integer`	`$error_reporting` When set, smarty uses this value as error_reporting-level. When set, smarty uses this value as error_reporting-level.	# `null`
`public boolean`	`$config_overwrite` Controls whether variables with the same name overwrite each other. Controls whether variables with the same name overwrite each other.	# `true`
`public boolean`	`$config_booleanize` Controls whether config values of on/true/yes and off/false/no get converted to boolean. Controls whether config values of on/true/yes and off/false/no get converted to boolean.	# `true`
`public boolean`	`$config_read_hidden` Controls whether hidden config sections/vars are read from the file. Controls whether hidden config sections/vars are read from the file.	# `false`
`public boolean`	`$compile_locking` locking concurrent compiles locking concurrent compiles	# `true`
`public boolean`	`$cache_locking` Controls whether cache resources should use locking mechanism Controls whether cache resources should use locking mechanism	# `false`
`public float`	`$locking_timeout` seconds to wait for acquiring a lock before ignoring the write lock seconds to wait for acquiring a lock before ignoring the write lock	# `10`
`public string`	`$default_resource_type` resource type used if none given Must be an valid key of $registered_resources. resource type used if none given Must be an valid key of $registered_resources.	# `'file'`
`public string`	`$caching_type` caching type Must be an element of $cache_resource_types. caching type Must be an element of $cache_resource_types.	# `'file'`
`public string`	`$default_config_type` config type config type	# `'file'`
`public boolean`	`$cache_modified_check` check If-Modified-Since headers check If-Modified-Since headers	# `false`
`public array`	`$registered_plugins` registered plugins registered plugins	# `array()`
`public array`	`$registered_objects` registered objects registered objects	# `array()`
`public array`	`$registered_classes` registered classes registered classes	# `array()`
`public array`	`$registered_filters` registered filters registered filters	# `array()`
`public array`	`$registered_resources` registered resources registered resources	# `array()`
`public array`	`$registered_cache_resources` registered cache resources registered cache resources	# `array()`
`public array`	`$autoload_filters` autoload filter autoload filter	# `array()`
`public array`	`$default_modifiers` default modifier default modifier	# `array()`
`public boolean`	`$escape_html` autoescape variable output autoescape variable output	# `false`
`public integer`	`$start_time` start time for execution time calculation start time for execution time calculation	# `0`
`public string`	`$_current_file` required by the compiler for BC required by the compiler for BC	# `null`
`public boolean`	`$_parserdebug` internal flag to enable parser debugging internal flag to enable parser debugging	# `false`
`public integer`	`$_objType` This object type (Smarty = 1, template = 2, data = 4) This object type (Smarty = 1, template = 2, data = 4)	# `1`
`public Smarty_Internal_Debug`	`$_debug` Debug object Debug object	# `null`

Classes

Exceptions

Functions

Class Smarty

Methods summary

Overrides

Parameters

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Link

Methods inherited from Smarty_Internal_TemplateBase

Methods inherited from Smarty_Internal_Data

Magic methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns