PHP Class Smarty, shudong-share

Inheritance: extends Smarty_Internal_TemplateBase
Afficher le fichier Open project: HFO4/shudong-share Class Usage Examples

Méthodes publiques

Свойство Type Description
$_CHARSET The character set to adhere to (e.g. "UTF-8")
$_DATE_FORMAT The date format to be used internally (accepts date() and strftime())
$_IS_WINDOWS Flag denoting if operating system is windows
$_MBSTRING Flag denoting if Multibyte String functions are available
$_UTF8_MODIFIER Flag denoting if PCRE should run in UTF-8 mode
$_cacheresource_handlers array cache resource handler cache
$_current_file string required by the compiler for BC
$_dir_perms integer default dir permissions
$_file_perms integer default file permissions
$_muted_directories contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors()
$_parserdebug boolean internal flag to enable parser debugging
$_previous_error_handler error handler returned by set_error_hanlder() in Smarty::muteExpectedErrors()
$_resource_handlers array resource handler cache
$_smarty_vars array global internal smarty vars
$_tag_stack array block tag hierarchy
$allow_ambiguous_resources boolean allow ambiguous resources (that are made unique by the resource handler)
$allow_php_templates boolean controls if the php template file resource is allowed
$auto_literal boolean auto literal on delimiters with whitspace
$autoload_filters array autoload filter
$cache_id string Set this if you want different sets of cache files for the same templates.
$cache_lifetime integer cache lifetime in seconds
$cache_locking boolean Controls whether cache resources should emply locking mechanism
$cache_modified_check boolean check If-Modified-Since headers
$caching boolean caching enabled
$caching_type string Must be an element of $cache_resource_types.
$compile_check boolean check template for modifications?
$compile_id string Set this if you want different sets of compiled files for the same templates.
$compile_locking boolean locking concurrent compiles
$config_booleanize boolean Controls whether config values of on/true/yes and off/false/no get converted to boolean.
$config_overwrite boolean Controls whether variables with the same name overwrite each other.
$config_read_hidden boolean Controls whether hidden config sections/vars are read from the file.
$debug_tpl string Path of debug template.
$debugging boolean Setting this to true enables the debug-console.
$debugging_ctrl string
  • NONE => no debugging control allowed
  • URL => enable debugging when SMARTY_DEBUG is found in the URL.
$default_config_handler_func callable default config handler
$default_config_type string config type
$default_modifiers array default modifier
$default_plugin_handler_func callable default plugin handler
$default_resource_type string Must be an valid key of $registered_resources.
$default_template_handler_func callable default template handler
$direct_access_security boolean {@internal Currently used by Smarty_Internal_Template only.}}
$error_reporting integer When set, smarty uses this value as error_reporting-level.
$error_unassigned boolean display error on not assigned variables
$escape_html boolean autoescape variable output
$force_cache boolean force cache file creation
$force_compile boolean force template compiling?
$get_used_tags boolean Internal flag for getTags()
$global_tpl_vars assigned global tpl vars
$inheritance_merge_compiled_includes boolean template inheritance merge compiled includes
$joined_config_dir string joined config directory string used in cache keys
$joined_template_dir string joined template directory string used in cache keys
$left_delimiter string template left-delimiter
$locking_timeout float seconds to wait for acquiring a lock before ignoring the write lock
$merge_compiled_includes boolean merge compiled includes
$merged_templates_func array Saved parameter of merged templates during compilation
$php_handling integer controls handling of PHP-blocks
$plugin_search_order array plugin search order
$properties array internal config properties
$registered_cache_resources array registered cache resources
$registered_classes array registered classes
$registered_filters array registered filters
$registered_objects array registered objects
$registered_plugins array registered plugins
$registered_resources array registered resources
$right_delimiter string template right-delimiter
$security_class string This should be instance of Smarty_Security.
$security_policy Smarty_Security implementation of security class
$smarty Smarty self pointer to Smarty object
$smarty_debug_id type Only used when $debugging_ctrl is set to 'URL'. The name of the URL-parameter that activates debugging.
$start_time integer start time for execution time calculation
$template_functions array global template functions
$template_objects array cached template objects
$use_include_path boolean look up relative filepaths in include_path
$use_sub_dirs boolean use sub dirs for compiled/cached files?

Méthodes publiques

Méthode Description
__clone ( ) <> set selfpointer on cloned object
__construct ( ) Initialize new Smarty object
__destruct ( ) Class destructor
__get ( string $name ) : mixed <> Generic getter.
__set ( string $name, mixed $value ) <> Generic setter.
addAutoloadFilters ( array $filters, string $type = null ) : Smarty Add autoload filters
addConfigDir ( string | array $config_dir, $key = null ) : Smarty Add config directory(s)
addDefaultModifiers ( array | string $modifiers ) : Smarty Add default modifiers
addPluginsDir ( $plugins_dir ) : Smarty Adds directory of plugin files
addTemplateDir ( string | array $template_dir, string $key = null ) : Smarty Add template directory(s)
clearAllCache ( integer $exp_time = null, string $type = null ) : integer Empty cache folder
clearCache ( string $template_name, string $cache_id = null, string $compile_id = null, integer $exp_time = null, string $type = null ) : integer Empty cache for a specific template
clearCompiledTemplate ( string $resource_name = null, string $compile_id = null, integer $exp_time = null ) : integer Delete compiled template file
compileAllConfig ( string $extension = '.conf', boolean $force_compile = false, integer $time_limit, integer $max_errors = null ) : integer Compile all config files
compileAllTemplates ( string $extension = '.tpl', boolean $force_compile = false, integer $time_limit, integer $max_errors = null ) : integer Compile all template files
createTemplate ( string $template, mixed $cache_id = null, mixed $compile_id = null, object $parent = null, boolean $do_clone = true ) : object creates a template object
disableSecurity ( ) : Smarty Disable security
enableSecurity ( string | Smarty_Security $security_class = null ) : Smarty Loads security class and enables security
getAutoloadFilters ( string $type = null ) : array Get autoload filters
getCacheDir ( ) : string Get cache directory
getCompileDir ( ) : string Get compiled directory
getConfigDir ( $index = null ) : array | string Get config directory
getDebugTemplate ( ) : string return name of debugging template
getDefaultModifiers ( ) : array Get default modifiers
getGlobal ( string $varname = null ) : string Returns a single or all global variables
getPluginsDir ( ) : array Get plugin directories
getTags ( Smarty_Internal_Template $template ) : array Return array of tag/attributes of all tags used by an template
getTemplateDir ( $index = null ) : array | string Get template directories
loadPlugin ( string $plugin_name, boolean $check = true ) : string | boolean Takes unknown classes and loads plugin files for them class name format: Smarty_PluginType_PluginName plugin filename format: plugintype.pluginname.php
muteExpectedErrors ( ) : void Enable error handler to mute expected messages
mutingErrorHandler ( integer $errno, $errstr, $errfile, $errline, $errcontext ) : boolean Error Handler to mute expected messages
setAutoloadFilters ( array $filters, string $type = null ) : Smarty Set autoload filters
setCacheDir ( string $cache_dir ) : Smarty Set cache directory
setCompileDir ( string $compile_dir ) : Smarty Set compile directory
setConfigDir ( $config_dir ) : Smarty Set config directory
setDebugTemplate ( string $tpl_name ) : Smarty set the debug template
setDefaultModifiers ( array | string $modifiers ) : Smarty Set default modifiers
setPluginsDir ( string | array $plugins_dir ) : Smarty Set plugins directory
setTemplateDir ( string | array $template_dir ) : Smarty Set template directory
templateExists ( string $resource_name ) : boolean Check if a template resource exists
testInstall ( array &$errors = null ) : boolean Run installation test
unmuteExpectedErrors ( ) : void Disable error handler muting expected messages

Method Details

__clone() public méthode

<> set selfpointer on cloned object
public __clone ( )

__construct() public méthode

Initialize new Smarty object
public __construct ( )

__destruct() public méthode

Class destructor
public __destruct ( )

__get() public méthode

Calls the appropriate getter function. Issues an E_USER_NOTICE if no valid getter is found.
public __get ( string $name ) : mixed
$name string property name
Résultat mixed

__set() public méthode

Calls the appropriate setter function. Issues an E_USER_NOTICE if no valid setter is found.
public __set ( string $name, mixed $value )
$name string property name
$value mixed parameter passed to setter

addAutoloadFilters() public méthode

Add autoload filters
public addAutoloadFilters ( array $filters, string $type = null ) : Smarty
$filters array filters to load automatically
$type string "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types
Résultat Smarty current Smarty instance for chaining

addConfigDir() public méthode

Add config directory(s)
public addConfigDir ( string | array $config_dir, $key = null ) : Smarty
$config_dir string | array directory(s) of config sources
Résultat Smarty current Smarty instance for chaining

addDefaultModifiers() public méthode

Add default modifiers
public addDefaultModifiers ( array | string $modifiers ) : Smarty
$modifiers array | string modifier or list of modifiers to add
Résultat Smarty current Smarty instance for chaining

addPluginsDir() public méthode

Adds directory of plugin files
public addPluginsDir ( $plugins_dir ) : Smarty
Résultat Smarty current Smarty instance for chaining

addTemplateDir() public méthode

Add template directory(s)
public addTemplateDir ( string | array $template_dir, string $key = null ) : Smarty
$template_dir string | array directory(s) of template sources
$key string of the array element to assign the template dir to
Résultat Smarty current Smarty instance for chaining

clearAllCache() public méthode

Empty cache folder
public clearAllCache ( integer $exp_time = null, string $type = null ) : integer
$exp_time integer expiration time
$type string resource type
Résultat integer number of cache files deleted

clearCache() public méthode

Empty cache for a specific template
public clearCache ( string $template_name, string $cache_id = null, string $compile_id = null, integer $exp_time = null, string $type = null ) : integer
$template_name string template name
$cache_id string cache id
$compile_id string compile id
$exp_time integer expiration time
$type string resource type
Résultat integer number of cache files deleted

clearCompiledTemplate() public méthode

Delete compiled template file
public clearCompiledTemplate ( string $resource_name = null, string $compile_id = null, integer $exp_time = null ) : integer
$resource_name string template name
$compile_id string compile id
$exp_time integer expiration time
Résultat integer number of template files deleted

compileAllConfig() public méthode

Compile all config files
public compileAllConfig ( string $extension = '.conf', boolean $force_compile = false, integer $time_limit, integer $max_errors = null ) : integer
$extension string file extension
$force_compile boolean force all to recompile
$time_limit integer
$max_errors integer
Résultat integer number of template files recompiled

compileAllTemplates() public méthode

Compile all template files
public compileAllTemplates ( string $extension = '.tpl', boolean $force_compile = false, integer $time_limit, integer $max_errors = null ) : integer
$extension string file extension
$force_compile boolean force all to recompile
$time_limit integer
$max_errors integer
Résultat integer number of template files recompiled

createTemplate() public méthode

creates a template object
public createTemplate ( string $template, mixed $cache_id = null, mixed $compile_id = null, object $parent = null, boolean $do_clone = true ) : object
$template string the resource handle of the template file
$cache_id mixed cache id to be used with this template
$compile_id mixed compile id to be used with this template
$parent object next higher level of Smarty variables
$do_clone boolean flag is Smarty object shall be cloned
Résultat object template object

disableSecurity() public méthode

Disable security
public disableSecurity ( ) : Smarty
Résultat Smarty current Smarty instance for chaining

enableSecurity() public méthode

Loads security class and enables security
public enableSecurity ( string | Smarty_Security $security_class = null ) : Smarty
$security_class string | Smarty_Security if a string is used, it must be class-name
Résultat Smarty current Smarty instance for chaining

getAutoloadFilters() public méthode

Get autoload filters
public getAutoloadFilters ( string $type = null ) : array
$type string type of filter to get autoloads for. Defaults to all autoload filters
Résultat array array( 'type1' => array( 'filter1', 'filter2', … ) ) or array( 'filter1', 'filter2', …) if $type was specified

getCacheDir() public méthode

Get cache directory
public getCacheDir ( ) : string
Résultat string path of cache directory

getCompileDir() public méthode

Get compiled directory
public getCompileDir ( ) : string
Résultat string path to compiled templates

getConfigDir() public méthode

Get config directory
public getConfigDir ( $index = null ) : array | string
Résultat array | string configuration directory

getDebugTemplate() public méthode

return name of debugging template
public getDebugTemplate ( ) : string
Résultat string

getDefaultModifiers() public méthode

Get default modifiers
public getDefaultModifiers ( ) : array
Résultat array list of default modifiers

getGlobal() public méthode

Returns a single or all global variables
public getGlobal ( string $varname = null ) : string
$varname string variable name or null
Résultat string variable value or or array of variables

getPluginsDir() public méthode

Get plugin directories
public getPluginsDir ( ) : array
Résultat array list of plugin directories

getTags() public méthode

Return array of tag/attributes of all tags used by an template
public getTags ( Smarty_Internal_Template $template ) : array
$template Smarty_Internal_Template
Résultat array of tag/attributes

getTemplateDir() public méthode

Get template directories
public getTemplateDir ( $index = null ) : array | string
Résultat array | string list of template directories, or directory of $index

loadPlugin() public méthode

Takes unknown classes and loads plugin files for them class name format: Smarty_PluginType_PluginName plugin filename format: plugintype.pluginname.php
public loadPlugin ( string $plugin_name, boolean $check = true ) : string | boolean
$plugin_name string class plugin name to load
$check boolean check if already loaded
Résultat string | boolean |boolean filepath of loaded file or false

muteExpectedErrors() public static méthode

Enable error handler to mute expected messages
public static muteExpectedErrors ( ) : void
Résultat void

mutingErrorHandler() public static méthode

Error Handler to mute expected messages
See link: http://php.net/set_error_handler
public static mutingErrorHandler ( integer $errno, $errstr, $errfile, $errline, $errcontext ) : boolean
$errno integer Error level
Résultat boolean

setAutoloadFilters() public méthode

Set autoload filters
public setAutoloadFilters ( array $filters, string $type = null ) : Smarty
$filters array filters to load automatically
$type string "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types
Résultat Smarty current Smarty instance for chaining

setCacheDir() public méthode

Set cache directory
public setCacheDir ( string $cache_dir ) : Smarty
$cache_dir string directory to store cached templates in
Résultat Smarty current Smarty instance for chaining

setCompileDir() public méthode

Set compile directory
public setCompileDir ( string $compile_dir ) : Smarty
$compile_dir string directory to store compiled templates in
Résultat Smarty current Smarty instance for chaining

setConfigDir() public méthode

Set config directory
public setConfigDir ( $config_dir ) : Smarty
Résultat Smarty current Smarty instance for chaining

setDebugTemplate() public méthode

set the debug template
public setDebugTemplate ( string $tpl_name ) : Smarty
$tpl_name string
Résultat Smarty current Smarty instance for chaining

setDefaultModifiers() public méthode

Set default modifiers
public setDefaultModifiers ( array | string $modifiers ) : Smarty
$modifiers array | string modifier or list of modifiers to set
Résultat Smarty current Smarty instance for chaining

setPluginsDir() public méthode

Set plugins directory
public setPluginsDir ( string | array $plugins_dir ) : Smarty
$plugins_dir string | array directory(s) of plugins
Résultat Smarty current Smarty instance for chaining

setTemplateDir() public méthode

Set template directory
public setTemplateDir ( string | array $template_dir ) : Smarty
$template_dir string | array directory(s) of template sources
Résultat Smarty current Smarty instance for chaining

templateExists() public méthode

Check if a template resource exists
public templateExists ( string $resource_name ) : boolean
$resource_name string template name
Résultat boolean status

testInstall() public méthode

Run installation test
public testInstall ( array &$errors = null ) : boolean
$errors array Array to write errors into, rather than outputting them
Résultat boolean true if setup is fine, false if something is wrong

unmuteExpectedErrors() public static méthode

Disable error handler muting expected messages
public static unmuteExpectedErrors ( ) : void
Résultat void

Property Details

$_CHARSET public_oe static_oe property

The character set to adhere to (e.g. "UTF-8")
public static $_CHARSET

$_DATE_FORMAT public_oe static_oe property

The date format to be used internally (accepts date() and strftime())
public static $_DATE_FORMAT

$_IS_WINDOWS public_oe static_oe property

Flag denoting if operating system is windows
public static $_IS_WINDOWS

$_MBSTRING public_oe static_oe property

Flag denoting if Multibyte String functions are available
public static $_MBSTRING

$_UTF8_MODIFIER public_oe static_oe property

Flag denoting if PCRE should run in UTF-8 mode
public static $_UTF8_MODIFIER

$_cacheresource_handlers public_oe property

cache resource handler cache
public array $_cacheresource_handlers
Résultat array

$_current_file public_oe property

required by the compiler for BC
public string $_current_file
Résultat string

$_dir_perms public_oe property

default dir permissions
public int $_dir_perms
Résultat integer

$_file_perms public_oe property

default file permissions
public int $_file_perms
Résultat integer

$_muted_directories public_oe static_oe property

contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors()
public static $_muted_directories

$_parserdebug public_oe property

internal flag to enable parser debugging
public bool $_parserdebug
Résultat boolean

$_previous_error_handler public_oe static_oe property

error handler returned by set_error_hanlder() in Smarty::muteExpectedErrors()
public static $_previous_error_handler

$_resource_handlers public_oe property

resource handler cache
public array $_resource_handlers
Résultat array

$_smarty_vars public_oe static_oe property

global internal smarty vars
public static array $_smarty_vars
Résultat array

$_tag_stack public_oe property

block tag hierarchy
public array $_tag_stack
Résultat array

$allow_ambiguous_resources public_oe property

allow ambiguous resources (that are made unique by the resource handler)
public bool $allow_ambiguous_resources
Résultat boolean

$allow_php_templates public_oe property

controls if the php template file resource is allowed
public bool $allow_php_templates
Résultat boolean

$auto_literal public_oe property

auto literal on delimiters with whitspace
public bool $auto_literal
Résultat boolean

$autoload_filters public_oe property

autoload filter
public array $autoload_filters
Résultat array

$cache_id public_oe property

Set this if you want different sets of cache files for the same templates.
public string $cache_id
Résultat string

$cache_lifetime public_oe property

cache lifetime in seconds
public int $cache_lifetime
Résultat integer

$cache_locking public_oe property

Controls whether cache resources should emply locking mechanism
public bool $cache_locking
Résultat boolean

$cache_modified_check public_oe property

check If-Modified-Since headers
public bool $cache_modified_check
Résultat boolean

$caching public_oe property

caching enabled
public bool $caching
Résultat boolean

$caching_type public_oe property

Must be an element of $cache_resource_types.
public string $caching_type
Résultat string

$compile_check public_oe property

check template for modifications?
public bool $compile_check
Résultat boolean

$compile_id public_oe property

Set this if you want different sets of compiled files for the same templates.
public string $compile_id
Résultat string

$compile_locking public_oe property

locking concurrent compiles
public bool $compile_locking
Résultat boolean

$config_booleanize public_oe property

Controls whether config values of on/true/yes and off/false/no get converted to boolean.
public bool $config_booleanize
Résultat boolean

$config_overwrite public_oe property

Controls whether variables with the same name overwrite each other.
public bool $config_overwrite
Résultat boolean

$config_read_hidden public_oe property

Controls whether hidden config sections/vars are read from the file.
public bool $config_read_hidden
Résultat boolean

$debug_tpl public_oe property

Path of debug template.
public string $debug_tpl
Résultat string

$debugging public_oe property

Setting this to true enables the debug-console.
public bool $debugging
Résultat boolean

$debugging_ctrl public_oe property

  • NONE => no debugging control allowed
  • URL => enable debugging when SMARTY_DEBUG is found in the URL.
public string $debugging_ctrl
Résultat string

$default_config_handler_func public_oe property

default config handler
public callable $default_config_handler_func
Résultat callable

$default_config_type public_oe property

config type
public string $default_config_type
Résultat string

$default_modifiers public_oe property

default modifier
public array $default_modifiers
Résultat array

$default_plugin_handler_func public_oe property

default plugin handler
public callable $default_plugin_handler_func
Résultat callable

$default_resource_type public_oe property

Must be an valid key of $registered_resources.
public string $default_resource_type
Résultat string

$default_template_handler_func public_oe property

default template handler
public callable $default_template_handler_func
Résultat callable

$direct_access_security public_oe property

{@internal Currently used by Smarty_Internal_Template only.}}
public bool $direct_access_security
Résultat boolean

$error_reporting public_oe property

When set, smarty uses this value as error_reporting-level.
public int $error_reporting
Résultat integer

$error_unassigned public_oe property

display error on not assigned variables
public bool $error_unassigned
Résultat boolean

$escape_html public_oe property

autoescape variable output
public bool $escape_html
Résultat boolean

$force_cache public_oe property

force cache file creation
public bool $force_cache
Résultat boolean

$force_compile public_oe property

force template compiling?
public bool $force_compile
Résultat boolean

$get_used_tags public_oe property

Internal flag for getTags()
public bool $get_used_tags
Résultat boolean

$global_tpl_vars public_oe static_oe property

assigned global tpl vars
public static $global_tpl_vars

$inheritance_merge_compiled_includes public_oe property

template inheritance merge compiled includes
public bool $inheritance_merge_compiled_includes
Résultat boolean

$joined_config_dir public_oe property

joined config directory string used in cache keys
public string $joined_config_dir
Résultat string

$joined_template_dir public_oe property

joined template directory string used in cache keys
public string $joined_template_dir
Résultat string

$left_delimiter public_oe property

template left-delimiter
public string $left_delimiter
Résultat string

$locking_timeout public_oe property

seconds to wait for acquiring a lock before ignoring the write lock
public float $locking_timeout
Résultat float

$merge_compiled_includes public_oe property

merge compiled includes
public bool $merge_compiled_includes
Résultat boolean

$merged_templates_func public_oe property

Saved parameter of merged templates during compilation
public array $merged_templates_func
Résultat array

$php_handling public_oe property

controls handling of PHP-blocks
public int $php_handling
Résultat integer

$plugin_search_order public_oe property

plugin search order
public array $plugin_search_order
Résultat array

$properties public_oe property

internal config properties
public array $properties
Résultat array

$registered_cache_resources public_oe property

registered cache resources
public array $registered_cache_resources
Résultat array

$registered_classes public_oe property

registered classes
public array $registered_classes
Résultat array

$registered_filters public_oe property

registered filters
public array $registered_filters
Résultat array

$registered_objects public_oe property

registered objects
public array $registered_objects
Résultat array

$registered_plugins public_oe property

registered plugins
public array $registered_plugins
Résultat array

$registered_resources public_oe property

registered resources
public array $registered_resources
Résultat array

$right_delimiter public_oe property

template right-delimiter
public string $right_delimiter
Résultat string

$security_class public_oe property

This should be instance of Smarty_Security.
See also: Smarty_Security
public string $security_class
Résultat string

$security_policy public_oe property

implementation of security class
public Smarty_Security $security_policy
Résultat Smarty_Security

$smarty public_oe property

self pointer to Smarty object
public Smarty $smarty
Résultat Smarty

$smarty_debug_id public_oe property

Only used when $debugging_ctrl is set to 'URL'. The name of the URL-parameter that activates debugging.
public type $smarty_debug_id
Résultat type

$start_time public_oe property

start time for execution time calculation
public int $start_time
Résultat integer

$template_functions public_oe property

global template functions
public array $template_functions
Résultat array

$template_objects public_oe property

cached template objects
public array $template_objects
Résultat array

$use_include_path public_oe property

look up relative filepaths in include_path
public bool $use_include_path
Résultat boolean

$use_sub_dirs public_oe property

use sub dirs for compiled/cached files?
public bool $use_sub_dirs
Résultat boolean