Wismas  1.1
BTS SN-IR La Salle Avignon 2017
Fonctions membres publiques | Attributs publics
Référence de la classe SmartyBC
Graphe d'héritage de SmartyBC:
Inheritance graph
[légende]
Graphe de collaboration de SmartyBC:
Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 __construct (array $options=array())
 assign_by_ref ($tpl_var, &$value)
 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)
 config_load ($file, $section=null, $scope= 'global')
 get_registered_object ($name)
 clear_config ($var=null)
 trigger_error ($error_msg, $error_type=E_USER_WARNING)

Attributs publics

 $_version = self::SMARTY_VERSION
 $trusted_dir = array()

Documentation des constructeurs et destructeur

SmartyBC::__construct ( array $  options = array())

Initialize new SmartyBC object

Paramètres:
array$optionsoptions to set during initialization, e.g. array( 'forceCompile' => false )

Références Smarty\__construct().

    {
        parent::__construct($options);
    }

Documentation des fonctions membres

SmartyBC::append_by_ref ( tpl_var,
&$  value,
merge = false 
)

wrapper for append_by_ref

Paramètres:
string$tpl_varthe template variable name
mixed&$valuethe referenced value to append
boolean$mergeflag if array elements shall be merged
    {
        $this->appendByRef($tpl_var, $value, $merge);
    }
SmartyBC::assign_by_ref ( tpl_var,
&$  value 
)

wrapper for assign_by_ref

Paramètres:
string$tpl_varthe template variable name
mixed&$valuethe referenced value to assign
    {
        $this->assignByRef($tpl_var, $value);
    }

clear all the assigned template variables.

    {
        $this->clearAllAssign();
    }
SmartyBC::clear_all_cache ( exp_time = null)

clear the entire contents of cache (all templates)

Paramètres:
string$exp_timeexpire time
Renvoie:
boolean
    {
        return $this->clearCache(null, null, null, $exp_time);
    }
SmartyBC::clear_assign ( tpl_var)

clear the given assigned template variable.

Paramètres:
string$tpl_varthe template variable to clear
    {
        $this->clearAssign($tpl_var);
    }
SmartyBC::clear_cache ( tpl_file = null,
cache_id = null,
compile_id = null,
exp_time = null 
)

clear cached content for the given template and cache id

Paramètres:
string$tpl_filename of template file
string$cache_idname of cache_id
string$compile_idname of compile_id
string$exp_timeexpiration time
Renvoie:
boolean
    {
        return $this->clearCache($tpl_file, $cache_id, $compile_id, $exp_time);
    }
SmartyBC::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.

Paramètres:
string$tpl_file
string$compile_id
string$exp_time
Renvoie:
boolean results of smarty_core_rm_auto()
    {
        return $this->clearCompiledTemplate($tpl_file, $compile_id, $exp_time);
    }
SmartyBC::clear_config ( var = null)

clear configuration values

Paramètres:
string$var
    {
        $this->clearConfig($var);
    }
SmartyBC::config_load ( file,
section = null,
scope = 'global' 
)

load configuration values

Paramètres:
string$file
string$section
string$scope
    {
        $this->ConfigLoad($file, $section, $scope);
    }
SmartyBC::get_config_vars ( name = null)

Returns an array containing config variables

Paramètres:
string$name
Renvoie:
array
    {
        return $this->getConfigVars($name);
    }

return a reference to a registered object

Paramètres:
string$name
Renvoie:
object
    {
        return $this->getRegisteredObject($name);
    }
SmartyBC::get_template_vars ( name = null)

Returns an array containing template variables

Paramètres:
string$name
Renvoie:
array
    {
        return $this->getTemplateVars($name);
    }
SmartyBC::is_cached ( tpl_file,
cache_id = null,
compile_id = null 
)

test to see if valid cache exists for this template

Paramètres:
string$tpl_filename of template file
string$cache_id
string$compile_id
Renvoie:
boolean
    {
        return $this->isCached($tpl_file, $cache_id, $compile_id);
    }
SmartyBC::load_filter ( type,
name 
)

load a filter of specified type and name

Paramètres:
string$typefilter type
string$namefilter name
    {
        $this->loadFilter($type, $name);
    }
SmartyBC::register_block ( block,
block_impl,
cacheable = true,
cache_attrs = null 
)

Registers block function to be used in templates

Paramètres:
string$blockname of template block
string$block_implPHP function to register
bool$cacheable
mixed$cache_attrs
    {
        $this->registerPlugin('block', $block, $block_impl, $cacheable, $cache_attrs);
    }
SmartyBC::register_compiler_function ( function,
function_impl,
cacheable = true 
)

Registers compiler function

Paramètres:
string$functionname of template function
string$function_implname of PHP function to register
bool$cacheable
    {
        $this->registerPlugin('compiler', $function, $function_impl, $cacheable);
    }
SmartyBC::register_function ( function,
function_impl,
cacheable = true,
cache_attrs = null 
)

Registers custom function to be used in templates

Paramètres:
string$functionthe name of the template function
string$function_implthe name of the PHP function to register
bool$cacheable
mixed$cache_attrs
    {
        $this->registerPlugin('function', $function, $function_impl, $cacheable, $cache_attrs);
    }
SmartyBC::register_modifier ( modifier,
modifier_impl 
)

Registers modifier to be used in templates

Paramètres:
string$modifiername of template modifier
string$modifier_implname of PHP function to register
    {
        $this->registerPlugin('modifier', $modifier, $modifier_impl);
    }
SmartyBC::register_object ( object,
object_impl,
allowed = array(),
smarty_args = true,
block_methods = array() 
)

Registers object to be used in templates

Paramètres:
string$objectname of template object
object$object_implthe referenced PHP object to register
array$allowedlist of allowed methods (empty = all)
boolean$smarty_argssmarty argument format, else traditional
array$block_methodslist of methods that are block format
Exceptions:
SmartyException
    {
        settype($allowed, 'array');
        settype($smarty_args, 'boolean');
        $this->registerObject($object, $object_impl, $allowed, $smarty_args, $block_methods);
    }

Registers an output filter function to apply to a template output

Paramètres:
callable$function
    {
        $this->registerFilter('output', $function);
    }

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

Paramètres:
callable$function
    {
        $this->registerFilter('post', $function);
    }

Registers a prefilter function to apply to a template before compiling

Paramètres:
callable$function
    {
        $this->registerFilter('pre', $function);
    }
SmartyBC::register_resource ( type,
functions 
)

Registers a resource to fetch a template

Paramètres:
string$typename of resource
array$functionsarray of functions to handle resource
    {
        $this->registerResource($type, $functions);
    }
SmartyBC::template_exists ( tpl_file)

Checks whether requested template exists.

Paramètres:
string$tpl_file
Renvoie:
boolean

Références Smarty\templateExists().

    {
        return $this->templateExists($tpl_file);
    }
SmartyBC::trigger_error ( error_msg,
error_type = E_USER_WARNING 
)

trigger Smarty error

Paramètres:
string$error_msg
integer$error_type
    {
        trigger_error("Smarty error: $error_msg", $error_type);
    }

Unregisters block function

Paramètres:
string$blockname of template function
    {
        $this->unregisterPlugin('block', $block);
    }

Unregisters compiler function

Paramètres:
string$functionname of template function
    {
        $this->unregisterPlugin('compiler', $function);
    }

Unregisters custom function

Paramètres:
string$functionname of template function
    {
        $this->unregisterPlugin('function', $function);
    }

Unregisters modifier

Paramètres:
string$modifiername of template modifier
    {
        $this->unregisterPlugin('modifier', $modifier);
    }

Unregisters object

Paramètres:
string$objectname of template object
    {
        $this->unregisterObject($object);
    }

Unregisters an outputfilter function

Paramètres:
callable$function
    {
        $this->unregisterFilter('output', $function);
    }

Unregisters a postfilter function

Paramètres:
callable$function
    {
        $this->unregisterFilter('post', $function);
    }

Unregisters a prefilter function

Paramètres:
callable$function
    {
        $this->unregisterFilter('pre', $function);
    }

Unregisters a resource

Paramètres:
string$typename of resource
    {
        $this->unregisterResource($type);
    }

Documentation des données membres

SmartyBC::$_version = self::SMARTY_VERSION
SmartyBC::$trusted_dir = array()

La documentation de cette classe a été générée à partir du fichier suivant :
 Tout Classes Fichiers Fonctions Variables Définitions de type Macros