[Sugar] element index

__construct

Sugar::__construct() in Sugar.php

Constructor

__construct

Sugar_Storage_String::__construct() in String.php

Constructor.

__construct

Sugar_Cache_Memcache::__construct() in Memcache.php

Constructor.

__construct

Sugar_Storage_File::__construct() in File.php

Constructor.

__construct

Sugar_Cache_File::__construct() in File.php

Constructor.

__construct

Sugar_Exception_Usage::__construct() in Exception.php

Constructor.

__construct

Sugar_Exception_Runtime::__construct() in Exception.php

Constructor.

__construct

Sugar_Exception_Parse::__construct() in Exception.php

Constructor.

__construct

Sugar_Exception::__construct() in Exception.php

Constructor.

__construct

Sugar_Template::__construct() in Template.php

Constructor.

addFunction

Sugar::addFunction() in Sugar.php

Registers a new function to be available within templates.

addModifier

Sugar::addModifier() in Sugar.php

Registers a new modifier to be available within templates.

addStorage

Sugar::addStorage() in Sugar.php

Register a new storage driver.

$cache

Sugar::$cache in Sugar.php

This is the cache driver to use for storing bytecode and HTML caches.

$cacheDir

Sugar::$cacheDir in Sugar.php

Directory in which bytecode and HTML caches can be stored when using the file cache driver.

$cacheHandler

Sugar::$cacheHandler in Sugar.php

Cache management. Used internally.

$cacheLimit

Sugar::$cacheLimit in Sugar.php

Maximum age of HTML caches in seconds.

$charset

Sugar::$charset in Sugar.php

Character set that output should be in.

CACHE_HTML

Sugar::CACHE_HTML in Sugar.php

Passed to cache drivers to indicate that an HTML cache is requested.

CACHE_LIMIT

Sugar::CACHE_LIMIT in Sugar.php

Cache expiration time in seconds.

CACHE_TPL

Sugar::CACHE_TPL in Sugar.php

Passed to cache drivers to indicate that a compile cache is requested.

CHARSET

Sugar::CHARSET in Sugar.php

Option code for setting or retrieving the charset used during encoding.

clearCache

Sugar::clearCache() in Sugar.php

Clear all HTML cache files.

clear

Sugar_Cache_Memcache::clear() in Memcache.php

Clears all caches the driver is responsible for.

clear

Sugar_Cache_File::clear() in File.php

Clears all caches the driver is responsible for.

clear

Sugar_CacheDriver::clear() in CacheDriver.php

Clears all caches the driver is responsible for.

CacheDriver.php

CacheDriver.php in CacheDriver.php

$cacheId

Sugar_Template::$cacheId in Template.php

Cache identifier.

$debug

Sugar::$debug in Sugar.php

Setting this to true will disable all caching, forcing every template to be recompiled and executed on every load.

$defaultStorage

Sugar::$defaultStorage in Sugar.php

This is the default storage driver to use when no storage driver is specified as part of a template name.

$delimEnd

Sugar::$delimEnd in Sugar.php

Closing delimiter character.

$delimStart

Sugar::$delimStart in Sugar.php

Opening delimiter character.

DEBUG

Sugar::DEBUG in Sugar.php

Option code to for toggling debug mode.

display

Sugar::display() in Sugar.php

Load, compile, and display the requested template.

displayCache

Sugar::displayCache() in Sugar.php

Load, compile, and display a template, caching the result.

displayString

Sugar::displayString() in Sugar.php

Compile and display the template source code given as a string.

display

Sugar_Template::display() in Template.php

Display the template

$errors

Sugar::$errors in Sugar.php

This is the error handling method Sugar should use. By default,

ERRORS

Sugar::ERRORS in Sugar.php

Option code to set or get the error handling mode used during script execution.

ERROR_DIE

Sugar::ERROR_DIE in Sugar.php

The error will be printed to the user, and then die() will be called to terminate the script.

ERROR_IGNORE

Sugar::ERROR_IGNORE in Sugar.php

The error will be silently ignored.

ERROR_PRINT

Sugar::ERROR_PRINT in Sugar.php

Causes all errors generated by Sugar templates to be printed to the user.

ERROR_THROW

Sugar::ERROR_THROW in Sugar.php

Errors will be thrown as Sugar_Exception objects.

escape

Sugar::escape() in Sugar.php

Escape the input string according to the current value of Sugar::$charset.

erase

Sugar_Cache_Memcache::erase() in Memcache.php

Erases the bytecode for the requested reference.

erase

Sugar_Cache_File::erase() in File.php

Erases the bytecode for the requested reference.

erase

Sugar_CacheDriver::erase() in CacheDriver.php

Erases the bytecode for the requested reference.

Exception.php

Exception.php in Exception.php

fetch

Sugar::fetch() in Sugar.php

Displays a template using Sugar::display, but returns the result as a string instead of displaying it to the user.

fetchCache

Sugar::fetchCache() in Sugar.php

Displays a cached template using Sugar::displayCache, but returns the result as a string instead of displaying it to the user.

fetchString

Sugar::fetchString() in Sugar.php

Processes template source using Sugar::displayString, but returns the result as a string instead of displaying it to the user.

File.php

File.php in File.php

File.php

File.php in File.php

$file

Sugar_Exception_Runtime::$file in Exception.php

File error occured in.

$file

Sugar_Exception_Parse::$file in Exception.php

File error occured in.

fetch

Sugar_Template::fetch() in Template.php

Fetch template output as a string

getContext

Sugar::getContext() in Sugar.php

Get the global variable context.

getFunction

Sugar::getFunction() in Sugar.php

Returns an array containing the data for template function. This will first look for registered functions, then it will attempt to auto-register a function using the smarty_function_foo naming scheme. Finally, it will attempt to load a function plugin.

getModifier

Sugar::getModifier() in Sugar.php

Returns the callback for a template modifier, if it exists. This will first look for registered modifiers, then it will attempt to auto-register a modifier using the smarty_modifier_foo naming scheme. Finally, it will attempt to load a modifier plugin.

getOption

Sugar::getOption() in Sugar.php

Get the value of an option

getRuntime

Sugar::getRuntime() in Sugar.php

Get a runtime instance.

getStorage

Sugar::getStorage() in Sugar.php

Get a storage driver.

getTemplate

Sugar::getTemplate() in Sugar.php

Load a template object

getVariable

Sugar::getVariable() in Sugar.php

Looks up the current value of a variable.

getHandle

Sugar_Storage_String::getHandle() in String.php

Returns the source code (the name) as the handle.

getHandle

Sugar_Storage_File::getHandle() in File.php

Searches for the template in the template directories

getHandle

Sugar_StorageDriver::getHandle() in StorageDriver.php

Search for the template and return a driver-specific handle.

getLastModified

Sugar_Storage_File::getLastModified() in File.php

Returns the modified timestamp of the template.

getLastModified

Sugar_Cache_File::getLastModified() in File.php

Returns the timestamp.

getLastModified

Sugar_Storage_String::getLastModified() in String.php

Returns the current time.

getLastModified

Sugar_CacheDriver::getLastModified() in CacheDriver.php

Returns the timestamp for the given reference, or zero if the file is not in the cache.

getLastModified

Sugar_StorageDriver::getLastModified() in StorageDriver.php

Returns the timestamp of the handle.

getLastModified

Sugar_Cache_Memcache::getLastModified() in Memcache.php

Returns the timestamp.

getName

Sugar_Storage_String::getName() in String.php

Returns the text 'source template'.

getName

Sugar_StorageDriver::getName() in StorageDriver.php

Returns a user-friendly name for the handle.

getName

Sugar_Storage_File::getName() in File.php

Returns the path to the template for error messages

getSource

Sugar_Storage_String::getSource() in String.php

Returns the source of the template.

getSource

Sugar_Storage_File::getSource() in File.php

Returns the source of the template.

getSource

Sugar_StorageDriver::getSource() in StorageDriver.php

Returns the source for the handle.

getContext

Sugar_Template::getContext() in Template.php

Get the template's local variable context

getLastModified

Sugar_Template::getLastModified() in Template.php

Get the last-modified timestamp of the template.

getName

Sugar_Template::getName() in Template.php

Get a user-friendly name for the template

getSource

Sugar_Template::getSource() in Template.php

Get the source code of the template.

handleError

Sugar::handleError() in Sugar.php

Process an exception according to the current value of Sugar::$errors.

isCached

Sugar::isCached() in Sugar.php

Check if a given template has a valid HTML cache. If an HTML cache already exists, applications can avoid expensive database queries and other operations necessary to fill in template data.

isCached

Sugar_Template::isCached() in Template.php

Check if the template has a valid and completely up-to-date ache.

load

Sugar_Cache_Memcache::load() in Memcache.php

Returns the bytecode for the requested reference.

load

Sugar_Cache_File::load() in File.php

Returns the bytecode for the requested reference.

load

Sugar_CacheDriver::load() in CacheDriver.php

Returns the bytecode for the requested reference.

$line

Sugar_Exception_Runtime::$line in Exception.php

Line error occured in.

$line

Sugar_Exception_Parse::$line in Exception.php

Line error occured in.

$methodAcl

Sugar::$methodAcl in Sugar.php

Callback for checking method access.

Memcache.php

Memcache.php in Memcache.php

$name

Sugar_Template::$name in Template.php

Name of the template as given by the user.

$output

Sugar::$output in Sugar.php

This is the output escaping method to be used. This is necessary for many formats, such as XML and HTML, to ensure that special are escaped properly.

OUTPUT

Sugar::OUTPUT in Sugar.php

Option code for setting or retrieving the output mode used during escaping.

OUTPUT_HTML

Sugar::OUTPUT_HTML in Sugar.php

All output will be escaped using htmlentities() with the ENT_QUOTES flag set, using the Sugar::$charset setting. This is the default behavior.

OUTPUT_TEXT

Sugar::OUTPUT_TEXT in Sugar.php

Disables all output escaping.

OUTPUT_XHTML

Sugar::OUTPUT_XHTML in Sugar.php

Identical to Sugar::OUTPUT_HTML.

OUTPUT_XML

Sugar::OUTPUT_XML in Sugar.php

All output will be escaped using htmlspecialchars() with the ENT_QUOTES flag set, using the Sugar::$charset setting. This differs from Sugar::OUTPUT_HTML as only <, >, ", ', and & will escaped.

$pluginDir

Sugar::$pluginDir in Sugar.php

Directory to search for plugins. This can either be a single string or an array.

set

Sugar::set() in Sugar.php

Set a new variable to be available within templates.

setDelimiter

Sugar::setDelimiter() in Sugar.php

Change the current delimiters.

setOption

Sugar::setOption() in Sugar.php

Set the value of an option

Sugar

Sugar in Sugar.php

Sugar core class.

Sugar.php

Sugar.php in Sugar.php

Sugar_Util_EscapeJavascript

Sugar_Util_EscapeJavascript() in Util.php

Performs string-escaping for JavaScript values.

Sugar_Util_GetArg

Sugar_Util_GetArg() in Util.php

Returns an argument from a function parameter list, supporting both position and named parameters and default values.

Sugar_Util_IsVector

Sugar_Util_IsVector() in Util.php

Checks if an array is a "vector," or an array with only integral indexes starting at zero and incrementally increasing. Used only for nice exporting to JavaScript.

Sugar_Util_Json

Sugar_Util_Json() in Util.php

Formats a PHP value in JavaScript format.

Sugar_Util_SearchForFile

Sugar_Util_SearchForFile() in Util.php

Attempt to locate a file in one or more source directories.

Sugar_Util_ValueToTime

Sugar_Util_ValueToTime() in Util.php

Convert a value into a timestamp. This is essentially strtotime(), except that if an integer timestamp is passed in it is returned verbatim, and if the value cannot be parsed, it returns the current timestamp.

store

Sugar_Cache_Memcache::store() in Memcache.php

Adds the bytecode to the cache.

store

Sugar_Cache_File::store() in File.php

Adds the bytecode to the cache.

store

Sugar_CacheDriver::store() in CacheDriver.php

Adds the bytecode to the cache.

String.php

String.php in String.php

StorageDriver.php

StorageDriver.php in StorageDriver.php

Sugar_CacheDriver

Sugar_CacheDriver in CacheDriver.php

Interface for Sugar cache drivers. These are used for storing and retrieving bytecode and HTML caches.

Sugar_Cache_File

Sugar_Cache_File in File.php

File-based cache driver.

Sugar_Cache_Memcache

Sugar_Cache_Memcache in Memcache.php

Memcache-based cache driver.

Sugar_StorageDriver

Sugar_StorageDriver in StorageDriver.php

Storage driver interface.

Sugar_Storage_File

Sugar_Storage_File in File.php

File-based storage driver.

Sugar_Storage_String

Sugar_Storage_String in String.php

String-based storage driver.

Sugar_Exception

Sugar_Exception in Exception.php

Generic Sugar exception.

Sugar_Exception_Parse

Sugar_Exception_Parse in Exception.php

Parse error.

Sugar_Exception_Runtime

Sugar_Exception_Runtime in Exception.php

Runtime error.

Sugar_Exception_Usage

Sugar_Exception_Usage in Exception.php

Invocation error.

Stdlib.php

Stdlib.php in Stdlib.php

sugar_function_array

sugar_function_array() in Stdlib.php

Standard library function

sugar_function_basename

sugar_function_basename() in Stdlib.php

Standard library function

sugar_function_checked

sugar_function_checked() in Stdlib.php

Standard library function

sugar_function_count

sugar_function_count() in Stdlib.php

Standard library function

sugar_function_cycle

sugar_function_cycle() in Stdlib.php

Standard library function

sugar_function_date

sugar_function_date() in Stdlib.php

Standard library function

sugar_function_default

sugar_function_default() in Stdlib.php

Standard library function

sugar_function_disabled

sugar_function_disabled() in Stdlib.php

Standard library function

sugar_function_eval

sugar_function_eval() in Stdlib.php

Standard library function

sugar_function_explode

sugar_function_explode() in Stdlib.php

Standard library function

sugar_function_implode

sugar_function_implode() in Stdlib.php

Standard library function

sugar_function_include

sugar_function_include() in Stdlib.php

Standard library function

sugar_function_isset

sugar_function_isset() in Stdlib.php

Standard library function

sugar_function_join

sugar_function_join() in Stdlib.php

Standard library function

sugar_function_json

sugar_function_json() in Stdlib.php

Standard library function

sugar_function_ldelim

sugar_function_ldelim() in Stdlib.php

Standard library function

sugar_function_merge

sugar_function_merge() in Stdlib.php

Standard library function

sugar_function_nl2br

sugar_function_nl2br() in Stdlib.php

Standard library function

sugar_function_printf

sugar_function_printf() in Stdlib.php

Standard library function

sugar_function_psplit

sugar_function_psplit() in Stdlib.php

Standard library function

sugar_function_rdelim

sugar_function_rdelim() in Stdlib.php

Standard library function

sugar_function_select

sugar_function_select() in Stdlib.php

Standard library function

sugar_function_selected

sugar_function_selected() in Stdlib.php

Standard library function

sugar_function_split

sugar_function_split() in Stdlib.php

Standard library function

sugar_function_sprintf

sugar_function_sprintf() in Stdlib.php

Standard library function

sugar_function_strtolower

sugar_function_strtolower() in Stdlib.php

Standard library function

sugar_function_strtoupper

sugar_function_strtoupper() in Stdlib.php

Standard library function

sugar_function_substr

sugar_function_substr() in Stdlib.php

Standard library function

sugar_function_time

sugar_function_time() in Stdlib.php

Standard library function

sugar_function_truncate

sugar_function_truncate() in Stdlib.php

Standard library function

sugar_function_urlencode

sugar_function_urlencode() in Stdlib.php

Standard library function

sugar_function_var

sugar_function_var() in Stdlib.php

Standard library function

sugar_modifier_default

sugar_modifier_default() in Stdlib.php

Standard library function

sugar_modifier_escape

sugar_modifier_escape() in Stdlib.php

Standard library function

sugar_modifier_int

sugar_modifier_int() in Stdlib.php

Standard library function

sugar_modifier_json

sugar_modifier_json() in Stdlib.php

Standard library function

sugar_modifier_lower

sugar_modifier_lower() in Stdlib.php

Standard library function

sugar_modifier_upper

sugar_modifier_upper() in Stdlib.php

Standard library function

$sugar

Sugar_Template::$sugar in Template.php

Our Sugar instance

set

Sugar_Template::set() in Template.php

Helper to set a variable in the template's local context

setInherit

Sugar_Template::setInherit() in Template.php

Set the inherited template, which overrides any inherited template specified in the template source.

Sugar_Template

Sugar_Template in Template.php

Template instance object.

$templateDir

Sugar::$templateDir in Sugar.php

Directory in which templates can be found when using the file storage driver. This can either be a single string or an array.

Template.php

Template.php in Template.php

Util.php

Util.php in Util.php

uncache

Sugar::uncache() in Sugar.php

Erases the HTML cache for a template if it exists.

VERSION

Sugar::VERSION in Sugar.php

Version of Sugar.