EC-CUBE
Public メソッド | 変数
クラス Smarty
Smartyに対する継承グラフ
Inheritance graph
[凡例]

Public メソッド

 Smarty ()
 assign ($tpl_var, $value=null)
 assign_by_ref ($tpl_var, &$value)
 append ($tpl_var, $value=null, $merge=false)
 append_by_ref ($tpl_var, &$value, $merge=false)
 clear_assign ($tpl_var)
 register_function ($function, $function_impl, $cacheable=true, $cache_attrs=null)
 unregister_function ($function)
 register_object ($object, &$object_impl, $allowed=array(), $smarty_args=true, $block_methods=array())
 unregister_object ($object)
 register_block ($block, $block_impl, $cacheable=true, $cache_attrs=null)
 unregister_block ($block)
 register_compiler_function ($function, $function_impl, $cacheable=true)
 unregister_compiler_function ($function)
 register_modifier ($modifier, $modifier_impl)
 unregister_modifier ($modifier)
 register_resource ($type, $functions)
 unregister_resource ($type)
 register_prefilter ($function)
 unregister_prefilter ($function)
 register_postfilter ($function)
 unregister_postfilter ($function)
 register_outputfilter ($function)
 unregister_outputfilter ($function)
 load_filter ($type, $name)
 clear_cache ($tpl_file=null, $cache_id=null, $compile_id=null, $exp_time=null)
 clear_all_cache ($exp_time=null)
 is_cached ($tpl_file, $cache_id=null, $compile_id=null)
 clear_all_assign ()
 clear_compiled_tpl ($tpl_file=null, $compile_id=null, $exp_time=null)
 template_exists ($tpl_file)
get_template_vars ($name=null)
get_config_vars ($name=null)
 trigger_error ($error_msg, $error_type=E_USER_WARNING)
 display ($resource_name, $cache_id=null, $compile_id=null)
 fetch ($resource_name, $cache_id=null, $compile_id=null, $display=false)
 config_load ($file, $section=null, $scope= 'global')
get_registered_object ($name)
 clear_config ($var=null)
 _get_plugin_filepath ($type, $name)
 _is_compiled ($resource_name, $compile_path)
 _compile_resource ($resource_name, $compile_path)
 _compile_source ($resource_name, &$source_content, &$compiled_content, $cache_include_path=null)
 _get_compile_path ($resource_name)
 _fetch_resource_info (&$params)
 _parse_resource_name (&$params)
 _run_mod_handler ()
 _dequote ($string)
 _read_file ($filename)
 _get_auto_filename ($auto_base, $auto_source=null, $auto_id=null)
 _unlink ($resource, $exp_time=null)
 _get_auto_id ($cache_id=null, $compile_id=null)
 _trigger_fatal_error ($error_msg, $tpl_file=null, $tpl_line=null, $file=null, $line=null, $error_type=E_USER_ERROR)
 _process_compiled_include_callback ($match)
 _smarty_include ($params)
_smarty_cache_attrs ($cache_serial, $count)
 _include ($filename, $once=false, $params=null)
 _eval ($code, $params=null)
 _get_filter_name ($function)

変数

 $template_dir = 'templates'
 $compile_dir = 'templates_c'
 $config_dir = 'configs'
 $plugins_dir = array('plugins')
 $debugging = false
 $error_reporting = null
 $debug_tpl = ''
 $debugging_ctrl = 'NONE'
 $compile_check = true
 $force_compile = false
 $caching = 0
 $cache_dir = 'cache'
 $cache_lifetime = 3600
 $cache_modified_check = false
 $php_handling = SMARTY_PHP_PASSTHRU
 $security = false
 $secure_dir = array()
 $security_settings
 $trusted_dir = array()
 $left_delimiter = '{'
 $right_delimiter = '}'
 $request_vars_order = 'EGPCS'
 $request_use_auto_globals = true
 $compile_id = null
 $use_sub_dirs = false
 $default_modifiers = array()
 $default_resource_type = 'file'
 $cache_handler_func = null
 $autoload_filters = array()
 $config_overwrite = true
 $config_booleanize = true
 $config_read_hidden = false
 $config_fix_newlines = true
 $default_template_handler_func = ''
 $compiler_file = 'Smarty_Compiler.class.php'
 $compiler_class = 'Smarty_Compiler'
 $config_class = 'Config_File'
 $_tpl_vars = array()
 $_smarty_vars = null
 $_sections = array()
 $_foreach = array()
 $_tag_stack = array()
 $_conf_obj = null
 $_config = array(array('vars' => array(), 'files' => array()))
 $_smarty_md5 = 'f8d698aea36fcbead2b9d5359ffca76f'
 $_version = '2.6.26'
 $_inclusion_depth = 0
 $_compile_id = null
 $_smarty_debug_id = 'SMARTY_DEBUG'
 $_smarty_debug_info = array()
 $_cache_info = array()
 $_file_perms = 0644
 $_dir_perms = 0771
 $_reg_objects = array()
 $_plugins
 $_cache_serials = array()
 $_cache_include = null
 $_cache_including = false

関数

_compile_resource ( resource_name,
compile_path 
)

compile the template

引数:
string$resource_name
string$compile_path
戻り値:
boolean
_compile_source ( resource_name,
&$  source_content,
&$  compiled_content,
cache_include_path = null 
)

compile the given source

引数:
string$resource_name
string$source_content
string$compiled_content
戻り値:
boolean
_dequote ( string)

Remove starting and ending quotes from the string

引数:
string$string
戻り値:
string
_eval ( code,
params = null 
)

wrapper for eval() retaining $this

戻り値:
mixed
_fetch_resource_info ( &$  params)

fetch the template info. Gets timestamp, and source if get_source is true

sets $source_content to the source of the template, and $resource_timestamp to its time stamp

引数:
string$resource_name
string$source_content
integer$resource_timestamp
boolean$get_source
boolean$quiet
戻り値:
boolean
_get_auto_filename ( auto_base,
auto_source = null,
auto_id = null 
)

get a concrete filename for automagically created content

引数:
string$auto_base
string$auto_source
string$auto_id
戻り値:
string string|null string|null
_get_auto_id ( cache_id = null,
compile_id = null 
)

returns an auto_id for auto-file-functions

引数:
string$cache_id
string$compile_id
戻り値:
string|null
_get_compile_path ( resource_name)

Get the compile path for this resource

引数:
string$resource_name
戻り値:
string results of _get_auto_filename()
_get_filter_name ( function)

Extracts the filter name from the given callback

引数:
callback$function
戻り値:
string
_get_plugin_filepath ( type,
name 
)

get filepath of requested plugin

引数:
string$type
string$name
戻り値:
string|false
_include ( filename,
once = false,
params = null 
)

wrapper for include() retaining $this

戻り値:
mixed
_is_compiled ( resource_name,
compile_path 
)

test if resource needs compiling

引数:
string$resource_name
string$compile_path
戻り値:
boolean
_parse_resource_name ( &$  params)

parse out the type and name from the resource

引数:
string$resource_base_path
string$resource_name
string$resource_type
string$resource_name
戻り値:
boolean

callback function for preg_replace, to call a non-cacheable block

戻り値:
string
_read_file ( filename)

read in a file

引数:
string$filename
戻り値:
string

Handle modifiers

引数:
string | null$modifier_name
array | null$map_array
戻り値:
string result of modifiers
& _smarty_cache_attrs ( cache_serial,
count 
)

get or set an array of cached attributes for function that is not cacheable

戻り値:
array
_smarty_include ( params)

called for included templates

引数:
string$_smarty_include_tpl_file
string$_smarty_include_vars
_trigger_fatal_error ( error_msg,
tpl_file = null,
tpl_line = null,
file = null,
line = null,
error_type = E_USER_ERROR 
)

trigger Smarty plugin error

引数:
string$error_msg
string$tpl_file
integer$tpl_line
string$file
integer$line
integer$error_type
_unlink ( resource,
exp_time = null 
)

unlink a file, possibly using expiration time

引数:
string$resource
integer$exp_time
append ( tpl_var,
value = null,
merge = false 
)

appends values to template variables

引数:
array | string$tpl_varthe template variable name(s)
mixed$valuethe value to append
append_by_ref ( tpl_var,
&$  value,
merge = false 
)

appends values to template variables by reference

引数:
string$tpl_varthe template variable name
mixed$valuethe referenced value to append
assign ( tpl_var,
value = null 
)

assigns values to template variables

引数:
array | string$tpl_varthe template variable name(s)
mixed$valuethe value to assign
assign_by_ref ( tpl_var,
&$  value 
)

assigns values to template variables by reference

引数:
string$tpl_varthe template variable name
mixed$valuethe referenced value to assign

clear all the assigned template variables.

clear_all_cache ( exp_time = null)

clear the entire contents of cache (all templates)

引数:
string$exp_timeexpire time
戻り値:
boolean results of smarty_core_rm_auto()
clear_assign ( tpl_var)

clear the given assigned template variable.

引数:
string$tpl_varthe template variable to clear
clear_cache ( tpl_file = null,
cache_id = null,
compile_id = null,
exp_time = null 
)

clear cached content for the given template and cache id

引数:
string$tpl_filename of template file
string$cache_idname of cache_id
string$compile_idname of compile_id
string$exp_timeexpiration time
戻り値:
boolean
clear_compiled_tpl ( tpl_file = null,
compile_id = null,
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.

引数:
string$tpl_file
string$compile_id
string$exp_time
戻り値:
boolean results of smarty_core_rm_auto()
clear_config ( var = null)

clear configuration values

引数:
string$var
config_load ( file,
section = null,
scope = 'global' 
)

load configuration values

引数:
string$file
string$section
string$scope
display ( resource_name,
cache_id = null,
compile_id = null 
)

executes & displays the template results

引数:
string$resource_name
string$cache_id
string$compile_id
fetch ( resource_name,
cache_id = null,
compile_id = null,
display = false 
)

executes & returns or displays the template results

引数:
string$resource_name
string$cache_id
string$compile_id
boolean$display
& get_config_vars ( name = null)

Returns an array containing config variables

引数:
string$name
string$type
戻り値:
array
& get_registered_object ( name)

return a reference to a registered object

引数:
string$name
戻り値:
object
& get_template_vars ( name = null)

Returns an array containing template variables

引数:
string$name
string$type
戻り値:
array
is_cached ( tpl_file,
cache_id = null,
compile_id = null 
)

test to see if valid cache exists for this template

引数:
string$tpl_filename of template file
string$cache_id
string$compile_id
戻り値:
string|false results of _read_cache_file()
load_filter ( type,
name 
)

load a filter of specified type and name

引数:
string$typefilter type
string$namefilter name
register_block ( block,
block_impl,
cacheable = true,
cache_attrs = null 
)

Registers block function to be used in templates

引数:
string$blockname of template block
string$block_implPHP function to register
register_compiler_function ( function,
function_impl,
cacheable = true 
)

Registers compiler function

引数:
string$functionname of template function
string$function_implname of PHP function to register
register_function ( function,
function_impl,
cacheable = true,
cache_attrs = null 
)

Registers custom function to be used in templates

引数:
string$functionthe name of the template function
string$function_implthe name of the PHP function to register
register_modifier ( modifier,
modifier_impl 
)

Registers modifier to be used in templates

引数:
string$modifiername of template modifier
string$modifier_implname of PHP function to register
register_object ( object,
&$  object_impl,
allowed = array(),
smarty_args = true,
block_methods = array() 
)

Registers object to be used in templates

引数:
string$objectname of template object
object&$object_implthe referenced PHP object to register
null | array$allowedlist of allowed methods (empty = all)
boolean$smarty_argssmarty argument format, else traditional
null | array$block_functslist of methods that are block format
register_outputfilter ( function)

Registers an output filter function to apply to a template output

引数:
callback$function
register_postfilter ( function)

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

引数:
callback$function
register_prefilter ( function)

Registers a prefilter function to apply to a template before compiling

引数:
callback$function
register_resource ( type,
functions 
)

Registers a resource to fetch a template

引数:
string$typename of resource
array$functionsarray of functions to handle resource
Smarty ( )

#@- The class constructor.

template_exists ( tpl_file)

Checks whether requested template exists.

引数:
string$tpl_file
戻り値:
boolean
trigger_error ( error_msg,
error_type = E_USER_WARNING 
)

trigger Smarty error

引数:
string$error_msg
integer$error_type
unregister_block ( block)

Unregisters block function

引数:
string$blockname of template function

Unregisters compiler function

引数:
string$functionname of template function
unregister_function ( function)

Unregisters custom function

引数:
string$functionname of template function
unregister_modifier ( modifier)

Unregisters modifier

引数:
string$modifiername of template modifier
unregister_object ( object)

Unregisters object

引数:
string$objectname of template object
unregister_outputfilter ( function)

Unregisters an outputfilter function

引数:
callback$function
unregister_postfilter ( function)

Unregisters a postfilter function

引数:
callback$function
unregister_prefilter ( function)

Unregisters a prefilter function

引数:
callback$function
unregister_resource ( type)

Unregisters a resource

引数:
string$typename of resource

構造体

$_plugins
初期値:
 array(
                                       'modifier'      => array(),
                                       'function'      => array(),
                                       'block'         => array(),
                                       'compiler'      => array(),
                                       'prefilter'     => array(),
                                       'postfilter'    => array(),
                                       'outputfilter'  => array(),
                                       'resource'      => array(),
                                       'insert'        => array())
$config_booleanize = true

This tells whether or not to automatically booleanize config file variables. If enabled, then the strings "on", "true", and "yes" are treated as boolean true, and "off", "false" and "no" are treated as boolean false.

$config_fix_newlines = true

This tells whether or not automatically fix newlines in config files. It basically converts (mac) or
(dos) to

$config_overwrite = true

This tells if config file vars of the same name overwrite each other or not. if disabled, same name variables are accumulated in an array.

$config_read_hidden = false

This tells whether hidden sections [.foobar] are readable from the tempalates or not. Normally you would never allow this since that is the point behind hidden sections: the application can access them, but the templates cannot.

$security_settings
初期値:
 array(
                                    'PHP_HANDLING'    => false,
                                    'IF_FUNCS'        => array('array', 'list',
                                                               'isset', 'empty',
                                                               'count', 'sizeof',
                                                               'in_array', 'is_array',
                                                               'true', 'false', 'null'),
                                    'INCLUDE_ANY'     => false,
                                    'PHP_TAGS'        => false,
                                    'MODIFIER_FUNCS'  => array('count'),
                                    'ALLOW_CONSTANTS'  => false,
                                    'ALLOW_SUPER_GLOBALS' => true
                                   )

このクラスの説明は次のファイルから生成されました:
 全て データ構造 ネームスペース 関数 変数