[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/Smarty/libs/ -> Smarty.class.php (summary)

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: Uwe Tews
Author: Rodney Rehm
Copyright: 2008 New Digital Group, Inc.
Version: 3.1.7
File Size: 1502 lines (45 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 classes

Smarty:: (42 methods):
  __construct()
  __destruct()
  __clone()
  __get()
  __set()
  templateExists()
  getGlobal()
  clearAllCache()
  clearCache()
  enableSecurity()
  disableSecurity()
  setTemplateDir()
  addTemplateDir()
  getTemplateDir()
  setConfigDir()
  addConfigDir()
  getConfigDir()
  setPluginsDir()
  addPluginsDir()
  getPluginsDir()
  setCompileDir()
  getCompileDir()
  setCacheDir()
  getCacheDir()
  setDefaultModifiers()
  addDefaultModifiers()
  getDefaultModifiers()
  setAutoloadFilters()
  addAutoloadFilters()
  getAutoloadFilters()
  getDebugTemplate()
  setDebugTemplate()
  createTemplate()
  loadPlugin()
  compileAllTemplates()
  compileAllConfig()
  clearCompiledTemplate()
  getTags()
  testInstall()
  mutingErrorHandler()
  muteExpectedErrors()
  unmuteExpectedErrors()

SmartyException:: (0 methods):

SmartyCompilerException:: (1 method):
  smartyAutoload()


Class: Smarty  - X-Ref

This is the main Smarty class

__construct()   X-Ref
Initialize new Smarty object


__destruct()   X-Ref
Class destructor


__clone()   X-Ref
<<magic>> set selfpointer on cloned object


__get($name)   X-Ref
<<magic>> Generic getter.

Calls the appropriate getter function.
Issues an E_USER_NOTICE if no valid getter is found.

param: string $name property name
return: mixed

__set($name, $value)   X-Ref
<<magic>> Generic setter.

Calls the appropriate setter function.
Issues an E_USER_NOTICE if no valid setter is found.

param: string $name  property name
param: mixed  $value parameter passed to setter

templateExists($resource_name)   X-Ref
Check if a template resource exists

param: string $resource_name template name
return: boolean status

getGlobal($varname = null)   X-Ref
Returns a single or all global  variables

param: object $smarty
param: string $varname variable name or null
return: string variable value or or array of variables

clearAllCache($exp_time = null, $type = null)   X-Ref
Empty cache folder

param: integer $exp_time expiration time
param: string  $type     resource type
return: integer number of cache files deleted

clearCache($template_name, $cache_id = null, $compile_id = null, $exp_time = null, $type = null)   X-Ref
Empty cache for a specific template

param: string  $template_name template name
param: string  $cache_id      cache id
param: string  $compile_id    compile id
param: integer $exp_time      expiration time
param: string  $type          resource type
return: integer number of cache files deleted

enableSecurity($security_class = null)   X-Ref
Loads security class and enables security

param: string|Smarty_Security $security_class if a string is used, it must be class-name
return: Smarty current Smarty instance for chaining

disableSecurity()   X-Ref
Disable security

return: Smarty current Smarty instance for chaining

setTemplateDir($template_dir)   X-Ref
Set template directory

param: string|array $template_dir directory(s) of template sources
return: Smarty current Smarty instance for chaining

addTemplateDir($template_dir, $key=null)   X-Ref
Add template directory(s)

param: string|array $template_dir directory(s) of template sources
param: string       $key          of the array element to assign the template dir to
return: Smarty current Smarty instance for chaining

getTemplateDir($index=null)   X-Ref
Get template directories

param: mixed index of directory to get, null to get all
return: array|string list of template directories, or directory of $index

setConfigDir($config_dir)   X-Ref
Set config directory

param: string|array $template_dir directory(s) of configuration sources
return: Smarty current Smarty instance for chaining

addConfigDir($config_dir, $key=null)   X-Ref
Add config directory(s)

param: string|array $config_dir directory(s) of config sources
param: string key of the array element to assign the config dir to
return: Smarty current Smarty instance for chaining

getConfigDir($index=null)   X-Ref
Get config directory

param: mixed index of directory to get, null to get all
return: array|string configuration directory

setPluginsDir($plugins_dir)   X-Ref
Set plugins directory

param: string|array $plugins_dir directory(s) of plugins
return: Smarty current Smarty instance for chaining

addPluginsDir($plugins_dir)   X-Ref
Adds directory of plugin files

param: object $smarty
param: string $ |array $ plugins folder
return: Smarty current Smarty instance for chaining

getPluginsDir()   X-Ref
Get plugin directories

return: array list of plugin directories

setCompileDir($compile_dir)   X-Ref
Set compile directory

param: string $compile_dir directory to store compiled templates in
return: Smarty current Smarty instance for chaining

getCompileDir()   X-Ref
Get compiled directory

return: string path to compiled templates

setCacheDir($cache_dir)   X-Ref
Set cache directory

param: string $cache_dir directory to store cached templates in
return: Smarty current Smarty instance for chaining

getCacheDir()   X-Ref
Get cache directory

return: string path of cache directory

setDefaultModifiers($modifiers)   X-Ref
Set default modifiers

param: array|string $modifiers modifier or list of modifiers to set
return: Smarty current Smarty instance for chaining

addDefaultModifiers($modifiers)   X-Ref
Add default modifiers

param: array|string $modifiers modifier or list of modifiers to add
return: Smarty current Smarty instance for chaining

getDefaultModifiers()   X-Ref
Get default modifiers

return: array list of default modifiers

setAutoloadFilters($filters, $type=null)   X-Ref
Set autoload filters

param: array $filters filters to load automatically
param: string $type "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types
return: Smarty current Smarty instance for chaining

addAutoloadFilters($filters, $type=null)   X-Ref
Add autoload filters

param: array $filters filters to load automatically
param: string $type "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types
return: Smarty current Smarty instance for chaining

getAutoloadFilters($type=null)   X-Ref
Get autoload filters

param: string $type type of filter to get autoloads for. Defaults to all autoload filters
return: array array( 'type1' => array( 'filter1', 'filter2', … ) ) or array( 'filter1', 'filter2', …) if $type was specified

getDebugTemplate()   X-Ref
return name of debugging template

return: string

setDebugTemplate($tpl_name)   X-Ref
set the debug template

param: string $tpl_name
return: Smarty current Smarty instance for chaining

createTemplate($template, $cache_id = null, $compile_id = null, $parent = null, $do_clone = true)   X-Ref
creates a template object

param: string $template the resource handle of the template file
param: mixed $cache_id cache id to be used with this template
param: mixed $compile_id compile id to be used with this template
param: object $parent next higher level of Smarty variables
param: boolean $do_clone flag is Smarty object shall be cloned
return: object template object

loadPlugin($plugin_name, $check = true)   X-Ref
Takes unknown classes and loads plugin files for them
class name format: Smarty_PluginType_PluginName
plugin filename format: plugintype.pluginname.php

param: string $plugin_name    class plugin name to load
param: bool   $check          check if already loaded
return: string |boolean filepath of loaded file or false

compileAllTemplates($extention = '.tpl', $force_compile = false, $time_limit = 0, $max_errors = null)   X-Ref
Compile all template files

param: string $extension file extension
param: bool $force_compile force all to recompile
param: int $time_limit
param: int $max_errors
return: integer number of template files recompiled

compileAllConfig($extention = '.conf', $force_compile = false, $time_limit = 0, $max_errors = null)   X-Ref
Compile all config files

param: string $extension file extension
param: bool $force_compile force all to recompile
param: int $time_limit
param: int $max_errors
return: integer number of template files recompiled

clearCompiledTemplate($resource_name = null, $compile_id = null, $exp_time = null)   X-Ref
Delete compiled template file

param: string $resource_name template name
param: string $compile_id compile id
param: integer $exp_time expiration time
return: integer number of template files deleted

getTags(Smarty_Internal_Template $template)   X-Ref
Return array of tag/attributes of all tags used by an template

param: object $templae template object
return: array of tag/attributes

testInstall(&$errors=null)   X-Ref
Run installation test

param: array $errors Array to write errors into, rather than outputting them
return: boolean true if setup is fine, false if something is wrong

mutingErrorHandler($errno, $errstr, $errfile, $errline, $errcontext)   X-Ref
Error Handler to mute expected messages

param: integer $errno Error level
return: boolean

muteExpectedErrors()   X-Ref
Enable error handler to mute expected messages

return: void

unmuteExpectedErrors()   X-Ref
Disable error handler muting expected messages

return: void

Class: SmartyException  - X-Ref

Smarty exception class

Class: SmartyCompilerException  - X-Ref

Smarty compiler exception class

smartyAutoload($class)   X-Ref
Autoloader




Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1