diff options
Diffstat (limited to 'vendor/smarty/smarty/docs/designers')
81 files changed, 6516 insertions, 0 deletions
diff --git a/vendor/smarty/smarty/docs/designers/chapter-debugging-console.md b/vendor/smarty/smarty/docs/designers/chapter-debugging-console.md new file mode 100644 index 000000000..6429b4876 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/chapter-debugging-console.md @@ -0,0 +1,41 @@ +Debugging Console {#chapter.debugging.console} +================= + +There is a debugging console included with Smarty. The console informs +you of all the [included](./language-builtin-functions/language-function-include.md) templates, +[assigned](../programmers/api-functions/api-assign.md) variables and +[config](./language-variables/language-config-variables.md) file variables for the current +invocation of the template. A template file named `debug.tpl` is +included with the distribution of Smarty which controls the formatting +of the console. + +Set [`$debugging`](../programmers/api-variables/variable-debugging.md) to TRUE in Smarty, and if needed +set [`$debug_tpl`](../programmers/api-variables/variable-debug-template.md) to the template resource +path to `debug.tpl` (this is in [`SMARTY_DIR`](../programmers/smarty-constants.md) by +default). When you load the page, a Javascript console window will pop +up and give you the names of all the included templates and assigned +variables for the current page. + +To see the available variables for a particular template, see the +[`{debug}`](./language-builtin-functions/language-function-debug.md) template function. To disable the +debugging console, set [`$debugging`](../programmers/api-variables/variable-debugging.md) to FALSE. You +can also temporarily turn on the debugging console by putting +`SMARTY_DEBUG` in the URL if you enable this option with +[`$debugging_ctrl`](../programmers/api-variables/variable-debugging-ctrl.md). + +> **Note** +> +> The debugging console does not work when you use the +> [`fetch()`](../programmers/api-functions/api-fetch.md) API, only when using +> [`display()`](../programmers/api-functions/api-display.md). It is a set of javascript statements +> added to the very bottom of the generated template. If you do not like +> javascript, you can edit the `debug.tpl` template to format the output +> however you like. Debug data is not cached and `debug.tpl` info is not +> included in the output of the debug console. + +> **Note** +> +> The load times of each template and config file are in seconds, or +> fractions thereof. + +See also [troubleshooting](../appendixes/troubleshooting.md). diff --git a/vendor/smarty/smarty/docs/designers/config-files.md b/vendor/smarty/smarty/docs/designers/config-files.md new file mode 100644 index 000000000..c840e3a67 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/config-files.md @@ -0,0 +1,77 @@ +Config Files {#config.files} +============ + +Config files are handy for designers to manage global template variables +from one file. One example is template colors. Normally if you wanted to +change the color scheme of an application, you would have to go through +each and every template file and change the colors. With a config file, +the colors can be kept in one place, and only one file needs to be +updated. + + + # global variables + pageTitle = "Main Menu" + bodyBgColor = #000000 + tableBgColor = #000000 + rowBgColor = #00ff00 + + [Customer] + pageTitle = "Customer Info" + + [Login] + pageTitle = "Login" + focus = "username" + Intro = """This is a value that spans more + than one line. you must enclose + it in triple quotes.""" + + # hidden section + [.Database] + host=my.example.com + db=ADDRESSBOOK + user=php-user + pass=foobar + + + +Values of [config file variables](./language-variables/language-config-variables.md) can be in +quotes, but not necessary. You can use either single or double quotes. +If you have a value that spans more than one line, enclose the entire +value with triple quotes (\"\"\"). You can put comments into config +files by any syntax that is not a valid config file syntax. We recommend +using a ` + #` (hash) at the beginning of the line. + +The example config file above has two sections. Section names are +enclosed in \[brackets\]. Section names can be arbitrary strings not +containing `[` or `]` symbols. The four variables at the top are global +variables, or variables not within a section. These variables are always +loaded from the config file. If a particular section is loaded, then the +global variables and the variables from that section are also loaded. If +a variable exists both as a global and in a section, the section +variable is used. If you name two variables the same within a section, +the last one will be used unless +[`$config_overwrite`](../programmers/api-variables/variable-config-overwrite.md) is disabled. + +Config files are loaded into templates with the built-in template +function [` + {config_load}`](./language-builtin-functions/language-function-config-load.md) or the API +[`configLoad()`](../programmers/api-functions/api-config-load.md) function. + +You can hide variables or entire sections by prepending the variable +name or section name with a period(.) eg `[.hidden]`. This is useful if +your application reads the config files and gets sensitive data from +them that the template engine does not need. If you have third parties +doing template editing, you can be certain that they cannot read +sensitive data from the config file by loading it into the template. + +Config files (or resources) are loaded by the same resource facilities +as templates. That means that a config file can also be loaded from a db +`$smarty->configLoad("db:my.conf")`. + +See also [`{config_load}`](./language-builtin-functions/language-function-config-load.md), +[`$config_overwrite`](../programmers/api-variables/variable-config-overwrite.md), +[`$default_config_handler_func`](../programmers/api-variables/variable-default-config-handler-func.md), +[`getConfigVars()`](../programmers/api-functions/api-get-config-vars.md), +[`clearConfig()`](../programmers/api-functions/api-clear-config.md) and +[`configLoad()`](../programmers/api-functions/api-config-load.md) diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax.md new file mode 100644 index 000000000..2509857c3 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax.md @@ -0,0 +1,33 @@ +Basic Syntax +============ + +A simple Smarty template could look like this: +```html +<h1>{$title|escape}</h1> +<ul> + {foreach $cities as $city} + <li>{$city.name|escape} ({$city.population})</li> + {foreachelse} + <li>no cities found</li> + {/foreach} +</ul> +``` + +All Smarty template tags are enclosed within delimiters. By default +these are `{` and `}`, but they can be +[changed](../programmers/api-variables/variable-left-delimiter.md). + +For the examples in this manual, we will assume that you are using the +default delimiters. In Smarty, all content outside of delimiters is +displayed as static content, or unchanged. When Smarty encounters +template tags, it attempts to interpret them, and displays the +appropriate output in their place. + +The basis components of the Smarty syntax are: +- [Comments](./language-basic-syntax/language-syntax-comments.md) +- [Variables](./language-basic-syntax/language-syntax-variables.md) +- [Functions](./language-basic-syntax/language-syntax-functions.md) +- [Attributes](./language-basic-syntax/language-syntax-attributes.md) +- [Quotes](./language-basic-syntax/language-syntax-quotes.md) +- [Math](./language-basic-syntax/language-math.md) +- [Escaping](./language-basic-syntax/language-escaping.md) diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md new file mode 100644 index 000000000..a62e7de89 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md @@ -0,0 +1,84 @@ +Escaping Smarty Parsing {#language.escaping} +======================= + +It is sometimes desirable or even necessary to have Smarty ignore +sections it would otherwise parse. A classic example is embedding +Javascript or CSS code in a template. The problem arises as those +languages use the { and } characters which are also the default +[delimiters](#language.function.ldelim) for Smarty. + +> **Note** +> +> A good practice for avoiding escapement altogether is by separating +> your Javascript/CSS into their own files and use standard HTML methods +> to access them. This will also take advantage of browser script +> caching. When you need to embed Smarty variables/functions into your +> Javascript/CSS, then the following applies. + +In Smarty templates, the { and } braces will be ignored so long as they +are surrounded by white space. This behavior can be disabled by setting +the Smarty class variable [`$auto_literal`](#variable.auto.literal) to +false. + + + <script> + // the following braces are ignored by Smarty + // since they are surrounded by whitespace + function foobar { + alert('foobar!'); + } + // this one will need literal escapement + {literal} + function bazzy {alert('foobar!');} + {/literal} + </script> + + + +[`{literal}..{/literal}`](#language.function.literal) blocks are used +for escaping blocks of template logic. You can also escape the braces +individually with +[`{ldelim}`](#language.function.ldelim),[`{rdelim}`](#language.function.ldelim) +tags or +[`{$smarty.ldelim}`,`{$smarty.rdelim}`](#language.variables.smarty.ldelim) +variables. + +Smarty\'s default delimiters { and } cleanly represent presentational +content. However if another set of delimiters suit your needs better, +you can change them with Smarty\'s +[`$left_delimiter`](#variable.left.delimiter) and +[`$right_delimiter`](#variable.right.delimiter) values. + +> **Note** +> +> Changing delimiters affects ALL template syntax and escapement. Be +> sure to clear out cache and compiled files if you decide to change +> them. + + + <?php + + $smarty->left_delimiter = '<!--{'; + $smarty->right_delimiter = '}-->'; + + $smarty->assign('foo', 'bar'); + $smarty->assign('name', 'Albert'); + $smarty->display('example.tpl'); + + ?> + + + +Where the template is: + + + Welcome <!--{$name}--> to Smarty + <script language="javascript"> + var foo = <!--{$foo}-->; + function dosomething() { + alert("foo is " + foo); + } + dosomething(); + </script> + + diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-math.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-math.md new file mode 100644 index 000000000..dc78a3512 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-math.md @@ -0,0 +1,29 @@ +Math {#language.math} +==== + +Math can be applied directly to variable values. + + + {$foo+1} + + {$foo*$bar} + + {* some more complicated examples *} + + {$foo->bar-$bar[1]*$baz->foo->bar()-3*7} + + {if ($foo+$bar.test%$baz*134232+10+$b+10)} + + {$foo|truncate:"`$fooTruncCount/$barTruncFactor-1`"} + + {assign var="foo" value="`$foo+$bar`"} + + + +> **Note** +> +> Although Smarty can handle some very complex expressions and syntax, +> it is a good rule of thumb to keep the template syntax minimal and +> focused on presentation. If you find your template syntax getting too +> complex, it may be a good idea to move the bits that do not deal +> explicitly with presentation to PHP by way of plugins or modifiers. diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md new file mode 100644 index 000000000..0fa7c7734 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md @@ -0,0 +1,50 @@ +Attributes {#language.syntax.attributes} +========== + +Most of the [functions](#language.syntax.functions) take attributes that +specify or modify their behavior. Attributes to Smarty functions are +much like HTML attributes. Static values don\'t have to be enclosed in +quotes, but it is required for literal strings. Variables with or +without modifiers may also be used, and should not be in quotes. You can +even use PHP function results, plugin results and complex expressions. + +Some attributes require boolean values (TRUE or FALSE). These can be +specified as `true` and `false`. If an attribute has no value assigned +it gets the default boolean value of true. + + + {include file="header.tpl"} + + {include file="header.tpl" nocache} // is equivalent to nocache=true + + {include file="header.tpl" attrib_name="attrib value"} + + {include file=$includeFile} + + {include file=#includeFile# title="My Title"} + + {assign var=foo value={counter}} // plugin result + + {assign var=foo value=substr($bar,2,5)} // PHP function result + + {assign var=foo value=$bar|strlen} // using modifier + + {assign var=foo value=$buh+$bar|strlen} // more complex expression + + {html_select_date display_days=true} + + {mailto address="smarty@example.com"} + + <select name="company_id"> + {html_options options=$companies selected=$company_id} + </select> + + + +> **Note** +> +> Although Smarty can handle some very complex expressions and syntax, +> it is a good rule of thumb to keep the template syntax minimal and +> focused on presentation. If you find your template syntax getting too +> complex, it may be a good idea to move the bits that do not deal +> explicitly with presentation to PHP by way of plugins or modifiers. diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md new file mode 100644 index 000000000..43104dbb6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md @@ -0,0 +1,71 @@ +Comments {#language.syntax.comments} +======== + +Template comments are surrounded by asterisks, and that is surrounded by +the [delimiter](#variable.left.delimiter) tags like so: + +::: {.informalexample} + + {* this is a comment *} + + +::: + +Smarty comments are NOT displayed in the final output of the template, +unlike `<!-- HTML comments -->`. These are useful for making internal +notes in the templates which no one will see ;-) + + + {* I am a Smarty comment, I don't exist in the compiled output *} + <html> + <head> + <title>{$title}</title> + </head> + <body> + + {* another single line smarty comment *} + <!-- HTML comment that is sent to the browser --> + + {* this multiline smarty + comment is + not sent to browser + *} + + {********************************************************* + Multi line comment block with credits block + @ author: bg@example.com + @ maintainer: support@example.com + @ para: var that sets block style + @ css: the style output + **********************************************************} + + {* The header file with the main logo and stuff *} + {include file='header.tpl'} + + + {* Dev note: the $includeFile var is assigned in foo.php script *} + <!-- Displays main content block --> + {include file=$includeFile} + + {* this <select> block is redundant *} + {* + <select name="company"> + {html_options options=$vals selected=$selected_id} + </select> + *} + + <!-- Show header from affiliate is disabled --> + {* $affiliate|upper *} + + {* you cannot nest comments *} + {* + <select name="company"> + {* <option value="0">-- none -- </option> *} + {html_options options=$vals selected=$selected_id} + </select> + *} + + </body> + </html> + + diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md new file mode 100644 index 000000000..9c8c94049 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md @@ -0,0 +1,40 @@ +Functions {#language.syntax.functions} +========= + +Every Smarty tag either prints a [variable](#language.variables) or +invokes some sort of function. These are processed and displayed by +enclosing the function and its [attributes](#language.syntax.attributes) +within delimiters like so: `{funcname attr1="val1" attr2="val2"}`. + + + {config_load file="colors.conf"} + + {include file="header.tpl"} + {insert file="banner_ads.tpl" title="My Site"} + + {if $logged_in} + Welcome, <span style="color:{#fontColor#}">{$name}!</span> + {else} + hi, {$name} + {/if} + + {include file="footer.tpl"} + + + +- Both [built-in functions](#language.builtin.functions) and [custom + functions](#language.custom.functions) have the same syntax within + templates. + +- Built-in functions are the **inner** workings of Smarty, such as + [`{if}`](#language.function.if), + [`{section}`](#language.function.section) and + [`{strip}`](#language.function.strip). There should be no need to + change or modify them. + +- Custom functions are **additional** functions implemented via + [plugins](#plugins). They can be modified to your liking, or you can + create new ones. [`{html_options}`](#language.function.html.options) + is an example of a custom function. + +See also [`registerPlugin()`](#api.register.plugin) diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md new file mode 100644 index 000000000..6fe185c97 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md @@ -0,0 +1,61 @@ +Embedding Vars in Double Quotes {#language.syntax.quotes} +=============================== + +- Smarty will recognize [assigned](#api.assign) + [variables](#language.syntax.variables) embedded in \"double + quotes\" so long as the variable name contains only numbers, letters + and under\_scores. See [naming](&url.php-manual;language.variables) + for more detail. + +- With any other characters, for example a period(.) or + `$object->reference`, then the variable must be surrounded by + `` `backticks` ``. + +- In addition Smarty3 does allow embedded Smarty tags in double quoted + strings. This is useful if you want to include variables with + modifiers, plugin or PHP function results. + +<!-- --> + + + {func var="test $foo test"} // sees $foo + {func var="test $foo_bar test"} // sees $foo_bar + {func var="test `$foo[0]` test"} // sees $foo[0] + {func var="test `$foo[bar]` test"} // sees $foo[bar] + {func var="test $foo.bar test"} // sees $foo (not $foo.bar) + {func var="test `$foo.bar` test"} // sees $foo.bar + {func var="test `$foo.bar` test"|escape} // modifiers outside quotes! + {func var="test {$foo|escape} test"} // modifiers inside quotes! + {func var="test {time()} test"} // PHP function result + {func var="test {counter} test"} // plugin result + {func var="variable foo is {if !$foo}not {/if} defined"} // Smarty block function + + + + + {* will replace $tpl_name with value *} + {include file="subdir/$tpl_name.tpl"} + + {* does NOT replace $tpl_name *} + {include file='subdir/$tpl_name.tpl'} // vars require double quotes! + + {* must have backticks as it contains a dot "." *} + {cycle values="one,two,`$smarty.config.myval`"} + + {* must have backticks as it contains a dot "." *} + {include file="`$module.contact`.tpl"} + + {* can use variable with dot syntax *} + {include file="`$module.$view`.tpl"} + + + +> **Note** +> +> Although Smarty can handle some very complex expressions and syntax, +> it is a good rule of thumb to keep the template syntax minimal and +> focused on presentation. If you find your template syntax getting too +> complex, it may be a good idea to move the bits that do not deal +> explicitly with presentation to PHP by way of plugins or modifiers. + +See also [`escape`](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md new file mode 100644 index 000000000..671ad8bb8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md @@ -0,0 +1,111 @@ +Variables {#language.syntax.variables} +========= + +Template variables start with the \$dollar sign. They can contain +numbers, letters and underscores, much like a [PHP +variable](&url.php-manual;language.variables). You can reference arrays +by index numerically or non-numerically. Also reference object +properties and methods. + +[Config file variables](#language.config.variables) are an exception to +the \$dollar syntax and are instead referenced with surrounding +\#hashmarks\#, or via the +[`$smarty.config`](#language.variables.smarty.config) variable. + + + {$foo} <-- displaying a simple variable (non array/object) + {$foo[4]} <-- display the 5th element of a zero-indexed array + {$foo.bar} <-- display the "bar" key value of an array, similar to PHP $foo['bar'] + {$foo.$bar} <-- display variable key value of an array, similar to PHP $foo[$bar] + {$foo->bar} <-- display the object property "bar" + {$foo->bar()} <-- display the return value of object method "bar" + {#foo#} <-- display the config file variable "foo" + {$smarty.config.foo} <-- synonym for {#foo#} + {$foo[bar]} <-- syntax only valid in a section loop, see {section} + {assign var=foo value='baa'}{$foo} <-- displays "baa", see {assign} + + Many other combinations are allowed + + {$foo.bar.baz} + {$foo.$bar.$baz} + {$foo[4].baz} + {$foo[4].$baz} + {$foo.bar.baz[4]} + {$foo->bar($baz,2,$bar)} <-- passing parameters + {"foo"} <-- static values are allowed + + {* display the server variable "SERVER_NAME" ($_SERVER['SERVER_NAME'])*} + {$smarty.server.SERVER_NAME} + + Math and embedding tags: + + {$x+$y} // will output the sum of x and y. + {assign var=foo value=$x+$y} // in attributes + {$foo[$x+3]} // as array index + {$foo={counter}+3} // tags within tags + {$foo="this is message {counter}"} // tags within double quoted strings + + Defining Arrays: + + {assign var=foo value=[1,2,3]} + {assign var=foo value=['y'=>'yellow','b'=>'blue']} + {assign var=foo value=[1,[9,8],3]} // can be nested + + Short variable assignment: + + {$foo=$bar+2} + {$foo = strlen($bar)} // function in assignment + {$foo = myfunct( ($x+$y)*3 )} // as function parameter + {$foo.bar=1} // assign to specific array element + {$foo.bar.baz=1} + {$foo[]=1} // appending to an array + + Smarty "dot" syntax (note: embedded {} are used to address ambiguities): + + {$foo.a.b.c} => $foo['a']['b']['c'] + {$foo.a.$b.c} => $foo['a'][$b]['c'] // with variable index + {$foo.a.{$b+4}.c} => $foo['a'][$b+4]['c'] // with expression as index + {$foo.a.{$b.c}} => $foo['a'][$b['c']] // with nested index + + PHP-like syntax, alternative to "dot" syntax: + + {$foo[1]} // normal access + {$foo['bar']} + {$foo['bar'][1]} + {$foo[$x+$x]} // index may contain any expression + {$foo[$bar[1]]} // nested index + {$foo[section_name]} // smarty {section} access, not array access! + + Variable variables: + + $foo // normal variable + $foo_{$bar} // variable name containing other variable + $foo_{$x+$y} // variable name containing expressions + $foo_{$bar}_buh_{$blar} // variable name with multiple segments + {$foo_{$x}} // will output the variable $foo_1 if $x has a value of 1. + + Object chaining: + + {$object->method1($x)->method2($y)} + + Direct PHP function access: + + {time()} + + + + +> **Note** +> +> Although Smarty can handle some very complex expressions and syntax, +> it is a good rule of thumb to keep the template syntax minimal and +> focused on presentation. If you find your template syntax getting too +> complex, it may be a good idea to move the bits that do not deal +> explicitly with presentation to PHP by way of plugins or modifiers. + +Request variables such as `$_GET`, `$_SESSION`, etc are available via +the reserved [`$smarty`](#language.variables.smarty) variable. + +See also [`$smarty`](#language.variables.smarty), [config +variables](#language.config.variables) +[`{assign}`](#language.function.assign) and [`assign()`](#api.assign). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions.md new file mode 100644 index 000000000..6c0879d6c --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions.md @@ -0,0 +1,39 @@ +Built-in Functions {#language.builtin.functions} +================== + +## Table of contents +- [{$var=...}](./language-builtin-functions/language-function-shortform-assign.md) +- [{append}](./language-builtin-functions/language-function-append.md) +- [{assign}](./language-builtin-functions/language-function-assign.md) +- [{block}](./language-builtin-functions/language-function-block.md) +- [{call}](./language-builtin-functions/language-function-call.md) +- [{capture}](./language-builtin-functions/language-function-capture.md) +- [{config_load}](./language-builtin-functions/language-function-config.load) +- [{debug}](./language-builtin-functions/language-function-debug.md) +- [{extends}](./language-builtin-functions/language-function-extends.md) +- [{for}](./language-builtin-functions/language-function-for.md) +- [{foreach},{foreachelse}](./language-builtin-functions/language-function-foreach.md) +- [{function}](./language-builtin-functions/language-function-function.md) +- [{if},{elseif},{else}](./language-builtin-functions/language-function-if.md) +- [{include}](./language-builtin-functions/language-function-include.md) +- [{include_php}](./language-builtin-functions/language-function-include.php) +- [{insert}](./language-builtin-functions/language-function-insert.md) +- [{ldelim},{rdelim}](./language-builtin-functions/language-function-ldelim.md) +- [{literal}](./language-builtin-functions/language-function-literal.md) +- [{nocache}](./language-builtin-functions/language-function-nocache.md) +- [{section},{sectionelse}](./language-builtin-functions/language-function-section.md) +- [{setfilter}](./language-builtin-functions/language-function-setfilter.md) +- [{strip}](./language-builtin-functions/language-function-strip.md) +- [{while}](./language-builtin-functions/language-function-while.md) + +Smarty comes with several built-in functions. These built-in functions +are the integral part of the smarty template engine. They are compiled +into corresponding inline PHP code for maximum performance. + +You cannot create your own [custom +functions](./language-custom-functions.md) with the same name; and you +should not need to modify the built-in functions. + +A few of these functions have an `assign` attribute which collects the +result the function to a named template variable instead of being +output; much like the [`{assign}`](./language-builtin-functions/language-function-assign.md) function. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-append.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-append.md new file mode 100644 index 000000000..62f2c7e19 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-append.md @@ -0,0 +1,49 @@ +{append} {#language.function.append} +======== + +`{append}` is used for creating or appending template variable arrays +**during the execution of a template**. + +> **Note** +> +> Assignment of variables in-template is essentially placing application +> logic into the presentation that may be better handled in PHP. Use at +> your own discretion. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ---------------------------------------------------------------------------------------------------- + var string Yes *n/a* The name of the variable being assigned + value string Yes *n/a* The value being assigned + index string No *n/a* The index for the new array element. If not specified the value is append to the end of the array. + scope string No *n/a* The scope of the assigned variable: \'parent\',\'root\' or \'global\' + +**Option Flags:** + + Name Description + --------- ----------------------------------------------------- + nocache Assigns the variable with the \'nocache\' attribute + + + {append var='name' value='Bob' index='first'} + {append var='name' value='Meyer' index='last'} + // or + {append 'name' 'Bob' index='first'} {* short-hand *} + {append 'name' 'Meyer' index='last'} {* short-hand *} + + The first name is {$name.first}.<br> + The last name is {$name.last}. + + + +The above example will output: + + + The first name is Bob. + The last name is Meyer. + + + +See also [`append()`](#api.append) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-assign.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-assign.md new file mode 100644 index 000000000..3d3615bff --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-assign.md @@ -0,0 +1,149 @@ +{assign} {#language.function.assign} +======== + +`{assign}` is used for assigning template variables **during the +execution of a template**. + +> **Note** +> +> Assignment of variables in-template is essentially placing application +> logic into the presentation that may be better handled in PHP. Use at +> your own discretion. + +> **Note** +> +> See also the [`short-form`](#language.function.shortform.assign) +> method of assigning template vars. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ----------------------------------------------------------------------- + var string Yes *n/a* The name of the variable being assigned + value string Yes *n/a* The value being assigned + scope string No *n/a* The scope of the assigned variable: \'parent\',\'root\' or \'global\' + +**Option Flags:** + + Name Description + --------- ----------------------------------------------------- + nocache Assigns the variable with the \'nocache\' attribute + + + {assign var="name" value="Bob"} + {assign "name" "Bob"} {* short-hand *} + + The value of $name is {$name}. + + + +The above example will output: + + + The value of $name is Bob. + + + + + {assign var="name" value="Bob" nocache} + {assign "name" "Bob" nocache} {* short-hand *} + + The value of $name is {$name}. + + + +The above example will output: + + + The value of $name is Bob. + + + + + {assign var=running_total value=$running_total+$some_array[$row].some_value} + + + +Variables assigned in the included template will be seen in the +including template. + + + {include file="sub_template.tpl"} + ... + {* display variable assigned in sub_template *} + {$foo}<br> + ... + + + +The template above includes the example `sub_template.tpl` below + + + ... + {* foo will be known also in the including template *} + {assign var="foo" value="something" scope=parent} + {* bar is assigned only local in the including template *} + {assign var="bar" value="value"} + ... + +You can assign a variable to root of the current root tree. The variable +is seen by all templates using the same root tree. + + + {assign var=foo value="bar" scope="root"} + + + +A global variable is seen by all templates. + + + {assign var=foo value="bar" scope="global"} + {assign "foo" "bar" scope="global"} {* short-hand *} + + + +To access `{assign}` variables from a php script use +[`getTemplateVars()`](#api.get.template.vars). Here\'s the template that +creates the variable `$foo`. + + + {assign var="foo" value="Smarty"} + +The template variables are only available after/during template +execution as in the following script. + + + <?php + + // this will output nothing as the template has not been executed + echo $smarty->getTemplateVars('foo'); + + // fetch the template to a variable + $whole_page = $smarty->fetch('index.tpl'); + + // this will output 'smarty' as the template has been executed + echo $smarty->getTemplateVars('foo'); + + $smarty->assign('foo','Even smarter'); + + // this will output 'Even smarter' + echo $smarty->getTemplateVars('foo'); + + ?> + +The following functions can also *optionally* assign template variables. + +[`{capture}`](#language.function.capture), +[`{include}`](#language.function.include), +[`{include_php}`](#language.function.include.php), +[`{insert}`](#language.function.insert), +[`{counter}`](#language.function.counter), +[`{cycle}`](#language.function.cycle), +[`{eval}`](#language.function.eval), +[`{fetch}`](#language.function.fetch), +[`{math}`](#language.function.math), +[`{textformat}`](#language.function.textformat) + +See also [`{$var=...}`](#language.function.shortform.assign), +[`assign()`](#api.assign) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-block.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-block.md new file mode 100644 index 000000000..941997a55 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-block.md @@ -0,0 +1,191 @@ +{block} {#language.function.block} +======= + +`{block}` is used to define a named area of template source for template +inheritance. For details see section of [Template +Interitance](#advanced.features.template.inheritance). + +The `{block}` template source area of a child template will replace the +correponding areas in the parent template(s). + +Optionally `{block}` areas of child and parent templates can be merged +into each other. You can append or prepend the parent `{block}` content +by using the `append` or `prepend` option flag with the childs `{block}` +definition. With the {\$smarty.block.parent} the `{block}` content of +the parent template can be inserted at any location of the child +`{block}` content. {\$smarty.block.child} inserts the `{block}` content +of the child template at any location of the parent `{block}`. + +`{blocks}'s` can be nested. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- --------------------------------------- + name string Yes *n/a* The name of the template source block + +**Option Flags (in child templates only):** + + Name Description + --------- ------------------------------------------------------------------------------------------- + append The `{block}` content will be be appended to the content of the parent template `{block}` + prepend The `{block}` content will be prepended to the content of the parent template `{block}` + hide Ignore the block content if no child block of same name is existing. + nocache Disables caching of the `{block}` content + +parent.tpl + + + <html> + <head> + <title>{block name="title"}Default Title{/block}</title> + <title>{block "title"}Default Title{/block}</title> {* short-hand *} + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title"} + Page Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>Page Title</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"}Title - {/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title" prepend} + Page Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>Title - Page Title</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"} is my title{/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title" append} + Page Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>Page title is my titel</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"}The {$smarty.block.child} was inserted here{/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title"} + Child Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>The Child Title was inserted here</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"}Parent Title{/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title"} + You will see now - {$smarty.block.parent} - here + {/block} + + + +The result would look like + + + <html> + <head> + <title>You will see now - Parent Title - here</title> + </head> + </html> + +See also [Template +Inheritance](#advanced.features.template.inheritance), +[`$smarty.block.parent`](#language.variables.smarty.block.parent), +[`$smarty.block.child`](#language.variables.smarty.block.child), and +[`{extends}`](#language.function.extends) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-call.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-call.md new file mode 100644 index 000000000..786f0c10c --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-call.md @@ -0,0 +1,76 @@ +{call} {#language.function.call} +====== + +`{call}` is used to call a template function defined by the +[`{function}`](#language.function.function) tag just like a plugin +function. + +> **Note** +> +> Template functions are defined global. Since the Smarty compiler is a +> single-pass compiler, The [`{call}`](#language.function.call) tag must +> be used to call a template function defined externally from the given +> template. Otherwise you can directly use the function as +> `{funcname ...}` in the template. + +- The `{call}` tag must have the `name` attribute which contains the + the name of the template function. + +- Values for variables can be passed to the template function as + [attributes](#language.syntax.attributes). + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------------- ---------- --------- ------------------------------------------------------------------------------------------ + name string Yes *n/a* The name of the template function + assign string No *n/a* The name of the variable that the output of called template function will be assigned to + \[var \...\] \[var type\] No *n/a* variable to pass local to template function + +**Option Flags:** + + Name Description + --------- -------------------------------------------- + nocache Call the template function in nocache mode + + + {* define the function *} + {function name=menu level=0} + <ul class="level{$level}"> + {foreach $data as $entry} + {if is_array($entry)} + <li>{$entry@key}</li> + {call name=menu data=$entry level=$level+1} + {else} + <li>{$entry}</li> + {/if} + {/foreach} + </ul> + {/function} + + {* create an array to demonstrate *} + {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' => + ['item3-3-1','item3-3-2']],'item4']} + + {* run the array through the function *} + {call name=menu data=$menu} + {call menu data=$menu} {* short-hand *} + + + +Will generate the following output + + + * item1 + * item2 + * item3 + o item3-1 + o item3-2 + o item3-3 + + item3-3-1 + + item3-3-2 + * item4 + + + +See also [`{function}`](#language.function.function) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-capture.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-capture.md new file mode 100644 index 000000000..9121b2874 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-capture.md @@ -0,0 +1,82 @@ +{capture} {#language.function.capture} +========= + +`{capture}` is used to collect the output of the template between the +tags into a variable instead of displaying it. Any content between +`{capture name='foo'}` and `{/capture}` is collected into the variable +specified in the `name` attribute. + +The captured content can be used in the template from the variable +[`$smarty.capture.foo`](#language.variables.smarty.capture) where "foo" +is the value passed in the `name` attribute. If you do not supply the +`name` attribute, then "default" will be used as the name ie +`$smarty.capture.default`. + +`{capture}'s` can be nested. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ---------------------------------------------------------------------- + name string Yes *n/a* The name of the captured block + assign string No *n/a* The variable name where to assign the captured output to + append string No *n/a* The name of an array variable where to append the captured output to + +**Option Flags:** + + Name Description + --------- ----------------------------------------- + nocache Disables caching of this captured block + +> **Note** +> +> Be careful when capturing [`{insert}`](#language.function.insert) +> output. If you have [`$caching`](#caching) enabled and you have +> [`{insert}`](#language.function.insert) commands that you expect to +> run within cached content, do not capture this content. + + + {* we don't want to print a div tag unless content is displayed *} + {capture name="banner"} + {capture "banner"} {* short-hand *} + {include file="get_banner.tpl"} + {/capture} + + {if $smarty.capture.banner ne ""} + <div id="banner">{$smarty.capture.banner}</div> + {/if} + + + +This example demonstrates the capture function. + + + {capture name=some_content assign=popText} + {capture some_content assign=popText} {* short-hand *} + The server is {$my_server_name|upper} at {$my_server_addr}<br> + Your ip is {$my_ip}. + {/capture} + <a href="#">{$popText}</a> + + + +This example also demonstrates how multiple calls of capture can be used +to create an array with captured content. + + + {capture append="foo"}hello{/capture}I say just {capture append="foo"}world{/capture} + {foreach $foo as $text}{$text} {/foreach} + + + +The above example will output: + + + I say just hello world + + + +See also [`$smarty.capture`](#language.variables.smarty.capture), +[`{eval}`](#language.function.eval), +[`{fetch}`](#language.function.fetch), [`fetch()`](#api.fetch) and +[`{assign}`](#language.function.assign). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md new file mode 100644 index 000000000..750f337c4 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md @@ -0,0 +1,91 @@ +{config\_load} {#language.function.config.load} +============== + +`{config_load}` is used for loading config +[`#variables#`](#language.config.variables) from a [configuration +file](#config.files) into the template. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + file string Yes *n/a* The name of the config file to include + section string No *n/a* The name of the section to load + scope string no *local* How the scope of the loaded variables are treated, which must be one of local, parent or global. local means variables are loaded into the local template context. parent means variables are loaded into both the local context and the parent template that called it. global means variables are available to all templates. + +The `example.conf` file. + + + #this is config file comment + + # global variables + pageTitle = "Main Menu" + bodyBgColor = #000000 + tableBgColor = #000000 + rowBgColor = #00ff00 + + #customer variables section + [Customer] + pageTitle = "Customer Info" + + + +and the template + + + {config_load file="example.conf"} + {config_load "example.conf"} {* short-hand *} + + <html> + <title>{#pageTitle#|default:"No title"}</title> + <body bgcolor="{#bodyBgColor#}"> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +[Config Files](#config.files) may also contain sections. You can load +variables from within a section with the added attribute `section`. Note +that global config variables are always loaded along with section +variables, and same-named section variables overwrite the globals. + +> **Note** +> +> Config file *sections* and the built-in template function called +> [`{section}`](#language.function.section) have nothing to do with each +> other, they just happen to share a common naming convention. + + + {config_load file='example.conf' section='Customer'} + {config_load 'example.conf' 'Customer'} {* short-hand *} + + <html> + <title>{#pageTitle#}</title> + <body bgcolor="{#bodyBgColor#}"> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +See [`$config_overwrite`](#variable.config.overwrite) to create arrays +of config file variables. + +See also the [config files](#config.files) page, [config +variables](#language.config.variables) page, +[`$config_dir`](#variable.config.dir), +[`getConfigVars()`](#api.get.config.vars) and +[`configLoad()`](#api.config.load). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-debug.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-debug.md new file mode 100644 index 000000000..fbaae1944 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-debug.md @@ -0,0 +1,18 @@ +{debug} {#language.function.debug} +======= + +`{debug}` dumps the debug console to the page. This works regardless of +the [debug](#chapter.debugging.console) settings in the php script. +Since this gets executed at runtime, this is only able to show the +[assigned](#api.assign) variables; not the templates that are in use. +However, you can see all the currently available variables within the +scope of a template. + +If caching is enabled and a page is loaded from cache `{debug}` does +show only the variables which assigned for the cached page. + +In order to see also the variables which have been locally assigned +within the template it does make sense to place the `{debug}` tag at the +end of the template. + +See also the [debugging console page](#chapter.debugging.console). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-extends.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-extends.md new file mode 100644 index 000000000..9559e7c5e --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-extends.md @@ -0,0 +1,37 @@ +{extends} {#language.function.extends} +========= + +`{extends}` tags are used in child templates in template inheritance for +extending parent templates. For details see section of [Template +Interitance](#advanced.features.template.inheritance). + +- The `{extends}` tag must be on the first line of the template. + +- If a child template extends a parent template with the `{extends}` + tag it may contain only `{block}` tags. Any other template content + is ignored. + +- Use the syntax for [template resources](#resources) to extend files + outside of the [`$template_dir`](#variable.template.dir) directory. + +> **Note** +> +> When extending a variable parent like `{extends file=$parent_file}`, +> make sure you include `$parent_file` in the +> [`$compile_id`](#variable.compile.id). Otherwise Smarty cannot +> distinguish between different `$parent_file`s. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ------------------------------------------------- + file string Yes *n/a* The name of the template file which is extended + + + {extends file='parent.tpl'} + {extends 'parent.tpl'} {* short-hand *} + + + +See also [Template Interitance](#advanced.features.template.inheritance) +and [`{block}`](#language.function.block). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-for.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-for.md new file mode 100644 index 000000000..0545c1729 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-for.md @@ -0,0 +1,97 @@ +{for} {#language.function.for} +===== + +The `{for}{forelse}` tag is used to create simple loops. The following +different formarts are supported: + +- `{for $var=$start to $end}` simple loop with step size of 1. + +- `{for $var=$start to $end step $step}` loop with individual step + size. + +`{forelse}` is executed when the loop is not iterated. + +**Attributes:** + + Attribute Name Shorthand Type Required Default Description + ---------------- ----------- --------- ---------- --------- -------------------------------- + max n/a integer No *n/a* Limit the number of iterations + +**Option Flags:** + + Name Description + --------- -------------------------------------- + nocache Disables caching of the `{for}` loop + + + <ul> + {for $foo=1 to 3} + <li>{$foo}</li> + {/for} + </ul> + + + +The above example will output: + + + <ul> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + + + + + $smarty->assign('to',10); + + + + + <ul> + {for $foo=3 to $to max=3} + <li>{$foo}</li> + {/for} + </ul> + + + +The above example will output: + + + <ul> + <li>3</li> + <li>4</li> + <li>5</li> + </ul> + + + + + $smarty->assign('start',10); + $smarty->assign('to',5); + + + + + <ul> + {for $foo=$start to $to} + <li>{$foo}</li> + {forelse} + no iteration + {/for} + </ul> + + + +The above example will output: + + + no iteration + + + +See also [`{foreach}`](#language.function.foreach), +[`{section}`](#language.function.section) and +[`{while}`](#language.function.while) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-foreach.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-foreach.md new file mode 100644 index 000000000..fdd740148 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-foreach.md @@ -0,0 +1,407 @@ +{foreach},{foreachelse} {#language.function.foreach} +======================= + +`{foreach}` is used for looping over arrays of data. `{foreach}` has a +simpler and cleaner syntax than the +[`{section}`](#language.function.section) loop, and can also loop over +associative arrays. + +`{foreach $arrayvar as $itemvar}` + +`{foreach $arrayvar as $keyvar=>$itemvar}` + +> **Note** +> +> This foreach syntax does not accept any named attributes. This syntax +> is new to Smarty 3, however the Smarty 2.x syntax +> `{foreach from=$myarray key="mykey" item="myitem"}` is still +> supported. + +- `{foreach}` loops can be nested. + +- The `array` variable, usually an array of values, determines the + number of times `{foreach}` will loop. You can also pass an integer + for arbitrary loops. + +- `{foreachelse}` is executed when there are no values in the `array` + variable. + +- `{foreach}` properties are [`@index`](#foreach.property.index), + [`@iteration`](#foreach.property.iteration), + [`@first`](#foreach.property.first), + [`@last`](#foreach.property.last), + [`@show`](#foreach.property.show), + [`@total`](#foreach.property.total). + +- `{foreach}` constructs are [`{break}`](#foreach.construct.break), + [`{continue}`](#foreach.construct.continue). + +- Instead of specifying the `key` variable you can access the current + key of the loop item by `{$item@key}` (see examples below). + +> **Note** +> +> The `$var@property` syntax is new to Smarty 3, however when using the +> Smarty 2 `{foreach from=$myarray key="mykey" item="myitem"}` style +> syntax, the `$smarty.foreach.name.property` syntax is still supported. + +> **Note** +> +> Although you can retrieve the array key with the syntax +> `{foreach $myArray as $myKey => $myValue}`, the key is always +> available as `$myValue@key` within the foreach loop. + +**Option Flags:** + + Name Description + --------- ------------------------------------------ + nocache Disables caching of the `{foreach}` loop + + + <?php + $arr = array('red', 'green', 'blue'); + $smarty->assign('myColors', $arr); + ?> + + + +Template to output `$myColors` in an un-ordered list + + + <ul> + {foreach $myColors as $color} + <li>{$color}</li> + {/foreach} + </ul> + + + +The above example will output: + + + <ul> + <li>red</li> + <li>green</li> + <li>blue</li> + </ul> + + + + + <?php + $people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com'); + $smarty->assign('myPeople', $people); + ?> + + + +Template to output `$myArray` as key/value pairs. + + + <ul> + {foreach $myPeople as $value} + <li>{$value@key}: {$value}</li> + {/foreach} + </ul> + + + +The above example will output: + + + <ul> + <li>fname: John</li> + <li>lname: Doe</li> + <li>email: j.doe@example.com</li> + </ul> + + + +Assign an array to Smarty, the key contains the key for each looped +value. + + + <?php + $smarty->assign('contacts', array( + array('phone' => '555-555-1234', + 'fax' => '555-555-5678', + 'cell' => '555-555-0357'), + array('phone' => '800-555-4444', + 'fax' => '800-555-3333', + 'cell' => '800-555-2222') + )); + ?> + + + +The template to output `$contact`. + + + {* key always available as a property *} + {foreach $contacts as $contact} + {foreach $contact as $value} + {$value@key}: {$value} + {/foreach} + {/foreach} + + {* accessing key the PHP syntax alternate *} + {foreach $contacts as $contact} + {foreach $contact as $key => $value} + {$key}: {$value} + {/foreach} + {/foreach} + + + +Either of the above examples will output: + + + phone: 555-555-1234 + fax: 555-555-5678 + cell: 555-555-0357 + phone: 800-555-4444 + fax: 800-555-3333 + cell: 800-555-2222 + + + +A database (PDO) example of looping over search results. This example is +looping over a PHP iterator instead of an array(). + + + <?php + include('Smarty.class.php'); + + $smarty = new Smarty; + + $dsn = 'mysql:host=localhost;dbname=test'; + $login = 'test'; + $passwd = 'test'; + + // setting PDO to use buffered queries in mysql is + // important if you plan on using multiple result cursors + // in the template. + + $db = new PDO($dsn, $login, $passwd, array( + PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true)); + + $res = $db->prepare("select * from users"); + $res->execute(); + $res->setFetchMode(PDO::FETCH_LAZY); + + // assign to smarty + $smarty->assign('res',$res); + + $smarty->display('index.tpl');?> + ?> + + + + + {foreach $res as $r} + {$r.id} + {$r.name} + {foreachelse} + .. no results .. + {/foreach} + + + +The above is assuming the results contain the columns named `id` and +`name`. + +What is the advantage of an iterator vs. looping over a plain old array? +With an array, all the results are accumulated into memory before being +looped. With an iterator, each result is loaded/released within the +loop. This saves processing time and memory, especially for very large +result sets. + +\@index {#foreach.property.index} +------- + +`index` contains the current array index, starting with zero. + + + {* output empty row on the 4th iteration (when index is 3) *} + <table> + {foreach $items as $i} + {if $i@index eq 3} + {* put empty table row *} + <tr><td>nbsp;</td></tr> + {/if} + <tr><td>{$i.label}</td></tr> + {/foreach} + </table> + + + +\@iteration {#foreach.property.iteration} +----------- + +`iteration` contains the current loop iteration and always starts at +one, unlike [`index`](#foreach.property.index). It is incremented by one +on each iteration. + +The *\"is div by\"* operator can be used to detect a specific iteration. +Here we bold-face the name every 4th iteration. + + + {foreach $myNames as $name} + {if $name@iteration is div by 4} + <b>{$name}</b> + {/if} + {$name} + {/foreach} + +The *\"is even by\"* and *\"is odd by\"* operators can be used to +alternate something every so many iterations. Choosing between even or +odd rotates which one starts. Here we switch the font color every 3rd +iteration. + + + {foreach $myNames as $name} + {if $name@iteration is even by 3} + <span style="color: #000">{$name}</span> + {else} + <span style="color: #eee">{$name}</span> + {/if} + {/foreach} + + + +This will output something similar to this: + + + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + ... + + + +\@first {#foreach.property.first} +------- + +`first` is TRUE if the current `{foreach}` iteration is the initial one. +Here we display a table header row on the first iteration. + + + {* show table header at first iteration *} + <table> + {foreach $items as $i} + {if $i@first} + <tr> + <th>key</td> + <th>name</td> + </tr> + {/if} + <tr> + <td>{$i@key}</td> + <td>{$i.name}</td> + </tr> + {/foreach} + </table> + + + +\@last {#foreach.property.last} +------ + +`last` is set to TRUE if the current `{foreach}` iteration is the final +one. Here we display a horizontal rule on the last iteration. + + + {* Add horizontal rule at end of list *} + {foreach $items as $item} + <a href="#{$item.id}">{$item.name}</a>{if $item@last}<hr>{else},{/if} + {foreachelse} + ... no items to loop ... + {/foreach} + + + +\@show {#foreach.property.show} +------ + +The show `show` property can be used after the execution of a +`{foreach}` loop to detect if data has been displayed or not. `show` is +a boolean value. + + + <ul> + {foreach $myArray as $name} + <li>{$name}</li> + {/foreach} + </ul> + {if $name@show} do something here if the array contained data {/if} + +\@total {#foreach.property.total} +------- + +`total` contains the number of iterations that this `{foreach}` will +loop. This can be used inside or after the `{foreach}`. + + + {* show number of rows at end *} + {foreach $items as $item} + {$item.name}<hr/> + {if $item@last} + <div id="total">{$item@total} items</div> + {/if} + {foreachelse} + ... no items to loop ... + {/foreach} + +See also [`{section}`](#language.function.section), +[`{for}`](#language.function.for) and +[`{while}`](#language.function.while) + +{break} {#foreach.construct.break} +------- + +`{break}` aborts the iteration of the array + + + {$data = [1,2,3,4,5]} + {foreach $data as $value} + {if $value == 3} + {* abort iterating the array *} + {break} + {/if} + {$value} + {/foreach} + {* + prints: 1 2 + *} + + + +{continue} {#foreach.construct.continue} +---------- + +`{continue}` leaves the current iteration and begins with the next +iteration. + + + {$data = [1,2,3,4,5]} + {foreach $data as $value} + {if $value == 3} + {* skip this iteration *} + {continue} + {/if} + {$value} + {/foreach} + {* + prints: 1 2 4 5 + *} + + diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-function.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-function.md new file mode 100644 index 000000000..647e4bfc8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-function.md @@ -0,0 +1,88 @@ +{function} {#language.function.function} +========== + +`{function}` is used to create functions within a template and call them +just like a plugin function. Instead of writing a plugin that generates +presentational content, keeping it in the template is often a more +manageable choice. It also simplifies data traversal, such as deeply +nested menus. + +> **Note** +> +> Template functions are defined global. Since the Smarty compiler is a +> single-pass compiler, The [`{call}`](#language.function.call) tag must +> be used to call a template function defined externally from the given +> template. Otherwise you can directly use the function as +> `{funcname ...}` in the template. + +- The `{function}` tag must have the `name` attribute which contains + the the name of the template function. A tag with this name can be + used to call the template function. + +- Default values for variables can be passed to the template function + as [attributes](#language.syntax.attributes). Like in PHP function + declarations you can only use scalar values as default. The default + values can be overwritten when the template function is being + called. + +- You can use all variables from the calling template inside the + template function. Changes to variables or new created variables + inside the template function have local scope and are not visible + inside the calling template after the template function is executed. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------------- ---------- --------- --------------------------------------------------------------- + name string Yes *n/a* The name of the template function + \[var \...\] \[var type\] No *n/a* default variable value to pass local to the template function + +> **Note** +> +> You can pass any number of parameter to the template function when it +> is called. The parameter variables must not be declared in the +> `{funcname ...}` tag unless you what to use default values. Default +> values must be scalar and can not be variable. Variables must be +> passed when the template is called. + + + {* define the function *} + {function name=menu level=0} + {function menu level=0} {* short-hand *} + <ul class="level{$level}"> + {foreach $data as $entry} + {if is_array($entry)} + <li>{$entry@key}</li> + {menu data=$entry level=$level+1} + {else} + <li>{$entry}</li> + {/if} + {/foreach} + </ul> + {/function} + + {* create an array to demonstrate *} + {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' => + ['item3-3-1','item3-3-2']],'item4']} + + {* run the array through the function *} + {menu data=$menu} + + + +Will generate the following output + + + * item1 + * item2 + * item3 + o item3-1 + o item3-2 + o item3-3 + + item3-3-1 + + item3-3-2 + * item4 + + + +See also [`{call}`](#language.function.call) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-if.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-if.md new file mode 100644 index 000000000..2c1d68eea --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-if.md @@ -0,0 +1,121 @@ +{if},{elseif},{else} {#language.function.if} +==================== + +`{if}` statements in Smarty have much the same flexibility as PHP +[if](&url.php-manual;if) statements, with a few added features for the +template engine. Every `{if}` must be paired with a matching `{/if}`. +`{else}` and `{elseif}` are also permitted. All PHP conditionals and +functions are recognized, such as *\|\|*, *or*, *&&*, *and*, +*is\_array()*, etc. + +If securty is enabled, only PHP functions from `$php_functions` property +of the securty policy are allowed. See the +[Security](#advanced.features.security) section for details. + +The following is a list of recognized qualifiers, which must be +separated from surrounding elements by spaces. Note that items listed in +\[brackets\] are optional. PHP equivalents are shown where applicable. + + Qualifier Alternates Syntax Example Meaning PHP Equivalent + -------------------- ------------ ------------------------ -------------------------------- ---------------------- + == eq \$a eq \$b equals == + != ne, neq \$a neq \$b not equals != + \> gt \$a gt \$b greater than \> + \< lt \$a lt \$b less than \< + \>= gte, ge \$a ge \$b greater than or equal \>= + \<= lte, le \$a le \$b less than or equal \<= + === \$a === 0 check for identity === + ! not not \$a negation (unary) ! + \% mod \$a mod \$b modulous \% + is \[not\] div by \$a is not div by 4 divisible by \$a % \$b == 0 + is \[not\] even \$a is not even \[not\] an even number (unary) \$a % 2 == 0 + is \[not\] even by \$a is not even by \$b grouping level \[not\] even (\$a / \$b) % 2 == 0 + is \[not\] odd \$a is not odd \[not\] an odd number (unary) \$a % 2 != 0 + is \[not\] odd by \$a is not odd by \$b \[not\] an odd grouping (\$a / \$b) % 2 != 0 + + + {if $name eq 'Fred'} + Welcome Sir. + {elseif $name eq 'Wilma'} + Welcome Ma'am. + {else} + Welcome, whatever you are. + {/if} + + {* an example with "or" logic *} + {if $name eq 'Fred' or $name eq 'Wilma'} + ... + {/if} + + {* same as above *} + {if $name == 'Fred' || $name == 'Wilma'} + ... + {/if} + + + {* parenthesis are allowed *} + {if ( $amount < 0 or $amount > 1000 ) and $volume >= #minVolAmt#} + ... + {/if} + + + {* you can also embed php function calls *} + {if count($var) gt 0} + ... + {/if} + + {* check for array. *} + {if is_array($foo) } + ..... + {/if} + + {* check for not null. *} + {if isset($foo) } + ..... + {/if} + + + {* test if values are even or odd *} + {if $var is even} + ... + {/if} + {if $var is odd} + ... + {/if} + {if $var is not odd} + ... + {/if} + + + {* test if var is divisible by 4 *} + {if $var is div by 4} + ... + {/if} + + + {* + test if var is even, grouped by two. i.e., + 0=even, 1=even, 2=odd, 3=odd, 4=even, 5=even, etc. + *} + {if $var is even by 2} + ... + {/if} + + {* 0=even, 1=even, 2=even, 3=odd, 4=odd, 5=odd, etc. *} + {if $var is even by 3} + ... + {/if} + + + + + {if isset($name) && $name == 'Blog'} + {* do something *} + {elseif $name == $foo} + {* do something *} + {/if} + + {if is_array($foo) && count($foo) > 0} + {* do a foreach loop *} + {/if} + diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include-php.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include-php.md new file mode 100644 index 000000000..8fc074a2b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include-php.md @@ -0,0 +1,74 @@ +{include\_php} {#language.function.include.php} +============== + +> **Note** +> +> `{include_php}` is deprecated from Smarty, use registered plugins to +> properly insulate presentation from the application code. As of Smarty +> 3.1 the `{include_php}` tags are only available from [SmartyBC](#bc). + + Attribute Name Type Required Default Description + ---------------- --------- ---------- --------- ---------------------------------------------------------------------------------- + file string Yes *n/a* The name of the php file to include as absolute path + once boolean No *TRUE* whether or not to include the php file more than once if included multiple times + assign string No *n/a* The name of the variable that the output of include\_php will be assigned to + +**Option Flags:** + + Name Description + --------- ---------------------------------------- + nocache Disables caching of inluded PHP script + +`{include_php}` tags are used to include a php script in your template. +The path of the attribute `file` can be either absolute, or relative to +[`$trusted_dir`](#variable.trusted.dir). If security is enabled, then +the script must be located in the `$trusted_dir` path of the securty +policy. See the [Security](#advanced.features.security) section for +details. + +By default, php files are only included once even if called multiple +times in the template. You can specify that it should be included every +time with the `once` attribute. Setting once to FALSE will include the +php script each time it is included in the template. + +You can optionally pass the `assign` attribute, which will specify a +template variable name that the output of `{include_php}` will be +assigned to instead of displayed. + +The smarty object is available as `$_smarty_tpl->smarty` within the PHP +script that you include. + +The `load_nav.php` file: + + + <?php + + // load in variables from a mysql db and assign them to the template + require_once('database.class.php'); + $db = new Db(); + $db->query('select url, name from navigation order by name'); + $this->assign('navigation', $db->getRows()); + + ?> + + + +where the template is: + + + {* absolute path, or relative to $trusted_dir *} + {include_php file='/path/to/load_nav.php'} + {include_php '/path/to/load_nav.php'} {* short-hand *} + + {foreach item='nav' from=$navigation} + <a href="{$nav.url}">{$nav.name}</a><br /> + {/foreach} + + + +See also [`{include}`](#language.function.include), +[`$trusted_dir`](#variable.trusted.dir), +[`{php}`](#language.function.php), +[`{capture}`](#language.function.capture), [template +resources](#resources) and [componentized +templates](#tips.componentized.templates) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include.md new file mode 100644 index 000000000..956d893e6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include.md @@ -0,0 +1,194 @@ +{include} {#language.function.include} +========= + +`{include}` tags are used for including other templates in the current +template. Any variables available in the current template are also +available within the included template. + +- The `{include}` tag must have the `file` attribute which contains + the template resource path. + +- Setting the optional `assign` attribute specifies the template + variable that the output of `{include}` is assigned to, instead of + being displayed. Similar to [`{assign}`](#language.function.assign). + +- Variables can be passed to included templates as + [attributes](#language.syntax.attributes). Any variables explicitly + passed to an included template are only available within the scope + of the included file. Attribute variables override current template + variables, in the case when they are named the same. + +- You can use all variables from the including template inside the + included template. But changes to variables or new created variables + inside the included template have local scope and are not visible + inside the including template after the `{include}` statement. This + default behaviour can be changed for all variables assigned in the + included template by using the scope attribute at the `{include}` + statement or for individual variables by using the scope attribute + at the [`{assign}`](#language.function.assign) statement. The later + is useful to return values from the included template to the + including template. + +- Use the syntax for [template resources](#resources) to `{include}` + files outside of the [`$template_dir`](#variable.template.dir) + directory. + +**Attributes:** + + Attribute Name Type Required Default Description + ----------------- ---------------- ---------- --------- -------------------------------------------------------------------------------------------------- + file string Yes *n/a* The name of the template file to include + assign string No *n/a* The name of the variable that the output of include will be assigned to + cache\_lifetime integer No *n/a* Enable caching of this subtemplate with an individual cache lifetime + compile\_id string/integer No *n/a* Compile this subtemplate with an individual compile\_id + cache\_id string/integer No *n/a* Enable caching of this subtemplate with an individual cache\_id + scope string No *n/a* Define the scope of all in the subtemplate assigned variables: \'parent\',\'root\' or \'global\' + \[var \...\] \[var type\] No *n/a* variable to pass local to template + +**Option Flags:** + + Name Description + --------- ------------------------------------------------------------------------------------- + nocache Disables caching of this subtemplate + caching Enable caching of this subtemplate + inline If set merge the compile code of the subtemplate into the compiled calling template + + + <html> + <head> + <title>{$title}</title> + </head> + <body> + {include file='page_header.tpl'} + + {* body of template goes here, the $tpl_name variable + is replaced with a value eg 'contact.tpl' + *} + {include file="$tpl_name.tpl"} + + {* using shortform file attribute *} + {include 'page_footer.tpl'} + </body> + </html> + + + + + {include 'links.tpl' title='Newest links' links=$link_array} + {* body of template goes here *} + {include 'footer.tpl' foo='bar'} + + + +The template above includes the example `links.tpl` below + + + <div id="box"> + <h3>{$title}{/h3> + <ul> + {foreach from=$links item=l} + .. do stuff ... + </foreach} + </ul> + </div> + +Variables assigned in the included template will be seen in the +including template. + + + {include 'sub_template.tpl' scope=parent} + ... + {* display variables assigned in sub_template *} + {$foo}<br> + {$bar}<br> + ... + + + +The template above includes the example `sub_template.tpl` below + + + ... + {assign var=foo value='something'} + {assign var=bar value='value'} + ... + +The included template will not be cached. + + + {include 'sub_template.tpl' nocache} + ... + + + +In this example included template will be cached with an individual +cache lifetime of 500 seconds. + + + {include 'sub_template.tpl' cache_lifetime=500} + ... + + + +In this example included template will be cached independent of the +global cahing setting. + + + {include 'sub_template.tpl' caching} + ... + + + +This example assigns the contents of `nav.tpl` to the `$navbar` +variable, which is then output at both the top and bottom of the page. + + + <body> + {include 'nav.tpl' assign=navbar} + {include 'header.tpl' title='Smarty is cool'} + {$navbar} + {* body of template goes here *} + {$navbar} + {include 'footer.tpl'} + </body> + + + +This example includes another template relative to the directory of the +current template. + + + {include 'template-in-a-template_dir-directory.tpl'} + {include './template-in-same-directory.tpl'} + {include '../template-in-parent-directory.tpl'} + + + + + {* absolute filepath *} + {include file='/usr/local/include/templates/header.tpl'} + + {* absolute filepath (same thing) *} + {include file='file:/usr/local/include/templates/header.tpl'} + + {* windows absolute filepath (MUST use "file:" prefix) *} + {include file='file:C:/www/pub/templates/header.tpl'} + + {* include from template resource named "db" *} + {include file='db:header.tpl'} + + {* include a $variable template - eg $module = 'contacts' *} + {include file="$module.tpl"} + + {* wont work as its single quotes ie no variable substitution *} + {include file='$module.tpl'} + + {* include a multi $variable template - eg amber/links.view.tpl *} + {include file="$style_dir/$module.$view.tpl"} + + + +See also [`{include_php}`](#language.function.include.php), +[`{insert}`](#language.function.insert), +[`{php}`](#language.function.php), [template resources](#resources) and +[componentized templates](#tips.componentized.templates). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-insert.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-insert.md new file mode 100644 index 000000000..e37c73890 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-insert.md @@ -0,0 +1,86 @@ +{insert} {#language.function.insert} +======== + +> **Note** +> +> `{insert}` tags are deprecated from Smarty, and should not be used. +> Put your PHP logic in PHP scripts or plugin functions instead. + +> **Note** +> +> As of Smarty 3.1 the `{insert}` tags are only available from +> [SmartyBC](#bc). + +`{insert}` tags work much like [`{include}`](#language.function.include) +tags, except that `{insert}` tags are NOT cached when template +[caching](#caching) is enabled. They will be executed on every +invocation of the template. + + Attribute Name Type Required Default Description + ---------------- -------------- ---------- --------- ---------------------------------------------------------------------------------- + name string Yes *n/a* The name of the insert function (insert\_`name`) or insert plugin + assign string No *n/a* The name of the template variable the output will be assigned to + script string No *n/a* The name of the php script that is included before the insert function is called + \[var \...\] \[var type\] No *n/a* variable to pass to insert function + +Let\'s say you have a template with a banner slot at the top of the +page. The banner can contain any mixture of HTML, images, flash, etc. so +we can\'t just use a static link here, and we don\'t want this contents +cached with the page. In comes the {insert} tag: the template knows +\#banner\_location\_id\# and \#site\_id\# values (gathered from a +[config file](#config.files)), and needs to call a function to get the +banner contents. + + {* example of fetching a banner *} + {insert name="getBanner" lid=#banner_location_id# sid=#site_id#} + {insert "getBanner" lid=#banner_location_id# sid=#site_id#} {* short-hand *} + +In this example, we are using the name "getBanner" and passing the +parameters \#banner\_location\_id\# and \#site\_id\#. Smarty will look +for a function named insert\_getBanner() in your PHP application, +passing the values of \#banner\_location\_id\# and \#site\_id\# as the +first argument in an associative array. All {insert} function names in +your application must be prepended with \"insert\_\" to remedy possible +function name-space conflicts. Your insert\_getBanner() function should +do something with the passed values and return the results. These +results are then displayed in the template in place of the {insert} tag. +In this example, Smarty would call this function: +insert\_getBanner(array(\"lid\" =\> \"12345\",\"sid\" =\> \"67890\")); +and display the returned results in place of the {insert} tag. + +- If you supply the `assign` attribute, the output of the `{insert}` + tag will be assigned to this template variable instead of being + output to the template. + + > **Note** + > + > Assigning the output to a template variable isn\'t too useful with + > [caching](#variable.caching) enabled. + +- If you supply the `script` attribute, this php script will be + included (only once) before the `{insert}` function is executed. + This is the case where the insert function may not exist yet, and a + php script must be included first to make it work. + + The path can be either absolute, or relative to + [`$trusted_dir`](#variable.trusted.dir). If security is enabled, + then the script must be located in the `$trusted_dir` path of the + securty policy. See the [Security](#advanced.features.security) + section for details. + +The Smarty object is passed as the second argument. This way you can +reference and modify information in the Smarty object from within the +`{insert}` function. + +If no PHP script can be found Smarty is looking for a corresponding +insert plugin. + +> **Note** +> +> It is possible to have portions of the template not cached. If you +> have [caching](#caching) turned on, `{insert}` tags will not be +> cached. They will run dynamically every time the page is created, even +> within cached pages. This works good for things like banners, polls, +> live weather, search results, user feedback areas, etc. + +See also [`{include}`](#language.function.include) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md new file mode 100644 index 000000000..2afda031a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md @@ -0,0 +1,55 @@ +{ldelim},{rdelim} {#language.function.ldelim} +================= + +`{ldelim}` and `{rdelim}` are used for [escaping](#language.escaping) +template delimiters, by default **{** and **}**. You can also use +[`{literal}{/literal}`](#language.function.literal) to escape blocks of +text eg Javascript or CSS. See also the complementary +[`{$smarty.ldelim}`](#language.variables.smarty.ldelim). + + + {* this will print literal delimiters out of the template *} + + {ldelim}funcname{rdelim} is how functions look in Smarty! + + + +The above example will output: + + + {funcname} is how functions look in Smarty! + + + +Another example with some Javascript + + + <script language="JavaScript"> + function foo() {ldelim} + ... code ... + {rdelim} + </script> + + + +will output + + + <script language="JavaScript"> + function foo() { + .... code ... + } + </script> + + + + + <script language="JavaScript" type="text/javascript"> + function myJsFunction(){ldelim} + alert("The server name\n{$smarty.server.SERVER_NAME}\n{$smarty.server.SERVER_ADDR}"); + {rdelim} + </script> + <a href="javascript:myJsFunction()">Click here for Server Info</a> + +See also [`{literal}`](#language.function.literal) and [escaping Smarty +parsing](#language.escaping). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-literal.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-literal.md new file mode 100644 index 000000000..27ebb3ff4 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-literal.md @@ -0,0 +1,36 @@ +{literal} {#language.function.literal} +========= + +`{literal}` tags allow a block of data to be taken literally. This is +typically used around Javascript or stylesheet blocks where {curly +braces} would interfere with the template +[delimiter](#variable.left.delimiter) syntax. Anything within +`{literal}{/literal}` tags is not interpreted, but displayed as-is. If +you need template tags embedded in a `{literal}` block, consider using +[`{ldelim}{rdelim}`](#language.function.ldelim) to escape the individual +delimiters instead. + +> **Note** +> +> `{literal}{/literal}` tags are normally not necessary, as Smarty +> ignores delimiters that are surrounded by whitespace. Be sure your +> javascript and CSS curly braces are surrounded by whitespace. This is +> new behavior to Smarty 3. + + + <script> + // the following braces are ignored by Smarty + // since they are surrounded by whitespace + function myFoo { + alert('Foo!'); + } + // this one will need literal escapement + {literal} + function myBar {alert('Bar!');} + {/literal} + </script> + + + +See also [`{ldelim} {rdelim}`](#language.function.ldelim) and the +[escaping Smarty parsing](#language.escaping) page. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-nocache.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-nocache.md new file mode 100644 index 000000000..a5922f838 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-nocache.md @@ -0,0 +1,23 @@ +{nocache} {#language.function.nocache} +========= + +`{nocache}` is used to disable caching of a template section. Every +`{nocache}` must be paired with a matching `{/nocache}`. + +> **Note** +> +> Be sure any variables used within a non-cached section are also +> assigned from PHP when the page is loaded from the cache. + + + + Today's date is + {nocache} + {$smarty.now|date_format} + {/nocache} + + + +The above code will output the current date on a cached page. + +See also the [caching section](#caching). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-section.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-section.md new file mode 100644 index 000000000..0bab5c715 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-section.md @@ -0,0 +1,644 @@ +{section},{sectionelse} {#language.function.section} +======================= + +A `{section}` is for looping over **sequentially indexed arrays of +data**, unlike [`{foreach}`](#language.function.foreach) which is used +to loop over a **single associative array**. Every `{section}` tag must +be paired with a closing `{/section}` tag. + +> **Note** +> +> The [`{foreach}`](#language.function.foreach) loop can do everything a +> {section} loop can do, and has a simpler and easier syntax. It is +> usually preferred over the {section} loop. + +> **Note** +> +> {section} loops cannot loop over associative arrays, they must be +> numerically indexed, and sequential (0,1,2,\...). For associative +> arrays, use the [`{foreach}`](#language.function.foreach) loop. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- --------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + name string Yes *n/a* The name of the section + loop mixed Yes *n/a* Value to determine the number of loop iterations + start integer No *0* The index position that the section will begin looping. If the value is negative, the start position is calculated from the end of the array. For example, if there are seven values in the loop array and start is -2, the start index is 5. Invalid values (values outside of the length of the loop array) are automatically truncated to the closest valid value. + step integer No *1* The step value that will be used to traverse the loop array. For example, step=2 will loop on index 0,2,4, etc. If step is negative, it will step through the array backwards. + max integer No *n/a* Sets the maximum number of times the section will loop. + show boolean No *TRUE* Determines whether or not to show this section + +**Option Flags:** + + Name Description + --------- ------------------------------------------ + nocache Disables caching of the `{section}` loop + +- Required attributes are `name` and `loop`. + +- The `name` of the `{section}` can be anything you like, made up of + letters, numbers and underscores, like [PHP + variables](&url.php-manual;language.variables). + +- {section}\'s can be nested, and the nested `{section}` names must be + unique from each other. + +- The `loop` attribute, usually an array of values, determines the + number of times the `{section}` will loop. You can also pass an + integer as the loop value. + +- When printing a variable within a `{section}`, the `{section}` + `name` must be given next to variable name within \[brackets\]. + +- `{sectionelse}` is executed when there are no values in the loop + variable. + +- A `{section}` also has its own variables that handle `{section}` + properties. These properties are accessible as: + [`{$smarty.section.name.property}`](#language.variables.smarty.loops) + where "name" is the attribute `name`. + +- `{section}` properties are [`index`](#section.property.index), + [`index_prev`](#section.property.index.prev), + [`index_next`](#section.property.index.next), + [`iteration`](#section.property.iteration), + [`first`](#section.property.first), + [`last`](#section.property.last), + [`rownum`](#section.property.rownum), + [`loop`](#section.property.loop), [`show`](#section.property.show), + [`total`](#section.property.total). + +[`assign()`](#api.assign) an array to Smarty + + + <?php + $data = array(1000,1001,1002); + $smarty->assign('custid',$data); + ?> + +The template that outputs the array + + + {* this example will print out all the values of the $custid array *} + {section name=customer loop=$custid} + {section customer $custid} {* short-hand *} + id: {$custid[customer]}<br /> + {/section} + <hr /> + {* print out all the values of the $custid array reversed *} + {section name=foo loop=$custid step=-1} + {section foo $custid step=-1} {* short-hand *} + {$custid[foo]}<br /> + {/section} + + + +The above example will output: + + + id: 1000<br /> + id: 1001<br /> + id: 1002<br /> + <hr /> + id: 1002<br /> + id: 1001<br /> + id: 1000<br /> + + + + + {section name=foo start=10 loop=20 step=2} + {$smarty.section.foo.index} + {/section} + <hr /> + {section name=bar loop=21 max=6 step=-2} + {$smarty.section.bar.index} + {/section} + +The above example will output: + + + 10 12 14 16 18 + <hr /> + 20 18 16 14 12 10 + + + +The `name` of the `{section}` can be anything you like, see [PHP +variables](&url.php-manual;language.variables). It is used to reference +the data within the `{section}`. + + + {section name=anything loop=$myArray} + {$myArray[anything].foo} + {$name[anything]} + {$address[anything].bar} + {/section} + + + +This is an example of printing an associative array of data with a +`{section}`. Following is the php script to assign the `$contacts` array +to Smarty. + + + <?php + $data = array( + array('name' => 'John Smith', 'home' => '555-555-5555', + 'cell' => '666-555-5555', 'email' => 'john@myexample.com'), + array('name' => 'Jack Jones', 'home' => '777-555-5555', + 'cell' => '888-555-5555', 'email' => 'jack@myexample.com'), + array('name' => 'Jane Munson', 'home' => '000-555-5555', + 'cell' => '123456', 'email' => 'jane@myexample.com') + ); + $smarty->assign('contacts',$data); + ?> + + + +The template to output `$contacts` + + + {section name=customer loop=$contacts} + <p> + name: {$contacts[customer].name}<br /> + home: {$contacts[customer].home}<br /> + cell: {$contacts[customer].cell}<br /> + e-mail: {$contacts[customer].email} + </p> + {/section} + + + +The above example will output: + + + <p> + name: John Smith<br /> + home: 555-555-5555<br /> + cell: 666-555-5555<br /> + e-mail: john@myexample.com + </p> + <p> + name: Jack Jones<br /> + home phone: 777-555-5555<br /> + cell phone: 888-555-5555<br /> + e-mail: jack@myexample.com + </p> + <p> + name: Jane Munson<br /> + home phone: 000-555-5555<br /> + cell phone: 123456<br /> + e-mail: jane@myexample.com + </p> + + + +This example assumes that `$custid`, `$name` and `$address` are all +arrays containing the same number of values. First the php script that +assign\'s the arrays to Smarty. + + + <?php + + $id = array(1001,1002,1003); + $smarty->assign('custid',$id); + + $fullnames = array('John Smith','Jack Jones','Jane Munson'); + $smarty->assign('name',$fullnames); + + $addr = array('253 Abbey road', '417 Mulberry ln', '5605 apple st'); + $smarty->assign('address',$addr); + + ?> + +The `loop` variable only determines the number of times to loop. You can +access ANY variable from the template within the `{section}`. This is +useful for looping multiple arrays. You can pass an array which will +determine the loop count by the array size, or you can pass an integer +to specify the number of loops. + + + {section name=customer loop=$custid} + <p> + id: {$custid[customer]}<br /> + name: {$name[customer]}<br /> + address: {$address[customer]} + </p> + {/section} + + + +The above example will output: + + + <p> + id: 1000<br /> + name: John Smith<br /> + address: 253 Abbey road + </p> + <p> + id: 1001<br /> + name: Jack Jones<br /> + address: 417 Mulberry ln + </p> + <p> + id: 1002<br /> + name: Jane Munson<br /> + address: 5605 apple st + </p> + + + +{section}\'s can be nested as deep as you like. With nested +{section}\'s, you can access complex data structures, such as +multi-dimensional arrays. This is an example `.php` script thats +assign\'s the arrays. + + + <?php + + $id = array(1001,1002,1003); + $smarty->assign('custid',$id); + + $fullnames = array('John Smith','Jack Jones','Jane Munson'); + $smarty->assign('name',$fullnames); + + $addr = array('253 N 45th', '417 Mulberry ln', '5605 apple st'); + $smarty->assign('address',$addr); + + $types = array( + array( 'home phone', 'cell phone', 'e-mail'), + array( 'home phone', 'web'), + array( 'cell phone') + ); + $smarty->assign('contact_type', $types); + + $info = array( + array('555-555-5555', '666-555-5555', 'john@myexample.com'), + array( '123-456-4', 'www.example.com'), + array( '0457878') + ); + $smarty->assign('contact_info', $info); + + ?> + + +In this template, *\$contact\_type\[customer\]* is an array of contact +types for the current customer. + + + {section name=customer loop=$custid} + <hr> + id: {$custid[customer]}<br /> + name: {$name[customer]}<br /> + address: {$address[customer]}<br /> + {section name=contact loop=$contact_type[customer]} + {$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br /> + {/section} + {/section} + + + +The above example will output: + + + <hr> + id: 1000<br /> + name: John Smith<br /> + address: 253 N 45th<br /> + home phone: 555-555-5555<br /> + cell phone: 666-555-5555<br /> + e-mail: john@myexample.com<br /> + <hr> + id: 1001<br /> + name: Jack Jones<br /> + address: 417 Mulberry ln<br /> + home phone: 123-456-4<br /> + web: www.example.com<br /> + <hr> + id: 1002<br /> + name: Jane Munson<br /> + address: 5605 apple st<br /> + cell phone: 0457878<br /> + + + +Results of a database search (eg ADODB or PEAR) are assigned to Smarty + + + <?php + $sql = 'select id, name, home, cell, email from contacts ' + ."where name like '$foo%' "; + $smarty->assign('contacts', $db->getAll($sql)); + ?> + +The template to output the database result in a HTML table + + + <table> + <tr><th> </th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr> + {section name=co loop=$contacts} + <tr> + <td><a href="view.php?id={$contacts[co].id}">view<a></td> + <td>{$contacts[co].name}</td> + <td>{$contacts[co].home}</td> + <td>{$contacts[co].cell}</td> + <td>{$contacts[co].email}</td> + <tr> + {sectionelse} + <tr><td colspan="5">No items found</td></tr> + {/section} + </table> + +.index {#section.property.index} +------ + +`index` contains the current array index, starting with zero or the +`start` attribute if given. It increments by one or by the `step` +attribute if given. + +> **Note** +> +> If the `step` and `start` properties are not modified, then this works +> the same as the [`iteration`](#section.property.iteration) property, +> except it starts at zero instead of one. + +> **Note** +> +> `$custid[customer.index]` and `$custid[customer]` are identical. + + + {section name=customer loop=$custid} + {$smarty.section.customer.index} id: {$custid[customer]}<br /> + {/section} + + + +The above example will output: + + + 0 id: 1000<br /> + 1 id: 1001<br /> + 2 id: 1002<br /> + + + +.index\_prev {#section.property.index.prev} +------------ + +`index_prev` is the previous loop index. On the first loop, this is set +to -1. + +.index\_next {#section.property.index.next} +------------ + +`index_next` is the next loop index. On the last loop, this is still one +more than the current index, respecting the setting of the `step` +attribute, if given. + + + <?php + $data = array(1001,1002,1003,1004,1005); + $smarty->assign('rows',$data); + ?> + +Template to output the above array in a table + + + {* $rows[row.index] and $rows[row] are identical in meaning *} + <table> + <tr> + <th>index</th><th>id</th> + <th>index_prev</th><th>prev_id</th> + <th>index_next</th><th>next_id</th> + </tr> + {section name=row loop=$rows} + <tr> + <td>{$smarty.section.row.index}</td><td>{$rows[row]}</td> + <td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td> + <td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td> + </tr> + {/section} + </table> + + + +The above example will output a table containing the following: + + + index id index_prev prev_id index_next next_id + 0 1001 -1 1 1002 + 1 1002 0 1001 2 1003 + 2 1003 1 1002 3 1004 + 3 1004 2 1003 4 1005 + 4 1005 3 1004 5 + + + +.iteration {#section.property.iteration} +---------- + +`iteration` contains the current loop iteration and starts at one. + +> **Note** +> +> This is not affected by the `{section}` properties `start`, `step` and +> `max`, unlike the [`index`](#section.property.index) property. +> `iteration` also starts with one instead of zero unlike `index`. +> [`rownum`](#section.property.rownum) is an alias to `iteration`, they +> are identical. + + + <?php + // array of 3000 to 3015 + $id = range(3000,3015); + $smarty->assign('arr',$id); + ?> + +Template to output every other element of the `$arr` array as `step=2` + + + {section name=cu loop=$arr start=5 step=2} + iteration={$smarty.section.cu.iteration} + index={$smarty.section.cu.index} + id={$custid[cu]}<br /> + {/section} + + + +The above example will output: + + + iteration=1 index=5 id=3005<br /> + iteration=2 index=7 id=3007<br /> + iteration=3 index=9 id=3009<br /> + iteration=4 index=11 id=3011<br /> + iteration=5 index=13 id=3013<br /> + iteration=6 index=15 id=3015<br /> + + + +Another example that uses the `iteration` property to output a table +header block every five rows. + + + <table> + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is div by 5} + <tr><th> </th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr> + {/if} + <tr> + <td><a href="view.php?id={$contacts[co].id}">view<a></td> + <td>{$contacts[co].name}</td> + <td>{$contacts[co].home}</td> + <td>{$contacts[co].cell}</td> + <td>{$contacts[co].email}</td> + <tr> + {/section} + </table> + + + +An that uses the `iteration` property to alternate a text color every +third row. + + + <table> + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is even by 3} + <span style="color: #ffffff">{$contacts[co].name}</span> + {else} + <span style="color: #dddddd">{$contacts[co].name}</span> + {/if} + {/section} + </table> + + + +> **Note** +> +> The *\"is div by\"* syntax is a simpler alternative to the PHP mod +> operator syntax. The mod operator is allowed: +> `{if $smarty.section.co.iteration % 5 == 1}` will work just the same. + +> **Note** +> +> You can also use *\"is odd by\"* to reverse the alternating. + +.first {#section.property.first} +------ + +`first` is set to TRUE if the current `{section}` iteration is the +initial one. + +.last {#section.property.last} +----- + +`last` is set to TRUE if the current section iteration is the final one. + +This example loops the `$customers` array, outputs a header block on the +first iteration and on the last outputs the footer block. Also uses the +[`total`](#section.property.total) property. + + + {section name=customer loop=$customers} + {if $smarty.section.customer.first} + <table> + <tr><th>id</th><th>customer</th></tr> + {/if} + + <tr> + <td>{$customers[customer].id}}</td> + <td>{$customers[customer].name}</td> + </tr> + + {if $smarty.section.customer.last} + <tr><td></td><td>{$smarty.section.customer.total} customers</td></tr> + </table> + {/if} + {/section} + + + +.rownum {#section.property.rownum} +------- + +`rownum` contains the current loop iteration, starting with one. It is +an alias to [`iteration`](#section.property.iteration), they work +identically. + +.loop {#section.property.loop} +----- + +`loop` contains the last index number that this {section} looped. This +can be used inside or after the `{section}`. + + + {section name=customer loop=$custid} + {$smarty.section.customer.index} id: {$custid[customer]}<br /> + {/section} + There are {$smarty.section.customer.loop} customers shown above. + + + +The above example will output: + + + 0 id: 1000<br /> + 1 id: 1001<br /> + 2 id: 1002<br /> + There are 3 customers shown above. + + + +.show {#section.property.show} +----- + +`show` is used as a parameter to section and is a boolean value. If +FALSE, the section will not be displayed. If there is a `{sectionelse}` +present, that will be alternately displayed. + +Boolean `$show_customer_info` has been passed from the PHP application, +to regulate whether or not this section shows. + + + {section name=customer loop=$customers show=$show_customer_info} + {$smarty.section.customer.rownum} id: {$customers[customer]}<br /> + {/section} + + {if $smarty.section.customer.show} + the section was shown. + {else} + the section was not shown. + {/if} + + + +The above example will output: + + + 1 id: 1000<br /> + 2 id: 1001<br /> + 3 id: 1002<br /> + + the section was shown. + + + +.total {#section.property.total} +------ + +`total` contains the number of iterations that this `{section}` will +loop. This can be used inside or after a `{section}`. + + + {section name=customer loop=$custid step=2} + {$smarty.section.customer.index} id: {$custid[customer]}<br /> + {/section} + There are {$smarty.section.customer.total} customers shown above. + + + +See also [`{foreach}`](#language.function.foreach), +[`{for}`](#language.function.for), [`{while}`](#language.function.while) +and [`$smarty.section`](#language.variables.smarty.loops). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md new file mode 100644 index 000000000..381c191a2 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md @@ -0,0 +1,42 @@ +{setfilter} {#language.function.setfilter} +=========== + +The `{setfilter}...{/setfilter}` block tag allows the definition of +template instance\'s variable filters. + +SYNTAX: {setfilter filter1\|filter2\|filter3\....}\...{/setfilter} + +The filter can be: + +- A variable filter plugin specified by it\'s name. + +- A modidier specified by it\'s name and optional additional + parameter. + +`{setfilter}...{/setfilter}` blocks can be nested. The filter definition +of inner blocks does replace the definition of the outer block. + +Template instance filters run in addition to other modifiers and +filters. They run in the following order: modifier, default\_modifier, +\$escape\_html, registered variable filters, autoloaded variable +filters, template instance\'s variable filters. Everything after +default\_modifier can be disabled with the `nofilter` flag. + + + <script> + {setfilter filter1} + {$foo} {* filter1 runs on output of $foo *} + {setfilter filter2|mod:true} + {$bar} {* filter2 and modifier mod runs on output of $bar *} + {/setfilter} + {$buh} {* filter1 runs on output of $buh *} + {/setfilter} + {$blar} {* no template instance filter runs on output of $blar} + </script> + + + +> **Note** +> +> The setting of template instance filters does not effect the output of +> included subtemplates. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-shortform-assign.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-shortform-assign.md new file mode 100644 index 000000000..d6a9e9798 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-shortform-assign.md @@ -0,0 +1,84 @@ +{\$var=\...} {#language.function.shortform.assign} +============ + +This is a short-hand version of the {assign} function. You can assign +values directly to the template, or assign values to array elements too. + +> **Note** +> +> Assignment of variables in-template is essentially placing application +> logic into the presentation that may be better handled in PHP. Use at +> your own discretion. + +The following attributes can be added to the tag: + +**Attributes:** + + Attribute Name Shorthand Type Required Default Description + ---------------- ----------- -------- ---------- --------- ----------------------------------------------------------------------- + scope n/a string No *n/a* The scope of the assigned variable: \'parent\',\'root\' or \'global\' + +**Option Flags:** + + Name Description + --------- ----------------------------------------------------- + nocache Assigns the variable with the \'nocache\' attribute + + + {$name='Bob'} + + The value of $name is {$name}. + + + +The above example will output: + + + The value of $name is Bob. + + + + + {$running_total=$running_total+$some_array[row].some_value} + + + + + {$user.name="Bob"} + + + + + {$user.name.first="Bob"} + + + + + {$users[]="Bob"} + + + +Variables assigned in the included template will be seen in the +including template. + + + {include file="sub_template.tpl"} + ... + {* display variable assigned in sub_template *} + {$foo}<br> + ... + + + +The template above includes the example `sub_template.tpl` below + + + ... + {* foo will be known also in the including template *} + {$foo="something" scope=parent} + {* bar is assigned only local in the including template *} + {$bar="value"} + ... + +See also [`{assign}`](#language.function.assign) and +[`{append}`](#language.function.append) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-strip.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-strip.md new file mode 100644 index 000000000..d40646e5f --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-strip.md @@ -0,0 +1,48 @@ +{strip} {#language.function.strip} +======= + +Many times web designers run into the issue where white space and +carriage returns affect the output of the rendered HTML (browser +\"features\"), so you must run all your tags together in the template to +get the desired results. This usually ends up in unreadable or +unmanageable templates. + +Anything within `{strip}{/strip}` tags are stripped of the extra spaces +or carriage returns at the beginnings and ends of the lines before they +are displayed. This way you can keep your templates readable, and not +worry about extra white space causing problems. + +> **Note** +> +> `{strip}{/strip}` does not affect the contents of template variables, +> see the [strip modifier](#language.modifier.strip) instead. + + + {* the following will be all run into one line upon output *} + {strip} + <table border='0'> + <tr> + <td> + <a href="{$url}"> + <font color="red">This is a test</font> + </a> + </td> + </tr> + </table> + {/strip} + + + +The above example will output: + + + <table border='0'><tr><td><a href="http://. snipped...</a></td></tr></table> + + + +Notice that in the above example, all the lines begin and end with HTML +tags. Be aware that all the lines are run together. If you have plain +text at the beginning or end of any line, they will be run together, and +may not be desired results. + +See also the [`strip`](#language.modifier.strip) modifier. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-while.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-while.md new file mode 100644 index 000000000..755c091f6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-while.md @@ -0,0 +1,43 @@ +{while} {#language.function.while} +======= + +`{while}` loops in Smarty have much the same flexibility as PHP +[while](&url.php-manual;while) statements, with a few added features for +the template engine. Every `{while}` must be paired with a matching +`{/while}`. All PHP conditionals and functions are recognized, such as +*\|\|*, *or*, *&&*, *and*, *is\_array()*, etc. + +The following is a list of recognized qualifiers, which must be +separated from surrounding elements by spaces. Note that items listed in +\[brackets\] are optional. PHP equivalents are shown where applicable. + + Qualifier Alternates Syntax Example Meaning PHP Equivalent + -------------------- ------------ ------------------------ -------------------------------- ---------------------- + == eq \$a eq \$b equals == + != ne, neq \$a neq \$b not equals != + \> gt \$a gt \$b greater than \> + \< lt \$a lt \$b less than \< + \>= gte, ge \$a ge \$b greater than or equal \>= + \<= lte, le \$a le \$b less than or equal \<= + === \$a === 0 check for identity === + ! not not \$a negation (unary) ! + \% mod \$a mod \$b modulous \% + is \[not\] div by \$a is not div by 4 divisible by \$a % \$b == 0 + is \[not\] even \$a is not even \[not\] an even number (unary) \$a % 2 == 0 + is \[not\] even by \$a is not even by \$b grouping level \[not\] even (\$a / \$b) % 2 == 0 + is \[not\] odd \$a is not odd \[not\] an odd number (unary) \$a % 2 != 0 + is \[not\] odd by \$a is not odd by \$b \[not\] an odd grouping (\$a / \$b) % 2 != 0 + + + + {while $foo > 0} + {$foo--} + {/while} + + + +The above example will count down the value of \$foo until 1 is reached. + +See also [`{foreach}`](#language.function.foreach), +[`{for}`](#language.function.for) and +[`{section}`](#language.function.section). diff --git a/vendor/smarty/smarty/docs/designers/language-combining-modifiers.md b/vendor/smarty/smarty/docs/designers/language-combining-modifiers.md new file mode 100644 index 000000000..edf1a83ea --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-combining-modifiers.md @@ -0,0 +1,35 @@ +Combining Modifiers {#language.combining.modifiers} +=================== + +You can apply any number of modifiers to a variable. They will be +applied in the order they are combined, from left to right. They must be +separated with a `|` (pipe) character. + + + <?php + + $smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.'); + + ?> + +where template is: + + + {$articleTitle} + {$articleTitle|upper|spacify} + {$articleTitle|lower|spacify|truncate} + {$articleTitle|lower|truncate:30|spacify} + {$articleTitle|lower|spacify|truncate:30:". . ."} + + + +The above example will output: + + + Smokers are Productive, but Death Cuts Efficiency. + S M O K E R S A R ....snip.... H C U T S E F F I C I E N C Y . + s m o k e r s a r ....snip.... b u t d e a t h c u t s... + s m o k e r s a r e p r o d u c t i v e , b u t . . . + s m o k e r s a r e p. . . + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions.md b/vendor/smarty/smarty/docs/designers/language-custom-functions.md new file mode 100644 index 000000000..20ad54e99 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions.md @@ -0,0 +1,21 @@ +Custom Functions {#language.custom.functions} +================ + +Smarty comes with several custom plugin functions that you can use in +the templates. + +## Table of contents +- [{counter}](./language-custom-functions/language-function-counter.md) +- [{cycle}](./language-custom-functions/language-function-cycle.md) +- [{eval}](./language-custom-functions/language-function-eval.md) +- [{fetch}](./language-custom-functions/language-function-fetch.md) +- [{html_checkboxes}](./language-custom-functions/language-function-html-checkboxes.md) +- [{html_image}](./language-custom-functions/language-function-html-image.md) +- [{html_options}](./language-custom-functions/language-function-html-options.md) +- [{html_radios}](./language-custom-functions/language-function-html-radios.md) +- [{html_select_date}](./language-custom-functions/language-function-html-select-date.md) +- [{html_select_time}](./language-custom-functions/language-function-html-select-time.md) +- [{html_table}](./language-custom-functions/language-function-html-table.md) +- [{mailto}](./language-custom-functions/language-function-mailto.md) +- [{math}](./language-custom-functions/language-function-math.md) +- [{textformat}](./language-custom-functions/language-function-textformat.md) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-counter.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-counter.md new file mode 100644 index 000000000..cc1ac08f2 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-counter.md @@ -0,0 +1,41 @@ +{counter} {#language.function.counter} +========= + +`{counter}` is used to print out a count. `{counter}` will remember the +count on each iteration. You can adjust the number, the interval and the +direction of the count, as well as determine whether or not to print the +value. You can run multiple counters concurrently by supplying a unique +name for each one. If you do not supply a name, the name "default" will +be used. + +If you supply the `assign` attribute, the output of the `{counter}` +function will be assigned to this template variable instead of being +output to the template. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ----------- ------------------------------------------------------ + name string No *default* The name of the counter + start number No *1* The initial number to start counting from + skip number No *1* The interval to count by + direction string No *up* The direction to count (up/down) + print boolean No *TRUE* Whether or not to print the value + assign string No *n/a* the template variable the output will be assigned to + + + {* initialize the count *} + {counter start=0 skip=2}<br /> + {counter}<br /> + {counter}<br /> + {counter}<br /> + + + +this will output: + + + 0<br /> + 2<br /> + 4<br /> + 6<br /> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-cycle.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-cycle.md new file mode 100644 index 000000000..5986e6322 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-cycle.md @@ -0,0 +1,57 @@ +{cycle} {#language.function.cycle} +======= + +`{cycle}` is used to alternate a set of values. This makes it easy to +for example, alternate between two or more colors in a table, or cycle +through an array of values. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ----------- ------------------------------------------------------------------------------------------------------------- + name string No *default* The name of the cycle + values mixed Yes *N/A* The values to cycle through, either a comma delimited list (see delimiter attribute), or an array of values + print boolean No *TRUE* Whether to print the value or not + advance boolean No *TRUE* Whether or not to advance to the next value + delimiter string No *,* The delimiter to use in the values attribute + assign string No *n/a* The template variable the output will be assigned to + reset boolean No *FALSE* The cycle will be set to the first value and not advanced + +- You can `{cycle}` through more than one set of values in a template + by supplying a `name` attribute. Give each `{cycle}` an unique + `name`. + +- You can force the current value not to print with the `print` + attribute set to FALSE. This would be useful for silently skipping a + value. + +- The `advance` attribute is used to repeat a value. When set to + FALSE, the next call to `{cycle}` will print the same value. + +- If you supply the `assign` attribute, the output of the `{cycle}` + function will be assigned to a template variable instead of being + output to the template. + +<!-- --> + + + {section name=rows loop=$data} + <tr class="{cycle values="odd,even"}"> + <td>{$data[rows]}</td> + </tr> + {/section} + + + +The above template would output: + + + <tr class="odd"> + <td>1</td> + </tr> + <tr class="even"> + <td>2</td> + </tr> + <tr class="odd"> + <td>3</td> + </tr> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-debug.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-debug.md new file mode 100644 index 000000000..79b3477c1 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-debug.md @@ -0,0 +1,15 @@ +{debug} {#language.function.debug} +======= + +`{debug}` dumps the debug console to the page. This works regardless of +the [debug](#chapter.debugging.console) settings in the php script. +Since this gets executed at runtime, this is only able to show the +[assigned](#api.assign) variables; not the templates that are in use. +However, you can see all the currently available variables within the +scope of a template. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- -------------- --------------------------------- + output string No *javascript* output type, html or javascript + +See also the [debugging console page](#chapter.debugging.console). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-eval.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-eval.md new file mode 100644 index 000000000..e11f57e3e --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-eval.md @@ -0,0 +1,84 @@ +{eval} {#language.function.eval} +====== + +`{eval}` is used to evaluate a variable as a template. This can be used +for things like embedding template tags/variables into variables or +tags/variables into config file variables. + +If you supply the `assign` attribute, the output of the `{eval}` +function will be assigned to this template variable instead of being +output to the template. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ------------------------------------------------------ + var mixed Yes *n/a* Variable (or string) to evaluate + assign string No *n/a* The template variable the output will be assigned to + +> **Note** +> +> - Evaluated variables are treated the same as templates. They follow +> the same escapement and security features just as if they were +> templates. +> +> - Evaluated variables are compiled on every invocation, the compiled +> versions are not saved! However if you have [caching](#caching) +> enabled, the output will be cached with the rest of the template. +> +> - If the content to evaluate doesn\'t change often, or is used +> repeatedly, consider using +> `{include file="string:{$template_code}"}` instead. This may cache +> the compiled state and thus doesn\'t have to run the (comparably +> slow) compiler on every invocation. +> +The contents of the config file, `setup.conf`. + + + emphstart = <strong> + emphend = </strong> + title = Welcome to {$company}'s home page! + ErrorCity = You must supply a {#emphstart#}city{#emphend#}. + ErrorState = You must supply a {#emphstart#}state{#emphend#}. + + + +Where the template is: + + + {config_load file='setup.conf'} + + {eval var=$foo} + {eval var=#title#} + {eval var=#ErrorCity#} + {eval var=#ErrorState# assign='state_error'} + {$state_error} + + + +The above template will output: + + + This is the contents of foo. + Welcome to Foobar Pub & Grill's home page! + You must supply a <strong>city</strong>. + You must supply a <strong>state</strong>. + + + +This outputs the server name (in uppercase) and IP. The assigned +variable `$str` could be from a database query. + + + <?php + $str = 'The server name is {$smarty.server.SERVER_NAME|upper} ' + .'at {$smarty.server.SERVER_ADDR}'; + $smarty->assign('foo',$str); + ?> + + + +Where the template is: + + + {eval var=$foo} + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-fetch.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-fetch.md new file mode 100644 index 000000000..2277f5056 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-fetch.md @@ -0,0 +1,59 @@ +{fetch} {#language.function.fetch} +======= + +`{fetch}` is used to retrieve files from the local file system, http, or +ftp and display the contents. + +- If the file name begins with `http://`, the web site page will be + fetched and displayed. + + > **Note** + > + > This will not support http redirects, be sure to include a + > trailing slash on your web page fetches where necessary. + +- If the file name begins with `ftp://`, the file will be downloaded + from the ftp server and displayed. + +- For local files, either a full system file path must be given, or a + path relative to the executed php script. + + > **Note** + > + > If security is enabled and you are fetching a file from the local + > file system, `{fetch}` will only allow files from within the + > `$secure_dir` path of the securty policy. See the + > [Security](#advanced.features.security) section for details. + +- If the `assign` attribute is set, the output of the `{fetch}` + function will be assigned to this template variable instead of being + output to the template. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ------------------------------------------------------ + file string Yes *n/a* The file, http or ftp site to fetch + assign string No *n/a* The template variable the output will be assigned to + + + {* include some javascript in your template *} + {fetch file='/export/httpd/www.example.com/docs/navbar.js'} + + {* embed some weather text in your template from another web site *} + {fetch file='http://www.myweather.com/68502/'} + + {* fetch a news headline file via ftp *} + {fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'} + {* as above but with variables *} + {fetch file="ftp://`$user`:`$password`@`$server`/`$path`"} + + {* assign the fetched contents to a template variable *} + {fetch file='http://www.myweather.com/68502/' assign='weather'} + {if $weather ne ''} + <div id="weather">{$weather}</div> + {/if} + + + +See also [`{capture}`](#language.function.capture), +[`{eval}`](#language.function.eval), +[`{assign}`](#language.function.assign) and [`fetch()`](#api.fetch). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md new file mode 100644 index 000000000..23af713b7 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md @@ -0,0 +1,113 @@ +{html\_checkboxes} {#language.function.html.checkboxes} +================== + +`{html_checkboxes}` is a [custom function](#language.custom.functions) +that creates an html checkbox group with provided data. It takes care of +which item(s) are selected by default as well. + + Attribute Name Type Required Default Description + ---------------- ------------------- ------------------------------------- ------------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + name string No *checkbox* Name of checkbox list + values array Yes, unless using options attribute *n/a* An array of values for checkbox buttons + output array Yes, unless using options attribute *n/a* An array of output for checkbox buttons + selected string/array No *empty* The selected checkbox element(s) + options associative array Yes, unless using values and output *n/a* An associative array of values and output + separator string No *empty* String of text to separate each checkbox item + assign string No *empty* Assign checkbox tags to an array instead of output + labels boolean No *TRUE* Add \<label\>-tags to the output + label\_ids boolean No *FALSE* Add id-attributes to \<label\> and \<input\> to the output + escape boolean No *TRUE* Escape the output / content (values are always escaped) + strict boolean No *FALSE* Will make the \"extra\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\"disabled\"* and *\"readonly\"* respectively + +- Required attributes are `values` and `output`, unless you use + `options` instead. + +- All output is XHTML compliant. + +- All parameters that are not in the list above are printed as + name/value-pairs inside each of the created \<input\>-tags. + +<!-- --> + + + <?php + + $smarty->assign('cust_ids', array(1000,1001,1002,1003)); + $smarty->assign('cust_names', array( + 'Joe Schmoe', + 'Jack Smith', + 'Jane Johnson', + 'Charlie Brown') + ); + $smarty->assign('customer_id', 1001); + + ?> + + + +where template is + + + {html_checkboxes name='id' values=$cust_ids output=$cust_names + selected=$customer_id separator='<br />'} + + + +or where PHP code is: + + + <?php + + $smarty->assign('cust_checkboxes', array( + 1000 => 'Joe Schmoe', + 1001 => 'Jack Smith', + 1002 => 'Jane Johnson', + 1003 => 'Charlie Brown') + ); + $smarty->assign('customer_id', 1001); + + ?> + + + +and the template is + + + {html_checkboxes name='id' options=$cust_checkboxes + selected=$customer_id separator='<br />'} + + + +both examples will output: + + + <label><input type="checkbox" name="id[]" value="1000" />Joe Schmoe</label><br /> + <label><input type="checkbox" name="id[]" value="1001" checked="checked" />Jack Smith</label> + <br /> + <label><input type="checkbox" name="id[]" value="1002" />Jane Johnson</label><br /> + <label><input type="checkbox" name="id[]" value="1003" />Charlie Brown</label><br /> + + + + + <?php + + $sql = 'select type_id, types from contact_types order by type'; + $smarty->assign('contact_types',$db->getAssoc($sql)); + + $sql = 'select contact_id, contact_type_id, contact ' + .'from contacts where contact_id=12'; + $smarty->assign('contact',$db->getRow($sql)); + + ?> + + + +The results of the database queries above would be output with. + + + {html_checkboxes name='contact_type_id' options=$contact_types + selected=$contact.contact_type_id separator='<br />'} + +See also [`{html_radios}`](#language.function.html.radios) and +[`{html_options}`](#language.function.html.options) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-image.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-image.md new file mode 100644 index 000000000..76740a1fe --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-image.md @@ -0,0 +1,56 @@ +{html\_image} {#language.function.html.image} +============= + +`{html_image}` is a [custom function](#language.custom.functions) that +generates an HTML `<img>` tag. The `height` and `width` are +automatically calculated from the image file if they are not supplied. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- ----------------------- --------------------------------------- + file string Yes *n/a* name/path to image + height string No *actual image height* Height to display image + width string No *actual image width* Width to display image + basedir string no *web server doc root* Directory to base relative paths from + alt string no *""* Alternative description of the image + href string no *n/a* href value to link the image to + path\_prefix string no *n/a* Prefix for output path + +- `basedir` is the base directory that relative image paths are based + from. If not given, the web server\'s document root + `$_ENV['DOCUMENT_ROOT']` is used as the base. If security is + enabled, then the image must be located in the `$secure_dir` path of + the securty policy. See the [Security](#advanced.features.security) + section for details. + +- `href` is the href value to link the image to. If link is supplied, + an `<a href="LINKVALUE"><a>` tag is placed around the image tag. + +- `path_prefix` is an optional prefix string you can give the output + path. This is useful if you want to supply a different server name + for the image. + +- All parameters that are not in the list above are printed as + name/value-pairs inside the created `<img>` tag. + +> **Note** +> +> `{html_image}` requires a hit to the disk to read the image and +> calculate the height and width. If you don\'t use template +> [caching](#caching), it is generally better to avoid `{html_image}` +> and leave image tags static for optimal performance. + + + {html_image file='pumpkin.jpg'} + {html_image file='/path/from/docroot/pumpkin.jpg'} + {html_image file='../path/relative/to/currdir/pumpkin.jpg'} + + + +Example output of the above template would be: + + + <img src="pumpkin.jpg" alt="" width="44" height="68" /> + <img src="/path/from/docroot/pumpkin.jpg" alt="" width="44" height="68" /> + <img src="../path/relative/to/currdir/pumpkin.jpg" alt="" width="44" height="68" /> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-options.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-options.md new file mode 100644 index 000000000..b7c04e940 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-options.md @@ -0,0 +1,155 @@ +{html\_options} {#language.function.html.options} +=============== + +`{html_options}` is a [custom function](#language.custom.functions) that +creates the html `<select><option>` group with the assigned data. It +takes care of which item(s) are selected by default as well. + + Attribute Name Type Required Default Description + ---------------- ------------------- ------------------------------------- --------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + values array Yes, unless using options attribute *n/a* An array of values for dropdown + output array Yes, unless using options attribute *n/a* An array of output for dropdown + selected string/array No *empty* The selected option element(s) + options associative array Yes, unless using values and output *n/a* An associative array of values and output + name string No *empty* Name of select group + strict boolean No *FALSE* Will make the \"extra\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\"disabled\"* and *\"readonly\"* respectively + +- Required attributes are `values` and `output`, unless you use the + combined `options` instead. + +- If the optional `name` attribute is given, the `<select></select>` + tags are created, otherwise ONLY the `<option>` list is generated. + +- If a given value is an array, it will treat it as an html + `<optgroup>`, and display the groups. Recursion is supported with + `<optgroup>`. + +- All parameters that are not in the list above are printed as + name/value-pairs inside the `<select>` tag. They are ignored if the + optional `name` is not given. + +- All output is XHTML compliant. + +<!-- --> + + + <?php + $smarty->assign('myOptions', array( + 1800 => 'Joe Schmoe', + 9904 => 'Jack Smith', + 2003 => 'Charlie Brown') + ); + $smarty->assign('mySelect', 9904); + ?> + + + +The following template will generate a drop-down list. Note the presence +of the `name` attribute which creates the `<select>` tags. + + + {html_options name=foo options=$myOptions selected=$mySelect} + + + +Output of the above example would be: + + + <select name="foo"> + <option value="1800">Joe Schmoe</option> + <option value="9904" selected="selected">Jack Smith</option> + <option value="2003">Charlie Brown</option> + </select> + + + <?php + $smarty->assign('cust_ids', array(56,92,13)); + $smarty->assign('cust_names', array( + 'Joe Schmoe', + 'Jane Johnson', + 'Charlie Brown')); + $smarty->assign('customer_id', 92); + ?> + + + +The above arrays would be output with the following template (note the +use of the php [`count()`](&url.php-manual;function.count) function as a +modifier to set the select size). + + + <select name="customer_id" size="{$cust_names|@count}"> + {html_options values=$cust_ids output=$cust_names selected=$customer_id} + </select> + + + +The above example would output: + + + <select name="customer_id" size="3"> + <option value="56">Joe Schmoe</option> + <option value="92" selected="selected">Jane Johnson</option> + <option value="13">Charlie Brown</option> + </select> + + + + + + <?php + + $sql = 'select type_id, types from contact_types order by type'; + $smarty->assign('contact_types',$db->getAssoc($sql)); + + $sql = 'select contact_id, name, email, contact_type_id + from contacts where contact_id='.$contact_id; + $smarty->assign('contact',$db->getRow($sql)); + + ?> + +Where a template could be as follows. Note the use of the +[`truncate`](#language.modifier.truncate) modifier. + + + <select name="type_id"> + <option value='null'>-- none --</option> + {html_options options=$contact_types|truncate:20 selected=$contact.type_id} + </select> + + + + + <?php + $arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim'); + $arr['Rest'] = array(3 => 'Sauna',1 => 'Massage'); + $smarty->assign('lookups', $arr); + $smarty->assign('fav', 7); + ?> + + + +The script above and the following template + + + {html_options name=foo options=$lookups selected=$fav} + + + +would output: + + + <select name="foo"> + <optgroup label="Sport"> + <option value="6">Golf</option> + <option value="9">Cricket</option> + <option value="7" selected="selected">Swim</option> + </optgroup> + <optgroup label="Rest"> + <option value="3">Sauna</option> + <option value="1">Massage</option> + </optgroup> + </select> + +See also [`{html_checkboxes}`](#language.function.html.checkboxes) and +[`{html_radios}`](#language.function.html.radios) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-radios.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-radios.md new file mode 100644 index 000000000..992adaeaf --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-radios.md @@ -0,0 +1,112 @@ +{html\_radios} {#language.function.html.radios} +============== + +`{html_radios}` is a [custom function](#language.custom.functions) that +creates a HTML radio button group. It also takes care of which item is +selected by default as well. + + Attribute Name Type Required Default Description + ---------------- ------------------- ------------------------------------- --------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + name string No *radio* Name of radio list + values array Yes, unless using options attribute *n/a* An array of values for radio buttons + output array Yes, unless using options attribute *n/a* An array of output for radio buttons + selected string No *empty* The selected radio element + options associative array Yes, unless using values and output *n/a* An associative array of values and output + separator string No *empty* String of text to separate each radio item + assign string No *empty* Assign radio tags to an array instead of output + labels boolean No *TRUE* Add \<label\>-tags to the output + label\_ids boolean No *FALSE* Add id-attributes to \<label\> and \<input\> to the output + escape boolean No *TRUE* Escape the output / content (values are always escaped) + strict boolean No *FALSE* Will make the \"extra\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\"disabled\"* and *\"readonly\"* respectively + +- Required attributes are `values` and `output`, unless you use + `options` instead. + +- All output is XHTML compliant. + +- All parameters that are not in the list above are output as + name/value-pairs inside each of the created `<input>`-tags. + +<!-- --> + + + <?php + + $smarty->assign('cust_ids', array(1000,1001,1002,1003)); + $smarty->assign('cust_names', array( + 'Joe Schmoe', + 'Jack Smith', + 'Jane Johnson', + 'Charlie Brown') + ); + $smarty->assign('customer_id', 1001); + + ?> + + + +Where template is: + + + {html_radios name='id' values=$cust_ids output=$cust_names + selected=$customer_id separator='<br />'} + + + + + <?php + + $smarty->assign('cust_radios', array( + 1000 => 'Joe Schmoe', + 1001 => 'Jack Smith', + 1002 => 'Jane Johnson', + 1003 => 'Charlie Brown')); + $smarty->assign('customer_id', 1001); + + ?> + + + +Where template is: + + + {html_radios name='id' options=$cust_radios + selected=$customer_id separator='<br />'} + + + +Both examples will output: + + + <label><input type="radio" name="id" value="1000" />Joe Schmoe</label><br /> + <label><input type="radio" name="id" value="1001" checked="checked" />Jack Smith</label><br /> + <label><input type="radio" name="id" value="1002" />Jane Johnson</label><br /> + <label><input type="radio" name="id" value="1003" />Charlie Brown</label><br /> + + + + + <?php + + $sql = 'select type_id, types from contact_types order by type'; + $smarty->assign('contact_types',$db->getAssoc($sql)); + + $sql = 'select contact_id, name, email, contact_type_id ' + .'from contacts where contact_id='.$contact_id; + $smarty->assign('contact',$db->getRow($sql)); + + ?> + + + +The variable assigned from the database above would be output with the +template: + + + {html_radios name='contact_type_id' options=$contact_types + selected=$contact.contact_type_id separator='<br />'} + + + +See also [`{html_checkboxes}`](#language.function.html.checkboxes) and +[`{html_options}`](#language.function.html.options) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-date.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-date.md new file mode 100644 index 000000000..b46eb0419 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-date.md @@ -0,0 +1,119 @@ +{html\_select\_date} {#language.function.html.select.date} +==================== + +`{html_select_date}` is a [custom function](#language.custom.functions) +that creates date dropdowns. It can display any or all of year, month, +and day. All parameters that are not in the list below are printed as +name/value-pairs inside the `<select>` tags of day, month and year. + + Attribute Name Type Required Default Description + ---------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---------- ---------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + prefix string No Date\_ What to prefix the var name with + time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL + start\_year string No current year The first year in the dropdown, either year number, or relative to current year (+/- N) + end\_year string No same as start\_year The last year in the dropdown, either year number, or relative to current year (+/- N) + display\_days boolean No TRUE Whether to display days or not + display\_months boolean No TRUE Whether to display months or not + display\_years boolean No TRUE Whether to display years or not + month\_names array No null List of strings to display for months. array(1 =\> \'Jan\', ..., 12 =\> \'Dec\') + month\_format string No \%B What format the month should be in (strftime) + day\_format string No \%02d What format the day output should be in (sprintf) + day\_value\_format string No \%d What format the day value should be in (sprintf) + year\_as\_text boolean No FALSE Whether or not to display the year as text + reverse\_years boolean No FALSE Display years in reverse order + field\_array string No null If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name\[Day\], name\[Year\], name\[Month\]. + day\_size string No null Adds size attribute to select tag if given + month\_size string No null Adds size attribute to select tag if given + year\_size string No null Adds size attribute to select tag if given + all\_extra string No null Adds extra attributes to all select/input tags if given + day\_extra string No null Adds extra attributes to select/input tags if given + month\_extra string No null Adds extra attributes to select/input tags if given + year\_extra string No null Adds extra attributes to select/input tags if given + all\_id string No null Adds id-attribute to all select/input tags if given + day\_id string No null Adds id-attribute to select/input tags if given + month\_id string No null Adds id-attribute to select/input tags if given + year\_id string No null Adds id-attribute to select/input tags if given + field\_order string No MDY The order in which to display the fields + field\_separator string No \\n String printed between different fields + month\_value\_format string No \%m strftime() format of the month values, default is %m for month numbers. + all\_empty string No null If supplied then the first element of any select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-boxes read "Please select" for example. + year\_empty string No null If supplied then the first element of the year\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select a year" for example. Note that you can use values like "-MM-DD" as time-attribute to indicate an unselected year. + month\_empty string No null If supplied then the first element of the month\'s select-box has this value as it\'s label and "" as it\'s value. . Note that you can use values like "YYYY\--DD" as time-attribute to indicate an unselected month. + day\_empty string No null If supplied then the first element of the day\'s select-box has this value as it\'s label and "" as it\'s value. Note that you can use values like "YYYY-MM-" as time-attribute to indicate an unselected day. + +> **Note** +> +> There is an useful php function on the [date tips page](#tips.dates) +> for converting `{html_select_date}` form values to a timestamp. + +Template code + + + {html_select_date} + + + +This will output: + + + <select name="Date_Month"> + <option value="1">January</option> + <option value="2">February</option> + <option value="3">March</option> + ..... snipped ..... + <option value="10">October</option> + <option value="11">November</option> + <option value="12" selected="selected">December</option> + </select> + <select name="Date_Day"> + <option value="1">01</option> + <option value="2">02</option> + <option value="3">03</option> + ..... snipped ..... + <option value="11">11</option> + <option value="12">12</option> + <option value="13" selected="selected">13</option> + <option value="14">14</option> + <option value="15">15</option> + ..... snipped ..... + <option value="29">29</option> + <option value="30">30</option> + <option value="31">31</option> + </select> + <select name="Date_Year"> + <option value="2006" selected="selected">2006</option> + </select> + + + + + {* start and end year can be relative to current year *} + {html_select_date prefix='StartDate' time=$time start_year='-5' + end_year='+1' display_days=false} + + + +With 2000 as the current year the output: + + + <select name="StartDateMonth"> + <option value="1">January</option> + <option value="2">February</option> + .... snipped .... + <option value="11">November</option> + <option value="12" selected="selected">December</option> + </select> + <select name="StartDateYear"> + <option value="1995">1995</option> + .... snipped .... + <option value="1999">1999</option> + <option value="2000" selected="selected">2000</option> + <option value="2001">2001</option> + </select> + + + +See also [`{html_select_time}`](#language.function.html.select.time), +[`date_format`](#language.modifier.date.format), +[`$smarty.now`](#language.variables.smarty.now) and the [date tips +page](#tips.dates). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-time.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-time.md new file mode 100644 index 000000000..6ccc59907 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-time.md @@ -0,0 +1,98 @@ +{html\_select\_time} {#language.function.html.select.time} +==================== + +`{html_select_time}` is a [custom function](#language.custom.functions) +that creates time dropdowns for you. It can display any or all of hour, +minute, second and meridian. + +The `time` attribute can have different formats. It can be a unique +timestamp, a string of the format `YYYYMMDDHHMMSS` or a string that is +parseable by PHP\'s [`strtotime()`](&url.php-manual;strtotime). + + Attribute Name Type Required Default Description + ----------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---------- ---------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + prefix string No Time\_ What to prefix the var name with + time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. + display\_hours boolean No TRUE Whether or not to display hours + display\_minutes boolean No TRUE Whether or not to display minutes + display\_seconds boolean No TRUE Whether or not to display seconds + display\_meridian boolean No TRUE Whether or not to display meridian (am/pm) + use\_24\_hours boolean No TRUE Whether or not to use 24 hour clock + minute\_interval integer No 1 Number interval in minute dropdown + second\_interval integer No 1 Number interval in second dropdown + hour\_format string No \%02d What format the hour label should be in (sprintf) + hour\_value\_format string No \%20d What format the hour value should be in (sprintf) + minute\_format string No \%02d What format the minute label should be in (sprintf) + minute\_value\_format string No \%20d What format the minute value should be in (sprintf) + second\_format string No \%02d What format the second label should be in (sprintf) + second\_value\_format string No \%20d What format the second value should be in (sprintf) + field\_array string No n/a Outputs values to array of this name + all\_extra string No null Adds extra attributes to select/input tags if given + hour\_extra string No null Adds extra attributes to select/input tags if given + minute\_extra string No null Adds extra attributes to select/input tags if given + second\_extra string No null Adds extra attributes to select/input tags if given + meridian\_extra string No null Adds extra attributes to select/input tags if given + field\_separator string No \\n String printed between different fields + option\_separator string No \\n String printed between different options of a field + all\_id string No null Adds id-attribute to all select/input tags if given + hour\_id string No null Adds id-attribute to select/input tags if given + minute\_id string No null Adds id-attribute to select/input tags if given + second\_id string No null Adds id-attribute to select/input tags if given + meridian\_id string No null Adds id-attribute to select/input tags if given + all\_empty string No null If supplied then the first element of any select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-boxes read "Please select" for example. + hour\_empty string No null If supplied then the first element of the hour\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an hour" for example. + minute\_empty string No null If supplied then the first element of the minute\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an minute" for example. + second\_empty string No null If supplied then the first element of the second\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an second" for example. + meridian\_empty string No null If supplied then the first element of the meridian\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an meridian" for example. + + + {html_select_time use_24_hours=true} + + + +At 9:20 and 23 seconds in the morning the template above would output: + + + <select name="Time_Hour"> + <option value="00">00</option> + <option value="01">01</option> + ... snipped .... + <option value="08">08</option> + <option value="09" selected>09</option> + <option value="10">10</option> + ... snipped .... + <option value="22">22</option> + <option value="23">23</option> + </select> + <select name="Time_Minute"> + <option value="00">00</option> + <option value="01">01</option> + ... snipped .... + <option value="19">19</option> + <option value="20" selected>20</option> + <option value="21">21</option> + ... snipped .... + <option value="58">58</option> + <option value="59">59</option> + </select> + <select name="Time_Second"> + <option value="00">00</option> + <option value="01">01</option> + ... snipped .... + <option value="22">22</option> + <option value="23" selected>23</option> + <option value="24">24</option> + ... snipped .... + <option value="58">58</option> + <option value="59">59</option> + </select> + <select name="Time_Meridian"> + <option value="am" selected>AM</option> + <option value="pm">PM</option> + </select> + + + +See also [`$smarty.now`](#language.variables.smarty.now), +[`{html_select_date}`](#language.function.html.select.date) and the +[date tips page](#tips.dates). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-table.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-table.md new file mode 100644 index 000000000..fed4ae4d7 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-table.md @@ -0,0 +1,89 @@ +{html\_table} {#language.function.html.table} +============= + +`{html_table}` is a [custom function](#language.custom.functions) that +dumps an array of data into an HTML `<table>`. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ---------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + loop array Yes *n/a* Array of data to loop through + cols mixed No *3* Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array. + rows integer No *empty* Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements. + inner string No *cols* Direction of consecutive elements in the loop-array to be rendered. *cols* means elements are displayed col-by-col. *rows* means elements are displayed row-by-row. + caption string No *empty* Text to be used for the `<caption>` element of the table + table\_attr string No *border=\"1\"* Attributes for `<table>` tag + th\_attr string No *empty* Attributes for `<th>` tag (arrays are cycled) + tr\_attr string No *empty* attributes for `<tr>` tag (arrays are cycled) + td\_attr string No *empty* Attributes for `<td>` tag (arrays are cycled) + trailpad string No * * Value to pad the trailing cells on last row with (if any) + hdir string No *right* Direction of each row to be rendered. possible values: *right* (left-to-right), and *left* (right-to-left) + vdir string No *down* Direction of each column to be rendered. possible values: *down* (top-to-bottom), *up* (bottom-to-top) + +- The `cols` attribute determines how many columns will be in the + table. + +- The `table_attr`, `tr_attr` and `td_attr` values determine the + attributes given to the `<table>`, `<tr>` and `<td>` tags. + +- If `tr_attr` or `td_attr` are arrays, they will be cycled through. + +- `trailpad` is the value put into the trailing cells on the last + table row if there are any present. + +<!-- --> + + + <?php + $smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) ); + $smarty->assign( 'tr', array('bgcolor="#eeeeee"','bgcolor="#dddddd"') ); + $smarty->display('index.tpl'); + ?> + + + +The variables assigned from php could be displayed as these three +examples demonstrate. Each example shows the template followed by +output. + + + {**** Example One ****} + {html_table loop=$data} + + <table border="1"> + <tbody> + <tr><td>1</td><td>2</td><td>3</td></tr> + <tr><td>4</td><td>5</td><td>6</td></tr> + <tr><td>7</td><td>8</td><td>9</td></tr> + </tbody> + </table> + + + {**** Example Two ****} + {html_table loop=$data cols=4 table_attr='border="0"'} + + <table border="0"> + <tbody> + <tr><td>1</td><td>2</td><td>3</td><td>4</td></tr> + <tr><td>5</td><td>6</td><td>7</td><td>8</td></tr> + <tr><td>9</td><td> </td><td> </td><td> </td></tr> + </tbody> + </table> + + + {**** Example Three ****} + {html_table loop=$data cols="first,second,third,fourth" tr_attr=$tr} + + <table border="1"> + <thead> + <tr> + <th>first</th><th>second</th><th>third</th><th>fourth</th> + </tr> + </thead> + <tbody> + <tr bgcolor="#eeeeee"><td>1</td><td>2</td><td>3</td><td>4</td></tr> + <tr bgcolor="#dddddd"><td>5</td><td>6</td><td>7</td><td>8</td></tr> + <tr bgcolor="#eeeeee"><td>9</td><td> </td><td> </td><td> </td></tr> + </tbody> + </table> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-mailto.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-mailto.md new file mode 100644 index 000000000..cc5bf6968 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-mailto.md @@ -0,0 +1,56 @@ +{mailto} {#language.function.mailto} +======== + +`{mailto}` automates the creation of a `mailto:` anchor links and +optionally encodes them. Encoding emails makes it more difficult for web +spiders to lift email addresses off of a site. + +> **Note** +> +> Javascript is probably the most thorough form of encoding, although +> you can use hex encoding too. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ----------------------------------------------------------------------------------------------- + address string Yes *n/a* The e-mail address + text string No *n/a* The text to display, default is the e-mail address + encode string No *none* How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`. + cc string No *n/a* Email addresses to carbon copy, separate entries by a comma. + bcc string No *n/a* Email addresses to blind carbon copy, separate entries by a comma + subject string No *n/a* Email subject + newsgroups string No *n/a* Newsgroups to post to, separate entries by a comma. + followupto string No *n/a* Addresses to follow up to, separate entries by a comma. + extra string No *n/a* Any extra information you want passed to the link, such as style sheet classes + + + {mailto address="me@example.com"} + <a href="mailto:me@example.com" >me@example.com</a> + + {mailto address="me@example.com" text="send me some mail"} + <a href="mailto:me@example.com" >send me some mail</a> + + {mailto address="me@example.com" encode="javascript"} + <script type="text/javascript" language="javascript"> + eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b')) + </script> + + {mailto address="me@example.com" encode="hex"} + <a href="mailto:%6d%65.. snipped..3%6f%6d">m&..snipped...#x6f;m</a> + + {mailto address="me@example.com" subject="Hello to you!"} + <a href="mailto:me@example.com?subject=Hello%20to%20you%21" >me@example.com</a> + + {mailto address="me@example.com" cc="you@example.com,they@example.com"} + <a href="mailto:me@example.com?cc=you@example.com,they@example.com" >me@example.com</a> + + {mailto address="me@example.com" extra='class="email"'} + <a href="mailto:me@example.com" class="email">me@example.com</a> + + {mailto address="me@example.com" encode="javascript_charcode"} + <script type="text/javascript" language="javascript"> + {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))} + </script> + +See also [`escape`](#language.modifier.escape), +[`{textformat}`](#language.function.textformat) and [obfuscating email +addresses](#tips.obfuscating.email). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-math.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-math.md new file mode 100644 index 000000000..9adfd1c5a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-math.md @@ -0,0 +1,104 @@ +{math} {#language.function.math} +====== + +`{math}` allows the template designer to do math equations in the +template. + +- Any numeric template variables may be used in the equations, and the + result is printed in place of the tag. + +- The variables used in the equation are passed as parameters, which + can be template variables or static values. + +- +, -, /, \*, abs, ceil, cos, exp, floor, log, log10, max, min, pi, + pow, rand, round, sin, sqrt, srans and tan are all valid operators. + Check the PHP documentation for further information on these + [math](&url.php-manual;eval) functions. + +- If you supply the `assign` attribute, the output of the `{math}` + function will be assigned to this template variable instead of being + output to the template. + +> **Note** +> +> `{math}` is an expensive function in performance due to its use of the +> php [`eval()`](&url.php-manual;eval) function. Doing the math in PHP +> is much more efficient, so whenever possible do the math calculations +> in the script and [`assign()`](#api.assign) the results to the +> template. Definitely avoid repetitive `{math}` function calls, eg +> within [`{section}`](#language.function.section) loops. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- --------- -------------------------------------------------- + equation string Yes *n/a* The equation to execute + format string No *n/a* The format of the result (sprintf) + var numeric Yes *n/a* Equation variable value + assign string No *n/a* Template variable the output will be assigned to + \[var \...\] numeric Yes *n/a* Equation variable value + +**Example a:** + + + {* $height=4, $width=5 *} + + {math equation="x + y" x=$height y=$width} + + + +The above example will output: + + + 9 + + + +**Example b:** + + + {* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *} + + {math equation="height * width / division" + height=$row_height + width=$row_width + division=#col_div#} + + + +The above example will output: + + + 100 + + + +**Example c:** + + + {* you can use parenthesis *} + + {math equation="(( x + y ) / z )" x=2 y=10 z=2} + + + +The above example will output: + + + 6 + + + +**Example d:** + + + {* you can supply a format parameter in sprintf format *} + + {math equation="x + y" x=4.4444 y=5.0000 format="%.2f"} + + + +The above example will output: + + + 9.44 + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-textformat.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-textformat.md new file mode 100644 index 000000000..d0cd4cfc8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-textformat.md @@ -0,0 +1,190 @@ +{textformat} {#language.function.textformat} +============ + +`{textformat}` is a [block function](#plugins.block.functions) used to +format text. It basically cleans up spaces and special characters, and +formats paragraphs by wrapping at a boundary and indenting lines. + +You can set the parameters explicitly, or use a preset style. Currently +"email" is the only available style. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ------------------ ---------------------------------------------------------------------------------------- + style string No *n/a* Preset style + indent number No *0* The number of chars to indent every line + indent\_first number No *0* The number of chars to indent the first line + indent\_char string No *(single space)* The character (or string of chars) to indent with + wrap number No *80* How many characters to wrap each line to + wrap\_char string No *\\n* The character (or string of chars) to break each line with + wrap\_cut boolean No *FALSE* If TRUE, wrap will break the line at the exact character instead of at a word boundary + assign string No *n/a* The template variable the output will be assigned to + + + {textformat wrap=40} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + + +The above example will output: + + + + This is foo. This is foo. This is foo. + This is foo. This is foo. This is foo. + + This is bar. + + bar foo bar foo foo. bar foo bar foo + foo. bar foo bar foo foo. bar foo bar + foo foo. bar foo bar foo foo. bar foo + bar foo foo. bar foo bar foo foo. + + + + + {textformat wrap=40 indent=4} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + + +The above example will output: + + + + This is foo. This is foo. This is + foo. This is foo. This is foo. This + is foo. + + This is bar. + + bar foo bar foo foo. bar foo bar foo + foo. bar foo bar foo foo. bar foo + bar foo foo. bar foo bar foo foo. + bar foo bar foo foo. bar foo bar + foo foo. + + + + + {textformat wrap=40 indent=4 indent_first=4} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + +The above example will output: + + + + This is foo. This is foo. This + is foo. This is foo. This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. bar foo bar + foo foo. bar foo bar foo foo. bar + foo bar foo foo. bar foo bar foo + foo. bar foo bar foo foo. bar foo + bar foo foo. + + + + + {textformat style="email"} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + + +The above example will output: + + + + This is foo. This is foo. This is foo. This is foo. This is foo. This is + foo. + + This is bar. + + bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo + bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo + foo. + + + + +See also [`{strip}`](#language.function.strip) and +[`wordwrap`](#language.modifier.wordwrap). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers.md b/vendor/smarty/smarty/docs/designers/language-modifiers.md new file mode 100644 index 000000000..4cb69cd1e --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers.md @@ -0,0 +1,123 @@ +Variable Modifiers {#language.modifiers} +================== + +## Table of contents +- [capitalize](./language-modifiers/language-modifier-capitalize.md) +- [cat](./language-modifiers/language-modifier-cat.md) +- [count_characters](./language-modifiers/language-modifier-count-characters.md) +- [count_paragraphs](./language-modifiers/language-modifier-count-paragraphs.md) +- [count_sentences](./language-modifiers/language-modifier-count-sentences.md) +- [count_words](./language-modifiers/language-modifier-count-words.md) +- [date_format](./language-modifiers/language-modifier-date-format.md) +- [default](./language-modifiers/language-modifier-default.md) +- [escape](./language-modifiers/language-modifier-escape.md) +- [from_charset](./language-modifiers/language-modifier-from-charset.md) +- [indent](./language-modifiers/language-modifier-indent.md) +- [lower](./language-modifiers/language-modifier-lower.md) +- [nl2br](./language-modifiers/language-modifier-nl2br.md) +- [regex_replace](./language-modifiers/language-modifier-regex-replace.md) +- [replace](./language-modifiers/language-modifier-replace.md) +- [spacify](./language-modifiers/language-modifier-spacify.md) +- [string_format](./language-modifiers/language-modifier-string-format.md) +- [strip](./language-modifiers/language-modifier-strip.md) +- [strip_tags](./language-modifiers/language-modifier-strip-tags.md) +- [to_charset](./language-modifiers/language-modifier-to-charset.md) +- [truncate](./language-modifiers/language-modifier-truncate.md) +- [unescape](./language-modifiers/language-modifier-unescape.md) +- [upper](./language-modifiers/language-modifier-upper.md) +- [wordwrap](./language-modifiers/language-modifier-wordwrap.md) + +Variable modifiers can be applied to +[variables](./language-variables.md), [custom +functions](./language-custom-functions.md) or strings. To apply a modifier, +specify the value followed by a `|` (pipe) and the modifier name. A +modifier may accept additional parameters that affect its behavior. +These parameters follow the modifier name and are separated by a `:` +(colon). Also, *all php-functions can be used as modifiers implicitly* +(more below) and modifiers can be +[combined](./language-combining-modifiers.md). + + + {* apply modifier to a variable *} + {$title|upper} + + {* modifier with parameters *} + {$title|truncate:40:"..."} + + {* apply modifier to a function parameter *} + {html_table loop=$myvar|upper} + + {* with parameters *} + {html_table loop=$myvar|truncate:40:"..."} + + {* apply modifier to literal string *} + {"foobar"|upper} + + {* using date_format to format the current date *} + {$smarty.now|date_format:"%Y/%m/%d"} + + {* apply modifier to a custom function *} + {mailto|upper address="smarty@example.com"} + + {* using php's str_repeat *} + {"="|str_repeat:80} + + {* php's count *} + {$myArray|@count} + + {* this will uppercase and truncate the whole array *} + <select name="name_id"> + {html_options output=$my_array|upper|truncate:20} + </select> + + + +- Modifiers can be applied to any type of variables, including arrays + and objects. + + > **Note** + > + > The default behavior was changed with Smarty 3. In Smarty 2.x, you + > had to use an \"`@`\" symbol to apply a modifier to an array, such + > as `{$articleTitle|@count}`. With Smarty 3, the \"`@`\" is no + > longer necessary, and is ignored. + > + > If you want a modifier to apply to each individual item of an + > array, you will either need to loop the array in the template, or + > provide for this functionality inside your modifier function. + + > **Note** + > + > Second, in Smarty 2.x, modifiers were applied to the result of + > math expressions like `{8+2}`, meaning that + > `{8+2|count_characters}` would give `2`, as 8+2=10 and 10 is two + > characters long. With Smarty 3, modifiers are applied to the + > variables or atomic expressions before executing the calculations, + > so since 2 is one character long, `{8+2|count_characters}` + > gives 9. To get the old result use parentheses like + > `{(8+2)|count_characters}`. + +- Modifiers are autoloaded from the + [`$plugins_dir`](../programmers/api-variables/variable-plugins-dir.md) or can be registered + explicitly with the [`registerPlugin()`](../programmers/api-functions/api-register-plugin.md) + function. The later is useful for sharing a function between php + scripts and smarty templates. + +- All php-functions can be used as modifiers implicitly, as + demonstrated in the example above. However, using php-functions as + modifiers has two little pitfalls: + + - First - sometimes the order of the function-parameters is not + the desirable one. Formatting `$foo` with + `{"%2.f"|sprintf:$foo}` actually works, but asks for the more + intuitive, like `{$foo|string_format:"%2.f"}` that is provided + by the Smarty distribution. + + - Secondly - if security is enabled, all php-functions that are to + be used as modifiers have to be declared trusted in the + `$modifiers` property of the securty policy. See the + [Security](../programmers/advanced-features/advanced-features-security.md) section for details. + +See also [`registerPlugin()`](../programmers/api-functions/api-register-plugin.md), [combining +modifiers](./language-combining-modifiers.md). and [extending smarty with +plugins](../programmers/plugins.md) diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-capitalize.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-capitalize.md new file mode 100644 index 000000000..015bb3bc0 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-capitalize.md @@ -0,0 +1,41 @@ +capitalize {#language.modifier.capitalize} +========== + +This is used to capitalize the first letter of all words in a variable. +This is similar to the PHP [`ucwords()`](&url.php-manual;ucwords) +function. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ----------------------------------------------------------------------------------------------------------- + 1 boolean No FALSE This determines whether or not words with digits will be uppercased + 2 boolean No FALSE This determines whether or not Capital letters within words should be lowercased, e.g. \"aAa\" to \"Aaa\" + + + <?php + + $smarty->assign('articleTitle', 'next x-men film, x3, delayed.'); + + ?> + + + +Where the template is: + + + {$articleTitle} + {$articleTitle|capitalize} + {$articleTitle|capitalize:true} + + + +Will output: + + + next x-men film, x3, delayed. + Next X-Men Film, x3, Delayed. + Next X-Men Film, X3, Delayed. + + + +See also [`lower`](#language.modifier.lower) and +[`upper`](#language.modifier.upper) diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-cat.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-cat.md new file mode 100644 index 000000000..1f43ae177 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-cat.md @@ -0,0 +1,31 @@ +cat {#language.modifier.cat} +=== + +This value is concatenated to the given variable. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- ----------------------------------------------- + 1 string No *empty* This value to catenate to the given variable. + + + <?php + + $smarty->assign('articleTitle', "Psychics predict world didn't end"); + + ?> + + + +Where template is: + + + {$articleTitle|cat:' yesterday.'} + + + +Will output: + + + Psychics predict world didn't end yesterday. + + diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-characters.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-characters.md new file mode 100644 index 000000000..23bc00d51 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-characters.md @@ -0,0 +1,39 @@ +count\_characters {#language.modifier.count.characters} +================= + +This is used to count the number of characters in a variable. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ------------------------------------------------------------------------------- + 1 boolean No FALSE This determines whether or not to include whitespace characters in the count. + + + <?php + + $smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_characters} + {$articleTitle|count_characters:true} + + + +Will output: + + + Cold Wave Linked to Temperatures. + 29 + 33 + + + +See also [`count_words`](#language.modifier.count.words), +[`count_sentences`](#language.modifier.count.sentences) and +[`count_paragraphs`](#language.modifier.count.paragraphs). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-paragraphs.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-paragraphs.md new file mode 100644 index 000000000..02c474e6b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-paragraphs.md @@ -0,0 +1,38 @@ +count\_paragraphs {#language.modifier.count.paragraphs} +================= + +This is used to count the number of paragraphs in a variable. + + + <?php + + $smarty->assign('articleTitle', + "War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\n + Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation." + ); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_paragraphs} + + + +Will output: + + + War Dims Hope for Peace. Child's Death Ruins Couple's Holiday. + + Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation. + 2 + + + +See also [`count_characters`](#language.modifier.count.characters), +[`count_sentences`](#language.modifier.count.sentences) and +[`count_words`](#language.modifier.count.words). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-sentences.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-sentences.md new file mode 100644 index 000000000..0a77ab82a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-sentences.md @@ -0,0 +1,37 @@ +count\_sentences {#language.modifier.count.sentences} +================ + +This is used to count the number of sentences in a variable. A sentence +being delimited by a dot, question- or exclamation-mark (.?!). + + + <?php + + $smarty->assign('articleTitle', + 'Two Soviet Ships Collide - One Dies. + Enraged Cow Injures Farmer with Axe.' + ); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_sentences} + + + +Will output: + + + Two Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe. + 2 + + + +See also [`count_characters`](#language.modifier.count.characters), +[`count_paragraphs`](#language.modifier.count.paragraphs) and +[`count_words`](#language.modifier.count.words). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-words.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-words.md new file mode 100644 index 000000000..d25fbd5b8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-words.md @@ -0,0 +1,33 @@ +count\_words {#language.modifier.count.words} +============ + +This is used to count the number of words in a variable. + + + <?php + + $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_words} + + + +This will output: + + + Dealers Will Hear Car Talk at Noon. + 7 + + + +See also [`count_characters`](#language.modifier.count.characters), +[`count_paragraphs`](#language.modifier.count.paragraphs) and +[`count_sentences`](#language.modifier.count.sentences). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-date-format.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-date-format.md new file mode 100644 index 000000000..edd81937b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-date-format.md @@ -0,0 +1,175 @@ +date\_format {#language.modifier.date.format} +============ + +This formats a date and time into the given +[`strftime()`](&url.php-manual;strftime) format. Dates can be passed to +Smarty as unix [timestamps](&url.php-manual;function.time), [DateTime +objects](&url.php-manual;class.DateTime), mysql timestamps or any string +made up of month day year, parsable by php\'s +[`strtotime()`](&url.php-manual;strtotime). Designers can then use +`date_format` to have complete control of the formatting of the date. If +the date passed to `date_format` is empty and a second parameter is +passed, that will be used as the date to format. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- ------------ ------------------------------------------------- + 1 string No \%b %e, %Y This is the format for the outputted date. + 2 string No n/a This is the default date if the input is empty. + +> **Note** +> +> Since Smarty-2.6.10 numeric values passed to `date_format` are +> *always* (except for mysql timestamps, see below) interpreted as a +> unix timestamp. +> +> Before Smarty-2.6.10 numeric strings that where also parsable by +> `strtotime()` in php (like `YYYYMMDD`) where sometimes (depending on +> the underlying implementation of `strtotime()`) interpreted as date +> strings and NOT as timestamps. +> +> The only exception are mysql timestamps: They are also numeric only +> and 14 characters long (`YYYYMMDDHHMMSS`), mysql timestamps have +> precedence over unix timestamps. + +> **Note** +> +> `date_format` is essentially a wrapper to PHP\'s +> [`strftime()`](&url.php-manual;strftime) function. You may have more +> or less conversion specifiers available depending on your system\'s +> [`strftime()`](&url.php-manual;strftime) function where PHP was +> compiled. Check your system\'s manpage for a full list of valid +> specifiers. However, a few of the specifiers are emulated on Windows. +> These are: %D, %e, %h, %l, %n, %r, %R, %t, %T. + + + <?php + + $config['date'] = '%I:%M %p'; + $config['time'] = '%H:%M:%S'; + $smarty->assign('config', $config); + $smarty->assign('yesterday', strtotime('-1 day')); + + ?> + + + +This template uses [`$smarty.now`](#language.variables.smarty.now) to +get the current time: + + + {$smarty.now|date_format} + {$smarty.now|date_format:"%D"} + {$smarty.now|date_format:$config.date} + {$yesterday|date_format} + {$yesterday|date_format:"%A, %B %e, %Y"} + {$yesterday|date_format:$config.time} + + + +This above will output: + + + Jan 1, 2022 + 01/01/22 + 02:33 pm + Dec 31, 2021 + Monday, December 1, 2021 + 14:33:00 + + + +`date_format` conversion specifiers: + +- \%a - abbreviated weekday name according to the current locale + +- \%A - full weekday name according to the current locale + +- \%b - abbreviated month name according to the current locale + +- \%B - full month name according to the current locale + +- \%c - preferred date and time representation for the current locale + +- \%C - century number (the year divided by 100 and truncated to an + integer, range 00 to 99) + +- \%d - day of the month as a decimal number (range 01 to 31) + +- \%D - same as %m/%d/%y + +- \%e - day of the month as a decimal number, a single digit is + preceded by a space (range 1 to 31) + +- \%g - Week-based year within century \[00,99\] + +- \%G - Week-based year, including the century \[0000,9999\] + +- \%h - same as %b + +- \%H - hour as a decimal number using a 24-hour clock (range 00 + to 23) + +- \%I - hour as a decimal number using a 12-hour clock (range 01 + to 12) + +- \%j - day of the year as a decimal number (range 001 to 366) + +- \%k - Hour (24-hour clock) single digits are preceded by a blank. + (range 0 to 23) + +- \%l - hour as a decimal number using a 12-hour clock, single digits + preceded by a space (range 1 to 12) + +- \%m - month as a decimal number (range 01 to 12) + +- \%M - minute as a decimal number + +- \%n - newline character + +- \%p - either \`am\' or \`pm\' according to the given time value, or + the corresponding strings for the current locale + +- \%r - time in a.m. and p.m. notation + +- \%R - time in 24 hour notation + +- \%S - second as a decimal number + +- \%t - tab character + +- \%T - current time, equal to %H:%M:%S + +- \%u - weekday as a decimal number \[1,7\], with 1 representing + Monday + +- \%U - week number of the current year as a decimal number, starting + with the first Sunday as the first day of the first week + +- \%V - The ISO 8601:1988 week number of the current year as a decimal + number, range 01 to 53, where week 1 is the first week that has at + least 4 days in the current year, and with Monday as the first day + of the week. + +- \%w - day of the week as a decimal, Sunday being 0 + +- \%W - week number of the current year as a decimal number, starting + with the first Monday as the first day of the first week + +- \%x - preferred date representation for the current locale without + the time + +- \%X - preferred time representation for the current locale without + the date + +- \%y - year as a decimal number without a century (range 00 to 99) + +- \%Y - year as a decimal number including the century + +- \%Z - time zone or name or abbreviation + +- \%% - a literal \`%\' character + +See also [`$smarty.now`](#language.variables.smarty.now), +[`strftime()`](&url.php-manual;strftime), +[`{html_select_date}`](#language.function.html.select.date) and the +[date tips](#tips.dates) page. diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-default.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-default.md new file mode 100644 index 000000000..ce08e96ef --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-default.md @@ -0,0 +1,41 @@ +default {#language.modifier.default} +======= + +This is used to set a default value for a variable. If the variable is +unset or an empty string, the given default value is printed instead. +Default takes the one argument. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- --------------------------------------------------------------- + 1 string No *empty* This is the default value to output if the variable is empty. + + + <?php + + $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.'); + $smarty->assign('email', ''); + + ?> + + + +Where template is: + + + {$articleTitle|default:'no title'} + {$myTitle|default:'no title'} + {$email|default:'No email address available'} + + + +Will output: + + + Dealers Will Hear Car Talk at Noon. + no title + No email address available + + + +See also the [default variable handling](#tips.default.var.handling) and +the [blank variable handling](#tips.blank.var.handling) pages. diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-escape.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-escape.md new file mode 100644 index 000000000..37c71dde9 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-escape.md @@ -0,0 +1,74 @@ +escape {#language.modifier.escape} +====== + +`escape` is used to encode or escape a variable to `html`, `url`, +`single quotes`, `hex`, `hexentity`, `javascript` and `mail`. By default +its `html`. + + Parameter Position Type Required Possible Values Default Description + -------------------- --------- ---------- ------------------------------------------------------------------------------------------------------------ --------- ------------------------------------------------------------------------------------- + 1 string No `html`, `htmlall`, `url`, `urlpathinfo`, `quotes`, `hex`, `hexentity`, `javascript`, `mail` `html` This is the escape format to use. + 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to htmlentities() et. al. + 3 boolean No FALSE TRUE Double encode entites from & to &amp; (applys to `html` and `htmlall` only) + + + <?php + + $smarty->assign('articleTitle', + "'Stiff Opposition Expected to Casketless Funeral Plan'" + ); + $smarty->assign('EmailAddress','smarty@example.com'); + + ?> + + + +These are example `escape` template lines followed by the output + + + {$articleTitle} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + {$articleTitle|escape} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + {$articleTitle|escape:'html'} {* escapes & " ' < > *} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + {$articleTitle|escape:'htmlall'} {* escapes ALL html entities *} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + <a href="?title={$articleTitle|escape:'url'}">click here</a> + <a + href="?title=%27Stiff%20Opposition%20Expected%20to%20Casketless%20Funeral%20Plan%27">click here</a> + + {$articleTitle|escape:'quotes'} + \'Stiff Opposition Expected to Casketless Funeral Plan\' + + <a href="mailto:{$EmailAddress|escape:"hex"}">{$EmailAddress|escape:"hexentity"}</a> + {$EmailAddress|escape:'mail'} {* this converts to email to text *} + <a href="mailto:%62%6f%..snip..%65%74">bob..snip..et</a> + + {'mail@example.com'|escape:'mail'} + smarty [AT] example [DOT] com + + + + + {* the "rewind" parameter registers the current location *} + <a href="$my_path?page=foo&rewind=$my_uri|urlencode}">click here</a> + + + +This snippet is useful for emails, but see also +[`{mailto}`](#language.function.mailto) + + + {* email address mangled *} + <a href="mailto:{$EmailAddress|escape:'hex'}">{$EmailAddress|escape:'mail'}</a> + + + +See also [escaping smarty parsing](#language.escaping), +[`{mailto}`](#language.function.mailto) and the [obfuscating email +addresses](#tips.obfuscating.email) page. diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-from-charset.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-from-charset.md new file mode 100644 index 000000000..8b7fdd50f --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-from-charset.md @@ -0,0 +1,19 @@ +from\_charset {#language.modifier.from_charset} +============= + +`from_charset` is used to transcode a string from a given charset to the +internal charset. This is the exact opposite of the [to\_charset +modifier](#language.modifier.to_charset). + + Parameter Position Type Required Possible Values Default Description + -------------------- -------- ---------- -------------------------------------------------------------------------------------------------------------------------- -------------- --------------------------------------------------------------- + 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be decoded from + +> **Note** +> +> Charset encoding should be handled by the application itself. This +> modifier should only be used in cases where the application cannot +> anticipate that a certain string is required in another encoding. + +See also [Charset Enconding](#charset), [from\_charset +modifier](#language.modifier.from_charset). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md new file mode 100644 index 000000000..d0264dca3 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md @@ -0,0 +1,62 @@ +indent {#language.modifier.indent} +====== + +This indents a string on each line, default is 4. As an optional +parameter, you can specify the number of characters to indent. As an +optional second parameter, you can specify the character to use to +indent with eg use `"\t"` for a tab. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- ------------- --------------------------------------------------- + 1 integer No 4 This determines how many characters to indent to. + 2 string No (one space) This is the character used to indent with. + + + <?php + + $smarty->assign('articleTitle', + 'NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25.' + ); + ?> + + + +Where template is: + + + {$articleTitle} + + {$articleTitle|indent} + + {$articleTitle|indent:10} + + {$articleTitle|indent:1:"\t"} + + + +Will output: + + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + + +See also [`strip`](#language.modifier.strip), +[`wordwrap`](#language.modifier.wordwrap) and +[`spacify`](#language.modifier.spacify). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-lower.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-lower.md new file mode 100644 index 000000000..90122e9e4 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-lower.md @@ -0,0 +1,33 @@ +lower {#language.modifier.lower} +===== + +This is used to lowercase a variable. This is equivalent to the PHP +[`strtolower()`](&url.php-manual;strtolower) function. + + + <?php + + $smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|lower} + + + +This will output: + + + Two Convicts Evade Noose, Jury Hung. + two convicts evade noose, jury hung. + + + +See also [`upper`](#language.modifier.upper) and +[`capitalize`](#language.modifier.capitalize). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-nl2br.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-nl2br.md new file mode 100644 index 000000000..541233c8b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-nl2br.md @@ -0,0 +1,35 @@ +nl2br {#language.modifier.nl2br} +===== + +All `"\n"` line breaks will be converted to html `<br />` tags in the +given variable. This is equivalent to the PHP\'s +[`nl2br()`](&url.php-manual;nl2br) function. + + + <?php + + $smarty->assign('articleTitle', + "Sun or rain expected\ntoday, dark tonight" + ); + + ?> + + + +Where the template is: + + + {$articleTitle|nl2br} + + + +Will output: + + + Sun or rain expected<br />today, dark tonight + + + +See also [`word_wrap`](#language.modifier.wordwrap), +[`count_paragraphs`](#language.modifier.count.paragraphs) and +[`count_sentences`](#language.modifier.count.sentences). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-regex-replace.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-regex-replace.md new file mode 100644 index 000000000..6fcb33fad --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-regex-replace.md @@ -0,0 +1,51 @@ +regex\_replace {#language.modifier.regex.replace} +============== + +A regular expression search and replace on a variable. Use the +[`preg_replace()`](&url.php-manual;preg_replace) syntax from the PHP +manual. + +> **Note** +> +> Although Smarty supplies this regex convenience modifier, it is +> usually better to apply regular expressions in PHP, either via custom +> functions or modifiers. Regular expressions are considered application +> code and are not part of presentation logic. + +Parameters + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- ------------------------------------------------ + 1 string Yes *n/a* This is the regular expression to be replaced. + 2 string Yes *n/a* This is the string of text to replace with. + + + <?php + + $smarty->assign('articleTitle', "Infertility unlikely to\nbe passed on, experts say."); + + ?> + + + +Where template is: + + + {* replace each carriage return, tab and new line with a space *} + + {$articleTitle} + {$articleTitle|regex_replace:"/[\r\t\n]/":" "} + + + +Will output: + + + Infertility unlikely to + be passed on, experts say. + Infertility unlikely to be passed on, experts say. + + + +See also [`replace`](#language.modifier.replace) and +[`escape`](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-replace.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-replace.md new file mode 100644 index 000000000..c7c2903ea --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-replace.md @@ -0,0 +1,40 @@ +replace {#language.modifier.replace} +======= + +A simple search and replace on a variable. This is equivalent to the +PHP\'s [`str_replace()`](&url.php-manual;str_replace) function. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- --------------------------------------------- + 1 string Yes *n/a* This is the string of text to be replaced. + 2 string Yes *n/a* This is the string of text to replace with. + + + <?php + + $smarty->assign('articleTitle', "Child's Stool Great for Use in Garden."); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|replace:'Garden':'Vineyard'} + {$articleTitle|replace:' ':' '} + + + +Will output: + + + Child's Stool Great for Use in Garden. + Child's Stool Great for Use in Vineyard. + Child's Stool Great for Use in Garden. + + + +See also [`regex_replace`](#language.modifier.regex.replace) and +[`escape`](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-spacify.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-spacify.md new file mode 100644 index 000000000..8856dab43 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-spacify.md @@ -0,0 +1,40 @@ +spacify {#language.modifier.spacify} +======= + +`spacify` is a way to insert a space between every character of a +variable. You can optionally pass a different character or string to +insert. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- ------------- ----------------------------------------------------------------- + 1 string No *one space* This what gets inserted between each character of the variable. + + + <?php + + $smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|spacify} + {$articleTitle|spacify:"^^"} + + + +Will output: + + + Something Went Wrong in Jet Crash, Experts Say. + S o m e t h i n g W .... snip .... s h , E x p e r t s S a y . + S^^o^^m^^e^^t^^h^^i^^n^^g^^ .... snip .... ^^e^^r^^t^^s^^ ^^S^^a^^y^^. + + + +See also [`wordwrap`](#language.modifier.wordwrap) and +[`nl2br`](#language.modifier.nl2br). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md new file mode 100644 index 000000000..754014e2d --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md @@ -0,0 +1,39 @@ +string\_format {#language.modifier.string.format} +============== + +This is a way to format strings, such as decimal numbers and such. Use +the syntax for [`sprintf()`](&url.php-manual;sprintf) for the +formatting. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- --------------------------------------- + 1 string Yes *n/a* This is what format to use. (sprintf) + + + <?php + + $smarty->assign('number', 23.5787446); + + ?> + + + +Where template is: + + + {$number} + {$number|string_format:"%.2f"} + {$number|string_format:"%d"} + + + +Will output: + + + 23.5787446 + 23.58 + 23 + + + +See also [`date_format`](#language.modifier.date.format). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip-tags.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip-tags.md new file mode 100644 index 000000000..4a019767b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip-tags.md @@ -0,0 +1,41 @@ +strip\_tags {#language.modifier.strip.tags} +=========== + +This strips out markup tags, basically anything between `<` and `>`. + + Parameter Position Type Required Default Description + -------------------- ------ ---------- --------- ---------------------------------------------------------------- + 1 bool No TRUE This determines whether the tags are replaced by \' \' or \'\' + + + <?php + + $smarty->assign('articleTitle', + "Blind Woman Gets <font face=\"helvetica\">New + Kidney</font> from Dad she Hasn't Seen in <b>years</b>." + ); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *} + {$articleTitle|strip_tags:false} + + + +Will output: + + + Blind Woman Gets <font face="helvetica">New Kidney</font> from Dad she Hasn't Seen in <b>years</b>. + Blind Woman Gets New Kidney from Dad she Hasn't Seen in years . + Blind Woman Gets New Kidney from Dad she Hasn't Seen in years. + + + +See also [`replace`](#language.modifier.replace) and +[`regex_replace`](#language.modifier.regex.replace). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip.md new file mode 100644 index 000000000..7027e0313 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip.md @@ -0,0 +1,40 @@ +strip {#language.modifier.strip} +===== + +This replaces all spaces, newlines and tabs with a single space, or with +the supplied string. + +> **Note** +> +> If you want to strip blocks of template text, use the built-in +> [`{strip}`](#language.function.strip) function. + + + <?php + $smarty->assign('articleTitle', "Grandmother of\neight makes\t hole in one."); + $smarty->display('index.tpl'); + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|strip} + {$articleTitle|strip:' '} + + + +Will output: + + + Grandmother of + eight makes hole in one. + Grandmother of eight makes hole in one. + Grandmother of eight makes hole in one. + + + +See also [`{strip}`](#language.function.strip) and +[`truncate`](#language.modifier.truncate). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-to-charset.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-to-charset.md new file mode 100644 index 000000000..6c53232c2 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-to-charset.md @@ -0,0 +1,19 @@ +to\_charset {#language.modifier.to_charset} +=========== + +`to_charset` is used to transcode a string from the internal charset to +a given charset. This is the exact opposite of the [from\_charset +modifier](#language.modifier.from_charset). + + Parameter Position Type Required Possible Values Default Description + -------------------- -------- ---------- -------------------------------------------------------------------------------------------------------------------------- -------------- ------------------------------------------------------------- + 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be encoded to + +> **Note** +> +> Charset encoding should be handled by the application itself. This +> modifier should only be used in cases where the application cannot +> anticipate that a certain string is required in another encoding. + +See also [Charset Enconding](#charset), [from\_charset +modifier](#language.modifier.from_charset). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-truncate.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-truncate.md new file mode 100644 index 000000000..2303a5432 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-truncate.md @@ -0,0 +1,52 @@ +truncate {#language.modifier.truncate} +======== + +This truncates a variable to a character length, the default is 80. As +an optional second parameter, you can specify a string of text to +display at the end if the variable was truncated. The characters in the +string are included with the original truncation length. By default, +`truncate` will attempt to cut off at a word boundary. If you want to +cut off at the exact character length, pass the optional third parameter +of TRUE. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + 1 integer No 80 This determines how many characters to truncate to. + 2 string No \... This is a text string that replaces the truncated text. Its length is included in the truncation length setting. + 3 boolean No FALSE This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE. + 4 boolean No FALSE This determines whether the truncation happens at the end of the string with FALSE, or in the middle of the string with TRUE. Note that if this setting is TRUE, then word boundaries are ignored. + + + <?php + $smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.'); + ?> + + + +where template is: + + + {$articleTitle} + {$articleTitle|truncate} + {$articleTitle|truncate:30} + {$articleTitle|truncate:30:""} + {$articleTitle|truncate:30:"---"} + {$articleTitle|truncate:30:"":true} + {$articleTitle|truncate:30:"...":true} + {$articleTitle|truncate:30:'..':true:true} + + + +This will output: + + + Two Sisters Reunite after Eighteen Years at Checkout Counter. + Two Sisters Reunite after Eighteen Years at Checkout Counter. + Two Sisters Reunite after... + Two Sisters Reunite after + Two Sisters Reunite after--- + Two Sisters Reunite after Eigh + Two Sisters Reunite after E... + Two Sisters Re..ckout Counter. + + diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md new file mode 100644 index 000000000..58d0b3f75 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md @@ -0,0 +1,39 @@ +unescape {#language.modifier.unescape} +======== + +`unescape` is used to decode `entity`, `html` and `htmlall`. It counters +the effects of the [escape modifier](#language.modifier.escape) for the +given types. + + Parameter Position Type Required Possible Values Default Description + -------------------- -------- ---------- ------------------------------------------------------------------------------------------------------------ --------- ------------------------------------------------------------------------------------------------------------------------------ + 1 string No `html`, `htmlall`, `entity`, `html` This is the escape format to use. + 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to html\_entity\_decode() or htmlspecialchars\_decode() or mb\_convert\_encoding() et. al. + + + <?php + + $smarty->assign('articleTitle', + "Germans use "Ümlauts" and pay in €uro" + ); + + ?> + + + +These are example `unescape` template lines followed by the output + + + {$articleTitle} + Germans use "Ümlauts" and pay in €uro + + {$articleTitle|unescape:"html"} + Germans use "Ümlauts" and pay in €uro + + {$articleTitle|unescape:"htmlall"} + Germans use "Ümlauts" and pay in €uro + + + +See also [escaping smarty parsing](#language.escaping), [escape +modifier](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-upper.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-upper.md new file mode 100644 index 000000000..9240f42d6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-upper.md @@ -0,0 +1,31 @@ +upper {#language.modifier.upper} +===== + +This is used to uppercase a variable. This is equivalent to the PHP +[`strtoupper()`](&url.php-manual;strtoupper) function. + + + <?php + $smarty->assign('articleTitle', "If Strike isn't Settled Quickly it may Last a While."); + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|upper} + + + +Will output: + + + If Strike isn't Settled Quickly it may Last a While. + IF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE. + + + +See also [`lower`](#language.modifier.lower) and +[`capitalize`](#language.modifier.capitalize). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-wordwrap.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-wordwrap.md new file mode 100644 index 000000000..97cd774f7 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-wordwrap.md @@ -0,0 +1,69 @@ +wordwrap {#language.modifier.wordwrap} +======== + +Wraps a string to a column width, the default is 80. As an optional +second parameter, you can specify a string of text to wrap the text to +the next line, the default is a carriage return `"\n"`. By default, +`wordwrap` will attempt to wrap at a word boundary. If you want to cut +off at the exact character length, pass the optional third parameter as +TRUE. This is equivalent to the PHP +[`wordwrap()`](&url.php-manual;wordwrap) function. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ------------------------------------------------------------------------------------------------------ + 1 integer No 80 This determines how many columns to wrap to. + 2 string No \\n This is the string used to wrap words with. + 3 boolean No FALSE This determines whether or not to wrap at a word boundary (FALSE), or at the exact character (TRUE). + + + <?php + + $smarty->assign('articleTitle', + "Blind woman gets new kidney from dad she hasn't seen in years." + ); + + ?> + + + +Where template is + + + {$articleTitle} + + {$articleTitle|wordwrap:30} + + {$articleTitle|wordwrap:20} + + {$articleTitle|wordwrap:30:"<br />\n"} + + {$articleTitle|wordwrap:26:"\n":true} + + + +Will output: + + + Blind woman gets new kidney from dad she hasn't seen in years. + + Blind woman gets new kidney + from dad she hasn't seen in + years. + + Blind woman gets new + kidney from dad she + hasn't seen in + years. + + Blind woman gets new kidney<br /> + from dad she hasn't seen in<br /> + years. + + Blind woman gets new kidn + ey from dad she hasn't se + en in years. + + + +See also [`nl2br`](#language.modifier.nl2br) and +[`{textformat}`](#language.function.textformat). diff --git a/vendor/smarty/smarty/docs/designers/language-variables.md b/vendor/smarty/smarty/docs/designers/language-variables.md new file mode 100644 index 000000000..3950d0baf --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables.md @@ -0,0 +1,37 @@ +Variables +========= + +## Table of contents +- [Variables assigned from PHP](./language-variables/language-assigned-variables.md) +- [Variable scopes](./language-variables/language-variable-scopes.md) +- [Variables loaded from config files](./language-variables/language-config-variables.md) +- [{$smarty} reserved variable](./language-variables/language-variables-smarty.md) + + +Smarty has several different types of variables. The type of the +variable depends on what symbol it is prefixed or enclosed within. + +Variables in Smarty can be either displayed directly or used as +arguments for [functions](./language-basic-syntax/language-syntax-functions.md), +[attributes](./language-basic-syntax/language-syntax-attributes.md) and +[modifiers](./language-modifiers.md), inside conditional expressions, etc. +To print a variable, simply enclose it in the +[delimiters](../programmers/api-variables/variable-left-delimiter.md) so that it is the only thing +contained between them. + + + {$Name} + + {$product.part_no} <b>{$product.description}</b> + + {$Contacts[row].Phone} + + <body bgcolor="{#bgcolor#}"> + + + +> **Note** +> +> An easy way to examine assigned Smarty variables is with the +> [debugging console](./chapter-debugging-console.md). + diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-assigned-variables.md b/vendor/smarty/smarty/docs/designers/language-variables/language-assigned-variables.md new file mode 100644 index 000000000..005dea4a9 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-assigned-variables.md @@ -0,0 +1,142 @@ +Variables assigned from PHP {#language.assigned.variables} +=========================== + +Assigned variables that are referenced by preceding them with a dollar +(`$`) sign. + +PHP code + + + <?php + + $smarty = new Smarty(); + + $smarty->assign('firstname', 'Doug'); + $smarty->assign('lastname', 'Evans'); + $smarty->assign('meetingPlace', 'New York'); + + $smarty->display('index.tpl'); + + ?> + +`index.tpl` source: + + + Hello {$firstname} {$lastname}, glad to see you can make it. + <br /> + {* this will not work as $variables are case sensitive *} + This weeks meeting is in {$meetingplace}. + {* this will work *} + This weeks meeting is in {$meetingPlace}. + + + +This above would output: + + + Hello Doug Evans, glad to see you can make it. + <br /> + This weeks meeting is in . + This weeks meeting is in New York. + + + +Associative arrays {#language.variables.assoc.arrays} +------------------ + +You can also reference associative array variables by specifying the key +after a dot \".\" symbol. + + + <?php + $smarty->assign('Contacts', + array('fax' => '555-222-9876', + 'email' => 'zaphod@slartibartfast.example.com', + 'phone' => array('home' => '555-444-3333', + 'cell' => '555-111-1234') + ) + ); + $smarty->display('index.tpl'); + ?> + + + +`index.tpl` source: + + + {$Contacts.fax}<br /> + {$Contacts.email}<br /> + {* you can print arrays of arrays as well *} + {$Contacts.phone.home}<br /> + {$Contacts.phone.cell}<br /> + + + +this will output: + + + 555-222-9876<br /> + zaphod@slartibartfast.example.com<br /> + 555-444-3333<br /> + 555-111-1234<br /> + + + +Array indexes {#language.variables.array.indexes} +------------- + +You can reference arrays by their index, much like native PHP syntax. + + + <?php + $smarty->assign('Contacts', array( + '555-222-9876', + 'zaphod@slartibartfast.example.com', + array('555-444-3333', + '555-111-1234') + )); + $smarty->display('index.tpl'); + ?> + + + +`index.tpl` source: + + + {$Contacts[0]}<br /> + {$Contacts[1]}<br /> + {* you can print arrays of arrays as well *} + {$Contacts[2][0]}<br /> + {$Contacts[2][1]}<br /> + + + +This will output: + + + 555-222-9876<br /> + zaphod@slartibartfast.example.com<br /> + 555-444-3333<br /> + 555-111-1234<br /> + + + +Objects {#language.variables.objects} +------- + +Properties of [objects](#advanced.features.objects) assigned from PHP +can be referenced by specifying the property name after the `->` symbol. + + + name: {$person->name}<br /> + email: {$person->email}<br /> + + + +this will output: + + + name: Zaphod Beeblebrox<br /> + email: zaphod@slartibartfast.example.com<br /> + + diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-config-variables.md b/vendor/smarty/smarty/docs/designers/language-variables/language-config-variables.md new file mode 100644 index 000000000..a3683d99b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-config-variables.md @@ -0,0 +1,83 @@ +Variables loaded from config files {#language.config.variables} +================================== + +Variables that are loaded from the [config files](#config.files) are +referenced by enclosing them within `#hash_marks#`, or with the smarty +variable [`$smarty.config`](#language.variables.smarty.config). The +later syntax is useful for embedding into quoted attribute values, or +accessing variable values such as \$smarty.config.\$foo. + +Example config file - `foo.conf`: + + + pageTitle = "This is mine" + bodyBgColor = '#eeeeee' + tableBorderSize = 3 + tableBgColor = "#bbbbbb" + rowBgColor = "#cccccc" + + + +A template demonstrating the `#hash#` method: + + + {config_load file='foo.conf'} + <html> + <title>{#pageTitle#}</title> + <body bgcolor="{#bodyBgColor#}"> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +A template demonstrating the +[`$smarty.config`](#language.variables.smarty.config) method: + + + {config_load file='foo.conf'} + <html> + <title>{$smarty.config.pageTitle}</title> + <body bgcolor="{$smarty.config.bodyBgColor}"> + <table border="{$smarty.config.tableBorderSize}" bgcolor="{$smarty.config.tableBgColor}"> + <tr bgcolor="{$smarty.config.rowBgColor}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +Both examples would output: + + + <html> + <title>This is mine</title> + <body bgcolor="#eeeeee"> + <table border="3" bgcolor="#bbbbbb"> + <tr bgcolor="#cccccc"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +Config file variables cannot be used until after they are loaded in from +a config file. This procedure is explained later in this document under +[`{config_load}`](#language.function.config.load). + +See also [variables](#language.syntax.variables) and [\$smarty reserved +variables](#language.variables.smarty) diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-variable-scopes.md b/vendor/smarty/smarty/docs/designers/language-variables/language-variable-scopes.md new file mode 100644 index 000000000..2ba3f026b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-variable-scopes.md @@ -0,0 +1,61 @@ +Variable scopes {#language.variable.scopes} +=============== + +You have the choice to assign variables to the scope of the main Smarty +object, data objects created with [`createData()`](#api.create.data), +and template objects created with +[`createTemplate()`](#api.create.template). These objects can be +chained. A template sees all the variables of its own object and all +variables assigned to the objects in its chain of parent objects. + +By default templates which are rendered by +[`$smarty->display(...)`](#api.display) or +[`$smarty->fetch(...)`](#api.fetch) calls are automatically linked to +the Smarty object variable scope. + +By assigning variables to individual data or template objects you have +full control which variables can be seen by a template. + + + + // assign variable to Smarty object scope + $smarty->assign('foo','smarty'); + + // assign variables to data object scope + $data = $smarty->createData(); + $data->assign('foo','data'); + $data->assign('bar','bar-data'); + + // assign variables to other data object scope + $data2 = $smarty->createData($data); + $data2->assign('bar','bar-data2'); + + // assign variable to template object scope + $tpl = $smarty->createTemplate('index.tpl'); + $tpl->assign('bar','bar-template'); + + // assign variable to template object scope with link to Smarty object + $tpl2 = $smarty->createTemplate('index.tpl',$smarty); + $tpl2->assign('bar','bar-template2'); + + // This display() does see $foo='smarty' from the $smarty object + $smarty->display('index.tpl'); + + // This display() does see $foo='data' and $bar='bar-data' from the data object $data + $smarty->display('index.tpl',$data); + + // This display() does see $foo='data' from the data object $data + // and $bar='bar-data2' from the data object $data2 + $smarty->display('index.tpl',$data2); + + // This display() does see $bar='bar-template' from the template object $tpl + $tpl->display(); // or $smarty->display($tpl); + + // This display() does see $bar='bar-template2' from the template object $tpl2 + // and $foo='smarty' form the Smarty object $foo + $tpl2->display(); // or $smarty->display($tpl2); + + + +See also [`assign()`](#api.assign), [`createData()`](#api.create.data) +and [`createTemplate()`](#api.create.template). diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-variables-smarty.md b/vendor/smarty/smarty/docs/designers/language-variables/language-variables-smarty.md new file mode 100644 index 000000000..f9aa2330a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-variables-smarty.md @@ -0,0 +1,176 @@ +{\$smarty} reserved variable {#language.variables.smarty} +============================ + +The PHP reserved `{$smarty}` variable can be used to access several +environment and request variables. The full list of them follows. + +Request variables {#language.variables.smarty.request} +----------------- + +The [request variables](&url.php-manual;reserved.variables) such as +`$_GET`, `$_POST`, `$_COOKIE`, `$_SERVER`, `$_ENV` and `$_SESSION` can +be accessed as demonstrated in the examples below: + + + {* display value of page from URL ($_GET) http://www.example.com/index.php?page=foo *} + {$smarty.get.page} + + {* display the variable "page" from a form ($_POST['page']) *} + {$smarty.post.page} + + {* display the value of the cookie "username" ($_COOKIE['username']) *} + {$smarty.cookies.username} + + {* display the server variable "SERVER_NAME" ($_SERVER['SERVER_NAME'])*} + {$smarty.server.SERVER_NAME} + + {* display the system environment variable "PATH" *} + {$smarty.env.PATH} + + {* display the php session variable "id" ($_SESSION['id']) *} + {$smarty.session.id} + + {* display the variable "username" from merged get/post/cookies/server/env *} + {$smarty.request.username} + + + +> **Note** +> +> For historical reasons `{$SCRIPT_NAME}` is short-hand for +> `{$smarty.server.SCRIPT_NAME}`. +> +> +> <a href="{$SCRIPT_NAME}?page=smarty">click me</a> +> <a href="{$smarty.server.SCRIPT_NAME}?page=smarty">click me</a> + +> **Note** +> +> Although Smarty provides direct access to PHP super globals for +> convenience, it should be used with caution. Directly accessing super +> globals mixes underlying application code structure with templates. A +> good practice is to assign specific needed values to template vars. + +{\$smarty.now} {#language.variables.smarty.now} +-------------- + +The current [timestamp](&url.php-manual;function.time) can be accessed +with `{$smarty.now}`. The value reflects the number of seconds passed +since the so-called Epoch on January 1, 1970, and can be passed directly +to the [`date_format`](#language.modifier.date.format) modifier for +display. Note that [`time()`](&url.php-manual;function.time) is called +on each invocation; eg a script that takes three seconds to execute with +a call to `$smarty.now` at start and end will show the three second +difference. + +::: {.informalexample} + + {* use the date_format modifier to show current date and time *} + {$smarty.now|date_format:'%Y-%m-%d %H:%M:%S'} + + +::: + +{\$smarty.const} {#language.variables.smarty.const} +---------------- + +You can access PHP constant values directly. See also [smarty +constants](#smarty.constants). + +::: {.informalexample} + + <?php + // the constant defined in php + define('MY_CONST_VAL','CHERRIES'); + ?> +::: + +Output the constant in a template with + +::: {.informalexample} + + {$smarty.const.MY_CONST_VAL} +::: + +> **Note** +> +> Although Smarty provides direct access to PHP constants for +> convenience, it is typically avoided as this is mixing underlying +> application code structure into the templates. A good practice is to +> assign specific needed values to template vars. + +{\$smarty.capture} {#language.variables.smarty.capture} +------------------ + +Template output captured via the built-in +[`{capture}..{/capture}`](#language.function.capture) function can be +accessed using the `{$smarty.capture}` variable. See the +[`{capture}`](#language.function.capture) page for more information. + +{\$smarty.config} {#language.variables.smarty.config} +----------------- + +`{$smarty.config}` variable can be used to refer to loaded [config +variables](#language.config.variables). `{$smarty.config.foo}` is a +synonym for `{#foo#}`. See the +[{config\_load}](#language.function.config.load) page for more info. + +{\$smarty.section} {#language.variables.smarty.loops} +------------------ + +The `{$smarty.section}` variables can be used to refer to +[`{section}`](#language.function.section) loop properties. These have +some very useful values such as `.first`, `.index`, etc. + +> **Note** +> +> The `{$smarty.foreach}` variable is no longer used with the new +> [`{foreach}`](#language.function.foreach) syntax, but is still +> supported with Smarty 2.x style foreach syntax. + +{\$smarty.template} {#language.variables.smarty.template} +------------------- + +Returns the name of the current template being processed (without the +directory). + +{\$smarty.template\_object} {#language.variables.smarty.template_object} +--------------------------- + +Returns the template object of the current template being processed. + +{\$smarty.current\_dir} {#language.variables.smarty.current_dir} +----------------------- + +Returns the name of the directory for the current template being +processed. + +{\$smarty.version} {#language.variables.smarty.version} +------------------ + +Returns the version of Smarty the template was compiled with. + + + <div id="footer">Powered by Smarty {$smarty.version}</div> + +{\$smarty.block.child} {#language.variables.smarty.block.child} +---------------------- + +Returns block text from child template. See [Template +interitance](#advanced.features.template.inheritance). + +{\$smarty.block.parent} {#language.variables.smarty.block.parent} +----------------------- + +Returns block text from parent template. See [Template +interitance](#advanced.features.template.inheritance) + +{\$smarty.ldelim}, {\$smarty.rdelim} {#language.variables.smarty.ldelim} +------------------------------------ + +These variables are used for printing the left-delimiter and +right-delimiter value literally, the same as +[`{ldelim},{rdelim}`](#language.function.ldelim). + +See also [assigned variables](#language.assigned.variables) and [config +variables](#language.config.variables) |