From 5fdcb3c6fad2f2e537fc84cc772415f2ec2b29b3 Mon Sep 17 00:00:00 2001 From: Simon Wisselink Date: Tue, 31 Jan 2023 11:23:50 +0100 Subject: [PATCH 01/19] Fix error in docs on prepend/append. Fixes #818. --- .../language-builtin-functions/language-function-block.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/designers/language-builtin-functions/language-function-block.md b/docs/designers/language-builtin-functions/language-function-block.md index 82659852..f8629c1e 100644 --- a/docs/designers/language-builtin-functions/language-function-block.md +++ b/docs/designers/language-builtin-functions/language-function-block.md @@ -79,7 +79,7 @@ child.tpl {extends file="parent.tpl"} - {block name="title" prepend} + {block name="title" append} Page Title {/block} @@ -109,7 +109,7 @@ child.tpl {extends file="parent.tpl"} - {block name="title" append} + {block name="title" prepend} Page Title {/block} From c94d3ddafa8e41e73f127af1959b4715db021d1e Mon Sep 17 00:00:00 2001 From: Simon Wisselink Date: Fri, 3 Feb 2023 22:29:08 +0100 Subject: [PATCH 02/19] multiversion mkdocs config --- .gitignore | 2 ++ mkdocs.yml | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index 67f0dc51..cf81ad04 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,8 @@ lexer/*.php lexer/*.php.bak lexer/*.out +/site + # Dev phpunit* .phpunit.result.cache diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..e1868e67 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,21 @@ +site_name: Smarty Documentation +theme: + name: material + palette: + primary: amber + features: + - content.code.copy + icon: + logo: material/lightbulb-on + favicon: images/favicon.ico + +extra: + version: + provider: mike + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences From 51ed0d6791cfedbdf2492603d226618133154d70 Mon Sep 17 00:00:00 2001 From: Simon Wisselink Date: Fri, 3 Feb 2023 22:31:59 +0100 Subject: [PATCH 03/19] fixes to docs --- docs/appendixes/tips.md | 4 ++-- docs/appendixes/troubleshooting.md | 2 +- .../language-syntax-quotes.md | 2 +- .../language-syntax-variables.md | 2 +- docs/designers/language-builtin-functions.md | 2 +- .../language-function-if.md | 2 +- .../language-function-section.md | 4 ++-- .../language-function-while.md | 2 +- .../language-function-html-options.md | 2 +- .../language-function-html-select-date.md | 2 +- .../language-function-html-select-time.md | 4 ++-- .../language-function-math.md | 4 ++-- .../language-modifier-capitalize.md | 2 +- .../language-modifier-date-format.md | 14 +++++++------- .../language-modifiers/language-modifier-escape.md | 2 +- .../language-modifier-from-charset.md | 2 +- .../language-modifiers/language-modifier-lower.md | 2 +- .../language-modifiers/language-modifier-nl2br.md | 2 +- .../language-modifier-regex-replace.md | 2 +- .../language-modifier-replace.md | 2 +- .../language-modifier-string-format.md | 2 +- .../language-modifier-to-charset.md | 2 +- .../language-modifier-unescape.md | 2 +- .../language-modifiers/language-modifier-upper.md | 2 +- .../language-modifier-wordwrap.md | 2 +- .../language-variables-smarty.md | 6 +++--- .../advanced-features/advanced-features-objects.md | 2 +- docs/programmers/api-functions/api-fetch.md | 2 +- .../api-functions/api-mute-expected-errors.md | 2 +- .../api-variables/variable-error-reporting.md | 2 +- .../api-variables/variable-template-dir.md | 2 +- .../api-variables/variable-use-include-path.md | 6 +++--- .../api-variables/variable-use-sub-dirs.md | 2 +- .../programmers/plugins/plugins-block-functions.md | 2 +- docs/programmers/plugins/plugins-modifiers.md | 2 +- .../plugins/plugins-naming-conventions.md | 2 +- docs/programmers/resources/resources-file.md | 2 +- docs/programmers/resources/resources-string.md | 4 ++-- 38 files changed, 53 insertions(+), 53 deletions(-) diff --git a/docs/appendixes/tips.md b/docs/appendixes/tips.md index cdcc56b1..8e905f90 100644 --- a/docs/appendixes/tips.md +++ b/docs/appendixes/tips.md @@ -14,7 +14,7 @@ shorthand way with Smarty, using the > **Note** > > "Undefined variable" errors will show an E\_NOTICE if not disabled in -> PHP\'s [`error_reporting()`](&url.php-manual;error_reporting) level or +> PHP\'s [`error_reporting()`](https://www.php.net/error_reporting) level or > Smarty\'s [`$error_reporting`](#variable.error.reporting) property and > a variable had not been assigned to Smarty. @@ -114,7 +114,7 @@ Dates {#tips.dates} ===== As a rule of thumb, always pass dates to Smarty as -[timestamps](&url.php-manual;time). This allows template designers to +[timestamps](https://www.php.net/time). This allows template designers to use the [`date_format`](#language.modifier.date.format) modifier for full control over date formatting, and also makes it easy to compare dates if necessary. diff --git a/docs/appendixes/troubleshooting.md b/docs/appendixes/troubleshooting.md index d605dd2b..dc896df6 100644 --- a/docs/appendixes/troubleshooting.md +++ b/docs/appendixes/troubleshooting.md @@ -110,7 +110,7 @@ the corresponding error is in the template. - This means that your application registered a custom error handler - (using [set\_error\_handler()](&url.php-manual;set_error_handler)) + (using [set\_error\_handler()](https://www.php.net/set_error_handler)) which is not respecting the given `$errno` as it should. If, for whatever reason, this is the desired behaviour of your custom error handler, please call diff --git a/docs/designers/language-basic-syntax/language-syntax-quotes.md b/docs/designers/language-basic-syntax/language-syntax-quotes.md index 6fe185c9..8dbd6c79 100644 --- a/docs/designers/language-basic-syntax/language-syntax-quotes.md +++ b/docs/designers/language-basic-syntax/language-syntax-quotes.md @@ -4,7 +4,7 @@ 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) + and under\_scores. See [naming](https://www.php.net/language.variables) for more detail. - With any other characters, for example a period(.) or diff --git a/docs/designers/language-basic-syntax/language-syntax-variables.md b/docs/designers/language-basic-syntax/language-syntax-variables.md index 671ad8bb..01482ffd 100644 --- a/docs/designers/language-basic-syntax/language-syntax-variables.md +++ b/docs/designers/language-basic-syntax/language-syntax-variables.md @@ -3,7 +3,7 @@ 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 +variable](https://www.php.net/language.variables). You can reference arrays by index numerically or non-numerically. Also reference object properties and methods. diff --git a/docs/designers/language-builtin-functions.md b/docs/designers/language-builtin-functions.md index fa615555..6031e953 100644 --- a/docs/designers/language-builtin-functions.md +++ b/docs/designers/language-builtin-functions.md @@ -8,7 +8,7 @@ Built-in Functions {#language.builtin.functions} - [{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) +- [{config_load}](./language-builtin-functions/language-function-config-load.md) - [{debug}](./language-builtin-functions/language-function-debug.md) - [{extends}](./language-builtin-functions/language-function-extends.md) - [{for}](./language-builtin-functions/language-function-for.md) diff --git a/docs/designers/language-builtin-functions/language-function-if.md b/docs/designers/language-builtin-functions/language-function-if.md index 2c1d68ee..b1ed2ae0 100644 --- a/docs/designers/language-builtin-functions/language-function-if.md +++ b/docs/designers/language-builtin-functions/language-function-if.md @@ -2,7 +2,7 @@ ==================== `{if}` statements in Smarty have much the same flexibility as PHP -[if](&url.php-manual;if) statements, with a few added features for the +[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*, diff --git a/docs/designers/language-builtin-functions/language-function-section.md b/docs/designers/language-builtin-functions/language-function-section.md index b28bb924..c6183c14 100644 --- a/docs/designers/language-builtin-functions/language-function-section.md +++ b/docs/designers/language-builtin-functions/language-function-section.md @@ -37,7 +37,7 @@ be paired with a closing `{/section}` tag. - 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). + variables](https://www.php.net/language.variables). - {section}\'s can be nested, and the nested `{section}` names must be unique from each other. @@ -124,7 +124,7 @@ The above example will output: The `name` of the `{section}` can be anything you like, see [PHP -variables](&url.php-manual;language.variables). It is used to reference +variables](https://www.php.net/language.variables). It is used to reference the data within the `{section}`. diff --git a/docs/designers/language-builtin-functions/language-function-while.md b/docs/designers/language-builtin-functions/language-function-while.md index 755c091f..64deabaf 100644 --- a/docs/designers/language-builtin-functions/language-function-while.md +++ b/docs/designers/language-builtin-functions/language-function-while.md @@ -2,7 +2,7 @@ ======= `{while}` loops in Smarty have much the same flexibility as PHP -[while](&url.php-manual;while) statements, with a few added features for +[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. diff --git a/docs/designers/language-custom-functions/language-function-html-options.md b/docs/designers/language-custom-functions/language-function-html-options.md index b7c04e94..9c9a00a1 100644 --- a/docs/designers/language-custom-functions/language-function-html-options.md +++ b/docs/designers/language-custom-functions/language-function-html-options.md @@ -74,7 +74,7 @@ Output of the above example would be: 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 +use of the php [`count()`](https://www.php.net/function.count) function as a modifier to set the select size). diff --git a/docs/designers/language-custom-functions/language-function-html-select-date.md b/docs/designers/language-custom-functions/language-function-html-select-date.md index b46eb041..80c7fdfb 100644 --- a/docs/designers/language-custom-functions/language-function-html-select-date.md +++ b/docs/designers/language-custom-functions/language-function-html-select-date.md @@ -9,7 +9,7 @@ name/value-pairs inside the ` - {html_options output=$my_array|upper|truncate:20} - +{* php's count *} +{$myArray|@count} +{* this will uppercase and truncate the whole array *} + +``` - - 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 + > 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 diff --git a/docs/designers/language-variables.md b/docs/designers/language-variables.md index 3950d0ba..04abda43 100644 --- a/docs/designers/language-variables.md +++ b/docs/designers/language-variables.md @@ -1,16 +1,13 @@ -Variables -========= +# Variables + +Smarty has several types of variables. The type of the +variable depends on what symbol it is prefixed or enclosed within. -## 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 @@ -19,17 +16,16 @@ 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. +```smarty +{$Name} - {$Name} +{$product.part_no} {$product.description} - {$product.part_no} {$product.description} - - {$Contacts[row].Phone} - - +{$Contacts[row].Phone} + +``` - > **Note** > > An easy way to examine assigned Smarty variables is with the diff --git a/docs/getting-started.md b/docs/getting-started.md index 2a1391f4..2ffbbd11 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,26 +1,25 @@ -What is Smarty? -============== +# Getting started ## Requirements Smarty can be run with PHP 7.1 to PHP 8.2. ## Installation -Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/). +Smarty can be installed with [Composer](https://getcomposer.org/). To get the latest stable version of Smarty use: -```bash +```shell composer require smarty/smarty -```` +``` To get the latest, unreleased version, use: -```bash +```shell composer require smarty/smarty:dev-master -```` +``` To get the previous stable version of Smarty, Smarty 3, use: -```bash +```shell composer require smarty/smarty:^3 -```` +``` Here's how you create an instance of Smarty in your PHP scripts: ```php @@ -30,7 +29,7 @@ require 'vendor/autoload.php'; $smarty = new Smarty(); ``` -Now that the library files are in place, it's time to setup the Smarty +Now that the library files are in place, it's time to set up the Smarty directories for your application. Smarty requires four directories which are by default named @@ -82,7 +81,7 @@ $smarty->testInstall(); Now, let's create the `index.tpl` file that Smarty will display. This needs to be located in the [`$template_dir`](./programmers/api-variables/variable-template-dir.md). -```html +```smarty {* Smarty *} Hello {$name}, welcome to Smarty! ``` @@ -118,24 +117,22 @@ $smarty->display('index.tpl'); > **Note** > -> In our example, we are setting absolute paths to all of the Smarty +> In our example, we are setting absolute paths to all the Smarty > directories. If `/web/www.example.com/guestbook/` is within your PHP > include\_path, then these settings are not necessary. However, it is > more efficient and (from experience) less error-prone to set them to > absolute paths. This ensures that Smarty is getting files from the > directories you intended. -Now, run your PHP file. You should see *\"Hello Ned, welcome to Smarty!\"* +Now, run your PHP file. You should see *"Hello Ned, welcome to Smarty!"* You have completed the basic setup for Smarty! -## Extended Setup {#installing.smarty.extended} -============== +## Extended Setup -This is a continuation of the [basic -installation](#installing.smarty.basic), please read that first! +This is a continuation of the [basic installation](#installation), please read that first! -A slightly more flexible way to setup Smarty is to extend the Smarty +A slightly more flexible way to set up Smarty is to extend the Smarty class and initialize your Smarty environment. So instead of repeatedly setting directory paths, assigning the same vars, etc., we can do that in one place. @@ -163,7 +160,8 @@ class Smarty_GuestBook extends Smarty { Now, we can use `Smarty_GuestBook` instead of `Smarty` in our scripts: ```php +assign('name','Ned'); +$smarty->assign('name', 'Ned'); $smarty->display('index.tpl'); ``` diff --git a/docs/index.md b/docs/index.md index cf2b2ddc..20680b52 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,11 +26,11 @@ and 480 for $height, the result is: - [Getting Started](./getting-started.md) ## Smarty for template designers -- [Basic Syntax](./designers/language-basic-syntax.md) +- [Basic Syntax](designers/language-basic-syntax/language-basic-syntax.md) - [Variables](./designers/language-variables.md) - [Variable Modifiers](./designers/language-modifiers.md) - [Combining Modifiers](./designers/language-combining-modifiers.md) -- [Built-in Functions](./designers/language-builtin-functions.md) +- [Built-in Functions](designers/language-builtin-functions/language-builtin-functions.md) - [Custom Functions](./designers/language-custom-functions.md) - [Config Files](./designers/config-files.md) - [Debugging Console](./designers/chapter-debugging-console.md) diff --git a/docs/philosophy.md b/docs/philosophy.md index 86f6c46e..34555c28 100644 --- a/docs/philosophy.md +++ b/docs/philosophy.md @@ -1,5 +1,4 @@ -Philosophy -======= +# Philosophy ## What is Smarty? diff --git a/mkdocs.yml b/mkdocs.yml index e1868e67..2ec4890a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,10 @@ theme: primary: amber features: - content.code.copy + - navigation.tabs + - navigation.tabs.sticky + - navigation.instant + - navigation.tracking icon: logo: material/lightbulb-on favicon: images/favicon.ico @@ -19,3 +23,55 @@ markdown_extensions: - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.superfences + +nav: + - Home: 'index.md' + - 'Getting started': 'getting-started.md' + - 'Designers': + - 'Basic Syntax': + - Introduction: 'designers/language-basic-syntax/index.md' + - Comments: 'designers/language-basic-syntax/language-syntax-comments.md' + - Variables: 'designers/language-basic-syntax/language-syntax-variables.md' + - Functions: 'designers/language-basic-syntax/language-syntax-functions.md' + - 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' + - 'designers/language-variables.md' + - 'designers/language-modifiers.md' + - 'designers/language-combining-modifiers.md' + - 'Builtin Functions': + - 'Introduction': 'designers/language-builtin-functions/index.md' + - '{append}': 'designers/language-builtin-functions/language-function-append.md' + - '{assign}': 'designers/language-builtin-functions/language-function-assign.md' + - '{block}': 'designers/language-builtin-functions/language-function-block.md' + - '{call}': 'designers/language-builtin-functions/language-function-call.md' + - '{capture}': 'designers/language-builtin-functions/language-function-capture.md' + - '{config_load}': 'designers/language-builtin-functions/language-function-config-load.md' + - '{debug}': 'designers/language-builtin-functions/language-function-debug.md' + - '{extends}': 'designers/language-builtin-functions/language-function-extends.md' + - '{for}': 'designers/language-builtin-functions/language-function-for.md' + - '{foreach}': 'designers/language-builtin-functions/language-function-foreach.md' + - '{function}': 'designers/language-builtin-functions/language-function-function.md' + - '{if},{elseif},{else}': 'designers/language-builtin-functions/language-function-if.md' + - '{include}': 'designers/language-builtin-functions/language-function-include.md' + - '{insert}': 'designers/language-builtin-functions/language-function-insert.md' + - '{ldelim},{rdelim}': 'designers/language-builtin-functions/language-function-ldelim.md' + - '{literal}': 'designers/language-builtin-functions/language-function-literal.md' + - '{nocache}': 'designers/language-builtin-functions/language-function-nocache.md' + - '{section}': 'designers/language-builtin-functions/language-function-section.md' + - '{setfilter}': 'designers/language-builtin-functions/language-function-setfilter.md' + - '{strip}': 'designers/language-builtin-functions/language-function-strip.md' + - '{while}': 'designers/language-builtin-functions/language-function-while.md' + - 'designers/language-custom-functions.md' + - 'designers/config-files.md' + - 'designers/chapter-debugging-console.md' + - 'Programmers': + - 'programmers/charset.md' + - 'programmers/smarty-constants.md' + - 'programmers/api-variables.md' + - 'programmers/api-functions.md' + - 'programmers/caching.md' + - 'programmers/resources.md' + - 'programmers/advanced-features.md' + - 'programmers/plugins.md' \ No newline at end of file From 694ff1b73361e276eeec3a364c3b11b1a48437af Mon Sep 17 00:00:00 2001 From: Simon Wisselink Date: Mon, 6 Feb 2023 10:40:00 +0100 Subject: [PATCH 05/19] Improved another chunk of the designers docs --- .../language-escaping.md | 88 +- .../language-basic-syntax/language-math.md | 23 +- .../language-syntax-attributes.md | 39 +- .../language-syntax-comments.md | 28 +- .../language-syntax-functions.md | 46 +- .../language-syntax-quotes.md | 75 +- .../language-syntax-variables.md | 142 ++-- .../language-function-config-load.md | 3 + .../language-function-extends.md | 2 + .../language-function-for.md | 112 ++- .../language-function-foreach.md | 472 +++++------ .../language-function-function.md | 89 +- .../language-function-if.md | 193 +++-- .../language-function-include.md | 207 +++-- .../language-function-insert.md | 48 +- .../language-function-ldelim.md | 74 +- .../language-function-literal.md | 38 +- .../language-function-nocache.md | 21 +- .../language-function-section.md | 776 +++++++++--------- .../language-function-setfilter.md | 37 +- .../language-function-strip.md | 33 +- .../language-function-while.md | 58 +- .../api-functions/api-add-config-dir.md | 2 +- mkdocs.yml | 2 +- 24 files changed, 1261 insertions(+), 1347 deletions(-) diff --git a/docs/designers/language-basic-syntax/language-escaping.md b/docs/designers/language-basic-syntax/language-escaping.md index fe8b1458..ea031bc9 100644 --- a/docs/designers/language-basic-syntax/language-escaping.md +++ b/docs/designers/language-basic-syntax/language-escaping.md @@ -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,37 +16,37 @@ 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 + +``` - -[`{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,30 +54,26 @@ you can change them with Smarty\'s > sure to clear out cache and compiled files if you decide to change > them. +```php +left_delimiter = ''; - $smarty->left_delimiter = ''; - - $smarty->assign('foo', 'bar'); - $smarty->assign('name', 'Albert'); - $smarty->display('example.tpl'); - - ?> - - +$smarty->assign('foo', 'bar'); +$smarty->assign('name', 'Albert'); +$smarty->display('example.tpl'); +``` Where the template is: - - Welcome to Smarty - - - +```smarty +Welcome to Smarty + +``` diff --git a/docs/designers/language-basic-syntax/language-math.md b/docs/designers/language-basic-syntax/language-math.md index dc78a351..a9a43efd 100644 --- a/docs/designers/language-basic-syntax/language-math.md +++ b/docs/designers/language-basic-syntax/language-math.md @@ -1,25 +1,24 @@ -Math {#language.math} -==== +# Math Math can be applied directly to variable values. +## Examples +```smarty +{$foo+1} - {$foo+1} +{$foo*$bar} - {$foo*$bar} +{* some more complicated examples *} - {* some more complicated examples *} +{$foo->bar-$bar[1]*$baz->foo->bar()-3*7} - {$foo->bar-$bar[1]*$baz->foo->bar()-3*7} +{if ($foo+$bar.test%$baz*134232+10+$b+10)} - {if ($foo+$bar.test%$baz*134232+10+$b+10)} - - {$foo|truncate:"`$fooTruncCount/$barTruncFactor-1`"} - - {assign var="foo" value="`$foo+$bar`"} +{$foo|truncate:"`$fooTruncCount/$barTruncFactor-1`"} +{assign var="foo" value="`$foo+$bar`"} +``` - > **Note** > > Although Smarty can handle some very complex expressions and syntax, diff --git a/docs/designers/language-basic-syntax/language-syntax-attributes.md b/docs/designers/language-basic-syntax/language-syntax-attributes.md index 417ac972..41f6c458 100644 --- a/docs/designers/language-basic-syntax/language-syntax-attributes.md +++ b/docs/designers/language-basic-syntax/language-syntax-attributes.md @@ -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,35 +11,35 @@ 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"} +{include file="header.tpl" nocache} // is equivalent to nocache=true - {include file="header.tpl" nocache} // is equivalent to nocache=true +{include file="header.tpl" attrib_name="attrib value"} - {include file="header.tpl" attrib_name="attrib value"} +{include file=$includeFile} - {include file=$includeFile} +{include file=#includeFile# title="My Title"} - {include file=#includeFile# title="My Title"} +{assign var=foo value={counter}} // plugin result - {assign var=foo value={counter}} // plugin result +{assign var=foo value=substr($bar,2,5)} // PHP function result - {assign var=foo value=substr($bar,2,5)} // PHP function result +{assign var=foo value=$bar|strlen} // using modifier - {assign var=foo value=$bar|strlen} // using modifier +{assign var=foo value=$buh+$bar|strlen} // more complex expression - {assign var=foo value=$buh+$bar|strlen} // more complex expression +{html_select_date display_days=true} - {html_select_date display_days=true} - - {mailto address="smarty@example.com"} - - +{mailto address="smarty@example.com"} + +``` - > **Note** > > Although Smarty can handle some very complex expressions and syntax, diff --git a/docs/designers/language-basic-syntax/language-syntax-comments.md b/docs/designers/language-basic-syntax/language-syntax-comments.md index 43104dbb..7052c20e 100644 --- a/docs/designers/language-basic-syntax/language-syntax-comments.md +++ b/docs/designers/language-basic-syntax/language-syntax-comments.md @@ -1,27 +1,25 @@ -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 - {* this is a comment *} - - -::: +```smarty +{* this is a comment *} +``` Smarty comments are NOT displayed in the final output of the template, unlike ``. 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 *} - +```smarty +{* I am a Smarty comment, I don't exist in the compiled output *} + - {$title} + {$title} - + {* another single line smarty comment *} @@ -66,6 +64,6 @@ notes in the templates which no one will see ;-) *} - - + +``` diff --git a/docs/designers/language-basic-syntax/language-syntax-functions.md b/docs/designers/language-basic-syntax/language-syntax-functions.md index 9c8c9404..663014e3 100644 --- a/docs/designers/language-basic-syntax/language-syntax-functions.md +++ b/docs/designers/language-basic-syntax/language-syntax-functions.md @@ -1,40 +1,40 @@ -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 - {config_load file="colors.conf"} +```smarty +{config_load file="colors.conf"} - {include file="header.tpl"} - {insert file="banner_ads.tpl" title="My Site"} +{include file="header.tpl"} +{insert file="banner_ads.tpl" title="My Site"} - {if $logged_in} - Welcome, {$name}! - {else} - hi, {$name} - {/if} - - {include file="footer.tpl"} +{if $logged_in} + Welcome, {$name}! +{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 +- 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) diff --git a/docs/designers/language-basic-syntax/language-syntax-quotes.md b/docs/designers/language-basic-syntax/language-syntax-quotes.md index 8dbd6c79..e04e6da7 100644 --- a/docs/designers/language-basic-syntax/language-syntax-quotes.md +++ b/docs/designers/language-basic-syntax/language-syntax-quotes.md @@ -1,55 +1,48 @@ -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] +{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"} - {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 +{* 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"} +``` - - - {* 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, @@ -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). diff --git a/docs/designers/language-basic-syntax/language-syntax-variables.md b/docs/designers/language-basic-syntax/language-syntax-variables.md index 01482ffd..c0285d07 100644 --- a/docs/designers/language-basic-syntax/language-syntax-variables.md +++ b/docs/designers/language-basic-syntax/language-syntax-variables.md @@ -1,99 +1,97 @@ -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 - {$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} +```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'] +{$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 +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 +{$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} +{* display the server variable "SERVER_NAME" ($_SERVER['SERVER_NAME'])*} +{$smarty.server.SERVER_NAME} - Math and embedding tags: +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 +{$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: +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 +{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: +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 +{$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): +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 +{$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: +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! +{$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: +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. +$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 chaining: - {$object->method1($x)->method2($y)} +{$object->method1($x)->method2($y)} - Direct PHP function access: +Direct PHP function access: - {time()} - - - +{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). diff --git a/docs/designers/language-builtin-functions/language-function-config-load.md b/docs/designers/language-builtin-functions/language-function-config-load.md index b66ff2bd..e13c3083 100644 --- a/docs/designers/language-builtin-functions/language-function-config-load.md +++ b/docs/designers/language-builtin-functions/language-function-config-load.md @@ -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 diff --git a/docs/designers/language-builtin-functions/language-function-extends.md b/docs/designers/language-builtin-functions/language-function-extends.md index 8f69d470..eba17b9b 100644 --- a/docs/designers/language-builtin-functions/language-function-extends.md +++ b/docs/designers/language-builtin-functions/language-function-extends.md @@ -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 *} diff --git a/docs/designers/language-builtin-functions/language-function-for.md b/docs/designers/language-builtin-functions/language-function-for.md index 5445f6f3..619b61ef 100644 --- a/docs/designers/language-builtin-functions/language-function-for.md +++ b/docs/designers/language-builtin-functions/language-function-for.md @@ -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,87 +9,83 @@ 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 +
      {for $foo=1 to 3}
    • {$foo}
      • {/for} -
    - +
+``` - The above example will output: - -
    -
  • 1
    • -
  • 2
    • -
  • 3
    • -
- +```html +
    +
  • 1
    • +
  • 2
    • +
  • 3
    • +
+``` - - - $smarty->assign('to',10); - - - - -
    +```php +assign('to',10); +``` + +```smarty +
      {for $foo=3 to $to max=3}
    • {$foo}
      • {/for} -
    - - +
+``` The above example will output: +```html +
    +
  • 3
    • +
  • 4
    • +
  • 5
    • +
+``` -
    -
  • 3
    • -
  • 4
    • -
  • 5
    • -
+```php +assign('start',10); +$smarty->assign('to',5); +``` - - - - $smarty->assign('start',10); - $smarty->assign('to',5); - - - - -
    +```smarty +
      {for $foo=$start to $to}
    • {$foo}
      • {forelse} no iteration {/for} -
    - - +
+``` The above example will output: - - no iteration - +``` + 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) diff --git a/docs/designers/language-builtin-functions/language-function-foreach.md b/docs/designers/language-builtin-functions/language-function-foreach.md index fdd74014..645d6c52 100644 --- a/docs/designers/language-builtin-functions/language-function-foreach.md +++ b/docs/designers/language-builtin-functions/language-function-foreach.md @@ -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,161 +66,139 @@ 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 - - - assign('myColors', $arr); - ?> - - - +```php +assign('myColors', $arr); +``` + Template to output `$myColors` in an un-ordered list - -
    +```smarty +
      {foreach $myColors as $color}
    • {$color}
      • {/foreach} -
    - +
+``` - The above example will output: +```html +
    +
  • red
    • +
  • green
    • +
  • blue
    • +
+``` -
    -
  • red
    • -
  • green
    • -
  • blue
    • -
- - - - - 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com'); - $smarty->assign('myPeople', $people); - ?> - - +```php + 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com'); +$smarty->assign('myPeople', $people); +``` Template to output `$myArray` as key/value pairs. - -
    +```smarty +
      {foreach $myPeople as $value}
    • {$value@key}: {$value}
      • {/foreach} -
    - - - +
+``` + The above example will output: - -
    -
  • fname: John
    • -
  • lname: Doe
    • -
  • email: j.doe@example.com
    • -
- +```html +
    +
  • fname: John
    • +
  • lname: Doe
    • +
  • email: j.doe@example.com
    • +
+``` - Assign an array to Smarty, the key contains the key for each looped value. - - 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') - )); - ?> - - +```php +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} + {$value@key}: {$value} + {/foreach} +{/foreach} - {* 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} - +{* 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 - +``` + 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 + true)); - $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); - $res = $db->prepare("select * from users"); - $res->execute(); - $res->setFetchMode(PDO::FETCH_LAZY); + // assign to smarty + $smarty->assign('res',$res); - // assign to smarty - $smarty->assign('res',$res); + $smarty->display('index.tpl');?> +``` - $smarty->display('index.tpl');?> - ?> - - - - - {foreach $res as $r} - {$r.id} - {$r.name} - {foreachelse} - .. no results .. - {/foreach} - - +```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,14 +209,13 @@ 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. - - {* output empty row on the 4th iteration (when index is 3) *} - +```smarty +{* output empty row on the 4th iteration (when index is 3) *} +
{foreach $items as $i} {if $i@index eq 3} {* put empty table row *} @@ -231,72 +223,69 @@ result sets. {/if} {/foreach} -
{$i.label}
- + +``` -\@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} + {$name} + {/if} + {$name} +{/foreach} +``` - {foreach $myNames as $name} - {if $name@iteration is div by 4} - {$name} - {/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. - - {foreach $myNames as $name} - {if $name@iteration is even by 3} - {$name} - {else} - {$name} - {/if} - {/foreach} - - +```smarty + {foreach $myNames as $name} + {if $name@iteration is even by 3} + {$name} + {else} + {$name} + {/if} + {/foreach} +``` This will output something similar to this: - - ... - ... - ... - ... - ... - ... - ... - ... - ... - ... - ... - ... - ... - +```html +... +... +... +... +... +... +... +... +... +... +... +... +... +``` - -\@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. - - {* show table header at first iteration *} - +```smarty +{* show table header at first iteration *} +
{foreach $items as $i} {if $i@first} @@ -309,99 +298,92 @@ Here we display a table header row on the first iteration. {/foreach} -
{$i.name}
- + +``` - -\@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. - - {* Add horizontal rule at end of list *} - {foreach $items as $item} - {$item.name}{if $item@last}
{else},{/if} - {foreachelse} - ... no items to loop ... - {/foreach} - +```smarty +{* Add horizontal rule at end of list *} +{foreach $items as $item} + {$item.name}{if $item@last}
{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 +
      {foreach $myArray as $name}
    • {$name}
      • {/foreach} -
    - {if $name@show} do something here if the array contained data {/if} +
+{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}
+ {if $item@last} +
{$item@total} items
+ {/if} +{foreachelse} + ... no items to loop ... +{/foreach} +``` - {* show number of rows at end *} - {foreach $items as $item} - {$item.name}
- {if $item@last} -
{$item@total} items
- {/if} - {foreachelse} - ... no items to loop ... - {/foreach} +See also [`{section}`](./language-function-section.md), +[`{for}`](./language-function-for.md) and +[`{while}`](./language-function-while.md) -See also [`{section}`](#language.function.section), -[`{for}`](#language.function.for) and -[`{while}`](#language.function.while) - -{break} {#foreach.construct.break} -------- +## {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 - *} - +```smarty + {$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} `{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 - *} - - +```smarty + {$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/docs/designers/language-builtin-functions/language-function-function.md b/docs/designers/language-builtin-functions/language-function-function.md index 647e4bfc..cee6762c 100644 --- a/docs/designers/language-builtin-functions/language-function-function.md +++ b/docs/designers/language-builtin-functions/language-function-function.md @@ -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,44 +46,44 @@ nested menus. > values must be scalar and can not be variable. Variables must be > passed when the template is called. +## Examples - {* define the function *} - {function name=menu level=0} - {function menu level=0} {* short-hand *} -
    - {foreach $data as $entry} - {if is_array($entry)} -
  • {$entry@key}
    • - {menu data=$entry level=$level+1} - {else} -
  • {$entry}
    • - {/if} - {/foreach} -
- {/function} +```smarty +{* define the function *} +{function name=menu level=0} +{function menu level=0} {* short-hand *} +
    + {foreach $data as $entry} + {if is_array($entry)} +
  • {$entry@key}
    • + {menu data=$entry level=$level+1} + {else} +
  • {$entry}
    • + {/if} + {/foreach} +
+{/function} - {* create an array to demonstrate *} - {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' => - ['item3-3-1','item3-3-2']],'item4']} +{* 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} - - +{* 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 - +``` +* 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) +See also [`{call}`](./language-function-call.md) diff --git a/docs/designers/language-builtin-functions/language-function-if.md b/docs/designers/language-builtin-functions/language-function-if.md index b1ed2ae0..c7be37a2 100644 --- a/docs/designers/language-builtin-functions/language-function-if.md +++ b/docs/designers/language-builtin-functions/language-function-if.md @@ -1,121 +1,120 @@ -{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'} + 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} - {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} - {* 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} - {* 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 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 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} - {* - 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} - +{if is_array($foo) && count($foo) > 0} + {* do a foreach loop *} +{/if} +``` diff --git a/docs/designers/language-builtin-functions/language-function-include.md b/docs/designers/language-builtin-functions/language-function-include.md index bda2d802..d12a817e 100644 --- a/docs/designers/language-builtin-functions/language-function-include.md +++ b/docs/designers/language-builtin-functions/language-function-include.md @@ -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,36 +37,25 @@ 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:** +## Option Flags - 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 +| 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 + {$title} @@ -69,124 +70,118 @@ available within the included template. {* using shortform file attribute *} {include 'page_footer.tpl'} - + +``` - +```smarty +{include 'links.tpl' title='Newest links' links=$link_array} +{* body of template goes here *} +{include 'footer.tpl' foo='bar'} - {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 +

{$title}{/h3>
    - {foreach from=$links item=l} - .. do stuff ... - -

- +
+``` 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}
- {$bar}
- ... - +```smarty +{include 'sub_template.tpl' scope=parent} +... +{* display variables assigned in sub_template *} +{$foo}
+{$bar}
+... +``` - The template above includes the example `sub_template.tpl` below - - ... - {assign var=foo value='something'} - {assign var=bar value='value'} - ... +```smarty +... +{assign var=foo value='something'} +{assign var=bar value='value'} +... +``` The included template will not be cached. - - {include 'sub_template.tpl' nocache} - ... - +```smarty +{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} - ... - +```smarty +{include 'sub_template.tpl' cache_lifetime=500} +... +``` - In this example included template will be cached independent of the global caching setting. - - {include 'sub_template.tpl' caching} - ... - +```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. - - - {include 'nav.tpl' assign=navbar} - {include 'header.tpl' title='Smarty is cool'} - {$navbar} - {* body of template goes here *} - {$navbar} - {include 'footer.tpl'} - - +```smarty + + {include 'nav.tpl' assign=navbar} + {include 'header.tpl' title='Smarty is cool'} + {$navbar} + {* body of template goes here *} + {$navbar} + {include 'footer.tpl'} + +``` - 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'} - +```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'} +{* absolute filepath (same thing) *} +{include file='file:/usr/local/include/templates/header.tpl'} - {* absolute filepath *} - {include file='/usr/local/include/templates/header.tpl'} +{* windows absolute filepath (MUST use "file:" prefix) *} +{include file='file:C:/www/pub/templates/header.tpl'} - {* absolute filepath (same thing) *} - {include file='file:/usr/local/include/templates/header.tpl'} +{* include from template resource named "db" *} +{include file='db:header.tpl'} - {* windows absolute filepath (MUST use "file:" prefix) *} - {include file='file:C:/www/pub/templates/header.tpl'} +{* include a $variable template - eg $module = 'contacts' *} +{include file="$module.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"} +{* 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 [`{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). diff --git a/docs/designers/language-builtin-functions/language-function-insert.md b/docs/designers/language-builtin-functions/language-function-insert.md index e5bc7dcb..54f0729d 100644 --- a/docs/designers/language-builtin-functions/language-function-insert.md +++ b/docs/designers/language-builtin-functions/language-function-insert.md @@ -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) diff --git a/docs/designers/language-builtin-functions/language-function-ldelim.md b/docs/designers/language-builtin-functions/language-function-ldelim.md index 2afda031..c9f73c30 100644 --- a/docs/designers/language-builtin-functions/language-function-ldelim.md +++ b/docs/designers/language-builtin-functions/language-function-ldelim.md @@ -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 *} - {* this will print literal delimiters out of the template *} - - {ldelim}funcname{rdelim} is how functions look in Smarty! - - +{ldelim}funcname{rdelim} is how functions look in Smarty! +``` The above example will output: - - {funcname} is how functions look in Smarty! - - +``` +{funcname} is how functions look in Smarty! +``` Another example with some Javascript - - - - +```smarty + +``` will output +```html + +``` - +```smarty + +Click here for Server Info +``` - - - - - Click here for Server Info - -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). diff --git a/docs/designers/language-builtin-functions/language-function-literal.md b/docs/designers/language-builtin-functions/language-function-literal.md index 27ebb3ff..4bc12f9d 100644 --- a/docs/designers/language-builtin-functions/language-function-literal.md +++ b/docs/designers/language-builtin-functions/language-function-literal.md @@ -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,20 +16,19 @@ delimiters instead. > javascript and CSS curly braces are surrounded by whitespace. This is > new behavior to Smarty 3. +```smarty + +``` - - - - -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. diff --git a/docs/designers/language-builtin-functions/language-function-nocache.md b/docs/designers/language-builtin-functions/language-function-nocache.md index a5922f83..e6d8453f 100644 --- a/docs/designers/language-builtin-functions/language-function-nocache.md +++ b/docs/designers/language-builtin-functions/language-function-nocache.md @@ -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. - - - Today's date is - {nocache} - {$smarty.now|date_format} - {/nocache} - - - +```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). diff --git a/docs/designers/language-builtin-functions/language-function-section.md b/docs/designers/language-builtin-functions/language-function-section.md index c6183c14..ba17224c 100644 --- a/docs/designers/language-builtin-functions/language-function-section.md +++ b/docs/designers/language-builtin-functions/language-function-section.md @@ -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,162 +56,156 @@ 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 - assign('custid',$data); - ?> +```php +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]}
- {/section} -
- {* 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]}
- {/section} - +```smarty +{* 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]}
+{/section} +
+{* 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]}
+{/section} +``` +The above example will output: + +```html +id: 1000
+id: 1001
+id: 1002
+
+id: 1002
+id: 1001
+id: 1000
+``` + +```smarty +{section name=foo start=10 loop=20 step=2} + {$smarty.section.foo.index} +{/section} +
+{section name=bar loop=21 max=6 step=-2} + {$smarty.section.bar.index} +{/section} +``` The above example will output: - - id: 1000
- id: 1001
- id: 1002
-
- id: 1002
- id: 1001
- id: 1000
- - - - - {section name=foo start=10 loop=20 step=2} - {$smarty.section.foo.index} - {/section} -
- {section name=bar loop=21 max=6 step=-2} - {$smarty.section.bar.index} - {/section} - -The above example will output: - - - 10 12 14 16 18 -
- 20 18 16 14 12 10 - - +```html +10 12 14 16 18 +
+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}`. - - {section name=anything loop=$myArray} - {$myArray[anything].foo} - {$name[anything]} - {$address[anything].bar} - {/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. - - '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); - ?> - - - +```php + '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` - - {section name=customer loop=$contacts} -

- name: {$contacts[customer].name}
- home: {$contacts[customer].home}
- cell: {$contacts[customer].cell}
- e-mail: {$contacts[customer].email} -

- {/section} - - +```smarty +{section name=customer loop=$contacts} +

+ name: {$contacts[customer].name}
+ home: {$contacts[customer].home}
+ cell: {$contacts[customer].cell}
+ e-mail: {$contacts[customer].email} +

+{/section} +``` The above example will output: - -

- name: John Smith
- home: 555-555-5555
- cell: 666-555-5555
- e-mail: john@myexample.com -

-

- name: Jack Jones
- home phone: 777-555-5555
- cell phone: 888-555-5555
- e-mail: jack@myexample.com -

-

- name: Jane Munson
- home phone: 000-555-5555
- cell phone: 123456
- e-mail: jane@myexample.com -

- +```html +

+ name: John Smith
+ home: 555-555-5555
+ cell: 666-555-5555
+ e-mail: john@myexample.com +

+

+ name: Jack Jones
+ home phone: 777-555-5555
+ cell phone: 888-555-5555
+ e-mail: jack@myexample.com +

+

+ name: Jane Munson
+ home phone: 000-555-5555
+ cell phone: 123456
+ e-mail: jane@myexample.com +

+``` - 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 +assign('custid',$id); - $id = array(1001,1002,1003); - $smarty->assign('custid',$id); +$fullnames = ['John Smith','Jack Jones','Jane Munson']; +$smarty->assign('name',$fullnames); - $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); - - ?> +$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,125 +213,119 @@ 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} -

- id: {$custid[customer]}
- name: {$name[customer]}
- address: {$address[customer]} -

- {/section} - +```smarty +{section name=customer loop=$custid} +

+ id: {$custid[customer]}
+ name: {$name[customer]}
+ address: {$address[customer]} +

+{/section} +``` - The above example will output: - -

- id: 1000
- name: John Smith
- address: 253 Abbey road -

-

- id: 1001
- name: Jack Jones
- address: 417 Mulberry ln -

-

- id: 1002
- name: Jane Munson
- address: 5605 apple st -

- +```html +

+ id: 1000
+ name: John Smith
+ address: 253 Abbey road +

+

+ id: 1001
+ name: Jack Jones
+ address: 417 Mulberry ln +

+

+ id: 1002
+ name: Jane Munson
+ address: 5605 apple st +

+``` - -{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 +assign('custid',$id); - $id = array(1001,1002,1003); - $smarty->assign('custid',$id); +$fullnames = ['John Smith','Jack Jones','Jane Munson']; +$smarty->assign('name',$fullnames); - $fullnames = array('John Smith','Jack Jones','Jane Munson'); - $smarty->assign('name',$fullnames); +$addr = ['253 N 45th', '417 Mulberry ln', '5605 apple st']; +$smarty->assign('address',$addr); - $addr = array('253 N 45th', '417 Mulberry ln', '5605 apple st'); - $smarty->assign('address',$addr); +$types = [ + [ 'home phone', 'cell phone', 'e-mail'], + [ 'home phone', 'web'], + [ 'cell phone'] + ]; +$smarty->assign('contact_type', $types); - $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); - - ?> +$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. - - {section name=customer loop=$custid} -
- id: {$custid[customer]}
- name: {$name[customer]}
- address: {$address[customer]}
- {section name=contact loop=$contact_type[customer]} - {$contact_type[customer][contact]}: {$contact_info[customer][contact]}
- {/section} - {/section} - +```smarty +{section name=customer loop=$custid} +
+ id: {$custid[customer]}
+ name: {$name[customer]}
+ address: {$address[customer]}
+ {section name=contact loop=$contact_type[customer]} + {$contact_type[customer][contact]}: {$contact_info[customer][contact]}
+ {/section} +{/section} +``` - The above example will output: - -
- id: 1000
- name: John Smith
- address: 253 N 45th
- home phone: 555-555-5555
- cell phone: 666-555-5555
- e-mail: john@myexample.com
-
- id: 1001
- name: Jack Jones
- address: 417 Mulberry ln
- home phone: 123-456-4
- web: www.example.com
-
- id: 1002
- name: Jane Munson
- address: 5605 apple st
- cell phone: 0457878
- +```html +
+ id: 1000
+ name: John Smith
+ address: 253 N 45th
+ home phone: 555-555-5555
+ cell phone: 666-555-5555
+ e-mail: john@myexample.com
+
+ id: 1001
+ name: Jack Jones
+ address: 417 Mulberry ln
+ home phone: 123-456-4
+ web: www.example.com
+
+ id: 1002
+ name: Jane Munson
+ address: 5605 apple st
+ cell phone: 0457878
+``` - Results of a database search (eg ADODB or PEAR) are assigned to Smarty - - assign('contacts', $db->getAll($sql)); - ?> +```php +assign('contacts', $db->getAll($sql)); +``` The template to output the database result in a HTML table - - +```smarty +
{section name=co loop=$contacts} @@ -348,11 +338,10 @@ The template to output the database result in a HTML table {sectionelse} {/section} -
 Name>HomeCellEmail
No items found
- -.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,129 +349,120 @@ 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. - - {section name=customer loop=$custid} - {$smarty.section.customer.index} id: {$custid[customer]}
- {/section} - +```smarty +{section name=customer loop=$custid} + {$smarty.section.customer.index} id: {$custid[customer]}
+{/section} +``` - The above example will output: - - 0 id: 1000
- 1 id: 1001
- 2 id: 1002
- +```html +0 id: 1000
+1 id: 1001
+2 id: 1002
+``` -.index\_prev {#section.property.index.prev} ------------- +## .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. - - assign('rows',$data); - ?> +``` Template to output the above array in a table - - {* $rows[row.index] and $rows[row] are identical in meaning *} - - - - - - - {section name=row loop=$rows} - - - - - - {/section} -
indexidindex_prevprev_idindex_nextnext_id
{$smarty.section.row.index}{$rows[row]}{$smarty.section.row.index_prev}{$rows[row.index_prev]}{$smarty.section.row.index_next}{$rows[row.index_next]}
- +```smarty +{* $rows[row.index] and $rows[row] are identical in meaning *} + + + + + + +{section name=row loop=$rows} + + + + + +{/section} +
indexidindex_prevprev_idindex_nextnext_id
{$smarty.section.row.index}{$rows[row]}{$smarty.section.row.index_prev}{$rows[row.index_prev]}{$smarty.section.row.index_next}{$rows[row.index_next]}
+``` - 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. - - assign('arr',$id); - ?> +```php +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]}
- {/section} - +```smarty +{section name=cu loop=$arr start=5 step=2} + iteration={$smarty.section.cu.iteration} + index={$smarty.section.cu.index} + id={$custid[cu]}
+{/section} +``` - The above example will output: - - iteration=1 index=5 id=3005
- iteration=2 index=7 id=3007
- iteration=3 index=9 id=3009
- iteration=4 index=11 id=3011
- iteration=5 index=13 id=3013
- iteration=6 index=15 id=3015
- - +```html +iteration=1 index=5 id=3005
+iteration=2 index=7 id=3007
+iteration=3 index=9 id=3009
+iteration=4 index=11 id=3011
+iteration=5 index=13 id=3013
+iteration=6 index=15 id=3015
+``` Another example that uses the `iteration` property to output a table header block every five rows. - - +```smarty +
{section name=co loop=$contacts} {if $smarty.section.co.iteration is div by 5} @@ -495,150 +475,136 @@ header block every five rows. {/section} -
 Name>HomeCellEmail
{$contacts[co].email}
+ +``` - - -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. - - - {section name=co loop=$contacts} - {if $smarty.section.co.iteration is even by 3} - {$contacts[co].name} - {else} - {$contacts[co].name} - {/if} - {/section} -
- - +```smarty + + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is even by 3} + {$contacts[co].name} + {else} + {$contacts[co].name} + {/if} + {/section} +
+``` > **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} + + + {/if} - {section name=customer loop=$customers} - {if $smarty.section.customer.first} -
idcustomer
- - {/if} + + + + - - - - + {if $smarty.section.customer.last} + +
idcustomer
{$customers[customer].id}}{$customers[customer].name}
{$customers[customer].id}}{$customers[customer].name}
{$smarty.section.customer.total} customers
+ {/if} +{/section} +``` - {if $smarty.section.customer.last} - {$smarty.section.customer.total} customers - - {/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}`. - - {section name=customer loop=$custid} - {$smarty.section.customer.index} id: {$custid[customer]}
- {/section} - There are {$smarty.section.customer.loop} customers shown above. - - +```smarty +{section name=customer loop=$custid} + {$smarty.section.customer.index} id: {$custid[customer]}
+{/section} +There are {$smarty.section.customer.loop} customers shown above. +``` The above example will output: +```html +0 id: 1000
+1 id: 1001
+2 id: 1002
+There are 3 customers shown above. +``` - 0 id: 1000
- 1 id: 1001
- 2 id: 1002
- 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]}
+{/section} - {section name=customer loop=$customers show=$show_customer_info} - {$smarty.section.customer.rownum} id: {$customers[customer]}
- {/section} - - {if $smarty.section.customer.show} - the section was shown. - {else} - the section was not shown. - {/if} - +{if $smarty.section.customer.show} + the section was shown. +{else} + the section was not shown. +{/if} +``` - The above example will output: +```html +1 id: 1000
+2 id: 1001
+3 id: 1002
- 1 id: 1000
- 2 id: 1001
- 3 id: 1002
- - the section was shown. - +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}`. - - {section name=customer loop=$custid step=2} - {$smarty.section.customer.index} id: {$custid[customer]}
- {/section} - There are {$smarty.section.customer.total} customers shown above. - +```smarty +{section name=customer loop=$custid step=2} + {$smarty.section.customer.index} id: {$custid[customer]}
+{/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). diff --git a/docs/designers/language-builtin-functions/language-function-setfilter.md b/docs/designers/language-builtin-functions/language-function-setfilter.md index c7f99e78..eb11cbf1 100644 --- a/docs/designers/language-builtin-functions/language-function-setfilter.md +++ b/docs/designers/language-builtin-functions/language-function-setfilter.md @@ -1,29 +1,35 @@ -{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. - + +``` - - -> **Note** -> -> The setting of template instance filters does not effect the output of -> included subtemplates. diff --git a/docs/designers/language-builtin-functions/language-function-strip.md b/docs/designers/language-builtin-functions/language-function-strip.md index d40646e5..800de84b 100644 --- a/docs/designers/language-builtin-functions/language-function-strip.md +++ b/docs/designers/language-builtin-functions/language-function-strip.md @@ -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. - - {* the following will be all run into one line upon output *} - {strip} - +```smarty +{* the following will be all run into one line upon output *} +{strip} +
- - This is a test + + This is a test
- {/strip} - +{/strip} +``` - The above example will output: - -
This is a test
+``` 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. diff --git a/docs/designers/language-builtin-functions/language-function-while.md b/docs/designers/language-builtin-functions/language-function-while.md index 64deabaf..13eaef9b 100644 --- a/docs/designers/language-builtin-functions/language-function-while.md +++ b/docs/designers/language-builtin-functions/language-function-while.md @@ -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} +``` - {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). diff --git a/docs/programmers/api-functions/api-add-config-dir.md b/docs/programmers/api-functions/api-add-config-dir.md index 6c8b54e4..c3a05228 100644 --- a/docs/programmers/api-functions/api-add-config-dir.md +++ b/docs/programmers/api-functions/api-add-config-dir.md @@ -21,7 +21,7 @@ key addConigDir('./config_1'); + $smarty->addConfigDir('./config_1'); // add directory where config files are stored and specify array-key $smarty->addConfigDir('./config_1', 'one'); diff --git a/mkdocs.yml b/mkdocs.yml index 2ec4890a..50af4210 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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' From badcae6e0c6aa92f5ec4929446d97e06104f73d4 Mon Sep 17 00:00:00 2001 From: Simon Wisselink Date: Mon, 6 Feb 2023 14:42:31 +0100 Subject: [PATCH 06/19] Finished improving designers docs --- .../language-escaping.md | 2 +- .../language-syntax-functions.md | 2 +- .../language-builtin-functions/index.md | 4 +- .../language-function-capture.md | 4 +- docs/designers/language-custom-functions.md | 19 -- .../language-custom-functions/index.md | 19 ++ .../language-function-counter.md | 50 +-- .../language-function-cycle.md | 42 ++- .../language-function-debug.md | 15 +- .../language-function-eval.md | 85 +++-- .../language-function-fetch.md | 56 ++-- .../language-function-html-checkboxes.md | 151 ++++----- .../language-function-html-image.md | 54 +-- .../language-function-html-options.md | 181 +++++----- .../language-function-html-radios.md | 152 ++++----- .../language-function-html-select-date.md | 135 ++++---- .../language-function-html-select-time.md | 116 +++---- .../language-function-html-table.md | 118 +++---- .../language-function-mailto.md | 77 +++-- .../language-function-math.md | 117 ++++--- .../language-function-textformat.md | 310 +++++++++--------- .../index.md} | 64 ++-- .../language-modifier-capitalize.md | 38 ++- .../language-modifier-cat.md | 33 +- .../language-modifier-count-characters.md | 40 ++- .../language-modifier-count-paragraphs.md | 31 +- .../language-modifier-count-sentences.md | 32 +- .../language-modifier-count-words.md | 32 +- .../language-modifier-date-format.md | 190 +++++------ .../language-modifier-default.md | 50 +-- .../language-modifier-escape.md | 98 +++--- .../language-modifier-from-charset.md | 19 +- .../language-modifier-indent.md | 73 +++-- .../language-modifier-lower.md | 39 +-- .../language-modifier-nl2br.md | 40 +-- .../language-modifier-regex-replace.md | 52 +-- .../language-modifier-replace.md | 55 ++-- .../language-modifier-spacify.md | 50 +-- .../language-modifier-string-format.md | 48 +-- .../language-modifier-strip-tags.md | 57 ++-- .../language-modifier-strip.md | 50 +-- .../language-modifier-to-charset.md | 17 +- .../language-modifier-truncate.md | 71 ++-- .../language-modifier-unescape.md | 52 +-- .../language-modifier-upper.md | 38 ++- .../language-modifier-wordwrap.md | 84 ++--- docs/designers/language-variables.md | 33 -- docs/designers/language-variables/index.md | 36 ++ .../language-assigned-variables.md | 186 +++++------ .../language-config-variables.md | 110 +++---- .../language-variable-scopes.md | 79 +++-- .../language-variables-smarty.md | 142 ++++---- docs/index.md | 10 +- .../api-variables/variable-auto-literal.md | 2 +- mkdocs.yml | 54 ++- 55 files changed, 1872 insertions(+), 1842 deletions(-) delete mode 100644 docs/designers/language-custom-functions.md create mode 100644 docs/designers/language-custom-functions/index.md rename docs/designers/{language-modifiers.md => language-modifiers/index.md} (57%) delete mode 100644 docs/designers/language-variables.md create mode 100644 docs/designers/language-variables/index.md diff --git a/docs/designers/language-basic-syntax/language-escaping.md b/docs/designers/language-basic-syntax/language-escaping.md index ea031bc9..4c75e09e 100644 --- a/docs/designers/language-basic-syntax/language-escaping.md +++ b/docs/designers/language-basic-syntax/language-escaping.md @@ -1,4 +1,4 @@ -# Escaping Smarty Parsing +# Escaping Smarty parsing It is sometimes desirable or even necessary to have Smarty ignore sections it would otherwise parse. A classic example is embedding diff --git a/docs/designers/language-basic-syntax/language-syntax-functions.md b/docs/designers/language-basic-syntax/language-syntax-functions.md index 663014e3..c3c8c21c 100644 --- a/docs/designers/language-basic-syntax/language-syntax-functions.md +++ b/docs/designers/language-basic-syntax/language-syntax-functions.md @@ -23,7 +23,7 @@ within delimiters like so: `{funcname attr1="val1" attr2="val2"}`. ``` - Both [built-in functions](../language-builtin-functions/index.md) and [custom - functions](../language-custom-functions.md) have the same syntax within + functions](../language-custom-functions/index.md) have the same syntax within templates. - Built-in functions are the **inner** workings of Smarty, such as diff --git a/docs/designers/language-builtin-functions/index.md b/docs/designers/language-builtin-functions/index.md index ccc4bf46..10dc3a6f 100644 --- a/docs/designers/language-builtin-functions/index.md +++ b/docs/designers/language-builtin-functions/index.md @@ -4,7 +4,7 @@ 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 +You cannot create your own [custom functions](../language-custom-functions/index.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 @@ -12,7 +12,7 @@ result the function to a named template variable instead of being output; much like the [`{assign}`](language-function-assign.md) function. - [{append}](language-function-append.md) -- [{assign}](language-function-assign.md) or [{$var=...}](language-function-shortform-assign.md) +- [{assign} or {$var=...}](language-function-assign.md) - [{block}](language-function-block.md) - [{call}](language-function-call.md) - [{capture}](language-function-capture.md) diff --git a/docs/designers/language-builtin-functions/language-function-capture.md b/docs/designers/language-builtin-functions/language-function-capture.md index 8b32665f..657f077c 100644 --- a/docs/designers/language-builtin-functions/language-function-capture.md +++ b/docs/designers/language-builtin-functions/language-function-capture.md @@ -76,6 +76,6 @@ I say just hello world See also [`$smarty.capture`](../language-variables/language-variables-smarty.md#smartycapture-languagevariablessmartycapture), -[`{eval}`](./language-function-eval.md), -[`{fetch}`](./language-function-fetch.md), [`fetch()`](../../programmers/api-functions/api-fetch.md) and +[`{eval}`](../language-custom-functions/language-function-eval.md), +[`{fetch}`](../language-custom-functions/language-function-fetch.md), [`fetch()`](../../programmers/api-functions/api-fetch.md) and [`{assign}`](./language-function-assign.md). diff --git a/docs/designers/language-custom-functions.md b/docs/designers/language-custom-functions.md deleted file mode 100644 index fd413c61..00000000 --- a/docs/designers/language-custom-functions.md +++ /dev/null @@ -1,19 +0,0 @@ -# Custom Functions - -Smarty comes with several custom plugin functions that you can use in -the templates. - -- [{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/docs/designers/language-custom-functions/index.md b/docs/designers/language-custom-functions/index.md new file mode 100644 index 00000000..81979654 --- /dev/null +++ b/docs/designers/language-custom-functions/index.md @@ -0,0 +1,19 @@ +# Custom Functions + +Smarty comes with several custom plugin functions that you can use in +the templates. + +- [{counter}](language-function-counter.md) +- [{cycle}](language-function-cycle.md) +- [{eval}](language-function-eval.md) +- [{fetch}](language-function-fetch.md) +- [{html_checkboxes}](language-function-html-checkboxes.md) +- [{html_image}](language-function-html-image.md) +- [{html_options}](language-function-html-options.md) +- [{html_radios}](language-function-html-radios.md) +- [{html_select_date}](language-function-html-select-date.md) +- [{html_select_time}](language-function-html-select-time.md) +- [{html_table}](language-function-html-table.md) +- [{mailto}](language-function-mailto.md) +- [{math}](language-function-math.md) +- [{textformat}](language-function-textformat.md) diff --git a/docs/designers/language-custom-functions/language-function-counter.md b/docs/designers/language-custom-functions/language-function-counter.md index cc1ac08f..de04c2fe 100644 --- a/docs/designers/language-custom-functions/language-function-counter.md +++ b/docs/designers/language-custom-functions/language-function-counter.md @@ -1,41 +1,45 @@ -{counter} {#language.function.counter} -========= +# {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 +direction of the count, as well as determine whether 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. +## Attributes + +| Attribute Name | Required | Description | +|----------------|----------|-----------------------------------------------------------| +| name | No | The name of the counter | +| start | No | The initial number to start counting from (defaults to 1) | +| skip | No | The interval to count by (defaults to 1) | +| direction | No | The direction to count (up/down) (defaults to 'up') | +| print | No | Whether or not to print the value (defaults to true) | +| assign | No | the template variable the output will be assigned to | + 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 +## Examples +```smarty - {* initialize the count *} - {counter start=0 skip=2}
- {counter}
- {counter}
- {counter}
+{* initialize the count *} +{counter start=0 skip=2}
+{counter}
+{counter}
+{counter}
- +``` this will output: - - 0
- 2
- 4
- 6
- +```html +0
+2
+4
+6
+``` diff --git a/docs/designers/language-custom-functions/language-function-cycle.md b/docs/designers/language-custom-functions/language-function-cycle.md index 5986e632..661e490d 100644 --- a/docs/designers/language-custom-functions/language-function-cycle.md +++ b/docs/designers/language-custom-functions/language-function-cycle.md @@ -1,22 +1,23 @@ -{cycle} {#language.function.cycle} -======= +# {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 +## Attributes + +| Attribute Name | Required | Description | +|----------------|----------|-------------------------------------------------------------------------------------------------------------| +| name | No | The name of the cycle | +| values | Yes | The values to cycle through, either a comma delimited list (see delimiter attribute), or an array of values | +| print | No | Whether to print the value or not (defaults to true) | +| advance | No | Whether or not to advance to the next value (defaults to true) | +| delimiter | No | The delimiter to use in the values attribute (defaults to ',') | +| assign | No | The template variable the output will be assigned to | +| reset | No | The cycle will be set to the first value and not advanced (defaults to false) | - You can `{cycle}` through more than one set of values in a template - by supplying a `name` attribute. Give each `{cycle}` an unique + by supplying a `name` attribute. Give each `{cycle}` a unique `name`. - You can force the current value not to print with the `print` @@ -30,20 +31,18 @@ through an array of values. function will be assigned to a template variable instead of being output to the template. - - - - {section name=rows loop=$data} +## Examples +```smarty +{section name=rows loop=$data} {$data[rows]} - {/section} - - +{/section} +``` The above template would output: - +```html 1 @@ -53,5 +52,4 @@ The above template would output: 3 - - +``` diff --git a/docs/designers/language-custom-functions/language-function-debug.md b/docs/designers/language-custom-functions/language-function-debug.md index 79b3477c..78861453 100644 --- a/docs/designers/language-custom-functions/language-function-debug.md +++ b/docs/designers/language-custom-functions/language-function-debug.md @@ -1,15 +1,14 @@ -{debug} {#language.function.debug} -======= +# {debug} `{debug}` dumps the debug console to the page. This works regardless of -the [debug](#chapter.debugging.console) settings in the php script. +the [debug](../chapter-debugging-console.md) 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. +[assigned](../../programmers/api-functions/api-assign.md) 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 +| Attribute Name | Required | Description | +|----------------|----------|------------------------------------------------------------| +| output | No | output type, html or javascript (defaults to 'javascript') | -See also the [debugging console page](#chapter.debugging.console). +See also the [debugging console page](../chapter-debugging-console.md). diff --git a/docs/designers/language-custom-functions/language-function-eval.md b/docs/designers/language-custom-functions/language-function-eval.md index e11f57e3..70c7a3d1 100644 --- a/docs/designers/language-custom-functions/language-function-eval.md +++ b/docs/designers/language-custom-functions/language-function-eval.md @@ -1,19 +1,20 @@ -{eval} {#language.function.eval} -====== +# {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. +## Attributes + +| Attribute Name | Required | Description | +|----------------|----------|------------------------------------------------------| +| var | Yes | Variable (or string) to evaluate | +| assign | No | The template variable the output will be assigned to | + 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 @@ -21,64 +22,60 @@ output to the template. > templates. > > - Evaluated variables are compiled on every invocation, the compiled -> versions are not saved! However if you have [caching](#caching) +> versions are not saved! However, if you have [caching](../../programmers/caching.md) > enabled, the output will be cached with the rest of the template. > -> - If the content to evaluate doesn\'t change often, or is used +> - 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 +> the compiled state and thus doesn't have to run the (comparably > slow) compiler on every invocation. -> + +## Examples + The contents of the config file, `setup.conf`. - - emphstart = - emphend = - title = Welcome to {$company}'s home page! - ErrorCity = You must supply a {#emphstart#}city{#emphend#}. - ErrorState = You must supply a {#emphstart#}state{#emphend#}. - - +```ini +emphstart = +emphend = +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: +```smarty +{config_load file='setup.conf'} - {config_load file='setup.conf'} - - {eval var=$foo} - {eval var=#title#} - {eval var=#ErrorCity#} - {eval var=#ErrorState# assign='state_error'} - {$state_error} - +{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 city. - You must supply a state. - - +```html +This is the contents of foo. +Welcome to Foobar Pub & Grill's home page! +You must supply a city. +You must supply a state. +``` This outputs the server name (in uppercase) and IP. The assigned variable `$str` could be from a database query. - - assign('foo',$str); - ?> - - +``` Where the template is: - - {eval var=$foo} - - +```smarty +{eval var=$foo} +``` diff --git a/docs/designers/language-custom-functions/language-function-fetch.md b/docs/designers/language-custom-functions/language-function-fetch.md index 3dbc5610..2ff494fd 100644 --- a/docs/designers/language-custom-functions/language-function-fetch.md +++ b/docs/designers/language-custom-functions/language-function-fetch.md @@ -1,10 +1,15 @@ -{fetch} {#language.function.fetch} -======= +# {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 +## Attributes +| Attribute | Required | Description | +|-----------|----------|------------------------------------------------------| +| file | Yes | The file, http or ftp site to fetch | +| assign | No | The template variable the output will be assigned to | + +- If the file name begins with `http://`, the website page will be fetched and displayed. > **Note** @@ -20,40 +25,37 @@ ftp and display the contents. > **Note** > - > If security is enabled and you are fetching a file from the local + > 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 security policy. See the - > [Security](#advanced.features.security) section for details. + > [Security](../../programmers/advanced-features/advanced-features-security.md) 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 +## Examples +```smarty +{* include some javascript in your template *} +{fetch file='/export/httpd/www.example.com/docs/navbar.js'} - {* 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/'} - {* 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 ''} -
{$weather}
- {/if} +{* 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 ''} +
{$weather}
+{/if} +``` -See also [`{capture}`](#language.function.capture), -[`{eval}`](#language.function.eval), -[`{assign}`](#language.function.assign) and [`fetch()`](#api.fetch). +See also [`{capture}`](../language-builtin-functions/language-function-capture.md), +[`{eval}`](language-function-eval.md), +[`{assign}`](../language-builtin-functions/language-function-assign.md) and [`fetch()`](../../programmers/api-functions/api-fetch.md). diff --git a/docs/designers/language-custom-functions/language-function-html-checkboxes.md b/docs/designers/language-custom-functions/language-function-html-checkboxes.md index 23af713b..3ab36096 100644 --- a/docs/designers/language-custom-functions/language-function-html-checkboxes.md +++ b/docs/designers/language-custom-functions/language-function-html-checkboxes.md @@ -1,113 +1,102 @@ -{html\_checkboxes} {#language.function.html.checkboxes} -================== +# {html_checkboxes} -`{html_checkboxes}` is a [custom function](#language.custom.functions) +`{html_checkboxes}` is a [custom function](index.md) 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 \-tags to the output - label\_ids boolean No *FALSE* Add id-attributes to \ and \ 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 +## Attributes -- Required attributes are `values` and `output`, unless you use - `options` instead. +| Attribute Name | Required | Description | +|----------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | No | Name of checkbox list (defaults to 'checkbox') | +| values | Yes, unless using options attribute | An array of values for checkbox buttons | +| output | Yes, unless using options attribute | An array of output for checkbox buttons | +| selected | No | The selected checkbox element(s) as a string or array | +| options | Yes, unless using values and output | An associative array of values and output | +| separator | No | String of text to separate each checkbox item | +| assign | No | Assign checkbox tags to an array instead of output | +| labels | No | Add -tags to the output (defaults to true) | +| label\_ids | No | Add id-attributes to and to the output (defaults to false) | +| escape | No | Escape the output / content (values are always escaped) (defaults to true) | +| strict | No | 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 (defaults to false) | + +- 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 \-tags. + name/value-pairs inside each of the created -tags. - +## Examples +```php +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); - - ?> - - +$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='
'} - - +```smarty +{html_checkboxes name='id' values=$cust_ids output=$cust_names selected=$customer_id separator='
'} +``` or where PHP code is: +```php +assign('cust_checkboxes', array( - 1000 => 'Joe Schmoe', - 1001 => 'Jack Smith', - 1002 => 'Jane Johnson', - 1003 => 'Charlie Brown') - ); - $smarty->assign('customer_id', 1001); - - ?> - - +$smarty->assign( + 'cust_checkboxes', + [ + 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='
'} - - +```smarty +{html_checkboxes name='id' options=$cust_checkboxes selected=$customer_id separator='
'} +``` both examples will output: - -
- -
-
-
- +```html +
+ +
+
+
+``` +```php +assign('contact_types',$db->getAssoc($sql)); - $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)); - - ?> - - +$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. +```smarty +{html_checkboxes name='contact_type_id' options=$contact_types selected=$contact.contact_type_id separator='
'} +``` - {html_checkboxes name='contact_type_id' options=$contact_types - selected=$contact.contact_type_id separator='
'} - -See also [`{html_radios}`](#language.function.html.radios) and -[`{html_options}`](#language.function.html.options) +See also [`{html_radios}`](./language-function-html-radios.md) and +[`{html_options}`](./language-function-html-options.md) diff --git a/docs/designers/language-custom-functions/language-function-html-image.md b/docs/designers/language-custom-functions/language-function-html-image.md index e21f2a12..7ecde265 100644 --- a/docs/designers/language-custom-functions/language-function-html-image.md +++ b/docs/designers/language-custom-functions/language-function-html-image.md @@ -1,25 +1,26 @@ -{html\_image} {#language.function.html.image} -============= +# {html_image} -`{html_image}` is a [custom function](#language.custom.functions) that +`{html_image}` is a [custom function](index.md) that generates an HTML `` 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 +## Attributes + +| Attribute Name | Required | Description | +|----------------|----------|-------------------------------------------------------------------------| +| file | Yes | name/path to image | +| height | No | Height to display image (defaults to actual image height) | +| width | No | Width to display image (defaults to actual image width) | +| basedir | no | Directory to base relative paths from (defaults to web server doc root) | +| alt | no | Alternative description of the image | +| href | no | href value to link the image to | +| path\_prefix | no | 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 + 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 security policy. See the [Security](#advanced.features.security) + the security policy. See the [Security](../../programmers/advanced-features/advanced-features-security.md) section for details. - `href` is the href value to link the image to. If link is supplied, @@ -35,22 +36,23 @@ automatically calculated from the image file if they are not supplied. > **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}` +> calculate the height and width. If you don't use template +> [caching](../../programmers/caching.md), it is generally better to avoid `{html_image}` > and leave image tags static for optimal performance. +## Examples - {html_image file='pumpkin.jpg'} - {html_image file='/path/from/docroot/pumpkin.jpg'} - {html_image file='../path/relative/to/currdir/pumpkin.jpg'} - - +```smarty +{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: - - - - - +```html + + + +``` diff --git a/docs/designers/language-custom-functions/language-function-html-options.md b/docs/designers/language-custom-functions/language-function-html-options.md index 9c9a00a1..a63ccc56 100644 --- a/docs/designers/language-custom-functions/language-function-html-options.md +++ b/docs/designers/language-custom-functions/language-function-html-options.md @@ -1,18 +1,19 @@ -{html\_options} {#language.function.html.options} -=============== +# {html_options} -`{html_options}` is a [custom function](#language.custom.functions) that +`{html_options}` is a [custom function](index.md) that creates the html `` tags. - - {html_options name=foo options=$myOptions selected=$mySelect} - - +```smarty +{html_options name=foo options=$myOptions selected=$mySelect} +``` Output of the above example would be: - - - + +``` - - assign('cust_ids', array(56,92,13)); - $smarty->assign('cust_names', array( - 'Joe Schmoe', - 'Jane Johnson', - 'Charlie Brown')); - $smarty->assign('customer_id', 92); - ?> - - +```php +assign('cust_ids', [56,92,13]); +$smarty->assign('cust_names', [ + '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()`](https://www.php.net/function.count) function as a modifier to set the select size). - - - - +```smarty + +``` The above example would output: +```html + +``` - +```php +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)); - - 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. +[`truncate`](../language-modifiers/language-modifier-truncate.md) modifier. +```smarty + +``` - - - - - - 'Golf', 9 => 'Cricket',7 => 'Swim'); - $arr['Rest'] = array(3 => 'Sauna',1 => 'Massage'); - $smarty->assign('lookups', $arr); - $smarty->assign('fav', 7); - ?> - - +```php + '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} - - +```smarty +{html_options name=foo options=$lookups selected=$fav} +``` would output: - - - - - + + + - - + + - + +``` -See also [`{html_checkboxes}`](#language.function.html.checkboxes) and -[`{html_radios}`](#language.function.html.radios) +See also [`{html_checkboxes}`](./language-function-html-checkboxes.md) and +[`{html_radios}`](./language-function-html-radios.md) diff --git a/docs/designers/language-custom-functions/language-function-html-radios.md b/docs/designers/language-custom-functions/language-function-html-radios.md index 992adaea..af8ecda6 100644 --- a/docs/designers/language-custom-functions/language-function-html-radios.md +++ b/docs/designers/language-custom-functions/language-function-html-radios.md @@ -1,23 +1,24 @@ -{html\_radios} {#language.function.html.radios} -============== +# {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 +`{html_radios}` is a [custom function](index.md) that +creates an 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 \-tags to the output - label\_ids boolean No *FALSE* Add id-attributes to \ and \ 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 +## Attributes + +| Attribute Name | Required | Description | +|----------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | No | Name of radio list | +| values | Yes, unless using options attribute | An array of values for radio buttons | +| output | Yes, unless using options attribute | An array of output for radio buttons | +| selected | No | The selected radio element | +| options | Yes, unless using values and output | An associative array of values and output | +| separator | No | String of text to separate each radio item | +| assign | No | Assign radio tags to an array instead of output | +| labels | No | Add