Smarty Class Methods {#api.functions}

Table of contents

• addConfigDir() ? add a directory to the list of directories where config files are stored
• addPluginsDir() ? add a directory to the list of directories where plugins are stored
• addTemplateDir() ? add a directory to the list of directories where templates are stored
• append() ? append an element to an assigned array
• appendByRef() ? append values by reference
• assign() ? assign variables/objects to the templates
• assignByRef() ? assign values by reference
• clearAllAssign() ? clears the values of all assigned variables
• clearAllCache() ? clears the entire template cache
• clearAssign() ? clears the value of an assigned variable
• clearCache() ? clears the cache for a specific template
• clearCompiledTemplate() ? clears the compiled version of the specified template resource
• clearConfig() ? clears assigned config variables
• compileAllConfig() ? compiles all known config files
• compileAllTemplates() ? compiles all known templates
• configLoad() ? loads config file data and assigns it to the template
• createData() ? creates a data object
• createTemplate() ? returns a template object
• disableSecurity() ? disables template security
• display() ? displays the template
• enableSecurity() ? enables template security
• fetch() ? returns the template output
• getCacheDir() ? return the directory where the rendered template's output is stored
• getCompileDir() ? returns the directory where compiled templates are stored
• getConfigDir() ? return the directory where config files are stored
• getConfigVars() ? returns the given loaded config variable value
• getPluginsDir() ? return the directory where plugins are stored
• getRegisteredObject() ? returns a reference to a registered object
• getTags() ? return tags used by template
• getTemplateDir() ? return the directory where templates are stored
• getTemplateVars() ? returns assigned variable value(s)
• isCached() ? returns true if there is a valid cache for this template
• loadFilter() ? load a filter plugin
• muteExpectedErrors() ? mutes expected warnings and notices deliberately generated by Smarty
• registerCacheResource() ? dynamically register CacheResources
• registerClass() ? register a class for use in the templates
• registerDefaultPluginHandler() ? register a function which gets called on undefined tags
• registerFilter() ? dynamically register filters
• registerPlugin() ? dynamically register plugins
• registerObject() ? register an object for use in the templates
• registerResource() ? dynamically register resources
• setCacheDir() ? set the directory where the rendered template's output is stored
• setCompileDir() ? set the directory where compiled templates are stored
• setConfigDir() ? set the directories where config files are stored
• setPluginsDir() ? set the directories where plugins are stored
• setTemplateDir() ? set the directories where templates are stored
• templateExists() ? checks whether the specified template exists
• unregisterCacheResource() ? dynamically unregister a CacheResource plugin
• unregisterFilter() ? dynamically unregister a filter
• unregisterPlugin() ? dynamically unregister plugins
• unregisterObject() ? dynamically unregister an object
• unregisterResource() ? dynamically unregister a resource plugin
• testInstall() ? checks Smarty installation

> Note > > See > Changing settings by template > section for how to use the functions for individual templates.