[ Index ]
 

Code source de Serendipity 1.2

Accédez au Source d'autres logiciels libres

title

Body

[fermer]

/bundled-libs/Smarty/libs/ -> Smarty.class.php (sommaire)

Project:     Smarty: the PHP compiling template engine File:        Smarty.class.php This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

Author: Monte Ohrt
Author: Andrei Zmievski <andrei@php.net>
Copyright: 2001-2005 New Digital Group, Inc.
Version: 2.6.18
Poids: 1944 lignes (63 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Smarty:: (58 méthodes):
  Smarty()
  assign()
  assign_by_ref()
  append()
  append_by_ref()
  clear_assign()
  register_function()
  unregister_function()
  register_object()
  unregister_object()
  register_block()
  unregister_block()
  register_compiler_function()
  unregister_compiler_function()
  register_modifier()
  unregister_modifier()
  register_resource()
  unregister_resource()
  register_prefilter()
  unregister_prefilter()
  register_postfilter()
  unregister_postfilter()
  register_outputfilter()
  unregister_outputfilter()
  load_filter()
  clear_cache()
  clear_all_cache()
  is_cached()
  clear_all_assign()
  clear_compiled_tpl()
  template_exists()
  get_template_vars()
  get_config_vars()
  trigger_error()
  display()
  fetch()
  config_load()
  get_registered_object()
  clear_config()
  _get_plugin_filepath()
  _is_compiled()
  _compile_resource()
  _compile_source()
  _get_compile_path()
  _fetch_resource_info()
  _parse_resource_name()
  _run_mod_handler()
  _dequote()
  _read_file()
  _get_auto_filename()
  _unlink()
  _get_auto_id()
  _trigger_fatal_error()
  _process_compiled_include_callback()
  _smarty_include()
  _smarty_cache_attrs()
  _include()
  _eval()


Classe: Smarty  - X-Ref


Smarty()   X-Ref
The class constructor.


assign($tpl_var, $value = null)   X-Ref
assigns values to template variables

param: array|string $tpl_var the template variable name(s)
param: mixed $value the value to assign

assign_by_ref($tpl_var, &$value)   X-Ref
assigns values to template variables by reference

param: string $tpl_var the template variable name
param: mixed $value the referenced value to assign

append($tpl_var, $value=null, $merge=false)   X-Ref
appends values to template variables

param: array|string $tpl_var the template variable name(s)
param: mixed $value the value to append

append_by_ref($tpl_var, &$value, $merge=false)   X-Ref
appends values to template variables by reference

param: string $tpl_var the template variable name
param: mixed $value the referenced value to append

clear_assign($tpl_var)   X-Ref
clear the given assigned template variable.

param: string $tpl_var the template variable to clear

register_function($function, $function_impl, $cacheable=true, $cache_attrs=null)   X-Ref
Registers custom function to be used in templates

param: string $function the name of the template function
param: string $function_impl the name of the PHP function to register

unregister_function($function)   X-Ref
Unregisters custom function

param: string $function name of template function

register_object($object, &$object_impl, $allowed = array()   X-Ref
Registers object to be used in templates

param: string $object name of template object
param: object &$object_impl the referenced PHP object to register
param: null|array $allowed list of allowed methods (empty = all)
param: boolean $smarty_args smarty argument format, else traditional
param: null|array $block_functs list of methods that are block format

unregister_object($object)   X-Ref
Unregisters object

param: string $object name of template object

register_block($block, $block_impl, $cacheable=true, $cache_attrs=null)   X-Ref
Registers block function to be used in templates

param: string $block name of template block
param: string $block_impl PHP function to register

unregister_block($block)   X-Ref
Unregisters block function

param: string $block name of template function

register_compiler_function($function, $function_impl, $cacheable=true)   X-Ref
Registers compiler function

param: string $function name of template function
param: string $function_impl name of PHP function to register

unregister_compiler_function($function)   X-Ref
Unregisters compiler function

param: string $function name of template function

register_modifier($modifier, $modifier_impl)   X-Ref
Registers modifier to be used in templates

param: string $modifier name of template modifier
param: string $modifier_impl name of PHP function to register

unregister_modifier($modifier)   X-Ref
Unregisters modifier

param: string $modifier name of template modifier

register_resource($type, $functions)   X-Ref
Registers a resource to fetch a template

param: string $type name of resource
param: array $functions array of functions to handle resource

unregister_resource($type)   X-Ref
Unregisters a resource

param: string $type name of resource

register_prefilter($function)   X-Ref
Registers a prefilter function to apply
to a template before compiling

param: string $function name of PHP function to register

unregister_prefilter($function)   X-Ref
Unregisters a prefilter function

param: string $function name of PHP function

register_postfilter($function)   X-Ref
Registers a postfilter function to apply
to a compiled template after compilation

param: string $function name of PHP function to register

unregister_postfilter($function)   X-Ref
Unregisters a postfilter function

param: string $function name of PHP function

register_outputfilter($function)   X-Ref
Registers an output filter function to apply
to a template output

param: string $function name of PHP function

unregister_outputfilter($function)   X-Ref
Unregisters an outputfilter function

param: string $function name of PHP function

load_filter($type, $name)   X-Ref
load a filter of specified type and name

param: string $type filter type
param: string $name filter name

clear_cache($tpl_file = null, $cache_id = null, $compile_id = null, $exp_time = null)   X-Ref
clear cached content for the given template and cache id

param: string $tpl_file name of template file
param: string $cache_id name of cache_id
param: string $compile_id name of compile_id
param: string $exp_time expiration time
return: boolean

clear_all_cache($exp_time = null)   X-Ref
clear the entire contents of cache (all templates)

param: string $exp_time expire time
return: boolean results of {@link smarty_core_rm_auto()}

is_cached($tpl_file, $cache_id = null, $compile_id = null)   X-Ref
test to see if valid cache exists for this template

param: string $tpl_file name of template file
param: string $cache_id
param: string $compile_id
return: string|false results of {@link _read_cache_file()}

clear_all_assign()   X-Ref
clear all the assigned template variables.


clear_compiled_tpl($tpl_file = null, $compile_id = null, $exp_time = null)   X-Ref
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: string $tpl_file
param: string $compile_id
param: string $exp_time
return: boolean results of {@link smarty_core_rm_auto()}

template_exists($tpl_file)   X-Ref
Checks whether requested template exists.

param: string $tpl_file
return: boolean

get_template_vars($name=null)   X-Ref
Returns an array containing template variables

param: string $name
param: string $type
return: array

get_config_vars($name=null)   X-Ref
Returns an array containing config variables

param: string $name
param: string $type
return: array

trigger_error($error_msg, $error_type = E_USER_WARNING)   X-Ref
trigger Smarty error

param: string $error_msg
param: integer $error_type

display($resource_name, $cache_id = null, $compile_id = null)   X-Ref
executes & displays the template results

param: string $resource_name
param: string $cache_id
param: string $compile_id

fetch($resource_name, $cache_id = null, $compile_id = null, $display = false)   X-Ref
executes & returns or displays the template results

param: string $resource_name
param: string $cache_id
param: string $compile_id
param: boolean $display

config_load($file, $section = null, $scope = 'global')   X-Ref
load configuration values

param: string $file
param: string $section
param: string $scope

get_registered_object($name)   X-Ref
return a reference to a registered object

param: string $name
return: object

clear_config($var = null)   X-Ref
clear configuration values

param: string $var

_get_plugin_filepath($type, $name)   X-Ref
get filepath of requested plugin

param: string $type
param: string $name
return: string|false

_is_compiled($resource_name, $compile_path)   X-Ref
test if resource needs compiling

param: string $resource_name
param: string $compile_path
return: boolean

_compile_resource($resource_name, $compile_path)   X-Ref
compile the template

param: string $resource_name
param: string $compile_path
return: boolean

_compile_source($resource_name, &$source_content, &$compiled_content, $cache_include_path=null)   X-Ref
compile the given source

param: string $resource_name
param: string $source_content
param: string $compiled_content
return: boolean

_get_compile_path($resource_name)   X-Ref
Get the compile path for this resource

param: string $resource_name
return: string results of {@link _get_auto_filename()}

_fetch_resource_info(&$params)   X-Ref
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
param: string $resource_name
param: string $source_content
param: integer $resource_timestamp
param: boolean $get_source
param: boolean $quiet
return: boolean

_parse_resource_name(&$params)   X-Ref
parse out the type and name from the resource

param: string $resource_base_path
param: string $resource_name
param: string $resource_type
param: string $resource_name
return: boolean

_run_mod_handler()   X-Ref
Handle modifiers

param: string|null $modifier_name
param: array|null $map_array
return: string result of modifiers

_dequote($string)   X-Ref
Remove starting and ending quotes from the string

param: string $string
return: string

_read_file($filename)   X-Ref
read in a file

param: string $filename
return: string

_get_auto_filename($auto_base, $auto_source = null, $auto_id = null)   X-Ref
get a concrete filename for automagically created content

param: string $auto_base
param: string $auto_source
param: string $auto_id
return: string

_unlink($resource, $exp_time = null)   X-Ref
unlink a file, possibly using expiration time

param: string $resource
param: integer $exp_time

_get_auto_id($cache_id=null, $compile_id=null)   X-Ref
returns an auto_id for auto-file-functions

param: string $cache_id
param: string $compile_id
return: string|null

_trigger_fatal_error($error_msg, $tpl_file = null, $tpl_line = null,$file = null, $line = null, $error_type = E_USER_ERROR)   X-Ref
trigger Smarty plugin error

param: string $error_msg
param: string $tpl_file
param: integer $tpl_line
param: string $file
param: integer $line
param: integer $error_type

_process_compiled_include_callback($match)   X-Ref
callback function for preg_replace, to call a non-cacheable block

return: string

_smarty_include($params)   X-Ref
Pas de description

_smarty_cache_attrs($cache_serial, $count)   X-Ref
get or set an array of cached attributes for function that is
not cacheable

return: array

_include($filename, $once=false, $params=null)   X-Ref
wrapper for include() retaining $this

return: mixed

_eval($code, $params=null)   X-Ref
wrapper for eval() retaining $this

return: mixed



Généré le : Sat Nov 24 09:00:37 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics