smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-07-30 16:07:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improved another chunk of the designers docs

Browse Source
This commit is contained in:
Simon Wisselink
2023-02-06 10:40:00 +01:00
parent 1e0d25638e
commit 694ff1b733
24 changed files with 1261 additions and 1347 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/designers/language-basic-syntax/language-escaping.md
View File

@ -4,7 +4,7 @@ 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.
[delimiters](../language-builtin-functions/language-function-ldelim.md) for Smarty.
> **Note**
>
@ -16,10 +16,12 @@ languages use the { and } characters which are also the default
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
the Smarty class variable [`$auto_literal`](../../programmers/api-variables/variable-auto-literal.md) to
false.
## Examples
```smarty
<script>
// the following braces are ignored by Smarty
// since they are surrounded by whitespace
@ -31,22 +33,20 @@ false.
function bazzy {alert('foobar!');}
{/literal}
</script>
```
[`{literal}..{/literal}`](#language.function.literal) blocks are used
[`{literal}..{/literal}`](../language-builtin-functions/language-function-literal.md) 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)
[`{ldelim}`, `{rdelim}`](../language-builtin-functions/language-function-ldelim.md) tags or
[`{$smarty.ldelim}`,`{$smarty.rdelim}`](../language-variables/language-variables-smarty.md#smartyldelim-smartyrdelim-languagevariablessmartyldelim)
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.
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`](../../programmers/api-variables/variable-left-delimiter.md) and
[`$right_delimiter`](../../programmers/api-variables/variable-right-delimiter.md) values.
> **Note**
>
@ -54,7 +54,7 @@ you can change them with Smarty\'s
> sure to clear out cache and compiled files if you decide to change
> them.
```php
<?php
$smarty->left_delimiter = '<!--{';
@ -63,14 +63,11 @@ you can change them with Smarty\'s
$smarty->assign('foo', 'bar');
$smarty->assign('name', 'Albert');
$smarty->display('example.tpl');
?>
```
Where the template is:
```smarty
Welcome <!--{$name}--> to Smarty
<script language="javascript">
var foo = <!--{$foo}-->;
@ -79,5 +76,4 @@ Where the template is:
}
dosomething();
</script>
```

9
docs/designers/language-basic-syntax/language-math.md
View File

@ -1,9 +1,9 @@
Math {#language.math}
====
# Math
Math can be applied directly to variable values.
## Examples
```smarty
{$foo+1}
{$foo*$bar}
@ -17,8 +17,7 @@ Math can be applied directly to variable values.
{$foo|truncate:"`$fooTruncCount/$barTruncFactor-1`"}
{assign var="foo" value="`$foo+$bar`"}
```
> **Note**
>

11
docs/designers/language-basic-syntax/language-syntax-attributes.md
View File

@ -1,7 +1,6 @@
Attributes {#language.syntax.attributes}
==========
# Attributes
Most of the [functions](#language.syntax.functions) take attributes that
Most of the [functions](./language-syntax-functions.md) 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
@ -12,7 +11,8 @@ 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.
## Examples
```smarty
{include file="header.tpl"}
{include file="header.tpl" nocache} // is equivalent to nocache=true
@ -38,8 +38,7 @@ it gets the default boolean value of true.
<select name="company_id">
{html_options options=$companies selected=$company_id}
</select>
```
> **Note**
>

16
docs/designers/language-basic-syntax/language-syntax-comments.md
View File

@ -1,21 +1,19 @@
Comments {#language.syntax.comments}
========
# Comments
Template comments are surrounded by asterisks, and that is surrounded by
the [delimiter](#variable.left.delimiter) tags like so:
the [delimiter](../../programmers/api-variables/variable-left-delimiter.md) tags like so:
::: {.informalexample}
## Examples
```smarty
{* 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 ;-)
```smarty
{* I am a Smarty comment, I don't exist in the compiled output *}
<html>
<head>
@ -67,5 +65,5 @@ notes in the templates which no one will see ;-)
</body>
</html>
```

28
docs/designers/language-basic-syntax/language-syntax-functions.md
View File

@ -1,12 +1,13 @@
Functions {#language.syntax.functions}
=========
# Functions
Every Smarty tag either prints a [variable](#language.variables) or
Every Smarty tag either prints a [variable](./language-syntax-variables.md) or
invokes some sort of function. These are processed and displayed by
enclosing the function and its [attributes](#language.syntax.attributes)
enclosing the function and its [attributes](./language-syntax-attributes.md)
within delimiters like so: `{funcname attr1="val1" attr2="val2"}`.
## Examples
```smarty
{config_load file="colors.conf"}
{include file="header.tpl"}
@ -19,22 +20,21 @@ within delimiters like so: `{funcname attr1="val1" attr2="val2"}`.
{/if}
{include file="footer.tpl"}
```
- Both [built-in functions](#language.builtin.functions) and [custom
functions](#language.custom.functions) have the same syntax within
- Both [built-in functions](../language-builtin-functions/index.md) and [custom
functions](../language-custom-functions.md) 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
[`{if}`](../language-builtin-functions/language-function-if.md),
[`{section}`](../language-builtin-functions/language-function-section.md) and
[`{strip}`](../language-builtin-functions/language-function-strip.md). 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)
[plugins](../../programmers/plugins.md). They can be modified to your liking, or you can
create new ones. [`{html_options}`](../language-custom-functions/language-function-html-options.md)
is an example of a custom function.
See also [`registerPlugin()`](#api.register.plugin)
See also [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md)

29
docs/designers/language-basic-syntax/language-syntax-quotes.md
View File

@ -1,23 +1,20 @@
Embedding Vars in Double Quotes {#language.syntax.quotes}
===============================
# Embedding Vars in Double 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](https://www.php.net/language.variables)
- Smarty will recognize [assigned](../../programmers/api-functions/api-assign.md)
[variables](./language-syntax-variables.md) embedded in "double
quotes" so long as the variable name contains only numbers, letters
and under_scores. See [naming](https://www.php.net/language.variables)
for more detail.
- With any other characters, for example a period(.) or
`$object->reference`, then the variable must be surrounded by
`` `backticks` ``.
`$object->reference`, then the variable must be surrounded by `` `backticks` ``.
- In addition Smarty3 does allow embedded Smarty tags in double quoted
- In addition, Smarty 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.
<!-- -->
## Examples
```smarty
{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]
@ -30,9 +27,6 @@ Embedding Vars in Double Quotes {#language.syntax.quotes}
{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"}
@ -47,8 +41,7 @@ Embedding Vars in Double Quotes {#language.syntax.quotes}
{* can use variable with dot syntax *}
{include file="`$module.$view`.tpl"}
```
> **Note**
>
@ -58,4 +51,4 @@ Embedding Vars in Double Quotes {#language.syntax.quotes}
> 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).
See also [`escape`](../language-modifiers/language-modifier-escape.md).

24
docs/designers/language-basic-syntax/language-syntax-variables.md
View File

@ -1,18 +1,18 @@
Variables {#language.syntax.variables}
=========
# Variables
Template variables start with the \$dollar sign. They can contain
Template variables start with the $dollar sign. They can contain
numbers, letters and underscores, much like a [PHP
variable](https://www.php.net/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
[Config file variables](../language-variables/language-config-variables.md) are an exception to
the \$dollar syntax and are instead referenced with surrounding
\#hashmarks\#, or via the
[`$smarty.config`](#language.variables.smarty.config) variable.
\#hashmarks\#, or via the [`$smarty.config`](../language-variables/language-variables-smarty.md#smartyconfig-languagevariablessmartyconfig) variable.
## Examples
```smarty
{$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']
@ -91,9 +91,7 @@ the \$dollar syntax and are instead referenced with surrounding
Direct PHP function access:
{time()}
```
> **Note**
>
@ -104,8 +102,8 @@ the \$dollar syntax and are instead referenced with surrounding
> 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.
the reserved [`$smarty`](../language-variables/language-variables-smarty.md) variable.
See also [`$smarty`](#language.variables.smarty), [config
variables](#language.config.variables)
[`{assign}`](#language.function.assign) and [`assign()`](#api.assign).
See also [`$smarty`](../language-variables/language-variables-smarty.md), [config
variables](../language-variables/language-config-variables.md)
[`{assign}`](../language-builtin-functions/language-function-assign.md) and [`assign()`](../../programmers/api-functions/api-assign.md).

3
docs/designers/language-builtin-functions/language-function-config-load.md
View File

@ -11,6 +11,9 @@
| section | No | The name of the section to load |
| scope | no | 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. |
## Examples
The `example.conf` file.
```ini

2
docs/designers/language-builtin-functions/language-function-extends.md
View File

@ -26,6 +26,8 @@ Inheritance](../../programmers/advanced-features/advanced-features-template-inhe
> [`$compile_id`](../../programmers/api-variables/variable-compile-id.md). Otherwise, Smarty cannot
> distinguish between different `$parent_file`s.
## Examples
```smarty
{extends file='parent.tpl'}
{extends 'parent.tpl'} {* short-hand *}

70
docs/designers/language-builtin-functions/language-function-for.md
View File

@ -1,8 +1,6 @@
{for} {#language.function.for}
=====
# {for}
The `{for}{forelse}` tag is used to create simple loops. The following
different formats are supported:
The `{for}{forelse}` tag is used to create simple loops. The following different formats are supported:
- `{for $var=$start to $end}` simple loop with step size of 1.
@ -11,70 +9,68 @@ different formats are supported:
`{forelse}` is executed when the loop is not iterated.
**Attributes:**
## Attributes
Attribute Name Shorthand Type Required Default Description
---------------- ----------- --------- ---------- --------- --------------------------------
max n/a integer No *n/a* Limit the number of iterations
| Attribute | Required | Description |
|-----------|----------|--------------------------------|
| max | No | Limit the number of iterations |
**Option Flags:**
## Option Flags
Name Description
--------- --------------------------------------
nocache Disables caching of the `{for}` loop
| Name | Description |
|---------|--------------------------------------|
| nocache | Disables caching of the `{for}` loop |
## Examples
```smarty
<ul>
{for $foo=1 to 3}
<li>{$foo}</li>
{/for}
</ul>
```
The above example will output:
```html
<ul>
<li>1</li>
<li>2</li>
<li>3</li>
</ul>
```
```php
<?php
$smarty->assign('to',10);
```
```smarty
<ul>
{for $foo=3 to $to max=3}
<li>{$foo}</li>
{/for}
</ul>
```
The above example will output:
```html
<ul>
<li>3</li>
<li>4</li>
<li>5</li>
</ul>
```
```php
<?php
$smarty->assign('start',10);
$smarty->assign('to',5);
```
```smarty
<ul>
{for $foo=$start to $to}
<li>{$foo}</li>
@ -82,16 +78,14 @@ The above example will output:
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)
See also [`{foreach}`](./language-function-foreach.md),
[`{section}`](./language-function-section.md) and
[`{while}`](./language-function-while.md)

200
docs/designers/language-builtin-functions/language-function-foreach.md
View File

@ -1,15 +1,30 @@
{foreach},{foreachelse} {#language.function.foreach}
=======================
# {foreach},{foreachelse}
`{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
[`{section}`](./language-function-section.md) loop, and can also loop over
associative arrays.
`{foreach $arrayvar as $itemvar}`
## Option Flags
`{foreach $arrayvar as $keyvar=>$itemvar}`
| Name | Description |
|---------|------------------------------------------|
| nocache | Disables caching of the `{foreach}` loop |
## Examples
```smarty
{foreach $arrayvar as $itemvar}
{$itemvar|escape}
{/foreach}
{foreach $arrayvar as $keyvar=>$itemvar}
{$keyvar}: {$itemvar|escape}
{/foreach}
```
> **Note**
>
> This foreach syntax does not accept any named attributes. This syntax
@ -26,15 +41,15 @@ associative arrays.
- `{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}` properties are [`@index`](#index),
[`@iteration`](#iteration),
[`@first`](#first),
[`@last`](#last),
[`@show`](#show),
[`@total`](#total).
- `{foreach}` constructs are [`{break}`](#foreach.construct.break),
[`{continue}`](#foreach.construct.continue).
- `{foreach}` constructs are [`{break}`](#break),
[`{continue}`](#continue).
- Instead of specifying the `key` variable you can access the current
key of the loop item by `{$item@key}` (see examples below).
@ -51,92 +66,75 @@ associative arrays.
> `{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
<?php
$arr = array('red', 'green', 'blue');
$smarty->assign('myColors', $arr);
?>
```
Template to output `$myColors` in an un-ordered list
```smarty
<ul>
{foreach $myColors as $color}
<li>{$color}</li>
{/foreach}
</ul>
```
The above example will output:
```html
<ul>
<li>red</li>
<li>green</li>
<li>blue</li>
</ul>
```
```php
<?php
$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');
$smarty->assign('myPeople', $people);
?>
```
Template to output `$myArray` as key/value pairs.
```smarty
<ul>
{foreach $myPeople as $value}
<li>{$value@key}: {$value}</li>
{/foreach}
</ul>
```
The above example will output:
```html
<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
<?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')
));
?>
$smarty->assign(
'contacts',
[
['phone' => '555-555-1234', 'fax' => '555-555-5678', 'cell' => '555-555-0357'],
['phone' => '800-555-4444', 'fax' => '800-555-3333', 'cell' => '800-555-2222'],
]
);
```
The template to output `$contact`.
```smarty
{* key always available as a property *}
{foreach $contacts as $contact}
{foreach $contact as $value}
@ -150,25 +148,23 @@ The template to output `$contact`.
{$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
<?php
include('Smarty.class.php');
@ -193,19 +189,16 @@ looping over a PHP iterator instead of an array().
$smarty->assign('res',$res);
$smarty->display('index.tpl');?>
?>
```
```smarty
{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`.
@ -216,12 +209,11 @@ 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
`index` contains the current array index, starting with zero.
```smarty
{* output empty row on the 4th iteration (when index is 3) *}
<table>
{foreach $items as $i}
@ -232,33 +224,33 @@ result sets.
<tr><td>{$i.label}</td></tr>
{/foreach}
</table>
```
\@iteration {#foreach.property.iteration}
-----------
## @iteration
`iteration` contains the current loop iteration and always starts at
one, unlike [`index`](#foreach.property.index). It is incremented by one
one, unlike [`index`](#index). It is incremented by one
on each iteration.
The *\"is div by\"* operator can be used to detect a specific iteration.
The *"is div by"* operator can be used to detect a specific iteration.
Here we bold-face the name every 4th iteration.
```smarty
{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
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.
```smarty
{foreach $myNames as $name}
{if $name@iteration is even by 3}
<span style="color: #000">{$name}</span>
@ -266,12 +258,11 @@ iteration.
<span style="color: #eee">{$name}</span>
{/if}
{/foreach}
```
This will output something similar to this:
```html
<span style="color: #000">...</span>
<span style="color: #000">...</span>
<span style="color: #000">...</span>
@ -285,16 +276,14 @@ This will output something similar to this:
<span style="color: #eee">...</span>
<span style="color: #eee">...</span>
...
```
\@first {#foreach.property.first}
-------
## @first
`first` is TRUE if the current `{foreach}` iteration is the initial one.
Here we display a table header row on the first iteration.
```smarty
{* show table header at first iteration *}
<table>
{foreach $items as $i}
@ -310,47 +299,43 @@ Here we display a table header row on the first iteration.
</tr>
{/foreach}
</table>
```
\@last {#foreach.property.last}
------
## @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.
```smarty
{* 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}
------
## @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.
```smarty
<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
`total` contains the number of iterations that this `{foreach}` will
loop. This can be used inside or after the `{foreach}`.
```smarty
{* show number of rows at end *}
{foreach $items as $item}
{$item.name}<hr/>
@ -360,17 +345,17 @@ loop. This can be used inside or after the `{foreach}`.
{foreachelse}
... no items to loop ...
{/foreach}
```
See also [`{section}`](#language.function.section),
[`{for}`](#language.function.for) and
[`{while}`](#language.function.while)
See also [`{section}`](./language-function-section.md),
[`{for}`](./language-function-for.md) and
[`{while}`](./language-function-while.md)
{break} {#foreach.construct.break}
-------
## {break}
`{break}` aborts the iteration of the array
```smarty
{$data = [1,2,3,4,5]}
{foreach $data as $value}
{if $value == 3}
@ -382,16 +367,14 @@ See also [`{section}`](#language.function.section),
{*
prints: 1 2
*}
```
{continue} {#foreach.construct.continue}
----------
## {continue}
`{continue}` leaves the current iteration and begins with the next
iteration.
```smarty
{$data = [1,2,3,4,5]}
{foreach $data as $value}
{if $value == 3}
@ -403,5 +386,4 @@ iteration.
{*
prints: 1 2 4 5
*}
```

33
docs/designers/language-builtin-functions/language-function-function.md
View File

@ -1,5 +1,4 @@
{function} {#language.function.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
@ -12,15 +11,22 @@ nested menus.
> 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
> template. Otherwise, you can directly use the function as
> `{funcname ...}` in the template.
## Attributes
| Attribute Name | Required | Description |
|----------------|----------|---------------------------------------------------------------|
| name | Yes | The name of the template function |
| \[var \...\] | No | default variable value to pass local to the template function |
- The `{function}` tag must have the `name` attribute which contains
the the name of the template function. A tag with this name can be
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
as [attributes](../language-basic-syntax/language-syntax-attributes.md). 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.
@ -30,12 +36,7 @@ nested menus.
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**
>
@ -45,7 +46,9 @@ nested menus.
> values must be scalar and can not be variable. Variables must be
> passed when the template is called.
## Examples
```smarty
{* define the function *}
{function name=menu level=0}
{function menu level=0} {* short-hand *}
@ -67,12 +70,11 @@ nested menus.
{* run the array through the function *}
{menu data=$menu}
```
Will generate the following output
```
* item1
* item2
* item3
@ -82,7 +84,6 @@ Will generate the following output
+ item3-3-1
+ item3-3-2
* item4
```
See also [`{call}`](#language.function.call)
See also [`{call}`](./language-function-call.md)

51
docs/designers/language-builtin-functions/language-function-if.md
View File

@ -1,39 +1,41 @@
{if},{elseif},{else} {#language.function.if}
====================
# {if},{elseif},{else}
`{if}` statements in Smarty have much the same flexibility as PHP
[if](https://www.php.net/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.
*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.
If security is enabled, only PHP functions from `$php_functions` property
of the security policy are allowed. See the
[Security](../../programmers/advanced-features/advanced-features-security.md) 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
## Qualifiers
| 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 | modulo | % |
| 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 |
## Examples
```smarty
{if $name eq 'Fred'}
Welcome Sir.
{elseif $name eq 'Wilma'}
@ -106,9 +108,6 @@ separated from surrounding elements by spaces. Note that items listed in
...
{/if}
{if isset($name) && $name == 'Blog'}
{* do something *}
{elseif $name == $foo}
@ -118,4 +117,4 @@ separated from surrounding elements by spaces. Note that items listed in
{if is_array($foo) && count($foo) > 0}
{* do a foreach loop *}
{/if}
```

105
docs/designers/language-builtin-functions/language-function-include.md
View File

@ -1,19 +1,31 @@
{include} {#language.function.include}
=========
# {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.
## Attributes
| Attribute Name | Required | Description |
|----------------|----------|--------------------------------------------------------------------------------------------|
| file | Yes | The name of the template file to include |
| assign | No | The name of the variable that the output of include will be assigned to |
| cache_lifetime | No | Enable caching of this subtemplate with an individual cache lifetime |
| compile_id | No | Compile this subtemplate with an individual compile_id |
| cache_id | No | Enable caching of this subtemplate with an individual cache_id |
| scope | No | Define the scope of all in the subtemplate assigned variables: 'parent','root' or 'global' |
| \[var \...\] | No | variable to pass local to 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).
being displayed. Similar to [`{assign}`](./language-function-assign.md).
- Variables can be passed to included templates as
[attributes](#language.syntax.attributes). Any variables explicitly
[attributes](../language-basic-syntax/language-syntax-attributes.md). 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.
@ -25,35 +37,24 @@ available within the included template.
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
at the [`{assign}`](./language-function-assign.md) 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)
- Use the syntax for [template resources](../../programmers/resources.md) to `{include}`
files outside of the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md)
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
## 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 |
## Examples
```smarty
<html>
<head>
<title>{$title}</title>
@ -70,19 +71,19 @@ available within the included template.
{include 'page_footer.tpl'}
</body>
</html>
```
```smarty
{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
```smarty
<div id="box">
<h3>{$title}{/h3>
<ul>
@ -91,58 +92,55 @@ The template above includes the example `links.tpl` below
</foreach}
</ul>
</div>
```
Variables assigned in the included template will be seen in the
including template.
```smarty
{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
```smarty
...
{assign var=foo value='something'}
{assign var=bar value='value'}
...
```
The included template will not be cached.
```smarty
{include 'sub_template.tpl' nocache}
...
```
In this example included template will be cached with an individual
cache lifetime of 500 seconds.
```smarty
{include 'sub_template.tpl' cache_lifetime=500}
...
```
In this example included template will be cached independent of the
global caching setting.
```smarty
{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.
```smarty
<body>
{include 'nav.tpl' assign=navbar}
{include 'header.tpl' title='Smarty is cool'}
@ -151,20 +149,18 @@ variable, which is then output at both the top and bottom of the page.
{$navbar}
{include 'footer.tpl'}
</body>
```
This example includes another template relative to the directory of the
current template.
```smarty
{include 'template-in-a-template_dir-directory.tpl'}
{include './template-in-same-directory.tpl'}
{include '../template-in-parent-directory.tpl'}
```
```smarty
{* absolute filepath *}
{include file='/usr/local/include/templates/header.tpl'}
@ -185,8 +181,7 @@ current template.
{* include a multi $variable template - eg amber/links.view.tpl *}
{include file="$style_dir/$module.$view.tpl"}
```
See also [`{insert}`](#language.function.insert), [template resources](#resources) and
[componentized templates](#tips.componentized.templates).
See also [`{insert}`](./language-function-insert.md), [template resources](../../programmers/resources.md) and
[componentized templates](../../appendixes/tips.md#componentized-templates).

48
docs/designers/language-builtin-functions/language-function-insert.md
View File

@ -1,51 +1,51 @@
{insert} {#language.function.insert}
========
# {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)
`{insert}` tags work much like [`{include}`](./language-function-include.md)
tags, except that `{insert}` tags are NOT cached when template
[caching](#caching) is enabled. They will be executed on every
[caching](../../programmers/caching.md) 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
| Attribute Name | Required | Description |
|----------------|----------|----------------------------------------------------------------------------------|
| name | Yes | The name of the insert function (insert_`name`) or insert plugin |
| assign | No | The name of the template variable the output will be assigned to |
| script | No | The name of the php script that is included before the insert function is called |
| \[var \...\] | No | variable to pass to insert function |
Let\'s say you have a template with a banner slot at the top of the
## Examples
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
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
[config file](../config-files.md)), and needs to call a function to get the
banner contents.
```smarty
{* 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
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\"));
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}`
@ -54,8 +54,8 @@ and display the returned results in place of the {insert} tag.
> **Note**
>
> Assigning the output to a template variable isn\'t too useful with
> [caching](#variable.caching) enabled.
> Assigning the output to a template variable isn't too useful with
> [caching](../../programmers/api-variables/variable-caching.md) enabled.
- If you supply the `script` attribute, this php script will be
included (only once) before the `{insert}` function is executed.
@ -63,9 +63,9 @@ and display the returned results in place of the {insert} tag.
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,
[`$trusted_dir`](../../programmers/api-variables/variable-trusted-dir.md). If security is enabled,
then the script must be located in the `$trusted_dir` path of the
security policy. See the [Security](#advanced.features.security)
security policy. See the [Security](../../programmers/advanced-features/advanced-features-security.md)
section for details.
The Smarty object is passed as the second argument. This way you can
@ -78,9 +78,9 @@ 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
> have [caching](../../programmers/api-variables/variable-caching.md) 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)
See also [`{include}`](./language-function-include.md)

44
docs/designers/language-builtin-functions/language-function-ldelim.md
View File

@ -1,55 +1,51 @@
{ldelim},{rdelim} {#language.function.ldelim}
=================
# {ldelim}, {rdelim}
`{ldelim}` and `{rdelim}` are used for [escaping](#language.escaping)
`{ldelim}` and `{rdelim}` are used for [escaping](../language-basic-syntax/language-escaping.md)
template delimiters, by default **{** and **}**. You can also use
[`{literal}{/literal}`](#language.function.literal) to escape blocks of
[`{literal}{/literal}`](./language-function-literal.md) to escape blocks of
text eg Javascript or CSS. See also the complementary
[`{$smarty.ldelim}`](#language.variables.smarty.ldelim).
[`{$smarty.ldelim}`](../../programmers/api-variables/variable-left-delimiter.md).
```smarty
{* 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">
```smarty
<script>
function foo() {ldelim}
... code ...
{rdelim}
</script>
```
will output
<script language="JavaScript">
```html
<script>
function foo() {
.... code ...
}
</script>
```
<script language="JavaScript" type="text/javascript">
```smarty
<script>
function myJsFunction(){ldelim}
alert("The server name\n{$smarty.server.SERVER_NAME}\n{$smarty.server.SERVER_ADDR}");
alert("The server name\n{$smarty.server.SERVER_NAME|escape:javascript}\n{$smarty.server.SERVER_ADDR|escape:javascript}");
{rdelim}
</script>
<a href="javascript:myJsFunction()">Click here for Server Info</a>
```
See also [`{literal}`](#language.function.literal) and [escaping Smarty
parsing](#language.escaping).
See also [`{literal}`](./language-function-literal.md) and [escaping Smarty
parsing](../language-basic-syntax/language-escaping.md).

16
docs/designers/language-builtin-functions/language-function-literal.md
View File

@ -1,13 +1,12 @@
{literal} {#language.function.literal}
=========
# {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
[delimiter](../../programmers/api-variables/variable-left-delimiter.md) 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
[`{ldelim}{rdelim}`](./language-function-ldelim.md) to escape the individual
delimiters instead.
> **Note**
@ -17,7 +16,7 @@ delimiters instead.
> javascript and CSS curly braces are surrounded by whitespace. This is
> new behavior to Smarty 3.
```smarty
<script>
// the following braces are ignored by Smarty
// since they are surrounded by whitespace
@ -29,8 +28,7 @@ delimiters instead.
function myBar {alert('Bar!');}
{/literal}
</script>
```
See also [`{ldelim} {rdelim}`](#language.function.ldelim) and the
[escaping Smarty parsing](#language.escaping) page.
See also [`{ldelim} {rdelim}`](./language-function-ldelim.md) and the
[escaping Smarty parsing](../language-basic-syntax/language-escaping.md) page.

11
docs/designers/language-builtin-functions/language-function-nocache.md
View File

@ -1,5 +1,4 @@
{nocache} {#language.function.nocache}
=========
# {nocache}
`{nocache}` is used to disable caching of a template section. Every
`{nocache}` must be paired with a matching `{/nocache}`.
@ -9,15 +8,13 @@
> Be sure any variables used within a non-cached section are also
> assigned from PHP when the page is loaded from the cache.
```smarty
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).
See also the [caching section](../../programmers/caching.md).

340
docs/designers/language-builtin-functions/language-function-section.md
View File

@ -1,14 +1,13 @@
{section},{sectionelse} {#language.function.section}
=======================
# {section}, {sectionelse}
A `{section}` is for looping over **sequentially indexed arrays of
data**, unlike [`{foreach}`](#language.function.foreach) which is used
data**, unlike [`{foreach}`](./language-function-foreach.md) 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
> The [`{foreach}`](./language-function-foreach.md) loop can do everything a
> {section} loop can do, and has a simpler and easier syntax. It is
> usually preferred over the {section} loop.
@ -16,22 +15,25 @@ be paired with a closing `{/section}` tag.
>
> {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.
> arrays, use the [`{foreach}`](./language-function-foreach.md) 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:**
## Attributes
Name Description
--------- ------------------------------------------
nocache Disables caching of the `{section}` loop
| Attribute Name | Required | Description |
|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | Yes | The name of the section |
| loop | Yes | Value to determine the number of loop iterations |
| start | No | 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. Defaults to 0. |
| step | No | 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. Defaults to 1. |
| max | No | Sets the maximum number of times the section will loop. |
| show | No | Determines whether to show this section (defaults to true) |
## Option Flags
| Name | Description |
|---------|------------------------------------------|
| nocache | Disables caching of the `{section}` loop |
- Required attributes are `name` and `loop`.
@ -39,7 +41,7 @@ be paired with a closing `{/section}` tag.
letters, numbers and underscores, like [PHP
variables](https://www.php.net/language.variables).
- {section}\'s can be nested, and the nested `{section}` names must be
- {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
@ -54,30 +56,32 @@ be paired with a closing `{/section}` tag.
- A `{section}` also has its own variables that handle `{section}`
properties. These properties are accessible as:
[`{$smarty.section.name.property}`](#language.variables.smarty.loops)
[`{$smarty.section.name.property}`](../language-variables/language-variables-smarty.md#smartysection-languagevariablessmartyloops)
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).
- `{section}` properties are [`index`](#index),
[`index_prev`](#index_prev),
[`index_next`](#index_next),
[`iteration`](#iteration),
[`first`](#first),
[`last`](#last),
[`rownum`](#rownum),
[`loop`](#loop), [`show`](#show),
[`total`](#total).
[`assign()`](#api.assign) an array to Smarty
[`assign()`](../../programmers/api-functions/api-assign.md) an array to Smarty
## Examples
```php
<?php
$data = array(1000,1001,1002);
$data = [1000, 1001, 1002];
$smarty->assign('custid', $data);
?>
```
The template that outputs the array
```smarty
{* this example will print out all the values of the $custid array *}
{section name=customer loop=$custid}
{section customer $custid} {* short-hand *}
@ -89,12 +93,11 @@ The template that outputs the array
{section foo $custid step=-1} {* short-hand *}
{$custid[foo]}<br />
{/section}
```
The above example will output:
```html
id: 1000<br />
id: 1001<br />
id: 1002<br />
@ -102,10 +105,9 @@ The above example will output:
id: 1002<br />
id: 1001<br />
id: 1000<br />
```
```smarty
{section name=foo start=10 loop=20 step=2}
{$smarty.section.foo.index}
{/section}
@ -113,51 +115,48 @@ The above example will output:
{section name=bar loop=21 max=6 step=-2}
{$smarty.section.bar.index}
{/section}
```
The above example will output:
```html
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](https://www.php.net/language.variables). It is used to reference
the data within the `{section}`.
```smarty
{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
<?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')
);
$data = [
['name' => 'John Smith', 'home' => '555-555-5555',
'cell' => '666-555-5555', 'email' => 'john@myexample.com'],
['name' => 'Jack Jones', 'home' => '777-555-5555',
'cell' => '888-555-5555', 'email' => 'jack@myexample.com'],
['name' => 'Jane Munson', 'home' => '000-555-5555',
'cell' => '123456', 'email' => 'jane@myexample.com']
];
$smarty->assign('contacts',$data);
?>
```
The template to output `$contacts`
```smarty
{section name=customer loop=$contacts}
<p>
name: {$contacts[customer].name}<br />
@ -166,12 +165,11 @@ The template to output `$contacts`
e-mail: {$contacts[customer].email}
</p>
{/section}
```
The above example will output:
```html
<p>
name: John Smith<br />
home: 555-555-5555<br />
@ -190,26 +188,24 @@ The above example will output:
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.
assign's the arrays to Smarty.
```php
<?php
$id = array(1001,1002,1003);
$id = [1001,1002,1003];
$smarty->assign('custid',$id);
$fullnames = array('John Smith','Jack Jones','Jane Munson');
$fullnames = ['John Smith','Jack Jones','Jane Munson'];
$smarty->assign('name',$fullnames);
$addr = array('253 Abbey road', '417 Mulberry ln', '5605 apple st');
$addr = ['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
@ -217,7 +213,7 @@ 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.
```smarty
{section name=customer loop=$custid}
<p>
id: {$custid[customer]}<br />
@ -225,12 +221,11 @@ to specify the number of loops.
address: {$address[customer]}
</p>
{/section}
```
The above example will output:
```html
<p>
id: 1000<br />
name: John Smith<br />
@ -246,47 +241,44 @@ The above example will output:
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 that
{section}'s can be nested as deep as you like. With nested
{section}'s, you can access complex data structures, such as
multidimensional arrays. This is an example `.php` script that
assigns the arrays.
```php
<?php
$id = array(1001,1002,1003);
$id = [1001,1002,1003];
$smarty->assign('custid',$id);
$fullnames = array('John Smith','Jack Jones','Jane Munson');
$fullnames = ['John Smith','Jack Jones','Jane Munson'];
$smarty->assign('name',$fullnames);
$addr = array('253 N 45th', '417 Mulberry ln', '5605 apple st');
$addr = ['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')
);
$types = [
[ 'home phone', 'cell phone', 'e-mail'],
[ 'home phone', 'web'],
[ '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')
);
$info = [
['555-555-5555', '666-555-5555', 'john@myexample.com'],
[ '123-456-4', 'www.example.com'],
[ '0457878']
];
$smarty->assign('contact_info', $info);
```
?>
In this template, *\$contact\_type\[customer\]* is an array of contact
In this template, *$contact_type\[customer\]* is an array of contact
types for the current customer.
```smarty
{section name=customer loop=$custid}
<hr>
id: {$custid[customer]}<br />
@ -296,12 +288,11 @@ types for the current customer.
{$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br />
{/section}
{/section}
```
The above example will output:
```html
<hr>
id: 1000<br />
name: John Smith<br />
@ -320,21 +311,20 @@ The above example will output:
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
<?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
```smarty
<table>
<tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>
{section name=co loop=$contacts}
@ -349,10 +339,9 @@ The template to output the database result in a HTML table
<tr><td colspan="5">No items found</td></tr>
{/section}
</table>
```
.index {#section.property.index}
------
## .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.
@ -360,51 +349,47 @@ 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,
> the same as the [`iteration`](#iteration) property,
> except it starts at zero instead of one.
> **Note**
>
> `$custid[customer.index]` and `$custid[customer]` are identical.
```smarty
{section name=customer loop=$custid}
{$smarty.section.customer.index} id: {$custid[customer]}<br />
{/section}
```
The above example will output:
```html
0 id: 1000<br />
1 id: 1001<br />
2 id: 1002<br />
```
## .index_prev
.index\_prev {#section.property.index.prev}
------------
`index_prev` is the previous loop index. On the first loop, this is set to -1.
`index_prev` is the previous loop index. On the first loop, this is set
to -1.
.index\_next {#section.property.index.next}
------------
## .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
<?php
$data = array(1001,1002,1003,1004,1005);
$data = [1001,1002,1003,1004,1005];
$smarty->assign('rows',$data);
?>
```
Template to output the above array in a table
```smarty
{* $rows[row.index] and $rows[row] are identical in meaning *}
<table>
<tr>
@ -420,68 +405,63 @@ Template to output the above array in a table
</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
`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.
> `max`, unlike the [`index`](#index) property.
> `iteration` also starts with one instead of zero unlike `index`.
> [`rownum`](#section.property.rownum) is an alias to `iteration`, they
> [`rownum`](#rownum) is an alias to `iteration`, they
> are identical.
```php
<?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`
```smarty
{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:
```html
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.
```smarty
<table>
{section name=co loop=$contacts}
{if $smarty.section.co.iteration is div by 5}
@ -496,13 +476,12 @@ header block every five rows.
<tr>
{/section}
</table>
```
An that uses the `iteration` property to alternate a text color every
An example that uses the `iteration` property to alternate a text color every
third row.
```smarty
<table>
{section name=co loop=$contacts}
{if $smarty.section.co.iteration is even by 3}
@ -512,35 +491,31 @@ third row.
{/if}
{/section}
</table>
```
> **Note**
>
> The *\"is div by\"* syntax is a simpler alternative to the PHP mod
> 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.
> You can also use *"is odd by"* to reverse the alternating.
.first {#section.property.first}
------
## .first
`first` is set to TRUE if the current `{section}` iteration is the
initial one.
`first` is set to TRUE if the current `{section}` iteration is the initial one.
.last {#section.property.last}
-----
## .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.
[`total`](#total) property.
```smarty
{section name=customer loop=$customers}
{if $smarty.section.customer.first}
<table>
@ -557,51 +532,45 @@ first iteration and on the last outputs the footer block. Also uses the
</table>
{/if}
{/section}
```
.rownum {#section.property.rownum}
-------
## .rownum
`rownum` contains the current loop iteration, starting with one. It is
an alias to [`iteration`](#section.property.iteration), they work
an alias to [`iteration`](#iteration), they work
identically.
.loop {#section.property.loop}
-----
## .loop
`loop` contains the last index number that this {section} looped. This
can be used inside or after the `{section}`.
```smarty
{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:
```html
0 id: 1000<br />
1 id: 1001<br />
2 id: 1002<br />
There are 3 customers shown above.
```
.show {#section.property.show}
-----
## .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.
to regulate whether this section shows.
```smarty
{section name=customer loop=$customers show=$show_customer_info}
{$smarty.section.customer.rownum} id: {$customers[customer]}<br />
{/section}
@ -611,34 +580,31 @@ to regulate whether or not this section shows.
{else}
the section was not shown.
{/if}
```
The above example will output:
```html
1 id: 1000<br />
2 id: 1001<br />
3 id: 1002<br />
the section was shown.
```
.total {#section.property.total}
------
## .total
`total` contains the number of iterations that this `{section}` will
loop. This can be used inside or after a `{section}`.
```smarty
{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).
See also [`{foreach}`](./language-function-foreach.md),
[`{for}`](./language-function-for.md), [`{while}`](./language-function-while.md)
and [`$smarty.section`](../language-variables/language-variables-smarty.md#smartysection-languagevariablessmartyloops).

33
docs/designers/language-builtin-functions/language-function-setfilter.md
View File

@ -1,28 +1,34 @@
{setfilter} {#language.function.setfilter}
===========
# {setfilter}
The `{setfilter}...{/setfilter}` block tag allows the definition of
template instance\'s variable filters.
template instance's variable filters.
SYNTAX: {setfilter filter1\|filter2\|filter3\....}\...{/setfilter}
SYNTAX: `{setfilter filter1\|filter2\|filter3\....}\...{/setfilter}`
The filter can be:
- A variable filter plugin specified by it\'s name.
- A variable filter plugin specified by it's name.
- A modifier specified by it\'s name and optional additional
- A modifier 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.
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.
> **Note**
>
> The setting of template instance filters does not affect the output of
> included subtemplates.
## Examples
```smarty
<script>
{setfilter filter1}
{$foo} {* filter1 runs on output of $foo *}
@ -33,10 +39,5 @@ default\_modifier can be disabled with the `nofilter` flag.
{/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.

27
docs/designers/language-builtin-functions/language-function-strip.md
View File

@ -1,9 +1,8 @@
{strip} {#language.function.strip}
=======
# {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
"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.
@ -15,34 +14,32 @@ 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.
> see the [strip modifier](../language-modifiers/language-modifier-strip.md) instead.
```smarty
{* the following will be all run into one line upon output *}
{strip}
<table border='0'>
<table>
<tr>
<td>
<a href="{$url}">
<font color="red">This is a test</font>
<a href="#">
This is a test
</a>
</td>
</tr>
</table>
{/strip}
```
The above example will output:
<table border='0'><tr><td><a href="http://. snipped...</a></td></tr></table>
```html
<table><tr><td><a href="#">This is a test</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.
See also the [`strip`](../language-modifiers/language-modifier-strip.md) modifier.

52
docs/designers/language-builtin-functions/language-function-while.md
View File

@ -1,43 +1,43 @@
{while} {#language.function.while}
=======
# {while}
`{while}` loops in Smarty have much the same flexibility as PHP
[while](https://www.php.net/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.
*\|\|*, *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
## Qualifiers
| 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 | modulo | % |
| 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 |
## Examples
```smarty
{while $foo > 0}
{$foo--}
{/while}
```
The above example will count down the value of $foo until 1 is reached.
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).
See also [`{foreach}`](./language-function-foreach.md),
[`{for}`](./language-function-for.md) and
[`{section}`](./language-function-section.md).

2
docs/programmers/api-functions/api-add-config-dir.md
View File

@ -21,7 +21,7 @@ key
<?php
// add directory where config files are stored
$smarty->addConigDir('./config_1');
$smarty->addConfigDir('./config_1');
// add directory where config files are stored and specify array-key
$smarty->addConfigDir('./config_1', 'one');

2
mkdocs.yml
View File

@ -36,7 +36,7 @@ nav:
- Attributes: 'designers/language-basic-syntax/language-syntax-attributes.md'
- Quotes: 'designers/language-basic-syntax/language-syntax-quotes.md'
- Math: 'designers/language-basic-syntax/language-math.md'
- Escaping: 'designers/language-basic-syntax/language-escaping.md'
- 'Escaping Smarty Parsing': 'designers/language-basic-syntax/language-escaping.md'
- 'designers/language-variables.md'
- 'designers/language-modifiers.md'
- 'designers/language-combining-modifiers.md'