Docs For Class Smarty

Class Smarty

Description

This is the main Smarty class

Located in /libs/Smarty.class.php (line 107)

Smarty_Internal_Data
   |
   --Smarty_Internal_TemplateBase
      |
      --Smarty

Direct descendents

Class	Description
SmartyBC	Smarty Backward Compatability Wrapper Class

Class Constant Summary

CACHING_LIFETIME_CURRENT = 1

CACHING_LIFETIME_SAVED = 2

CACHING_OFF = 0

CLEAR_EXPIRED = -1

COMPILECHECK_CACHEMISS = 2

COMPILECHECK_OFF = 0

COMPILECHECK_ON = 1

FILTER_OUTPUT = 'output'

FILTER_POST = 'post'

FILTER_PRE = 'pre'

FILTER_VARIABLE = 'variable'

PHP_ALLOW = 3

PHP_PASSTHRU = 0

PHP_QUOTE = 1

PHP_REMOVE = 2

PLUGIN_BLOCK = 'block'

PLUGIN_COMPILER = 'compiler'

PLUGIN_FUNCTION = 'function'

PLUGIN_MODIFIER = 'modifier'

PLUGIN_MODIFIERCOMPILER = 'modifiercompiler'

SCOPE_GLOBAL = 3

SCOPE_LOCAL = 0

SCOPE_PARENT = 1

SCOPE_ROOT = 2

SMARTY_VERSION = 'Smarty-3.1-DEV'

Variable Summary

static mixed $global_tpl_vars

static mixed $_CHARSET

static mixed $_DATE_FORMAT

static mixed $_IS_WINDOWS

static mixed $_MBSTRING

static mixed $_muted_directories

static mixed $_previous_error_handler

static array $_smarty_vars

static mixed $_UTF8_MODIFIER

boolean $allow_ambiguous_resources

bool $allow_php_templates

array $autoload_filters

boolean $auto_literal

string $cache_id

integer $cache_lifetime

boolean $cache_locking

boolean $cache_modified_check

boolean $caching

string $caching_type

boolean $compile_check

string $compile_id

boolean $compile_locking

boolean $config_booleanize

boolean $config_overwrite

boolean $config_read_hidden

boolean $debugging

string $debugging_ctrl

string $debug_tpl

callable $default_config_handler_func

string $default_config_type

array $default_modifiers

callable $default_plugin_handler_func

string $default_resource_type

callable $default_template_handler_func

boolean $direct_access_security

int $error_reporting

boolean $error_unassigned

boolean $escape_html

boolean $force_cache

boolean $force_compile

boolean $get_used_tags

string $joined_config_dir

string $joined_template_dir

string $left_delimiter

float $locking_timeout

array $merged_templates_func

boolean $merge_compiled_includes

integer $php_handling

array $plugin_search_order

array $properties

array $registered_cache_resources

array $registered_classes

array $registered_filters

array $registered_objects

array $registered_plugins

array $registered_resources

string $right_delimiter

string $security_class

Smarty_Security $security_policy

Smarty $smarty

type $smarty_debug_id

int $start_time

array $template_functions

array $template_objects

boolean $use_include_path

boolean $use_sub_dirs

array $_cacheresource_handlers

string $_current_file

int $_dir_perms

int $_file_perms

bool $_parserdebug

array $_resource_handlers

array $_tag_stack

Method Summary

static void muteExpectedErrors ()

static boolean mutingErrorHandler (integer $errno, $errstr, $errfile, $errline, $errcontext)

static void unmuteExpectedErrors ()

Smarty addAutoloadFilters (array $filters, [string $type = null])

Smarty addConfigDir (string|array $config_dir, [string $key = null])

Smarty addDefaultModifiers (array|string $modifiers)

Smarty addPluginsDir ( $plugins_dir, object $smarty, string $)

Smarty addTemplateDir (string|array $template_dir, [string $key = null])

Smarty __construct ()

void __destruct ()

integer clearAllCache ([integer $exp_time = null], [string $type = null])

integer clearCache (string $template_name, [string $cache_id = null], [string $compile_id = null], [integer $exp_time = null], [string $type = null])

integer clearCompiledTemplate ([string $resource_name = null], [string $compile_id = null], [integer $exp_time = null])

integer compileAllConfig ([string $extension = '.conf'], [bool $force_compile = false], [int $time_limit = 0], [int $max_errors = null])

integer compileAllTemplates ([string $extension = '.tpl'], [bool $force_compile = false], [int $time_limit = 0], [int $max_errors = null])

object template createTemplate (string $template, [mixed $cache_id = null], [mixed $compile_id = null], [object $parent = null], [boolean $do_clone = true])

Smarty disableSecurity ()

Smarty enableSecurity ([string|Smarty_Security $security_class = null])

array getAutoloadFilters ([string $type = null])

string getCacheDir ()

string getCompileDir ()

array|string getConfigDir ([mixed $index = null])

string getDebugTemplate ()

array getDefaultModifiers ()

string getGlobal ([string $varname = null], object $smarty)

array getPluginsDir ()

array getTags (Smarty_Internal_Template $template, object $templae)

array|string getTemplateDir ([mixed $index = null])

string loadPlugin (string $plugin_name, [bool $check = true])

Smarty setAutoloadFilters (array $filters, [string $type = null])

Smarty setCacheDir (string $cache_dir)

Smarty setCompileDir (string $compile_dir)

Smarty setConfigDir ( $config_dir, string|array $template_dir)

Smarty setDebugTemplate (string $tpl_name)

Smarty setDefaultModifiers (array|string $modifiers)

Smarty setPluginsDir (string|array $plugins_dir)

Smarty setTemplateDir (string|array $template_dir)

boolean templateExists (string $resource_name)

boolean testInstall ([ &$errors = null], array $errors)

void __clone ()

mixed __get (string $name)

void __set (string $name, mixed $value)

Variables

Strict standards: Only variables should be passed by reference in C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php on line 712 Call Stack: 0.0006 229032 1. {main}() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:0 0.0027 240216 2. include('C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:59 0.1463 8650352 3. phpDocumentor_setup->createDocs() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc:65 13.2331 130016152 4. phpDocumentor_IntermediateParser->Output() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Setup.inc.php:761 13.9644 131381624 5. phpDocumentor_IntermediateParser->Convert() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1865 13.9644 131381720 6. Converter->walk() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1652 18.1075 135945552 7. HTMLframesConverter->endClass() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converter.inc:1904 18.1079 135946736 8. Smarty->fetch() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converters\HTML\frames\HTMLframesConverter.inc:347 18.1463 136435376 9. include('C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1298 18.1512 136628704 10. Smarty->_smarty_include() C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php:585 18.1514 136632960 11. Smarty->_compile_resource() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1935 18.1517 136639616 12. Smarty->_compile_source() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1458 18.1521 136673640 13. Smarty_Compiler->_compile_file() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1523 18.1533 136719056 14. Smarty_Compiler->_compile_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:316 18.1542 136719976 15. Smarty_Compiler->_compile_custom_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:537 Strict standards: Only variables should be passed by reference in C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php on line 712 Call Stack: 0.0006 229032 1. {main}() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:0 0.0027 240216 2. include('C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:59 0.1463 8650352 3. phpDocumentor_setup->createDocs() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc:65 13.2331 130016152 4. phpDocumentor_IntermediateParser->Output() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Setup.inc.php:761 13.9644 131381624 5. phpDocumentor_IntermediateParser->Convert() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1865 13.9644 131381720 6. Converter->walk() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1652 18.1075 135945552 7. HTMLframesConverter->endClass() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converter.inc:1904 18.1079 135946736 8. Smarty->fetch() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converters\HTML\frames\HTMLframesConverter.inc:347 18.1463 136435376 9. include('C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1298 18.1512 136628704 10. Smarty->_smarty_include() C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php:585 18.1514 136632960 11. Smarty->_compile_resource() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1935 18.1517 136639616 12. Smarty->_compile_source() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1458 18.1521 136673640 13. Smarty_Compiler->_compile_file() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1523 18.1602 136732072 14. Smarty_Compiler->_compile_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:316 18.1609 136732992 15. Smarty_Compiler->_compile_custom_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:537

static mixed $global_tpl_vars = array() (line 170)

assigned global tpl vars

access: public

static mixed $_CHARSET = SMARTY_RESOURCE_CHAR_SET (line 187)

The character set to adhere to (e.g. "UTF-8")

access: public

static mixed $_DATE_FORMAT = SMARTY_RESOURCE_DATE_FORMAT (line 192)

The date format to be used internally

(accepts date() and strftime())

access: public

static mixed $_IS_WINDOWS = false (line 201)

Flag denoting if operating system is windows

access: public

static mixed $_MBSTRING = SMARTY_MBSTRING (line 183)

Flag denoting if Multibyte String functions are available

access: public

static mixed $_muted_directories = array() (line 179)

contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors()

access: public

static mixed $_previous_error_handler = null (line 175)

error handler returned by set_error_hanlder() in Smarty::muteExpectedErrors()

access: public

static array $_smarty_vars = array() (line 567)

global internal smarty vars

access: public

static mixed $_UTF8_MODIFIER = 'u' (line 196)

Flag denoting if PCRE should run in UTF-8 mode

access: public

boolean $allow_ambiguous_resources = false (line 291)

allow ambiguous resources (that are made unique by the resource handler)

variables

access: public

bool $allow_php_templates = false (line 365)

controls if the php template file resource is allowed

security

access: public

array $autoload_filters = array() (line 552)

autoload filter

access: public

boolean $auto_literal = true (line 211)

auto literal on delimiters with whitspace

variables

access: public

string $cache_id = null (line 318)

Set this if you want different sets of cache files for the same templates.

variables

access: public

integer $cache_lifetime = 3600 (line 306)

cache lifetime in seconds

variables

access: public

boolean $cache_locking = false (line 454)

Controls whether cache resources should emply locking mechanism

resource locking

access: public

boolean $cache_modified_check = false (line 502)

check If-Modified-Since headers

access: public

boolean $caching = false (line 296)

caching enabled

variables

access: public

string $caching_type = 'file' (line 482)

caching type

Must be an element of $cache_resource_types.

access: public

boolean $compile_check = true (line 281)

check template for modifications?

variables

access: public

string $compile_id = null (line 325)

Set this if you want different sets of compiled files for the same templates.

variables

access: public

boolean $compile_locking = true (line 449)

locking concurrent compiles

resource locking

access: public

boolean $config_booleanize = true (line 432)

Controls whether config values of on/true/yes and off/false/no get converted to boolean.

config var settings

access: public

boolean $config_overwrite = true (line 427)

Controls whether variables with the same name overwrite each other.

config var settings

access: public

boolean $config_read_hidden = false (line 437)

Controls whether hidden config sections/vars are read from the file.

config var settings

access: public

boolean $debugging = false (line 384)

debug mode

Setting this to true enables the debug-console.

access: public

string $debugging_ctrl = 'NONE' (line 393)

This determines if debugging is enable-able from the browser.

NONE => no debugging control allowed
URL => enable debugging when SMARTY_DEBUG is found in the URL.

access: public

string $debug_tpl = null (line 407)

Path of debug template.

access: public

callable $default_config_handler_func = null (line 246)

default config handler

variables

access: public

string $default_config_type = 'file' (line 492)

config type

access: public

array $default_modifiers = array() (line 557)

default modifier

access: public

callable $default_plugin_handler_func = null (line 251)

default plugin handler

variables

access: public

string $default_resource_type = 'file' (line 474)

resource type used if none given

Must be an valid key of $registered_resources.

access: public

callable $default_template_handler_func = null (line 241)

default template handler

variables

access: public

boolean $direct_access_security = true (line 375)

Should compiled-templates be prevented from being called directly?

security

access: public

int $error_reporting = null (line 412)

When set, smarty uses this value as error_reporting-level.

access: public

boolean $error_unassigned = false (line 216)

display error on not assigned variables

variables

access: public

boolean $escape_html = false (line 562)

autoescape variable output

access: public

boolean $force_cache = false (line 311)

force cache file creation

variables

access: public

boolean $force_compile = false (line 276)

force template compiling?

variables

access: public

boolean $get_used_tags = false (line 417)

Internal flag for getTags()

access: public

string $joined_config_dir = null (line 236)

joined config directory string used in cache keys

variables

access: public

string $joined_template_dir = null (line 231)

joined template directory string used in cache keys

variables

access: public

string $left_delimiter = "{" (line 330)

template left-delimiter

variables

access: public

float $locking_timeout = 10 (line 459)

seconds to wait for acquiring a lock before ignoring the write lock

resource locking

access: public

array $merged_templates_func = array() (line 608)

Saved parameter of merged templates during compilation

access: public

boolean $merge_compiled_includes = false (line 301)

merge compiled includes

variables

access: public

integer $php_handling = self::PHP_PASSTHRU (line 359)

controls handling of PHP-blocks

security

access: public

array $plugin_search_order = array('function', 'block', 'compiler', 'class') (line 512)

plugin search order

access: public

array $properties = array() (line 487)

internal config properties

access: public

array $registered_cache_resources = array() (line 542)

registered cache resources

access: public

array $registered_classes = array() (line 522)

registered classes

access: public

array $registered_filters = array() (line 527)

registered filters

access: public

array $registered_objects = array() (line 517)

registered objects

access: public

array $registered_plugins = array() (line 507)

registered plugins

access: public

array $registered_resources = array() (line 532)

registered resources

access: public

string $right_delimiter = "}" (line 335)

template right-delimiter

variables

access: public

string $security_class = 'Smarty_Security' (line 347)

class name

security This should be instance of Smarty_Security.

see: Smarty_Security
access: public

Smarty_Security $security_policy = null (line 353)

implementation of security class

security

access: public

Smarty $smarty (line 592)

self pointer to Smarty object

access: public

type $smarty_debug_id = 'SMARTY_DEBUG' (line 402)

Name of debugging URL-param.

Only used when $debugging_ctrl is set to 'URL'. The name of the URL-parameter that activates debugging.

access: public

int $start_time = 0 (line 572)

start time for execution time calculation

access: public

array $template_functions = array() (line 467)

global template functions

access: public

array $template_objects = array() (line 497)

cached template objects

access: public

boolean $use_include_path = false (line 221)

look up relative filepaths in include_path

variables

access: public

boolean $use_sub_dirs = false (line 286)

use sub dirs for compiled/cached files?

variables

access: public

array $_cacheresource_handlers = array() (line 547)

cache resource handler cache

access: public

string $_current_file = null (line 597)

required by the compiler for BC

access: public

int $_dir_perms = 0771 (line 582)

default dir permissions

access: public

int $_file_perms = 0644 (line 577)

default file permissions

access: public

bool $_parserdebug = false (line 602)

internal flag to enable parser debugging

access: public

array $_resource_handlers = array() (line 537)

resource handler cache

access: public

array $_tag_stack = array() (line 587)

block tag hierarchy

access: public

Inherited Variables

Inherited from Smarty_Internal_Data

Smarty_Internal_Data::$config_vars
Smarty_Internal_Data::$parent
Smarty_Internal_Data::$template_class
Smarty_Internal_Data::$tpl_vars

Methods

Strict standards: Only variables should be passed by reference in C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php on line 712 Call Stack: 0.0006 229032 1. {main}() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:0 0.0027 240216 2. include('C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:59 0.1463 8650352 3. phpDocumentor_setup->createDocs() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc:65 13.2331 130016152 4. phpDocumentor_IntermediateParser->Output() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Setup.inc.php:761 13.9644 131381624 5. phpDocumentor_IntermediateParser->Convert() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1865 13.9644 131381720 6. Converter->walk() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1652 18.1075 135945552 7. HTMLframesConverter->endClass() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converter.inc:1904 18.1079 135946736 8. Smarty->fetch() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converters\HTML\frames\HTMLframesConverter.inc:347 18.1463 136435376 9. include('C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1298 18.2223 136688880 10. Smarty->_smarty_include() C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php:686 18.2224 136693192 11. Smarty->_compile_resource() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1935 18.2228 136706984 12. Smarty->_compile_source() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1458 18.2230 136744608 13. Smarty_Compiler->_compile_file() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1523 18.2245 136837096 14. Smarty_Compiler->_compile_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:316 18.2253 136838016 15. Smarty_Compiler->_compile_custom_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:537 Strict standards: Only variables should be passed by reference in C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php on line 712 Call Stack: 0.0006 229032 1. {main}() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:0 0.0027 240216 2. include('C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpdoc:59 0.1463 8650352 3. phpDocumentor_setup->createDocs() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\phpdoc.inc:65 13.2331 130016152 4. phpDocumentor_IntermediateParser->Output() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Setup.inc.php:761 13.9644 131381624 5. phpDocumentor_IntermediateParser->Convert() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1865 13.9644 131381720 6. Converter->walk() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\IntermediateParser.inc:1652 18.1075 135945552 7. HTMLframesConverter->endClass() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converter.inc:1904 18.1079 135946736 8. Smarty->fetch() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Converters\HTML\frames\HTMLframesConverter.inc:347 18.1463 136435376 9. include('C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php') C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1298 18.2223 136688880 10. Smarty->_smarty_include() C:\wamp\www\smarty3.1.0\development\Smarty3Doc\Smarty\PluginsShared\26d3399f63abd43a7d72f8c21440dcb0\%%165^%%1653142046^class.tpl.php:686 18.2224 136693192 11. Smarty->_compile_resource() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1935 18.2228 136706984 12. Smarty->_compile_source() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1458 18.2230 136744608 13. Smarty_Compiler->_compile_file() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty.class.php:1523 18.2333 136862200 14. Smarty_Compiler->_compile_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:316 18.2341 136863120 15. Smarty_Compiler->_compile_custom_tag() C:\wamp\www\phpdocumentator\PhpDocumentor-1.4.3\phpDocumentor\Smarty-2.6.0\libs\Smarty_Compiler.class.php:537

static method muteExpectedErrors (line 1445)

Enable error handler to mute expected messages

access: public

static void muteExpectedErrors ()

static method mutingErrorHandler (line 1393)

Error Handler to mute expected messages

link: http://php.net/set_error_handler
access: public

static boolean mutingErrorHandler (integer $errno, $errstr, $errfile, $errline, $errcontext)

integer $errno: Error level
$errstr
$errfile
$errline
$errcontext

static method unmuteExpectedErrors (line 1477)

Disable error handler muting expected messages

access: public

static void unmuteExpectedErrors ()

addAutoloadFilters (line 1124)

Add autoload filters

return: current Smarty instance for chaining
access: public

Smarty addAutoloadFilters (array $filters, [string $type = null])

array $filters: filters to load automatically
string $type: "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types

addConfigDir (line 910)

Add config directory(s)

return: current Smarty instance for chaining
access: public

Smarty addConfigDir (string|array $config_dir, [string $key = null])

string|array $config_dir: directory(s) of config sources
string $key: key of the array element to assign the config dir to

addDefaultModifiers (line 1077)

Add default modifiers

return: current Smarty instance for chaining
access: public

Smarty addDefaultModifiers (array|string $modifiers)

array|string $modifiers: modifier or list of modifiers to add

addPluginsDir (line 975)

Adds directory of plugin files

return: current Smarty instance for chaining
access: public

Smarty addPluginsDir ( $plugins_dir, object $smarty, string $)

object $smarty
string $: |array $ plugins folder
$plugins_dir

addTemplateDir (line 845)

Add template directory(s)

return: current Smarty instance for chaining
throws: SmartyException when the given template directory is not valid
access: public

Smarty addTemplateDir (string|array $template_dir, [string $key = null])

string|array $template_dir: directory(s) of template sources
string $key: of the array element to assign the template dir to

Constructor __construct (line 615)

Initialize new Smarty object

access: public

Smarty __construct ()

Redefined in descendants as:

SmartyBC::__construct() : Initialize new SmartyBC object

Destructor __destruct (line 640)

Class destructor

access: public

void __destruct ()

clearAllCache (line 754)

Empty cache folder

return: number of cache files deleted

integer clearAllCache ([integer $exp_time = null], [string $type = null])

integer $exp_time: expiration time
string $type: resource type

clearCache (line 772)

Empty cache for a specific template

return: number of cache files deleted
access: public

integer clearCache (string $template_name, [string $cache_id = null], [string $compile_id = null], [integer $exp_time = null], [string $type = null])

string $template_name: template name
string $cache_id: cache id
string $compile_id: compile id
integer $exp_time: expiration time
string $type: resource type

clearCompiledTemplate (line 1358)

Delete compiled template file

return: number of template files deleted
access: public

integer clearCompiledTemplate ([string $resource_name = null], [string $compile_id = null], [integer $exp_time = null])

string $resource_name: template name
string $compile_id: compile id
integer $exp_time: expiration time

compileAllConfig (line 1345)

Compile all config files

return: number of template files recompiled
access: public

integer compileAllConfig ([string $extension = '.conf'], [bool $force_compile = false], [int $time_limit = 0], [int $max_errors = null])

string $extension: file extension
bool $force_compile: force all to recompile
int $time_limit
int $max_errors

compileAllTemplates (line 1331)

Compile all template files

return: number of template files recompiled
access: public

integer compileAllTemplates ([string $extension = '.tpl'], [bool $force_compile = false], [int $time_limit = 0], [int $max_errors = null])

string $extension: file extension
bool $force_compile: force all to recompile
int $time_limit
int $max_errors

createTemplate (line 1197)

creates a template object

return: object
access: public

object template createTemplate (string $template, [mixed $cache_id = null], [mixed $compile_id = null], [object $parent = null], [boolean $do_clone = true])

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

disableSecurity (line 813)

Disable security

return: current Smarty instance for chaining
access: public

Smarty disableSecurity ()

enableSecurity (line 787)

Loads security class and enables security

return: current Smarty instance for chaining
throws: SmartyException when an invalid class name is provided
access: public

Smarty enableSecurity ([string|Smarty_Security $security_class = null])

string|Smarty_Security $security_class: if a string is used, it must be class-name

getAutoloadFilters (line 1151)

Get autoload filters

return: array( 'type1' => array( 'filter1', 'filter2', … ) ) or array( 'filter1', 'filter2', …) if $type was specified
access: public

array getAutoloadFilters ([string $type = null])

string $type: type of filter to get autoloads for. Defaults to all autoload filters

getCacheDir (line 1054)

Get cache directory

return: path of cache directory
access: public

string getCacheDir ()

getCompileDir (line 1029)

Get compiled directory

return: path to compiled templates
access: public

string getCompileDir ()

getConfigDir (line 943)

Get config directory

return: configuration directory
access: public

array|string getConfigDir ([mixed $index = null])

mixed $index: index of directory to get, null to get all

getDebugTemplate (line 1165)

return name of debugging template

access: public

string getDebugTemplate ()

getDefaultModifiers (line 1093)

Get default modifiers

return: list of default modifiers
access: public

array getDefaultModifiers ()

getGlobal (line 730)

Returns a single or all global variables

return: variable value or or array of variables
access: public

string getGlobal ([string $varname = null], object $smarty)

object $smarty
string $varname: variable name or null

getPluginsDir (line 1004)

Get plugin directories

return: list of plugin directories
access: public

array getPluginsDir ()

getTags (line 1370)

Return array of tag/attributes of all tags used by an template

return: of tag/attributes
access: public

array getTags (Smarty_Internal_Template $template, object $templae)

object $templae: template object
Smarty_Internal_Template $template

getTemplateDir (line 877)

Get template directories

return: list of template directories, or directory of $index
access: public

array|string getTemplateDir ([mixed $index = null])

mixed $index: index of directory to get, null to get all

loadPlugin (line 1263)

Takes unknown classes and loads plugin files for them class name format: Smarty_PluginType_PluginName plugin filename format: plugintype.pluginname.php

return: |boolean filepath of loaded file or false
access: public

string loadPlugin (string $plugin_name, [bool $check = true])

string $plugin_name: class plugin name to load
bool $check: check if already loaded

setAutoloadFilters (line 1106)

Set autoload filters

return: current Smarty instance for chaining
access: public

Smarty setAutoloadFilters (array $filters, [string $type = null])

array $filters: filters to load automatically
string $type: "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types

setCacheDir (line 1040)

Set cache directory

return: current Smarty instance for chaining
access: public

Smarty setCacheDir (string $cache_dir)

string $cache_dir: directory to store cached templates in

setCompileDir (line 1015)

Set compile directory

return: current Smarty instance for chaining
access: public

Smarty setCompileDir (string $compile_dir)

string $compile_dir: directory to store compiled templates in

setConfigDir (line 892)

Set config directory

return: current Smarty instance for chaining
access: public

Smarty setConfigDir ( $config_dir, string|array $template_dir)

string|array $template_dir: directory(s) of configuration sources
$config_dir

setDebugTemplate (line 1177)

set the debug template

return: current Smarty instance for chaining
throws: SmartyException if file is not readable
access: public

Smarty setDebugTemplate (string $tpl_name)

string $tpl_name

setDefaultModifiers (line 1065)

Set default modifiers

return: current Smarty instance for chaining
access: public

Smarty setDefaultModifiers (array|string $modifiers)

array|string $modifiers: modifier or list of modifiers to set

setPluginsDir (line 958)

Set plugins directory

return: current Smarty instance for chaining
access: public

Smarty setPluginsDir (string|array $plugins_dir)

string|array $plugins_dir: directory(s) of plugins

setTemplateDir (line 826)

Set template directory

return: current Smarty instance for chaining
access: public

Smarty setTemplateDir (string|array $template_dir)

string|array $template_dir: directory(s) of template sources

templateExists (line 712)

Check if a template resource exists

return: status
access: public

boolean templateExists (string $resource_name)

string $resource_name: template name

testInstall (line 1381)

Run installation test

return: true if setup is fine, false if something is wrong
access: public

boolean testInstall ([ &$errors = null], array $errors)

array $errors: Array to write errors into, rather than outputting them
&$errors

__clone (line 648)

<<magic>> set selfpointer on cloned object

access: public

void __clone ()

__get (line 663)

<<magic>> Generic getter.

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

access: public

mixed __get (string $name)

string $name: property name

__set (line 689)

<<magic>> Generic setter.

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

access: public

void __set (string $name, mixed $value)

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

Inherited Methods

Inherited From Smarty_Internal_TemplateBase

Smarty_Internal_TemplateBase::createData()
Smarty_Internal_TemplateBase::display()
Smarty_Internal_TemplateBase::fetch()
Smarty_Internal_TemplateBase::getRegisteredObject()
Smarty_Internal_TemplateBase::isCached()
Smarty_Internal_TemplateBase::loadFilter()
Smarty_Internal_TemplateBase::registerCacheResource()
Smarty_Internal_TemplateBase::registerClass()
Smarty_Internal_TemplateBase::registerDefaultConfigHandler()
Smarty_Internal_TemplateBase::registerDefaultPluginHandler()
Smarty_Internal_TemplateBase::registerDefaultTemplateHandler()
Smarty_Internal_TemplateBase::registerFilter()
Smarty_Internal_TemplateBase::registerObject()
Smarty_Internal_TemplateBase::registerPlugin()
Smarty_Internal_TemplateBase::registerResource()
Smarty_Internal_TemplateBase::unloadFilter()
Smarty_Internal_TemplateBase::unregisterCacheResource()
Smarty_Internal_TemplateBase::unregisterFilter()
Smarty_Internal_TemplateBase::unregisterObject()
Smarty_Internal_TemplateBase::unregisterPlugin()
Smarty_Internal_TemplateBase::unregisterResource()
Smarty_Internal_TemplateBase::_get_filter_name()
Smarty_Internal_TemplateBase::__call()

Inherited From Smarty_Internal_Data

Smarty_Internal_Data::append()
Smarty_Internal_Data::appendByRef()
Smarty_Internal_Data::assign()
Smarty_Internal_Data::assignByRef()
Smarty_Internal_Data::assignGlobal()
Smarty_Internal_Data::clearAllAssign()
Smarty_Internal_Data::clearAssign()
Smarty_Internal_Data::clearConfig()
Smarty_Internal_Data::configLoad()
Smarty_Internal_Data::getConfigVariable()
Smarty_Internal_Data::getConfigVars()
Smarty_Internal_Data::getStreamVariable()
Smarty_Internal_Data::getTemplateVars()
Smarty_Internal_Data::getVariable()

Class Constants

CACHING_LIFETIME_CURRENT = 1 (line 129)

constant definitions

CACHING_LIFETIME_SAVED = 2 (line 130)

constant definitions

CACHING_OFF = 0 (line 128)

define caching modes

constant definitions

CLEAR_EXPIRED = -1 (line 134)

define constant for clearing cache files be saved expiration datees

constant definitions

COMPILECHECK_CACHEMISS = 2 (line 141)

constant definitions

COMPILECHECK_OFF = 0 (line 139)

define compile check modes

constant definitions

COMPILECHECK_ON = 1 (line 140)

constant definitions

FILTER_OUTPUT = 'output' (line 154)

constant definitions

FILTER_POST = 'post' (line 152)

filter types

constant definitions

FILTER_PRE = 'pre' (line 153)

constant definitions

FILTER_VARIABLE = 'variable' (line 155)

constant definitions

PHP_ALLOW = 3 (line 148)

constant definitions

PHP_PASSTHRU = 0 (line 145)

modes for handling of "<?php ... ?>" tags in templates.

constant definitions

PHP_QUOTE = 1 (line 146)

constant definitions

PHP_REMOVE = 2 (line 147)

constant definitions

PLUGIN_BLOCK = 'block' (line 160)

constant definitions

PLUGIN_COMPILER = 'compiler' (line 161)

constant definitions

PLUGIN_FUNCTION = 'function' (line 159)

plugin types

constant definitions

PLUGIN_MODIFIER = 'modifier' (line 162)

constant definitions

PLUGIN_MODIFIERCOMPILER = 'modifiercompiler' (line 163)

constant definitions

SCOPE_GLOBAL = 3 (line 124)

constant definitions

SCOPE_LOCAL = 0 (line 121)

define variable scopes

constant definitions

SCOPE_PARENT = 1 (line 122)

constant definitions

SCOPE_ROOT = 2 (line 123)

constant definitions

SMARTY_VERSION = 'Smarty-3.1-DEV' (line 116)

smarty version

constant definitions

Documentation generated on Mon, 17 Jun 2013 21:06:43 +0000 by phpDocumentor 1.4.3