Smarty

_ A C D F G I L P R S T U

_

_smarty_regex_replace_check() - Function in package Smarty

A

append() - Method in class Smarty\Smarty
appends values to template variables
append_by_ref() - Method in class Smarty\Smarty
appends values to template variables by reference
assign() - Method in class Smarty\Smarty
assigns values to template variables
assign_by_ref() - Method in class Smarty\Smarty
assigns values to template variables by reference

C

clear() - Method in class Smarty\Config_File
Clear loaded config data for a certain file or all files.
clear_all_assign() - Method in class Smarty\Smarty
clear all the assigned template variables.
clear_all_cache() - Method in class Smarty\Smarty
clear the entire contents of cache (all templates)
clear_assign() - Method in class Smarty\Smarty
clear the given assigned template variable.
clear_cache() - Method in class Smarty\Smarty
clear cached content for the given template and cache id
clear_compiled_tpl() - Method in class Smarty\Smarty
clears compiled version of specified template resource, or all compiled template files if one is not specified.
clear_config() - Method in class Smarty\Smarty
clear configuration values
Config_File() - Class in package Smarty
Config file reading class
config_load() - Method in class Smarty\Smarty
load configuration values

D

DIR_SEP() - Global in package Smarty
DIR_SEP isn't used anymore, but third party apps might
display() - Method in class Smarty\Smarty
executes & displays the template results

F

fetch() - Method in class Smarty\Smarty
executes & returns or displays the template results

G

get() - Method in class Smarty\Config_File
Retrieves config info based on the file, section, and variable name.
get_config_vars() - Method in class Smarty\Smarty
Returns an array containing config variables
get_file_names() - Method in class Smarty\Config_File
Get all loaded config file names.
get_key() - Method in class Smarty\Config_File
Retrieves config info based on the key.
get_registered_object() - Method in class Smarty\Smarty
return a reference to a registered object
get_section_names() - Method in class Smarty\Config_File
Get all section names from a loaded file.
get_template_vars() - Method in class Smarty\Smarty
Returns an array containing template variables
get_var_names() - Method in class Smarty\Config_File
Get all global or section variable names.

I

is_cached() - Method in class Smarty\Smarty
test to see if valid cache exists for this template

L

load_file() - Method in class Smarty\Config_File
Load a configuration file manually.
load_filter() - Method in class Smarty\Smarty
load a filter of specified type and name

P

parse_contents() - Method in class Smarty\Config_File
parse the source of a configuration file manually.

R

register_block() - Method in class Smarty\Smarty
Registers block function to be used in templates
register_compiler_function() - Method in class Smarty\Smarty
Registers compiler function
register_function() - Method in class Smarty\Smarty
Registers custom function to be used in templates
register_modifier() - Method in class Smarty\Smarty
Registers modifier to be used in templates
register_object() - Method in class Smarty\Smarty
Registers object to be used in templates
register_outputfilter() - Method in class Smarty\Smarty
Registers an output filter function to apply to a template output
register_postfilter() - Method in class Smarty\Smarty
Registers a postfilter function to apply to a compiled template after compilation
register_prefilter() - Method in class Smarty\Smarty
Registers a prefilter function to apply to a template before compiling
register_resource() - Method in class Smarty\Smarty
Registers a resource to fetch a template

S

set_file_contents() - Method in class Smarty\Config_File
Store the contents of a file manually.
set_path() - Method in class Smarty\Config_File
Set the path where configuration files can be found.
Smarty() - Class in package Smarty
smarty() - Global in package Smarty
Include the {@link shared.make_timestamp.php} plugin
smarty_block_textformat() - Function in package Smarty
Smarty {textformat}{/textformat} block plugin Type: block function
Name: textformat
Purpose: format text a certain way with preset styles or custom wrap/indent settings
Smarty_Compiler() - Class in package Smarty
Template compiling class
smarty_compiler_assign() - Function in package Smarty
Smarty {assign} compiler function plugin Type: compiler function
Name: assign
Purpose: assign a value to a template variable
smarty_core_assemble_plugin_filepath() - Function in package Smarty
assemble filepath of requested plugin
smarty_core_assign_smarty_interface() - Function in package Smarty
Smarty assign_smarty_interface core plugin Type: core
Name: assign_smarty_interface
Purpose: assign the $smarty interface variable
smarty_core_create_dir_structure() - Function in package Smarty
create full directory structure
SMARTY_CORE_DIR() - Global in package Smarty
smarty_core_display_debug_console() - Function in package Smarty
Smarty debug_console function plugin Type: core
Name: display_debug_console
Purpose: display the javascript debug console window
smarty_core_get_include_path() - Function in package Smarty
Get path to file from include_path
smarty_core_get_microtime() - Function in package Smarty
Get seconds and microseconds
smarty_core_get_php_resource() - Function in package Smarty
Retrieves PHP script resource sets $php_resource to the returned resource
smarty_core_is_secure() - Function in package Smarty
determines if a resource is secure or not.
smarty_core_is_trusted() - Function in package Smarty
determines if a resource is trusted or not
smarty_core_load_plugins() - Function in package Smarty
Load requested plugins
smarty_core_load_resource_plugin() - Function in package Smarty
load a resource plugin
smarty_core_process_cached_inserts() - Function in package Smarty
Replace cached inserts with the actual results
smarty_core_read_cache_file() - Function in package Smarty
read a cache file, determine if it needs to be regenerated or not
smarty_core_rm_auto() - Function in package Smarty
delete an automagically created file by name and id
smarty_core_rmdir() - Function in package Smarty
delete a dir recursively (level=0 -> keep root) WARNING: no tests, it will try to remove what you tell it!
smarty_core_run_insert_handler() - Function in package Smarty
Handle insert tags
smarty_core_smarty_include_php() - Function in package Smarty
called for included php files within templates
smarty_core_write_cache_file() - Function in package Smarty
Prepend the cache information to the cache file and write it
smarty_core_write_file() - Function in package Smarty
write out a file to disk
SMARTY_DIR() - Global in package Smarty
set SMARTY_DIR to absolute path to Smarty library files.
smarty_function_assign_debug_info() - Function in package Smarty
Smarty {assign_debug_info} function plugin Type: function
Name: assign_debug_info
Purpose: assign debug info to the template
smarty_function_config_load() - Function in package Smarty
Smarty {config_load} function plugin Type: function
Name: config_load
Purpose: load config file vars
smarty_function_counter() - Function in package Smarty
Smarty {counter} function plugin Type: function
Name: counter
Purpose: print out a counter value
smarty_function_cycle() - Function in package Smarty
Smarty {cycle} function plugin Type: function
Name: cycle
Date: May 3, 2002
Purpose: cycle through given values
Input: - name = name of cycle (optional) - values = comma separated list of values to cycle, or an array of values to cycle (this can be left out for subsequent calls) - reset = boolean - resets given var to true - print = boolean - print var or not.
smarty_function_debug() - Function in package Smarty
Smarty {debug} function plugin Type: function
Name: debug
Date: July 1, 2002
Purpose: popup debug window
smarty_function_escape_special_chars() - Function in package Smarty
escape_special_chars common function Function: smarty_function_escape_special_chars
Purpose: used by other smarty functions to escape special chars except for already escaped ones
smarty_function_eval() - Function in package Smarty
Smarty {eval} function plugin Type: function
Name: eval
Purpose: evaluate a template variable as a template
smarty_function_fetch() - Function in package Smarty
Smarty {fetch} plugin Type: function
Name: fetch
Purpose: fetch file, web or ftp data and display results
smarty_function_html_checkboxes() - Function in package Smarty
Smarty {html_checkboxes} function plugin File: function.html_checkboxes.php
Type: function
Name: html_checkboxes
Date: 24.Feb.2003
Purpose: Prints out a list of checkbox input types
Input:
- name (optional) - string default "checkbox" - values (required) - array - options (optional) - associative array - checked (optional) - array default not set - separator (optional) - ie
or   - output (optional) - the output next to each checkbox - assign (optional) - assign the output as an array to this variable Examples:
{html_checkboxes values=$ids output=$names}
{html_checkboxes values=$ids name='box' separator='
' output=$names} {html_checkboxes values=$ids checked=$checked separator='
' output=$names}
smarty_function_html_checkboxes_output() - Function in package Smarty
smarty_function_html_image() - Function in package Smarty
Smarty {html_image} function plugin Type: function
Name: html_image
Date: Feb 24, 2003
Purpose: format HTML tags for the image
Input:
- file = file (and path) of image (required) - height = image height (optional, default actual height) - width = image width (optional, default actual width) - basedir = base directory for absolute paths, default is environment variable DOCUMENT_ROOT - path_prefix = prefix for path output (optional, default empty) Examples: {html_image file="/images/masthead.gif"} Output:
smarty_function_html_options() - Function in package Smarty
Smarty {html_options} function plugin Type: function
Name: html_options
Input:
- name (optional) - string default "select" - values (required if no options supplied) - array - options (required if no values supplied) - associative array - selected (optional) - string default not set - output (required if not options supplied) - array Purpose: Prints the list of
smarty_function_html_options_optgroup() - Function in package Smarty
smarty_function_html_options_optoutput() - Function in package Smarty
smarty_function_html_radios() - Function in package Smarty
Smarty {html_radios} function plugin File: function.html_radios.php
Type: function
Name: html_radios
Date: 24.Feb.2003
Purpose: Prints out a list of radio input types
Input:
- name (optional) - string default "radio" - values (required) - array - options (optional) - associative array - checked (optional) - array default not set - separator (optional) - ie
or   - output (optional) - the output next to each radio button - assign (optional) - assign the output as an array to this variable Examples:
{html_radios values=$ids output=$names}
{html_radios values=$ids name='box' separator='
' output=$names} {html_radios values=$ids checked=$checked separator='
' output=$names}
smarty_function_html_radios_output() - Function in package Smarty
smarty_function_html_select_date() - Function in package Smarty
Smarty {html_select_date} plugin Type: function
Name: html_select_date
Purpose: Prints the dropdowns for date selection.
smarty_function_html_select_time() - Function in package Smarty
Smarty {html_select_time} function plugin Type: function
Name: html_select_time
Purpose: Prints the dropdowns for time selection
smarty_function_html_table() - Function in package Smarty
Smarty {html_table} function plugin Type: function
Name: html_table
Date: Feb 17, 2003
Purpose: make an html table from an array of data
Input:
- loop = array to loop through - cols = number of columns, comma separated list of column names or array of column names - rows = number of rows - table_attr = table attributes - th_attr = table heading attributes (arrays are cycled) - tr_attr = table row attributes (arrays are cycled) - td_attr = table cell attributes (arrays are cycled) - trailpad = value to pad trailing cells with - caption = text for caption element - vdir = vertical direction (default: "down", means top-to-bottom) - hdir = horizontal direction (default: "right", means left-to-right) - inner = inner loop (default "cols": print $loop line by line, $loop will be printed column by column otherwise) Examples:
{table loop=$data}
{table loop=$data cols=4 tr_attr='"bgcolor=red"'}
{table loop=$data cols="first,second,third" tr_attr=$colors}
smarty_function_html_table_cycle() - Function in package Smarty
smarty_function_mailto() - Function in package Smarty
Smarty {mailto} function plugin Type: function
Name: mailto
Date: May 21, 2002 Purpose: automate mailto address link creation, and optionally encode them.
Input:
- address = e-mail address - text = (optional) text to display, default is address - encode = (optional) can be one of: none : no encoding (default) javascript : encode with javascript javascript_charcode : encode with javascript charcode hex : encode with hexidecimal (no javascript) - cc = (optional) address(es) to carbon copy - bcc = (optional) address(es) to blind carbon copy - subject = (optional) e-mail subject - newsgroups = (optional) newsgroup(s) to post to - followupto = (optional) address(es) to follow up to - extra = (optional) extra tags for the href link Examples:
{mailto address="me@domain.com"}
{mailto address="me@domain.com" encode="javascript"}
{mailto address="me@domain.com" encode="hex"}
{mailto address="me@domain.com" subject="Hello to you!"}
{mailto address="me@domain.com" cc="you@domain.com,they@domain.com"}
{mailto address="me@domain.com" extra='class="mailto"'}
smarty_function_math() - Function in package Smarty
Smarty {math} function plugin Type: function
Name: math
Purpose: handle math computations in template
smarty_function_popup() - Function in package Smarty
Smarty {popup} function plugin Type: function
Name: popup
Purpose: make text pop up in windows via overlib
smarty_function_popup_init() - Function in package Smarty
Smarty {popup_init} function plugin Type: function
Name: popup_init
Purpose: initialize overlib
smarty_make_timestamp() - Function in package Smarty
Function: smarty_make_timestamp
Purpose: used by other smarty functions to make a timestamp from a string.
smarty_modifier_capitalize() - Function in package Smarty
Smarty capitalize modifier plugin Type: modifier
Name: capitalize
Purpose: capitalize words in the string
smarty_modifier_capitalize_ucfirst() - Function in package Smarty
smarty_modifier_cat() - Function in package Smarty
Smarty cat modifier plugin Type: modifier
Name: cat
Date: Feb 24, 2003 Purpose: catenate a value to a variable Input: string to catenate Example: {$var|cat:"foo"}
smarty_modifier_count_characters() - Function in package Smarty
Smarty count_characters modifier plugin Type: modifier
Name: count_characteres
Purpose: count the number of characters in a text
smarty_modifier_count_paragraphs() - Function in package Smarty
Smarty count_paragraphs modifier plugin Type: modifier
Name: count_paragraphs
Purpose: count the number of paragraphs in a text
smarty_modifier_count_sentences() - Function in package Smarty
Smarty count_sentences modifier plugin Type: modifier
Name: count_sentences Purpose: count the number of sentences in a text
smarty_modifier_count_words() - Function in package Smarty
Smarty count_words modifier plugin Type: modifier
Name: count_words
Purpose: count the number of words in a text
smarty_modifier_date_format() - Function in package Smarty
Smarty date_format modifier plugin Type: modifier
Name: date_format
Purpose: format datestamps via strftime
Input:
- string: input date string - format: strftime format for output - default_date: default date if $string is empty
smarty_modifier_debug_print_var() - Function in package Smarty
Smarty debug_print_var modifier plugin Type: modifier
Name: debug_print_var
Purpose: formats variable contents for display in the console
smarty_modifier_default() - Function in package Smarty
Smarty default modifier plugin Type: modifier
Name: default
Purpose: designate default value for empty variables
smarty_modifier_escape() - Function in package Smarty
Smarty escape modifier plugin Type: modifier
Name: escape
Purpose: Escape the string according to escapement type
smarty_modifier_indent() - Function in package Smarty
Smarty indent modifier plugin Type: modifier
Name: indent
Purpose: indent lines of text
smarty_modifier_lower() - Function in package Smarty
Smarty lower modifier plugin Type: modifier
Name: lower
Purpose: convert string to lowercase
smarty_modifier_nl2br() - Function in package Smarty
Smarty plugin Type: modifier
Name: nl2br
Date: Feb 26, 2003 Purpose: convert \r\n, \r or \n to <
> Input:
- contents = contents to replace - preceed_test = if true, includes preceeding break tags in replacement Example: {$text|nl2br}
smarty_modifier_regex_replace() - Function in package Smarty
Smarty regex_replace modifier plugin Type: modifier
Name: regex_replace
Purpose: regular expression search/replace
smarty_modifier_replace() - Function in package Smarty
Smarty replace modifier plugin Type: modifier
Name: replace
Purpose: simple search/replace
smarty_modifier_spacify() - Function in package Smarty
Smarty spacify modifier plugin Type: modifier
Name: spacify
Purpose: add spaces between characters in a string
smarty_modifier_string_format() - Function in package Smarty
Smarty string_format modifier plugin Type: modifier
Name: string_format
Purpose: format strings via sprintf
smarty_modifier_strip() - Function in package Smarty
Smarty strip modifier plugin Type: modifier
Name: strip
Purpose: Replace all repeated spaces, newlines, tabs with a single space or supplied replacement string.
Example: {$var|strip} {$var|strip:" "} Date: September 25th, 2002
smarty_modifier_strip_tags() - Function in package Smarty
Smarty strip_tags modifier plugin Type: modifier
Name: strip_tags
Purpose: strip html tags from text
smarty_modifier_truncate() - Function in package Smarty
Smarty truncate modifier plugin Type: modifier
Name: truncate
Purpose: Truncate a string to a certain length if necessary, optionally splitting in the middle of a word, and appending the $etc string or inserting $etc into the middle.
smarty_modifier_upper() - Function in package Smarty
Smarty upper modifier plugin Type: modifier
Name: upper
Purpose: convert string to uppercase
smarty_modifier_wordwrap() - Function in package Smarty
Smarty wordwrap modifier plugin Type: modifier
Name: wordwrap
Purpose: wrap a string of text at a given length
smarty_outputfilter_trimwhitespace() - Function in package Smarty
Smarty trimwhitespace outputfilter plugin File: outputfilter.trimwhitespace.php
Type: outputfilter
Name: trimwhitespace
Date: Jan 25, 2003
Purpose: trim leading white space and blank lines from template source after it gets interpreted, cleaning up code and saving bandwidth.
smarty_outputfilter_trimwhitespace_replace() - Function in package Smarty
SMARTY_PHP_ALLOW() - Global in package Smarty
SMARTY_PHP_PASSTHRU() - Global in package Smarty
SMARTY_PHP_QUOTE() - Global in package Smarty
SMARTY_PHP_REMOVE() - Global in package Smarty

T

template_exists() - Method in class Smarty\Smarty
Checks whether requested template exists.
trigger_error() - Method in class Smarty\Smarty
trigger Smarty error

U

unregister_block() - Method in class Smarty\Smarty
Unregisters block function
unregister_compiler_function() - Method in class Smarty\Smarty
Unregisters compiler function
unregister_function() - Method in class Smarty\Smarty
Unregisters custom function
unregister_modifier() - Method in class Smarty\Smarty
Unregisters modifier
unregister_object() - Method in class Smarty\Smarty
Unregisters object
unregister_outputfilter() - Method in class Smarty\Smarty
Unregisters an outputfilter function
unregister_postfilter() - Method in class Smarty\Smarty
Unregisters a postfilter function
unregister_prefilter() - Method in class Smarty\Smarty
Unregisters a prefilter function
unregister_resource() - Method in class Smarty\Smarty
Unregisters a resource

Smarty