DS
DS = DIRECTORY_SEPARATOR
| lib |
| index | |
| Smarty | This is the main Smarty class |
| Smarty_Autoloader | Smarty Autoloader |
| Smarty_CacheResource | Cache Handler API |
| Smarty_CacheResource_Custom | Cache Handler API |
| Smarty_CacheResource_KeyValueStore | Smarty Cache Handler Base for Key/Value Storage Implementations This class implements the functionality required to use simple key/value stores for hierarchical cache groups. key/value stores like memcache or APC do not support wildcards in keys, therefore a cache group cannot be cleared like "a|*" - which is no problem to filesystem and RDBMS implementations. |
| Smarty_Data | class for the Smarty data object The Smarty data object will hold Smarty variables in the current scope |
| Smarty_Internal_Block | Smarty {block} tag class |
| Smarty_Internal_CacheResource_File | This class does contain all necessary methods for the HTML cache on file system Implements the file system as resource for the HTML cache Version ussing nocache inserts. |
| Smarty_Internal_Compile_Append | Smarty Internal Plugin Compile Append Class |
| Smarty_Internal_Compile_Assign | Smarty Internal Plugin Compile Assign Class |
| Smarty_Internal_Compile_Block | Smarty Internal Plugin Compile Block Class |
| Smarty_Internal_Compile_Blockclose | Smarty Internal Plugin Compile BlockClose Class |
| Smarty_Internal_Compile_Break | Smarty Internal Plugin Compile Break Class |
| Smarty_Internal_Compile_Call | Smarty Internal Plugin Compile Function_Call Class |
| Smarty_Internal_Compile_Capture | Smarty Internal Plugin Compile Capture Class |
| Smarty_Internal_Compile_CaptureClose | Smarty Internal Plugin Compile Captureclose Class |
| Smarty_Internal_Compile_Config_Load | Smarty Internal Plugin Compile Config Load Class |
| Smarty_Internal_Compile_Continue | Smarty Internal Plugin Compile Continue Class |
| Smarty_Internal_Compile_Debug | Smarty Internal Plugin Compile Debug Class |
| Smarty_Internal_Compile_Else | Smarty Internal Plugin Compile Else Class |
| Smarty_Internal_Compile_Elseif | Smarty Internal Plugin Compile ElseIf Class |
| Smarty_Internal_Compile_Eval | Smarty Internal Plugin Compile Eval Class |
| Smarty_Internal_Compile_Extends | Smarty Internal Plugin Compile extend Class |
| Smarty_Internal_Compile_For | Smarty Internal Plugin Compile For Class |
| Smarty_Internal_Compile_Forclose | Smarty Internal Plugin Compile Forclose Class |
| Smarty_Internal_Compile_Foreach | Smarty Internal Plugin Compile Foreach Class |
| Smarty_Internal_Compile_Foreachclose | Smarty Internal Plugin Compile Foreachclose Class |
| Smarty_Internal_Compile_Foreachelse | Smarty Internal Plugin Compile Foreachelse Class |
| Smarty_Internal_Compile_Forelse | Smarty Internal Plugin Compile Forelse Class |
| Smarty_Internal_Compile_Function | Smarty Internal Plugin Compile Function Class |
| Smarty_Internal_Compile_Functionclose | Smarty Internal Plugin Compile Functionclose Class |
| Smarty_Internal_Compile_If | Smarty Internal Plugin Compile If Class |
| Smarty_Internal_Compile_Ifclose | Smarty Internal Plugin Compile Ifclose Class |
| Smarty_Internal_Compile_Include | Smarty Internal Plugin Compile Include Class |
| Smarty_Internal_Compile_Include_Php | Smarty Internal Plugin Compile Insert Class |
| Smarty_Internal_Compile_Insert | Smarty Internal Plugin Compile Insert Class |
| Smarty_Internal_Compile_Ldelim | Smarty Internal Plugin Compile Ldelim Class |
| Smarty_Internal_Compile_Make_Nocache | Smarty Internal Plugin Compile Make_Nocache Class |
| Smarty_Internal_Compile_Nocache | Smarty Internal Plugin Compile Nocache Class |
| Smarty_Internal_Compile_Nocacheclose | Smarty Internal Plugin Compile Nocacheclose Class |
| Smarty_Internal_Compile_Private_Block_Plugin | Smarty Internal Plugin Compile Block Plugin Class |
| Smarty_Internal_Compile_Private_ForeachSection | Smarty Internal Plugin Compile ForeachSection Class |
| Smarty_Internal_Compile_Private_Function_Plugin | Smarty Internal Plugin Compile Function Plugin Class |
| Smarty_Internal_Compile_Private_Modifier | Smarty Internal Plugin Compile Modifier Class |
| Smarty_Internal_Compile_Private_Object_Block_Function | Smarty Internal Plugin Compile Object Block Function Class |
| Smarty_Internal_Compile_Private_Object_Function | Smarty Internal Plugin Compile Object Function Class |
| Smarty_Internal_Compile_Private_Php | Smarty Internal Plugin Compile PHP Expression Class |
| Smarty_Internal_Compile_Private_Print_Expression | Smarty Internal Plugin Compile Print Expression Class |
| Smarty_Internal_Compile_Private_Registered_Block | Smarty Internal Plugin Compile Registered Block Class |
| Smarty_Internal_Compile_Private_Registered_Function | Smarty Internal Plugin Compile Registered Function Class |
| Smarty_Internal_Compile_Private_Special_Variable | Smarty Internal Plugin Compile special Smarty Variable Class |
| Smarty_Internal_Compile_Rdelim | Smarty Internal Plugin Compile Rdelim Class |
| Smarty_Internal_Compile_Section | Smarty Internal Plugin Compile Section Class |
| Smarty_Internal_Compile_Sectionclose | Smarty Internal Plugin Compile Sectionclose Class |
| Smarty_Internal_Compile_Sectionelse | Smarty Internal Plugin Compile Sectionelse Class |
| Smarty_Internal_Compile_Setfilter | Smarty Internal Plugin Compile Setfilter Class |
| Smarty_Internal_Compile_Setfilterclose | Smarty Internal Plugin Compile Setfilterclose Class |
| Smarty_Internal_Compile_Shared_Inheritance | Smarty Internal Plugin Compile Shared Inheritance Class |
| Smarty_Internal_Compile_While | Smarty Internal Plugin Compile While Class |
| Smarty_Internal_Compile_Whileclose | Smarty Internal Plugin Compile Whileclose Class |
| Smarty_Internal_CompileBase | This class does extend all internal compile plugins |
| Smarty_Internal_Config_File_Compiler | Main config file compiler class |
| Smarty_Internal_Configfilelexer | Smarty_Internal_Configfilelexer |
| Smarty_Internal_Configfileparser | Smarty Internal Plugin Configfileparse |
| Smarty_Internal_Data | Base class with template and variable methods |
| Smarty_Internal_Debug | Smarty Internal Plugin Debug Class |
| Smarty_Internal_Extension_Clear | Smarty Extension Clear |
| Smarty_Internal_Extension_Handler | Smarty Extension handler |
| Smarty_Internal_Method_AddAutoloadFilters | Smarty Method AddAutoloadFilters |
| Smarty_Internal_Method_AddDefaultModifiers | Smarty Method AddDefaultModifiers |
| Smarty_Internal_Method_Append | Smarty Method Append |
| Smarty_Internal_Method_AppendByRef | Smarty Method AppendByRef |
| Smarty_Internal_Method_AssignByRef | Smarty Method AssignByRef |
| Smarty_Internal_Method_AssignGlobal | Smarty Method AssignGlobal |
| Smarty_Internal_Method_ClearAllAssign | Smarty Method ClearAllAssign |
| Smarty_Internal_Method_ClearAllCache | Smarty Method ClearAllCache |
| Smarty_Internal_Method_ClearAssign | Smarty Method ClearAssign |
| Smarty_Internal_Method_ClearCache | Smarty Method ClearCache |
| Smarty_Internal_Method_ClearCompiledTemplate | Smarty Method ClearCompiledTemplate |
| Smarty_Internal_Method_ClearConfig | Smarty Method ClearConfig |
| Smarty_Internal_Method_CompileAllConfig | Smarty Method CompileAllConfig |
| Smarty_Internal_Method_CompileAllTemplates | Smarty Method CompileAllTemplates |
| Smarty_Internal_Method_ConfigLoad | Smarty Method ConfigLoad |
| Smarty_Internal_Method_CreateData | Smarty Method CreateData |
| Smarty_Internal_Method_GetAutoloadFilters | Smarty Method GetAutoloadFilters |
| Smarty_Internal_Method_GetConfigVars | Smarty Method GetConfigVars |
| Smarty_Internal_Method_GetDebugTemplate | Smarty Method GetDebugTemplate |
| Smarty_Internal_Method_GetDefaultModifiers | Smarty Method GetDefaultModifiers |
| Smarty_Internal_Method_GetGlobal | Smarty Method GetGlobal |
| Smarty_Internal_Method_GetRegisteredObject | Smarty Method GetRegisteredObject |
| Smarty_Internal_Method_GetStreamVariable | Smarty Method GetStreamVariable |
| Smarty_Internal_Method_GetTags | Smarty Method GetTags |
| Smarty_Internal_Method_GetTemplateVars | Smarty Method GetTemplateVars |
| Smarty_Internal_Method_LoadFilter | Smarty Method LoadFilter |
| Smarty_Internal_Method_LoadPlugin | Smarty Extension Loadplugin |
| Smarty_Internal_Method_MustCompile | Smarty Method MustCompile |
| Smarty_Internal_Method_RegisterCacheResource | Smarty Method RegisterCacheResource |
| Smarty_Internal_Method_RegisterClass | Smarty Method RegisterClass |
| Smarty_Internal_Method_RegisterDefaultConfigHandler | Smarty Method RegisterDefaultConfigHandler |
| Smarty_Internal_Method_RegisterDefaultPluginHandler | Smarty Method RegisterDefaultPluginHandler |
| Smarty_Internal_Method_RegisterDefaultTemplateHandler | Smarty Method RegisterDefaultTemplateHandler |
| Smarty_Internal_Method_RegisterFilter | Smarty Method RegisterFilter |
| Smarty_Internal_Method_RegisterObject | Smarty Method RegisterObject |
| Smarty_Internal_Method_RegisterPlugin | Smarty Method RegisterPlugin |
| Smarty_Internal_Method_RegisterResource | Smarty Method RegisterResource |
| Smarty_Internal_Method_SetAutoloadFilters | Smarty Method SetAutoloadFilters |
| Smarty_Internal_Method_SetDebugTemplate | Smarty Method SetDebugTemplate |
| Smarty_Internal_Method_SetDefaultModifiers | Smarty Method SetDefaultModifiers |
| Smarty_Internal_Method_UnloadFilter | Smarty Method UnloadFilter |
| Smarty_Internal_Method_UnregisterCacheResource | Smarty Method UnregisterCacheResource |
| Smarty_Internal_Method_UnregisterFilter | Smarty Method UnregisterFilter |
| Smarty_Internal_Method_UnregisterObject | Smarty Method UnregisterObject |
| Smarty_Internal_Method_UnregisterPlugin | Smarty Method UnregisterPlugin |
| Smarty_Internal_Method_UnregisterResource | Smarty Method UnregisterResource |
| Smarty_Internal_Nocache_Insert | Smarty Internal Plugin Compile Insert Class |
| Smarty_Internal_ParseTree | |
| Smarty_Internal_ParseTree_Code | Code fragment inside a tag . |
| Smarty_Internal_ParseTree_Dq | Double quoted string inside a tag. |
| Smarty_Internal_ParseTree_DqContent | Raw chars as part of a double quoted string. |
| Smarty_Internal_ParseTree_Tag | A complete smarty tag. |
| Smarty_Internal_ParseTree_Template | Template element |
| Smarty_Internal_ParseTree_Text | Smarty Internal Plugin Templateparser Parse Tree These are classes to build parse tree in the template parser |
| Smarty_Internal_Resource_Eval | Smarty Internal Plugin Resource Eval Implements the strings as resource for Smarty template {@internal unlike string-resources the compiled state of eval-resources is NOT saved for subsequent access}} |
| Smarty_Internal_Resource_Extends | Smarty Internal Plugin Resource Extends Implements the file system as resource for Smarty which {extend}s a chain of template files templates |
| Smarty_Internal_Resource_File | Smarty Internal Plugin Resource File Implements the file system as resource for Smarty templates |
| Smarty_Internal_Resource_Php | Smarty Internal Plugin Resource PHP Implements the file system as resource for PHP templates |
| Smarty_Internal_Resource_Registered | Smarty Internal Plugin Resource Registered Implements the registered resource for Smarty template |
| Smarty_Internal_Resource_Stream | Smarty Internal Plugin Resource Stream Implements the streams as resource for Smarty template |
| Smarty_Internal_Resource_String | Smarty Internal Plugin Resource String Implements the strings as resource for Smarty template {@internal unlike eval-resources the compiled state of string-resources is saved for subsequent access}} |
| Smarty_Internal_Runtime_CacheModify | Inline Runtime Methods render, setSourceByUid, setupSubTemplate |
| Smarty_Internal_Runtime_Capture | Runtime Extension Capture |
| Smarty_Internal_Runtime_CodeFrame | Class Smarty_Internal_Extension_CodeFrame Create code frame for compiled and cached templates |
| Smarty_Internal_Runtime_FilterHandler | Class for filter processing |
| Smarty_Internal_Runtime_Foreach | Foreach Runtime Methods count(), init(), restore() |
| Smarty_Internal_Runtime_GetIncludePath | Smarty Internal Read Include Path Class |
| Smarty_Internal_Runtime_Inheritance | Inheritance Runtime Methods processBlock, endChild, init |
| Smarty_Internal_Runtime_Make_Nocache | {make_nocache} Runtime Methods save(), store() |
| Smarty_Internal_Runtime_TplFunction | Tplfunc Runtime Methods callTemplateFunction |
| Smarty_Internal_Runtime_UpdateCache | Inline Runtime Methods render, setSourceByUid, setupSubTemplate |
| Smarty_Internal_Runtime_UpdateScope | Runtime Extension updateScope |
| Smarty_Internal_Runtime_WriteFile | Smarty Internal Write File Class |
| Smarty_Internal_SmartyTemplateCompiler | Class SmartyTemplateCompiler |
| Smarty_Internal_Template | Main class with template data structures and methods |
| Smarty_Internal_TemplateBase | Class with shared smarty/template methods |
| Smarty_Internal_TemplateCompilerBase | Main abstract compiler class |
| Smarty_Internal_Templatelexer | Smarty_Internal_Templatelexer This is the template file lexer. |
| Smarty_Internal_Templateparser | Smarty Template Parser Class |
| Smarty_Internal_TestInstall | TestInstall class |
| Smarty_Internal_Undefined | Smarty Method AppendByRef |
| Smarty_Resource | Smarty Resource Plugin Base implementation for resource plugins |
| Smarty_Resource_Custom | Smarty Resource Plugin Wrapper Implementation for custom resource plugins |
| Smarty_Resource_Recompiled | Smarty Resource Plugin Base implementation for resource plugins that don't compile cache |
| Smarty_Resource_Uncompiled | Smarty Resource Plugin Base implementation for resource plugins that don't use the compiler |
| Smarty_Security | This class does contain the security settings |
| Smarty_Template_Cached | Smarty Resource Data Object Cache Data Container for Template Files |
| Smarty_Template_Compiled | Smarty Resource Data Object Meta Data Container for Template Files |
| Smarty_Template_Config | Smarty Config Resource Data Object Meta Data Container for Template Files |
| Smarty_Template_Resource_Base | Smarty Template Resource Base Object |
| Smarty_Template_Source | Smarty Resource Data Object Meta Data Container for Template Files |
| Smarty_Undefined_Variable | class for undefined variable object This class defines an object for undefined variable handling |
| Smarty_Variable | class for the Smarty variable object This class defines the Smarty variable object |
| SmartyBC | Smarty Backward Compatibility Wrapper Class |
| SmartyCompilerException | Smarty compiler exception class |
| SmartyException | Smarty exception class |
| TP_yyStackEntry | |
| TP_yyToken | |
| TPC_yyStackEntry | |
| TPC_yyToken |
content_5b9b54debfe505_01072684(\Smarty_Internal_Template $_smarty_tpl)
| \Smarty_Internal_Template | $_smarty_tpl |
smarty_block_textformat(array $params, string $content, \Smarty_Internal_Template $template, $repeat) : string
Smarty {textformat}{/textformat} block plugin Type: block function<br> Name: textformat<br> Purpose: format text a certain way with preset styles or custom wrap/indent settings<br> Params: <pre> - style - string (email) - indent - integer (0) - wrap - integer (80) - wrap_char - string ("\n") - indent_char - string (" ") - wrap_boundary - boolean (true) </pre>
| array | $params | parameters |
| string | $content | contents of the block |
| \Smarty_Internal_Template | $template | template object |
| $repeat |
content re-formatted
smarty_function_counter(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {counter} function plugin Type: function<br> Name: counter<br> Purpose: print out a counter value
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
smarty_function_cycle(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {cycle} function plugin Type: function<br> Name: cycle<br> Date: May 3, 2002<br> Purpose: cycle through given values<br> Params: <pre> - 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. default is true - advance - boolean - whether or not to advance the cycle - delimiter - the value delimiter, default is "," - assign - boolean, assigns to template var instead of printed.
Examples:
{cycle values="#eeeeee,#d0d0d0d"}
{cycle name=row values="one,two,three" reset=true}
{cycle name=row}
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
smarty_function_escape_special_chars(string $string) : string
escape_special_chars common function Function: smarty_function_escape_special_chars<br> Purpose: used by other smarty functions to escape special chars except for already escaped ones
| string | $string | text that should by escaped |
smarty_function_fetch(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {fetch} plugin Type: function<br> Name: fetch<br> Purpose: fetch file, web or ftp data and display results
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
if the assign parameter is passed, Smarty assigns the result to a template variable
smarty_function_html_checkboxes(array $params, object $template) : string
Smarty {html_checkboxes} function plugin File: function.html_checkboxes.php<br> Type: function<br> Name: html_checkboxes<br> Date: 24.Feb.2003<br> Purpose: Prints out a list of checkbox input types<br> Examples: <pre> {html_checkboxes values=$ids output=$names} {html_checkboxes values=$ids name='box' separator='<br>' output=$names} {html_checkboxes values=$ids checked=$checked separator='<br>' output=$names} </pre> Params: <pre> - name (optional) - string default "checkbox" - values (required) - array - options (optional) - associative array - checked (optional) - array default not set - separator (optional) - ie <br> or - output (optional) - the output next to each checkbox - assign (optional) - assign the output as an array to this variable - escape (optional) - escape the content (not value), defaults to true </pre>
| array | $params | parameters |
| object | $template | template object |
smarty_function_html_image(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_image} function plugin Type: function<br> Name: html_image<br> Date: Feb 24, 2003<br> Purpose: format HTML tags for the image<br> Examples: {html_image file="/images/masthead.gif"}<br> Output: <img src="/images/masthead.gif" width=400 height=23><br> Params: <pre> - file - (required) - file (and path) of image - height - (optional) - image height (default actual height) - width - (optional) - image width (default actual width) - basedir - (optional) - base directory for absolute paths, default is environment variable DOCUMENT_ROOT - path_prefix - prefix for path output (optional, default empty) </pre>
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
smarty_function_html_options(array $params) : string
Smarty {html_options} function plugin Type: function<br> Name: html_options<br> Purpose: Prints the list of <option> tags generated from the passed parameters<br> Params: <pre> - 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 - id (optional) - string default not set - class (optional) - string default not set </pre>
| array | $params | parameters |
smarty_function_html_radios(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_radios} function plugin File: function.html_radios.php<br> Type: function<br> Name: html_radios<br> Date: 24.Feb.2003<br> Purpose: Prints out a list of radio input types<br> Params: <pre> - name (optional) - string default "radio" - values (required) - array - options (required) - associative array - checked (optional) - array default not set - separator (optional) - ie <br> or - output (optional) - the output next to each radio button - assign (optional) - assign the output as an array to this variable - escape (optional) - escape the content (not value), defaults to true </pre> Examples: <pre> {html_radios values=$ids output=$names} {html_radios values=$ids name='box' separator='<br>' output=$names} {html_radios values=$ids checked=$checked separator='<br>' output=$names} </pre>
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
smarty_function_html_select_date(array $params) : string
Smarty {html_select_date} plugin Type: function<br> Name: html_select_date<br> Purpose: Prints the dropdowns for date selection.
ChangeLog:
- 1.0 initial release
- 1.1 added support for +/- N syntax for begin
and end year values. (Monte)
- 1.2 added support for yyyy-mm-dd syntax for
time value. (Jan Rosier)
- 1.3 added support for choosing format for
month values (Gary Loescher)
- 1.3.1 added support for choosing format for
day values (Marcus Bointon)
- 1.3.2 support negative timestamps, force year
dropdown to include given date unless explicitly set (Monte)
- 1.3.4 fix behaviour of 0000-00-00 00:00:00 dates to match that
of 0000-00-00 dates (cybot, boots)
- 2.0 complete rewrite for performance,
added attributes month_names, *_id
| array | $params | parameters |
smarty_function_html_table(array $params) : string
Smarty {html_table} function plugin Type: function<br> Name: html_table<br> Date: Feb 17, 2003<br> Purpose: make an html table from an array of data<br> Params: <pre> - 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) </pre> Examples: <pre> {table loop=$data} {table loop=$data cols=4 tr_attr='"bgcolor=red"'} {table loop=$data cols="first,second,third" tr_attr=$colors} </pre>
| array | $params | parameters |
smarty_function_mailto(array $params) : string
Smarty {mailto} function plugin Type: function<br> Name: mailto<br> Date: May 21, 2002 Purpose: automate mailto address link creation, and optionally encode them.<br> Params: <pre> - address - (required) - 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 </pre> Examples: <pre> {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"'} </pre>
| array | $params | parameters |
smarty_function_math(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {math} function plugin Type: function<br> Name: math<br> Purpose: handle math computations in template
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
smarty_literal_compiler_param(array $params, integer $index, mixed $default = null) : mixed
evaluate compiler parameter
| array | $params | parameter array as given to the compiler function |
| integer | $index | array index of the parameter to convert |
| mixed | $default | value to be returned if the parameter is not present |
if parameter is not a literal (but an expression, variable, …)
evaluated value of parameter or $default
smarty_make_timestamp(\DateTime|integer|string $string) : integer
Function: smarty_make_timestamp<br> Purpose: used by other smarty functions to make a timestamp from a string.
| \DateTime|integer|string | $string | date object, timestamp or string that can be converted using strtotime() |
smarty_mb_from_unicode(integer|array $unicode, string $encoding = null) : string
convert unicodes to the character of given encoding
| integer|array | $unicode | single unicode or list of unicodes to convert |
| string | $encoding | encoding of returned string, if null mb_internal_encoding() is used |
unicode as character sequence in given $encoding
smarty_mb_str_replace(string $search, string $replace, string $subject, $count) : string
Multibyte string replace
| string | $search | the string to be searched |
| string | $replace | the replacement string |
| string | $subject | the source string |
| $count |
replaced string
smarty_mb_to_unicode(string $string, string $encoding = null) : array
convert characters to their decimal unicode equivalents
| string | $string | characters to calculate unicode of |
| string | $encoding | encoding of $string, if null mb_internal_encoding() is used |
sequence of unicodes
smarty_mb_wordwrap(string $str, integer $width = 75, string $break = "\n", boolean $cut = false) : string
Wrap a string to a given number of characters
| string | $str | the string to wrap |
| integer | $width | the width of the output |
| string | $break | the character used to break the line |
| boolean | $cut | ignored parameter, just for the sake of |
wrapped string
smarty_modifier_capitalize(string $string, boolean $uc_digits = false, boolean $lc_rest = false) : string
Smarty capitalize modifier plugin Type: modifier<br> Name: capitalize<br> Purpose: capitalize words in the string {@internal {$string|capitalize:true:true} is the fastest option for MBString enabled systems }}
| string | $string | string to capitalize |
| boolean | $uc_digits | also capitalize "x123" to "X123" |
| boolean | $lc_rest | capitalize first letters, lowercase all following letters "aAa" to "Aaa" |
capitalized string
smarty_modifier_date_format(string $string, string $format = null, string $default_date = '', string $formatter = 'auto') : string
Smarty date_format modifier plugin Type: modifier<br> Name: date_format<br> Purpose: format datestamps via strftime<br> Input:<br> - string: input date string - format: strftime format for output - default_date: default date if $string is empty
| string | $string | input date string |
| string | $format | strftime format for output |
| string | $default_date | default date if $string is empty |
| string | $formatter | either 'strftime' or 'auto' |
|void
smarty_modifier_debug_print_var(array|object $var, integer $max = 10, integer $length = 40, integer $depth, array $objects = array()) : string
Smarty debug_print_var modifier plugin Type: modifier<br> Name: debug_print_var<br> Purpose: formats variable contents for display in the console
| array|object | $var | variable to be formatted |
| integer | $max | maximum recursion depth if $var is an array or object |
| integer | $length | maximum string length if $var is a string |
| integer | $depth | actual recursion depth |
| array | $objects | processed objects in actual depth to prevent recursive object processing |
smarty_modifier_escape(string $string, string $esc_type = 'html', string $char_set = null, boolean $double_encode = true) : string
Smarty escape modifier plugin Type: modifier<br> Name: escape<br> Purpose: escape string for output
| string | $string | input string |
| string | $esc_type | escape type |
| string | $char_set | character set, used for htmlspecialchars() or htmlentities() |
| boolean | $double_encode | encode already encoded entitites again, used for htmlspecialchars() or htmlentities() |
escaped input string
smarty_modifier_regex_replace(string $string, string|array $search, string|array $replace, integer $limit = -1) : string
Smarty regex_replace modifier plugin Type: modifier<br> Name: regex_replace<br> Purpose: regular expression search/replace
| string | $string | input string |
| string|array | $search | regular expression(s) to search for |
| string|array | $replace | string(s) that should be replaced |
| integer | $limit | the maximum number of replacements |
smarty_modifier_replace(string $string, string $search, string $replace) : string
Smarty replace modifier plugin Type: modifier<br> Name: replace<br> Purpose: simple search/replace
| string | $string | input string |
| string | $search | text to search for |
| string | $replace | replacement text |
smarty_modifier_spacify(string $string, string $spacify_char = ' ') : string
Smarty spacify modifier plugin Type: modifier<br> Name: spacify<br> Purpose: add spaces between characters in a string
| string | $string | input string |
| string | $spacify_char | string to insert between characters. |
smarty_modifier_truncate(string $string, integer $length = 80, string $etc = '...', boolean $break_words = false, boolean $middle = false) : string
Smarty truncate modifier plugin Type: modifier<br> Name: truncate<br> 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.
| string | $string | input string |
| integer | $length | length of truncated text |
| string | $etc | end string |
| boolean | $break_words | truncate at word boundary |
| boolean | $middle | truncate in the middle of text |
truncated string
smarty_modifiercompiler_cat(array $params) : string
Smarty cat modifier plugin Type: modifier<br> Name: cat<br> Date: Feb 24, 2003<br> Purpose: catenate a value to a variable<br> Input: string to catenate<br> Example: {$var|cat:"foo"}
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_count_characters(array $params) : string
Smarty count_characters modifier plugin Type: modifier<br> Name: count_characteres<br> Purpose: count the number of characters in a text
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_count_paragraphs(array $params) : string
Smarty count_paragraphs modifier plugin Type: modifier<br> Name: count_paragraphs<br> Purpose: count the number of paragraphs in a text
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_count_sentences(array $params) : string
Smarty count_sentences modifier plugin Type: modifier<br> Name: count_sentences Purpose: count the number of sentences in a text
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_from_charset(array $params) : string
Smarty from_charset modifier plugin Type: modifier<br> Name: from_charset<br> Purpose: convert character encoding from $charset to internal encoding
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_strip(array $params) : string
Smarty strip modifier plugin Type: modifier<br> Name: strip<br> Purpose: Replace all repeated spaces, newlines, tabs with a single space or supplied replacement string.<br> Example: {$var|strip} {$var|strip:" "}<br> Date: September 25th, 2002
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_to_charset(array $params) : string
Smarty to_charset modifier plugin Type: modifier<br> Name: to_charset<br> Purpose: convert character encoding from internal encoding to $charset
| array | $params | parameters |
with compiled code
smarty_modifiercompiler_wordwrap(array $params, $compiler) : string
Smarty wordwrap modifier plugin Type: modifier<br> Name: wordwrap<br> Purpose: wrap a string of text at a given length
| array | $params | parameters |
| $compiler |
with compiled code