diff --git a/4.x/404.html b/4.x/404.html index c293614f..34cb24e6 100644 --- a/4.x/404.html +++ b/4.x/404.html @@ -180,16 +180,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -303,19 +304,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/appendixes/tips/index.html b/4.x/appendixes/tips/index.html index 4adc5de6..f6d7b072 100644 --- a/4.x/appendixes/tips/index.html +++ b/4.x/appendixes/tips/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/appendixes/troubleshooting/index.html b/4.x/appendixes/troubleshooting/index.html index e765ae79..8fe2f49f 100644 --- a/4.x/appendixes/troubleshooting/index.html +++ b/4.x/appendixes/troubleshooting/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/chapter-debugging-console/index.html b/4.x/designers/chapter-debugging-console/index.html index 7c57761b..1b4adabd 100644 --- a/4.x/designers/chapter-debugging-console/index.html +++ b/4.x/designers/chapter-debugging-console/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/config-files/index.html b/4.x/designers/config-files/index.html index f06f24b5..c335d11c 100644 --- a/4.x/designers/config-files/index.html +++ b/4.x/designers/config-files/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/index.html b/4.x/designers/language-basic-syntax/index.html index 91bc6270..d5ad9baf 100644 --- a/4.x/designers/language-basic-syntax/index.html +++ b/4.x/designers/language-basic-syntax/index.html @@ -9,7 +9,7 @@ - + @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-escaping/index.html b/4.x/designers/language-basic-syntax/language-escaping/index.html index 8d5c89d5..048c803d 100644 --- a/4.x/designers/language-basic-syntax/language-escaping/index.html +++ b/4.x/designers/language-basic-syntax/language-escaping/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-math/index.html b/4.x/designers/language-basic-syntax/language-math/index.html index b8327df7..025ad62f 100644 --- a/4.x/designers/language-basic-syntax/language-math/index.html +++ b/4.x/designers/language-basic-syntax/language-math/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-syntax-attributes/index.html b/4.x/designers/language-basic-syntax/language-syntax-attributes/index.html index 2ed5c12a..4f3b392f 100644 --- a/4.x/designers/language-basic-syntax/language-syntax-attributes/index.html +++ b/4.x/designers/language-basic-syntax/language-syntax-attributes/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-syntax-comments/index.html b/4.x/designers/language-basic-syntax/language-syntax-comments/index.html index 03f4315e..cf0e9037 100644 --- a/4.x/designers/language-basic-syntax/language-syntax-comments/index.html +++ b/4.x/designers/language-basic-syntax/language-syntax-comments/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-syntax-functions/index.html b/4.x/designers/language-basic-syntax/language-syntax-functions/index.html index 8e091bbe..bfac2fff 100644 --- a/4.x/designers/language-basic-syntax/language-syntax-functions/index.html +++ b/4.x/designers/language-basic-syntax/language-syntax-functions/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-syntax-quotes/index.html b/4.x/designers/language-basic-syntax/language-syntax-quotes/index.html index e410427b..2a20175a 100644 --- a/4.x/designers/language-basic-syntax/language-syntax-quotes/index.html +++ b/4.x/designers/language-basic-syntax/language-syntax-quotes/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-basic-syntax/language-syntax-variables/index.html b/4.x/designers/language-basic-syntax/language-syntax-variables/index.html index 7bb1c801..a51027bf 100644 --- a/4.x/designers/language-basic-syntax/language-syntax-variables/index.html +++ b/4.x/designers/language-basic-syntax/language-syntax-variables/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/index.html b/4.x/designers/language-builtin-functions/index.html index dbc146ec..2ffa348c 100644 --- a/4.x/designers/language-builtin-functions/index.html +++ b/4.x/designers/language-builtin-functions/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-append/index.html b/4.x/designers/language-builtin-functions/language-function-append/index.html index 9ec12cc7..25cfef08 100644 --- a/4.x/designers/language-builtin-functions/language-function-append/index.html +++ b/4.x/designers/language-builtin-functions/language-function-append/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-assign/index.html b/4.x/designers/language-builtin-functions/language-function-assign/index.html index df3253f0..339e2081 100644 --- a/4.x/designers/language-builtin-functions/language-function-assign/index.html +++ b/4.x/designers/language-builtin-functions/language-function-assign/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-block/index.html b/4.x/designers/language-builtin-functions/language-function-block/index.html index a5ba1745..a1b995f4 100644 --- a/4.x/designers/language-builtin-functions/language-function-block/index.html +++ b/4.x/designers/language-builtin-functions/language-function-block/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-call/index.html b/4.x/designers/language-builtin-functions/language-function-call/index.html index 3bc556e1..13566381 100644 --- a/4.x/designers/language-builtin-functions/language-function-call/index.html +++ b/4.x/designers/language-builtin-functions/language-function-call/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-capture/index.html b/4.x/designers/language-builtin-functions/language-function-capture/index.html index db1f7e3b..774d0cc6 100644 --- a/4.x/designers/language-builtin-functions/language-function-capture/index.html +++ b/4.x/designers/language-builtin-functions/language-function-capture/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-config-load/index.html b/4.x/designers/language-builtin-functions/language-function-config-load/index.html index 4f4fb4dd..f250c6e6 100644 --- a/4.x/designers/language-builtin-functions/language-function-config-load/index.html +++ b/4.x/designers/language-builtin-functions/language-function-config-load/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-debug/index.html b/4.x/designers/language-builtin-functions/language-function-debug/index.html index bcdb9911..d0d216c3 100644 --- a/4.x/designers/language-builtin-functions/language-function-debug/index.html +++ b/4.x/designers/language-builtin-functions/language-function-debug/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-extends/index.html b/4.x/designers/language-builtin-functions/language-function-extends/index.html index ffbaef40..484db132 100644 --- a/4.x/designers/language-builtin-functions/language-function-extends/index.html +++ b/4.x/designers/language-builtin-functions/language-function-extends/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-for/index.html b/4.x/designers/language-builtin-functions/language-function-for/index.html index af961673..3b6a6ded 100644 --- a/4.x/designers/language-builtin-functions/language-function-for/index.html +++ b/4.x/designers/language-builtin-functions/language-function-for/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-foreach/index.html b/4.x/designers/language-builtin-functions/language-function-foreach/index.html index a0ee0f0c..7aaa248e 100644 --- a/4.x/designers/language-builtin-functions/language-function-foreach/index.html +++ b/4.x/designers/language-builtin-functions/language-function-foreach/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-function/index.html b/4.x/designers/language-builtin-functions/language-function-function/index.html index b1f5ceb7..6d69489f 100644 --- a/4.x/designers/language-builtin-functions/language-function-function/index.html +++ b/4.x/designers/language-builtin-functions/language-function-function/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-if/index.html b/4.x/designers/language-builtin-functions/language-function-if/index.html index 3a617042..5326a82a 100644 --- a/4.x/designers/language-builtin-functions/language-function-if/index.html +++ b/4.x/designers/language-builtin-functions/language-function-if/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-include/index.html b/4.x/designers/language-builtin-functions/language-function-include/index.html index e8b03ff5..cec6b67b 100644 --- a/4.x/designers/language-builtin-functions/language-function-include/index.html +++ b/4.x/designers/language-builtin-functions/language-function-include/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-insert/index.html b/4.x/designers/language-builtin-functions/language-function-insert/index.html index accdaf9e..9f2c0bd3 100644 --- a/4.x/designers/language-builtin-functions/language-function-insert/index.html +++ b/4.x/designers/language-builtin-functions/language-function-insert/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-ldelim/index.html b/4.x/designers/language-builtin-functions/language-function-ldelim/index.html index a36a8043..d737cb0c 100644 --- a/4.x/designers/language-builtin-functions/language-function-ldelim/index.html +++ b/4.x/designers/language-builtin-functions/language-function-ldelim/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-literal/index.html b/4.x/designers/language-builtin-functions/language-function-literal/index.html index 0c1f5215..fe0ff9cd 100644 --- a/4.x/designers/language-builtin-functions/language-function-literal/index.html +++ b/4.x/designers/language-builtin-functions/language-function-literal/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-nocache/index.html b/4.x/designers/language-builtin-functions/language-function-nocache/index.html index 02c2e110..6dc0f1cb 100644 --- a/4.x/designers/language-builtin-functions/language-function-nocache/index.html +++ b/4.x/designers/language-builtin-functions/language-function-nocache/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-section/index.html b/4.x/designers/language-builtin-functions/language-function-section/index.html index 96971dde..537ca5be 100644 --- a/4.x/designers/language-builtin-functions/language-function-section/index.html +++ b/4.x/designers/language-builtin-functions/language-function-section/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-setfilter/index.html b/4.x/designers/language-builtin-functions/language-function-setfilter/index.html index a9825eff..094f843d 100644 --- a/4.x/designers/language-builtin-functions/language-function-setfilter/index.html +++ b/4.x/designers/language-builtin-functions/language-function-setfilter/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-strip/index.html b/4.x/designers/language-builtin-functions/language-function-strip/index.html index 95ad2b9e..2c803dad 100644 --- a/4.x/designers/language-builtin-functions/language-function-strip/index.html +++ b/4.x/designers/language-builtin-functions/language-function-strip/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-builtin-functions/language-function-while/index.html b/4.x/designers/language-builtin-functions/language-function-while/index.html index b8b6a303..f81ca98b 100644 --- a/4.x/designers/language-builtin-functions/language-function-while/index.html +++ b/4.x/designers/language-builtin-functions/language-function-while/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-combining-modifiers/index.html b/4.x/designers/language-combining-modifiers/index.html index 953ee75f..9329aa14 100644 --- a/4.x/designers/language-combining-modifiers/index.html +++ b/4.x/designers/language-combining-modifiers/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/index.html b/4.x/designers/language-custom-functions/index.html index 1e7b4b3c..50f03cfa 100644 --- a/4.x/designers/language-custom-functions/index.html +++ b/4.x/designers/language-custom-functions/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-counter/index.html b/4.x/designers/language-custom-functions/language-function-counter/index.html index ca5f47ce..8cf565b0 100644 --- a/4.x/designers/language-custom-functions/language-function-counter/index.html +++ b/4.x/designers/language-custom-functions/language-function-counter/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-cycle/index.html b/4.x/designers/language-custom-functions/language-function-cycle/index.html index 547293a1..a8989332 100644 --- a/4.x/designers/language-custom-functions/language-function-cycle/index.html +++ b/4.x/designers/language-custom-functions/language-function-cycle/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-debug/index.html b/4.x/designers/language-custom-functions/language-function-debug/index.html index 1108ac4a..b815810b 100644 --- a/4.x/designers/language-custom-functions/language-function-debug/index.html +++ b/4.x/designers/language-custom-functions/language-function-debug/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-eval/index.html b/4.x/designers/language-custom-functions/language-function-eval/index.html index c66639e8..02905216 100644 --- a/4.x/designers/language-custom-functions/language-function-eval/index.html +++ b/4.x/designers/language-custom-functions/language-function-eval/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-fetch/index.html b/4.x/designers/language-custom-functions/language-function-fetch/index.html index 711fbced..173ad3ea 100644 --- a/4.x/designers/language-custom-functions/language-function-fetch/index.html +++ b/4.x/designers/language-custom-functions/language-function-fetch/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-checkboxes/index.html b/4.x/designers/language-custom-functions/language-function-html-checkboxes/index.html index 22a2256a..5b0e4db8 100644 --- a/4.x/designers/language-custom-functions/language-function-html-checkboxes/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-checkboxes/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-image/index.html b/4.x/designers/language-custom-functions/language-function-html-image/index.html index 1b98941d..ccdb2d3b 100644 --- a/4.x/designers/language-custom-functions/language-function-html-image/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-image/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-options/index.html b/4.x/designers/language-custom-functions/language-function-html-options/index.html index d1016428..a94bcf6c 100644 --- a/4.x/designers/language-custom-functions/language-function-html-options/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-options/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-radios/index.html b/4.x/designers/language-custom-functions/language-function-html-radios/index.html index bc3e5402..bc1c7f86 100644 --- a/4.x/designers/language-custom-functions/language-function-html-radios/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-radios/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-select-date/index.html b/4.x/designers/language-custom-functions/language-function-html-select-date/index.html index aa292eec..38fa3fb2 100644 --- a/4.x/designers/language-custom-functions/language-function-html-select-date/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-select-date/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-select-time/index.html b/4.x/designers/language-custom-functions/language-function-html-select-time/index.html index 88decb57..753a198b 100644 --- a/4.x/designers/language-custom-functions/language-function-html-select-time/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-select-time/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-html-table/index.html b/4.x/designers/language-custom-functions/language-function-html-table/index.html index fd5ee5fa..52927a91 100644 --- a/4.x/designers/language-custom-functions/language-function-html-table/index.html +++ b/4.x/designers/language-custom-functions/language-function-html-table/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-mailto/index.html b/4.x/designers/language-custom-functions/language-function-mailto/index.html index 4e70581f..3378e568 100644 --- a/4.x/designers/language-custom-functions/language-function-mailto/index.html +++ b/4.x/designers/language-custom-functions/language-function-mailto/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-math/index.html b/4.x/designers/language-custom-functions/language-function-math/index.html index cc6d4fda..9c9dd4ee 100644 --- a/4.x/designers/language-custom-functions/language-function-math/index.html +++ b/4.x/designers/language-custom-functions/language-function-math/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-custom-functions/language-function-textformat/index.html b/4.x/designers/language-custom-functions/language-function-textformat/index.html index 92d6beee..358b8783 100644 --- a/4.x/designers/language-custom-functions/language-function-textformat/index.html +++ b/4.x/designers/language-custom-functions/language-function-textformat/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/index.html b/4.x/designers/language-modifiers/index.html index b04886db..0fe04e9c 100644 --- a/4.x/designers/language-modifiers/index.html +++ b/4.x/designers/language-modifiers/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-capitalize/index.html b/4.x/designers/language-modifiers/language-modifier-capitalize/index.html index 06a81cf4..590fb692 100644 --- a/4.x/designers/language-modifiers/language-modifier-capitalize/index.html +++ b/4.x/designers/language-modifiers/language-modifier-capitalize/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-cat/index.html b/4.x/designers/language-modifiers/language-modifier-cat/index.html index dcb3e6bd..a4e07333 100644 --- a/4.x/designers/language-modifiers/language-modifier-cat/index.html +++ b/4.x/designers/language-modifiers/language-modifier-cat/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-count-characters/index.html b/4.x/designers/language-modifiers/language-modifier-count-characters/index.html index 592a26af..d47ec8f8 100644 --- a/4.x/designers/language-modifiers/language-modifier-count-characters/index.html +++ b/4.x/designers/language-modifiers/language-modifier-count-characters/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-count-paragraphs/index.html b/4.x/designers/language-modifiers/language-modifier-count-paragraphs/index.html index 4165321c..bd024a32 100644 --- a/4.x/designers/language-modifiers/language-modifier-count-paragraphs/index.html +++ b/4.x/designers/language-modifiers/language-modifier-count-paragraphs/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-count-sentences/index.html b/4.x/designers/language-modifiers/language-modifier-count-sentences/index.html index 401f38fb..29c50052 100644 --- a/4.x/designers/language-modifiers/language-modifier-count-sentences/index.html +++ b/4.x/designers/language-modifiers/language-modifier-count-sentences/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-count-words/index.html b/4.x/designers/language-modifiers/language-modifier-count-words/index.html index 1d6a4e63..52ab3c2b 100644 --- a/4.x/designers/language-modifiers/language-modifier-count-words/index.html +++ b/4.x/designers/language-modifiers/language-modifier-count-words/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-date-format/index.html b/4.x/designers/language-modifiers/language-modifier-date-format/index.html index e1f02816..201933b0 100644 --- a/4.x/designers/language-modifiers/language-modifier-date-format/index.html +++ b/4.x/designers/language-modifiers/language-modifier-date-format/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-default/index.html b/4.x/designers/language-modifiers/language-modifier-default/index.html index 7cc91203..bd4ffcef 100644 --- a/4.x/designers/language-modifiers/language-modifier-default/index.html +++ b/4.x/designers/language-modifiers/language-modifier-default/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-escape/index.html b/4.x/designers/language-modifiers/language-modifier-escape/index.html index 555a4487..b12e437a 100644 --- a/4.x/designers/language-modifiers/language-modifier-escape/index.html +++ b/4.x/designers/language-modifiers/language-modifier-escape/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-from-charset/index.html b/4.x/designers/language-modifiers/language-modifier-from-charset/index.html index d9674dbc..ca7e782b 100644 --- a/4.x/designers/language-modifiers/language-modifier-from-charset/index.html +++ b/4.x/designers/language-modifiers/language-modifier-from-charset/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-indent/index.html b/4.x/designers/language-modifiers/language-modifier-indent/index.html index 96c9c4d7..d9cf1a69 100644 --- a/4.x/designers/language-modifiers/language-modifier-indent/index.html +++ b/4.x/designers/language-modifiers/language-modifier-indent/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-lower/index.html b/4.x/designers/language-modifiers/language-modifier-lower/index.html index 2c74dab8..79303b0b 100644 --- a/4.x/designers/language-modifiers/language-modifier-lower/index.html +++ b/4.x/designers/language-modifiers/language-modifier-lower/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-nl2br/index.html b/4.x/designers/language-modifiers/language-modifier-nl2br/index.html index 50a4c762..4bc1675d 100644 --- a/4.x/designers/language-modifiers/language-modifier-nl2br/index.html +++ b/4.x/designers/language-modifiers/language-modifier-nl2br/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-regex-replace/index.html b/4.x/designers/language-modifiers/language-modifier-regex-replace/index.html index fdcdd903..edddde8d 100644 --- a/4.x/designers/language-modifiers/language-modifier-regex-replace/index.html +++ b/4.x/designers/language-modifiers/language-modifier-regex-replace/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-replace/index.html b/4.x/designers/language-modifiers/language-modifier-replace/index.html index 0f7be45b..ac053c42 100644 --- a/4.x/designers/language-modifiers/language-modifier-replace/index.html +++ b/4.x/designers/language-modifiers/language-modifier-replace/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-spacify/index.html b/4.x/designers/language-modifiers/language-modifier-spacify/index.html index 1cabb142..cbc8f9db 100644 --- a/4.x/designers/language-modifiers/language-modifier-spacify/index.html +++ b/4.x/designers/language-modifiers/language-modifier-spacify/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-string-format/index.html b/4.x/designers/language-modifiers/language-modifier-string-format/index.html index b59d5b56..5c24dd43 100644 --- a/4.x/designers/language-modifiers/language-modifier-string-format/index.html +++ b/4.x/designers/language-modifiers/language-modifier-string-format/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-strip-tags/index.html b/4.x/designers/language-modifiers/language-modifier-strip-tags/index.html index 6ac99f36..fe395786 100644 --- a/4.x/designers/language-modifiers/language-modifier-strip-tags/index.html +++ b/4.x/designers/language-modifiers/language-modifier-strip-tags/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-strip/index.html b/4.x/designers/language-modifiers/language-modifier-strip/index.html index d2b2fb72..ccac0592 100644 --- a/4.x/designers/language-modifiers/language-modifier-strip/index.html +++ b/4.x/designers/language-modifiers/language-modifier-strip/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-to-charset/index.html b/4.x/designers/language-modifiers/language-modifier-to-charset/index.html index 171cbe3c..8a991861 100644 --- a/4.x/designers/language-modifiers/language-modifier-to-charset/index.html +++ b/4.x/designers/language-modifiers/language-modifier-to-charset/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-truncate/index.html b/4.x/designers/language-modifiers/language-modifier-truncate/index.html index 61feddb0..6768019c 100644 --- a/4.x/designers/language-modifiers/language-modifier-truncate/index.html +++ b/4.x/designers/language-modifiers/language-modifier-truncate/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-unescape/index.html b/4.x/designers/language-modifiers/language-modifier-unescape/index.html index 70b7bceb..2dd8cc52 100644 --- a/4.x/designers/language-modifiers/language-modifier-unescape/index.html +++ b/4.x/designers/language-modifiers/language-modifier-unescape/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-upper/index.html b/4.x/designers/language-modifiers/language-modifier-upper/index.html index 4bc2c00a..43e15955 100644 --- a/4.x/designers/language-modifiers/language-modifier-upper/index.html +++ b/4.x/designers/language-modifiers/language-modifier-upper/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-modifiers/language-modifier-wordwrap/index.html b/4.x/designers/language-modifiers/language-modifier-wordwrap/index.html index 2e1e4857..581d7ec6 100644 --- a/4.x/designers/language-modifiers/language-modifier-wordwrap/index.html +++ b/4.x/designers/language-modifiers/language-modifier-wordwrap/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-variables/index.html b/4.x/designers/language-variables/index.html index 0b9611a9..a1fbfcd5 100644 --- a/4.x/designers/language-variables/index.html +++ b/4.x/designers/language-variables/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-variables/language-assigned-variables/index.html b/4.x/designers/language-variables/language-assigned-variables/index.html index b87e7f99..45773f14 100644 --- a/4.x/designers/language-variables/language-assigned-variables/index.html +++ b/4.x/designers/language-variables/language-assigned-variables/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-variables/language-config-variables/index.html b/4.x/designers/language-variables/language-config-variables/index.html index f825ba14..56c78bff 100644 --- a/4.x/designers/language-variables/language-config-variables/index.html +++ b/4.x/designers/language-variables/language-config-variables/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-variables/language-variable-scopes/index.html b/4.x/designers/language-variables/language-variable-scopes/index.html index 942d0eb9..6ce86c07 100644 --- a/4.x/designers/language-variables/language-variable-scopes/index.html +++ b/4.x/designers/language-variables/language-variable-scopes/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/designers/language-variables/language-variables-smarty/index.html b/4.x/designers/language-variables/language-variables-smarty/index.html index 78610977..eec3871e 100644 --- a/4.x/designers/language-variables/language-variables-smarty/index.html +++ b/4.x/designers/language-variables/language-variables-smarty/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,19 +317,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/features/index.html b/4.x/features/index.html index 08a85201..8148544d 100644 --- a/4.x/features/index.html +++ b/4.x/features/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/getting-started/index.html b/4.x/getting-started/index.html index 63147ad1..6d6f9617 100644 --- a/4.x/getting-started/index.html +++ b/4.x/getting-started/index.html @@ -12,7 +12,7 @@ - + @@ -20,7 +20,7 @@ - Getting started - Smarty Documentation + Introduction - Smarty Documentation @@ -110,7 +110,7 @@
    - Getting started + Introduction
    @@ -191,16 +191,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -316,6 +317,48 @@ + + + + + + + + +
  • + + + + + + + + + + + +
    • + + diff --git a/4.x/index.html b/4.x/index.html index dc97eeec..2c9ad162 100644 --- a/4.x/index.html +++ b/4.x/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -388,19 +389,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/philosophy/index.html b/4.x/philosophy/index.html index cb0d4c99..8ecfaec2 100644 --- a/4.x/philosophy/index.html +++ b/4.x/philosophy/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-objects/index.html b/4.x/programmers/advanced-features/advanced-features-objects/index.html index 5689269c..5a5a094f 100644 --- a/4.x/programmers/advanced-features/advanced-features-objects/index.html +++ b/4.x/programmers/advanced-features/advanced-features-objects/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-outputfilters/index.html b/4.x/programmers/advanced-features/advanced-features-outputfilters/index.html index 8eb86b7e..02d618c6 100644 --- a/4.x/programmers/advanced-features/advanced-features-outputfilters/index.html +++ b/4.x/programmers/advanced-features/advanced-features-outputfilters/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-postfilters/index.html b/4.x/programmers/advanced-features/advanced-features-postfilters/index.html index 5962fbfe..fe2cf99a 100644 --- a/4.x/programmers/advanced-features/advanced-features-postfilters/index.html +++ b/4.x/programmers/advanced-features/advanced-features-postfilters/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-prefilters/index.html b/4.x/programmers/advanced-features/advanced-features-prefilters/index.html index 8f3ff03e..b22c5fea 100644 --- a/4.x/programmers/advanced-features/advanced-features-prefilters/index.html +++ b/4.x/programmers/advanced-features/advanced-features-prefilters/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-security/index.html b/4.x/programmers/advanced-features/advanced-features-security/index.html index aa5cc0c0..ffada0d9 100644 --- a/4.x/programmers/advanced-features/advanced-features-security/index.html +++ b/4.x/programmers/advanced-features/advanced-features-security/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-static-classes/index.html b/4.x/programmers/advanced-features/advanced-features-static-classes/index.html index e8348fd0..1ae83843 100644 --- a/4.x/programmers/advanced-features/advanced-features-static-classes/index.html +++ b/4.x/programmers/advanced-features/advanced-features-static-classes/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-streams/index.html b/4.x/programmers/advanced-features/advanced-features-streams/index.html index c545199c..8b02d925 100644 --- a/4.x/programmers/advanced-features/advanced-features-streams/index.html +++ b/4.x/programmers/advanced-features/advanced-features-streams/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-template-inheritance/index.html b/4.x/programmers/advanced-features/advanced-features-template-inheritance/index.html index 370829f1..82c2ce0c 100644 --- a/4.x/programmers/advanced-features/advanced-features-template-inheritance/index.html +++ b/4.x/programmers/advanced-features/advanced-features-template-inheritance/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/advanced-features-template-settings/index.html b/4.x/programmers/advanced-features/advanced-features-template-settings/index.html index 7961a363..3c8a46fe 100644 --- a/4.x/programmers/advanced-features/advanced-features-template-settings/index.html +++ b/4.x/programmers/advanced-features/advanced-features-template-settings/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/advanced-features/index.html b/4.x/programmers/advanced-features/index.html index cf697884..b653f7e5 100644 --- a/4.x/programmers/advanced-features/index.html +++ b/4.x/programmers/advanced-features/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-add-config-dir/index.html b/4.x/programmers/api-functions/api-add-config-dir/index.html index d696b5b7..074c2790 100644 --- a/4.x/programmers/api-functions/api-add-config-dir/index.html +++ b/4.x/programmers/api-functions/api-add-config-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-add-plugins-dir/index.html b/4.x/programmers/api-functions/api-add-plugins-dir/index.html index 4b916788..5f6d5615 100644 --- a/4.x/programmers/api-functions/api-add-plugins-dir/index.html +++ b/4.x/programmers/api-functions/api-add-plugins-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-add-template-dir/index.html b/4.x/programmers/api-functions/api-add-template-dir/index.html index 7407d094..94d5cb66 100644 --- a/4.x/programmers/api-functions/api-add-template-dir/index.html +++ b/4.x/programmers/api-functions/api-add-template-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-append-by-ref/index.html b/4.x/programmers/api-functions/api-append-by-ref/index.html index 7f42bb0b..e65a8efc 100644 --- a/4.x/programmers/api-functions/api-append-by-ref/index.html +++ b/4.x/programmers/api-functions/api-append-by-ref/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-append/index.html b/4.x/programmers/api-functions/api-append/index.html index 11dfdf75..d015bf04 100644 --- a/4.x/programmers/api-functions/api-append/index.html +++ b/4.x/programmers/api-functions/api-append/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-assign-by-ref/index.html b/4.x/programmers/api-functions/api-assign-by-ref/index.html index c4ffe9e0..3fd1236a 100644 --- a/4.x/programmers/api-functions/api-assign-by-ref/index.html +++ b/4.x/programmers/api-functions/api-assign-by-ref/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-assign/index.html b/4.x/programmers/api-functions/api-assign/index.html index d0d00607..3a0825ca 100644 --- a/4.x/programmers/api-functions/api-assign/index.html +++ b/4.x/programmers/api-functions/api-assign/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-clear-all-assign/index.html b/4.x/programmers/api-functions/api-clear-all-assign/index.html index ff40e3c7..98d65305 100644 --- a/4.x/programmers/api-functions/api-clear-all-assign/index.html +++ b/4.x/programmers/api-functions/api-clear-all-assign/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-clear-all-cache/index.html b/4.x/programmers/api-functions/api-clear-all-cache/index.html index 6a63f8f7..71d365a6 100644 --- a/4.x/programmers/api-functions/api-clear-all-cache/index.html +++ b/4.x/programmers/api-functions/api-clear-all-cache/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-clear-assign/index.html b/4.x/programmers/api-functions/api-clear-assign/index.html index 85475036..461e2902 100644 --- a/4.x/programmers/api-functions/api-clear-assign/index.html +++ b/4.x/programmers/api-functions/api-clear-assign/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-clear-cache/index.html b/4.x/programmers/api-functions/api-clear-cache/index.html index 294291e8..4afe39ed 100644 --- a/4.x/programmers/api-functions/api-clear-cache/index.html +++ b/4.x/programmers/api-functions/api-clear-cache/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-clear-compiled-tpl/index.html b/4.x/programmers/api-functions/api-clear-compiled-tpl/index.html index 378dfa5f..69966b0a 100644 --- a/4.x/programmers/api-functions/api-clear-compiled-tpl/index.html +++ b/4.x/programmers/api-functions/api-clear-compiled-tpl/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-clear-config/index.html b/4.x/programmers/api-functions/api-clear-config/index.html index 229d9f78..7612fbca 100644 --- a/4.x/programmers/api-functions/api-clear-config/index.html +++ b/4.x/programmers/api-functions/api-clear-config/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-compile-all-config/index.html b/4.x/programmers/api-functions/api-compile-all-config/index.html index 392ac456..e401b654 100644 --- a/4.x/programmers/api-functions/api-compile-all-config/index.html +++ b/4.x/programmers/api-functions/api-compile-all-config/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-compile-all-templates/index.html b/4.x/programmers/api-functions/api-compile-all-templates/index.html index 67b7ae8d..4a0ac9c0 100644 --- a/4.x/programmers/api-functions/api-compile-all-templates/index.html +++ b/4.x/programmers/api-functions/api-compile-all-templates/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-config-load/index.html b/4.x/programmers/api-functions/api-config-load/index.html index 13a1c53f..3c6f1941 100644 --- a/4.x/programmers/api-functions/api-config-load/index.html +++ b/4.x/programmers/api-functions/api-config-load/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-create-data/index.html b/4.x/programmers/api-functions/api-create-data/index.html index eec91e69..37b05ee0 100644 --- a/4.x/programmers/api-functions/api-create-data/index.html +++ b/4.x/programmers/api-functions/api-create-data/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-create-template/index.html b/4.x/programmers/api-functions/api-create-template/index.html index d03f7e70..6b3f3cb2 100644 --- a/4.x/programmers/api-functions/api-create-template/index.html +++ b/4.x/programmers/api-functions/api-create-template/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-disable-security/index.html b/4.x/programmers/api-functions/api-disable-security/index.html index dad026d1..cfb9d63b 100644 --- a/4.x/programmers/api-functions/api-disable-security/index.html +++ b/4.x/programmers/api-functions/api-disable-security/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-display/index.html b/4.x/programmers/api-functions/api-display/index.html index 39e4aeb7..ef8f70d1 100644 --- a/4.x/programmers/api-functions/api-display/index.html +++ b/4.x/programmers/api-functions/api-display/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-enable-security/index.html b/4.x/programmers/api-functions/api-enable-security/index.html index d6af5cc6..71645e23 100644 --- a/4.x/programmers/api-functions/api-enable-security/index.html +++ b/4.x/programmers/api-functions/api-enable-security/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-fetch/index.html b/4.x/programmers/api-functions/api-fetch/index.html index bcd55c5c..fe1f82b0 100644 --- a/4.x/programmers/api-functions/api-fetch/index.html +++ b/4.x/programmers/api-functions/api-fetch/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-cache-dir/index.html b/4.x/programmers/api-functions/api-get-cache-dir/index.html index 2031d54f..b76b8496 100644 --- a/4.x/programmers/api-functions/api-get-cache-dir/index.html +++ b/4.x/programmers/api-functions/api-get-cache-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-compile-dir/index.html b/4.x/programmers/api-functions/api-get-compile-dir/index.html index 5f3ce9d4..d1d98f82 100644 --- a/4.x/programmers/api-functions/api-get-compile-dir/index.html +++ b/4.x/programmers/api-functions/api-get-compile-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-config-dir/index.html b/4.x/programmers/api-functions/api-get-config-dir/index.html index 77b48bee..3114d11b 100644 --- a/4.x/programmers/api-functions/api-get-config-dir/index.html +++ b/4.x/programmers/api-functions/api-get-config-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-config-vars/index.html b/4.x/programmers/api-functions/api-get-config-vars/index.html index e16e237a..9b98d2d5 100644 --- a/4.x/programmers/api-functions/api-get-config-vars/index.html +++ b/4.x/programmers/api-functions/api-get-config-vars/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-plugins-dir/index.html b/4.x/programmers/api-functions/api-get-plugins-dir/index.html index 7ba1d607..805efb22 100644 --- a/4.x/programmers/api-functions/api-get-plugins-dir/index.html +++ b/4.x/programmers/api-functions/api-get-plugins-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-registered-object/index.html b/4.x/programmers/api-functions/api-get-registered-object/index.html index 72121891..92748cc6 100644 --- a/4.x/programmers/api-functions/api-get-registered-object/index.html +++ b/4.x/programmers/api-functions/api-get-registered-object/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-tags/index.html b/4.x/programmers/api-functions/api-get-tags/index.html index 1f41de9c..68e4be16 100644 --- a/4.x/programmers/api-functions/api-get-tags/index.html +++ b/4.x/programmers/api-functions/api-get-tags/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-template-dir/index.html b/4.x/programmers/api-functions/api-get-template-dir/index.html index a108641c..e6f65205 100644 --- a/4.x/programmers/api-functions/api-get-template-dir/index.html +++ b/4.x/programmers/api-functions/api-get-template-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-get-template-vars/index.html b/4.x/programmers/api-functions/api-get-template-vars/index.html index 14a718f5..0b8f8bf7 100644 --- a/4.x/programmers/api-functions/api-get-template-vars/index.html +++ b/4.x/programmers/api-functions/api-get-template-vars/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-is-cached/index.html b/4.x/programmers/api-functions/api-is-cached/index.html index 7d57f565..114d3f84 100644 --- a/4.x/programmers/api-functions/api-is-cached/index.html +++ b/4.x/programmers/api-functions/api-is-cached/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-load-filter/index.html b/4.x/programmers/api-functions/api-load-filter/index.html index 84379681..8a3ebeff 100644 --- a/4.x/programmers/api-functions/api-load-filter/index.html +++ b/4.x/programmers/api-functions/api-load-filter/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-mute-expected-errors/index.html b/4.x/programmers/api-functions/api-mute-expected-errors/index.html index f8495f57..ca181af6 100644 --- a/4.x/programmers/api-functions/api-mute-expected-errors/index.html +++ b/4.x/programmers/api-functions/api-mute-expected-errors/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-cacheresource/index.html b/4.x/programmers/api-functions/api-register-cacheresource/index.html index d26c5697..e296ecaa 100644 --- a/4.x/programmers/api-functions/api-register-cacheresource/index.html +++ b/4.x/programmers/api-functions/api-register-cacheresource/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-class/index.html b/4.x/programmers/api-functions/api-register-class/index.html index 4e4be171..b8f79b1a 100644 --- a/4.x/programmers/api-functions/api-register-class/index.html +++ b/4.x/programmers/api-functions/api-register-class/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-default-plugin-handler/index.html b/4.x/programmers/api-functions/api-register-default-plugin-handler/index.html index 93747d44..0227523e 100644 --- a/4.x/programmers/api-functions/api-register-default-plugin-handler/index.html +++ b/4.x/programmers/api-functions/api-register-default-plugin-handler/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-filter/index.html b/4.x/programmers/api-functions/api-register-filter/index.html index 947c44e6..9f404616 100644 --- a/4.x/programmers/api-functions/api-register-filter/index.html +++ b/4.x/programmers/api-functions/api-register-filter/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-object/index.html b/4.x/programmers/api-functions/api-register-object/index.html index 178f6dee..de6dd85d 100644 --- a/4.x/programmers/api-functions/api-register-object/index.html +++ b/4.x/programmers/api-functions/api-register-object/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-plugin/index.html b/4.x/programmers/api-functions/api-register-plugin/index.html index 352b8fb8..f23762cc 100644 --- a/4.x/programmers/api-functions/api-register-plugin/index.html +++ b/4.x/programmers/api-functions/api-register-plugin/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-register-resource/index.html b/4.x/programmers/api-functions/api-register-resource/index.html index e449dcb3..0df85d56 100644 --- a/4.x/programmers/api-functions/api-register-resource/index.html +++ b/4.x/programmers/api-functions/api-register-resource/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-set-cache-dir/index.html b/4.x/programmers/api-functions/api-set-cache-dir/index.html index a69daa3a..c6e6a80d 100644 --- a/4.x/programmers/api-functions/api-set-cache-dir/index.html +++ b/4.x/programmers/api-functions/api-set-cache-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-set-compile-dir/index.html b/4.x/programmers/api-functions/api-set-compile-dir/index.html index 59fa802d..fa64cfc5 100644 --- a/4.x/programmers/api-functions/api-set-compile-dir/index.html +++ b/4.x/programmers/api-functions/api-set-compile-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-set-config-dir/index.html b/4.x/programmers/api-functions/api-set-config-dir/index.html index 69791b1c..a9781485 100644 --- a/4.x/programmers/api-functions/api-set-config-dir/index.html +++ b/4.x/programmers/api-functions/api-set-config-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-set-plugins-dir/index.html b/4.x/programmers/api-functions/api-set-plugins-dir/index.html index f5e2c3ee..d5e580c3 100644 --- a/4.x/programmers/api-functions/api-set-plugins-dir/index.html +++ b/4.x/programmers/api-functions/api-set-plugins-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-set-template-dir/index.html b/4.x/programmers/api-functions/api-set-template-dir/index.html index 7eee289a..65c36ee0 100644 --- a/4.x/programmers/api-functions/api-set-template-dir/index.html +++ b/4.x/programmers/api-functions/api-set-template-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-template-exists/index.html b/4.x/programmers/api-functions/api-template-exists/index.html index 39277bab..cd501aa0 100644 --- a/4.x/programmers/api-functions/api-template-exists/index.html +++ b/4.x/programmers/api-functions/api-template-exists/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-test-install/index.html b/4.x/programmers/api-functions/api-test-install/index.html index a0558901..191f07d0 100644 --- a/4.x/programmers/api-functions/api-test-install/index.html +++ b/4.x/programmers/api-functions/api-test-install/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-unregister-cacheresource/index.html b/4.x/programmers/api-functions/api-unregister-cacheresource/index.html index 68ccb5bb..9fede1b7 100644 --- a/4.x/programmers/api-functions/api-unregister-cacheresource/index.html +++ b/4.x/programmers/api-functions/api-unregister-cacheresource/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-unregister-filter/index.html b/4.x/programmers/api-functions/api-unregister-filter/index.html index c4e945bc..316b091b 100644 --- a/4.x/programmers/api-functions/api-unregister-filter/index.html +++ b/4.x/programmers/api-functions/api-unregister-filter/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-unregister-object/index.html b/4.x/programmers/api-functions/api-unregister-object/index.html index 85a8eb33..2458c4d5 100644 --- a/4.x/programmers/api-functions/api-unregister-object/index.html +++ b/4.x/programmers/api-functions/api-unregister-object/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-unregister-plugin/index.html b/4.x/programmers/api-functions/api-unregister-plugin/index.html index a1938d1a..faba3764 100644 --- a/4.x/programmers/api-functions/api-unregister-plugin/index.html +++ b/4.x/programmers/api-functions/api-unregister-plugin/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/api-unregister-resource/index.html b/4.x/programmers/api-functions/api-unregister-resource/index.html index a261cd99..64037f40 100644 --- a/4.x/programmers/api-functions/api-unregister-resource/index.html +++ b/4.x/programmers/api-functions/api-unregister-resource/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-functions/index.html b/4.x/programmers/api-functions/index.html index 26776197..d16d1c59 100644 --- a/4.x/programmers/api-functions/index.html +++ b/4.x/programmers/api-functions/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/index.html b/4.x/programmers/api-variables/index.html index 3d083469..bf4673ce 100644 --- a/4.x/programmers/api-variables/index.html +++ b/4.x/programmers/api-variables/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-allow-php-templates/index.html b/4.x/programmers/api-variables/variable-allow-php-templates/index.html index 79019e9f..b2ea4427 100644 --- a/4.x/programmers/api-variables/variable-allow-php-templates/index.html +++ b/4.x/programmers/api-variables/variable-allow-php-templates/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-auto-literal/index.html b/4.x/programmers/api-variables/variable-auto-literal/index.html index c49182b3..57b19fbd 100644 --- a/4.x/programmers/api-variables/variable-auto-literal/index.html +++ b/4.x/programmers/api-variables/variable-auto-literal/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-autoload-filters/index.html b/4.x/programmers/api-variables/variable-autoload-filters/index.html index 8efcc47a..dec03af8 100644 --- a/4.x/programmers/api-variables/variable-autoload-filters/index.html +++ b/4.x/programmers/api-variables/variable-autoload-filters/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-cache-dir/index.html b/4.x/programmers/api-variables/variable-cache-dir/index.html index 10b89d03..91237e34 100644 --- a/4.x/programmers/api-variables/variable-cache-dir/index.html +++ b/4.x/programmers/api-variables/variable-cache-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-cache-id/index.html b/4.x/programmers/api-variables/variable-cache-id/index.html index 883d7344..08d428a2 100644 --- a/4.x/programmers/api-variables/variable-cache-id/index.html +++ b/4.x/programmers/api-variables/variable-cache-id/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-cache-lifetime/index.html b/4.x/programmers/api-variables/variable-cache-lifetime/index.html index 19d27234..99a12d74 100644 --- a/4.x/programmers/api-variables/variable-cache-lifetime/index.html +++ b/4.x/programmers/api-variables/variable-cache-lifetime/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-cache-locking/index.html b/4.x/programmers/api-variables/variable-cache-locking/index.html index eae865a8..847104d3 100644 --- a/4.x/programmers/api-variables/variable-cache-locking/index.html +++ b/4.x/programmers/api-variables/variable-cache-locking/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-cache-modified-check/index.html b/4.x/programmers/api-variables/variable-cache-modified-check/index.html index a64696a4..133d84a9 100644 --- a/4.x/programmers/api-variables/variable-cache-modified-check/index.html +++ b/4.x/programmers/api-variables/variable-cache-modified-check/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-caching-type/index.html b/4.x/programmers/api-variables/variable-caching-type/index.html index b7be539e..02ea3747 100644 --- a/4.x/programmers/api-variables/variable-caching-type/index.html +++ b/4.x/programmers/api-variables/variable-caching-type/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-caching/index.html b/4.x/programmers/api-variables/variable-caching/index.html index 60ebb23e..e962dd05 100644 --- a/4.x/programmers/api-variables/variable-caching/index.html +++ b/4.x/programmers/api-variables/variable-caching/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-compile-check/index.html b/4.x/programmers/api-variables/variable-compile-check/index.html index e6ef9c43..a75f485d 100644 --- a/4.x/programmers/api-variables/variable-compile-check/index.html +++ b/4.x/programmers/api-variables/variable-compile-check/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-compile-dir/index.html b/4.x/programmers/api-variables/variable-compile-dir/index.html index 0d3e25d4..ab6b6e8f 100644 --- a/4.x/programmers/api-variables/variable-compile-dir/index.html +++ b/4.x/programmers/api-variables/variable-compile-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-compile-id/index.html b/4.x/programmers/api-variables/variable-compile-id/index.html index f8ea9ce9..3c9392d5 100644 --- a/4.x/programmers/api-variables/variable-compile-id/index.html +++ b/4.x/programmers/api-variables/variable-compile-id/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-compile-locking/index.html b/4.x/programmers/api-variables/variable-compile-locking/index.html index bf871699..39092e09 100644 --- a/4.x/programmers/api-variables/variable-compile-locking/index.html +++ b/4.x/programmers/api-variables/variable-compile-locking/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-compiler-class/index.html b/4.x/programmers/api-variables/variable-compiler-class/index.html index ece58931..40c90bd0 100644 --- a/4.x/programmers/api-variables/variable-compiler-class/index.html +++ b/4.x/programmers/api-variables/variable-compiler-class/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-config-booleanize/index.html b/4.x/programmers/api-variables/variable-config-booleanize/index.html index 19551d40..59430bc4 100644 --- a/4.x/programmers/api-variables/variable-config-booleanize/index.html +++ b/4.x/programmers/api-variables/variable-config-booleanize/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-config-dir/index.html b/4.x/programmers/api-variables/variable-config-dir/index.html index 76ec7135..26ef2dea 100644 --- a/4.x/programmers/api-variables/variable-config-dir/index.html +++ b/4.x/programmers/api-variables/variable-config-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-config-overwrite/index.html b/4.x/programmers/api-variables/variable-config-overwrite/index.html index 21e140c5..1a26ec8d 100644 --- a/4.x/programmers/api-variables/variable-config-overwrite/index.html +++ b/4.x/programmers/api-variables/variable-config-overwrite/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-config-read-hidden/index.html b/4.x/programmers/api-variables/variable-config-read-hidden/index.html index 102d5a0f..22c846b2 100644 --- a/4.x/programmers/api-variables/variable-config-read-hidden/index.html +++ b/4.x/programmers/api-variables/variable-config-read-hidden/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-debug-template/index.html b/4.x/programmers/api-variables/variable-debug-template/index.html index d6764310..53cfeed9 100644 --- a/4.x/programmers/api-variables/variable-debug-template/index.html +++ b/4.x/programmers/api-variables/variable-debug-template/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-debugging-ctrl/index.html b/4.x/programmers/api-variables/variable-debugging-ctrl/index.html index ff4be7fd..f2df85e6 100644 --- a/4.x/programmers/api-variables/variable-debugging-ctrl/index.html +++ b/4.x/programmers/api-variables/variable-debugging-ctrl/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-debugging/index.html b/4.x/programmers/api-variables/variable-debugging/index.html index 9261e3d6..27bb5ed1 100644 --- a/4.x/programmers/api-variables/variable-debugging/index.html +++ b/4.x/programmers/api-variables/variable-debugging/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-default-config-handler-func/index.html b/4.x/programmers/api-variables/variable-default-config-handler-func/index.html index 53295fc2..58ff5490 100644 --- a/4.x/programmers/api-variables/variable-default-config-handler-func/index.html +++ b/4.x/programmers/api-variables/variable-default-config-handler-func/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-default-config-type/index.html b/4.x/programmers/api-variables/variable-default-config-type/index.html index 7a9f399e..14551c53 100644 --- a/4.x/programmers/api-variables/variable-default-config-type/index.html +++ b/4.x/programmers/api-variables/variable-default-config-type/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-default-modifiers/index.html b/4.x/programmers/api-variables/variable-default-modifiers/index.html index 6ff47d3a..ead6430e 100644 --- a/4.x/programmers/api-variables/variable-default-modifiers/index.html +++ b/4.x/programmers/api-variables/variable-default-modifiers/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-default-resource-type/index.html b/4.x/programmers/api-variables/variable-default-resource-type/index.html index 7ffd5847..0863dd39 100644 --- a/4.x/programmers/api-variables/variable-default-resource-type/index.html +++ b/4.x/programmers/api-variables/variable-default-resource-type/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-default-template-handler-func/index.html b/4.x/programmers/api-variables/variable-default-template-handler-func/index.html index b90898f7..bd1559dd 100644 --- a/4.x/programmers/api-variables/variable-default-template-handler-func/index.html +++ b/4.x/programmers/api-variables/variable-default-template-handler-func/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-direct-access-security/index.html b/4.x/programmers/api-variables/variable-direct-access-security/index.html index c24a82ed..10f2c365 100644 --- a/4.x/programmers/api-variables/variable-direct-access-security/index.html +++ b/4.x/programmers/api-variables/variable-direct-access-security/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-error-reporting/index.html b/4.x/programmers/api-variables/variable-error-reporting/index.html index f402911d..ebbd74a2 100644 --- a/4.x/programmers/api-variables/variable-error-reporting/index.html +++ b/4.x/programmers/api-variables/variable-error-reporting/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-escape-html/index.html b/4.x/programmers/api-variables/variable-escape-html/index.html index 1a218a75..c0e86b4d 100644 --- a/4.x/programmers/api-variables/variable-escape-html/index.html +++ b/4.x/programmers/api-variables/variable-escape-html/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-force-cache/index.html b/4.x/programmers/api-variables/variable-force-cache/index.html index 98b8da0d..6811a1c5 100644 --- a/4.x/programmers/api-variables/variable-force-cache/index.html +++ b/4.x/programmers/api-variables/variable-force-cache/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-force-compile/index.html b/4.x/programmers/api-variables/variable-force-compile/index.html index f9dbf057..e2453435 100644 --- a/4.x/programmers/api-variables/variable-force-compile/index.html +++ b/4.x/programmers/api-variables/variable-force-compile/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-left-delimiter/index.html b/4.x/programmers/api-variables/variable-left-delimiter/index.html index 3b00a598..407a9985 100644 --- a/4.x/programmers/api-variables/variable-left-delimiter/index.html +++ b/4.x/programmers/api-variables/variable-left-delimiter/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-locking-timeout/index.html b/4.x/programmers/api-variables/variable-locking-timeout/index.html index 05eca039..cdf28382 100644 --- a/4.x/programmers/api-variables/variable-locking-timeout/index.html +++ b/4.x/programmers/api-variables/variable-locking-timeout/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-merge-compiled-includes/index.html b/4.x/programmers/api-variables/variable-merge-compiled-includes/index.html index 194ca18e..05837469 100644 --- a/4.x/programmers/api-variables/variable-merge-compiled-includes/index.html +++ b/4.x/programmers/api-variables/variable-merge-compiled-includes/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-plugins-dir/index.html b/4.x/programmers/api-variables/variable-plugins-dir/index.html index 21525b9f..25541f6a 100644 --- a/4.x/programmers/api-variables/variable-plugins-dir/index.html +++ b/4.x/programmers/api-variables/variable-plugins-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-right-delimiter/index.html b/4.x/programmers/api-variables/variable-right-delimiter/index.html index c21bebbe..2eb26007 100644 --- a/4.x/programmers/api-variables/variable-right-delimiter/index.html +++ b/4.x/programmers/api-variables/variable-right-delimiter/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-smarty-debug-id/index.html b/4.x/programmers/api-variables/variable-smarty-debug-id/index.html index d60683cd..3ac60aa2 100644 --- a/4.x/programmers/api-variables/variable-smarty-debug-id/index.html +++ b/4.x/programmers/api-variables/variable-smarty-debug-id/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-template-dir/index.html b/4.x/programmers/api-variables/variable-template-dir/index.html index 58684ee1..c1f3caaf 100644 --- a/4.x/programmers/api-variables/variable-template-dir/index.html +++ b/4.x/programmers/api-variables/variable-template-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-trusted-dir/index.html b/4.x/programmers/api-variables/variable-trusted-dir/index.html index afd5e594..63ba8777 100644 --- a/4.x/programmers/api-variables/variable-trusted-dir/index.html +++ b/4.x/programmers/api-variables/variable-trusted-dir/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-use-include-path/index.html b/4.x/programmers/api-variables/variable-use-include-path/index.html index 3d6b2b03..31bec6db 100644 --- a/4.x/programmers/api-variables/variable-use-include-path/index.html +++ b/4.x/programmers/api-variables/variable-use-include-path/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/api-variables/variable-use-sub-dirs/index.html b/4.x/programmers/api-variables/variable-use-sub-dirs/index.html index b7eb5ebd..dee59945 100644 --- a/4.x/programmers/api-variables/variable-use-sub-dirs/index.html +++ b/4.x/programmers/api-variables/variable-use-sub-dirs/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/caching/caching-cacheable/index.html b/4.x/programmers/caching/caching-cacheable/index.html index f1510e6e..49cdec0f 100644 --- a/4.x/programmers/caching/caching-cacheable/index.html +++ b/4.x/programmers/caching/caching-cacheable/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/caching/caching-custom/index.html b/4.x/programmers/caching/caching-custom/index.html index 7e89a43c..39ff67d1 100644 --- a/4.x/programmers/caching/caching-custom/index.html +++ b/4.x/programmers/caching/caching-custom/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/caching/caching-groups/index.html b/4.x/programmers/caching/caching-groups/index.html index 91c747dd..9b4bac09 100644 --- a/4.x/programmers/caching/caching-groups/index.html +++ b/4.x/programmers/caching/caching-groups/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/caching/caching-multiple-caches/index.html b/4.x/programmers/caching/caching-multiple-caches/index.html index 0482516d..68ecf66c 100644 --- a/4.x/programmers/caching/caching-multiple-caches/index.html +++ b/4.x/programmers/caching/caching-multiple-caches/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/caching/caching-setting-up/index.html b/4.x/programmers/caching/caching-setting-up/index.html index 82322275..fbfc08d9 100644 --- a/4.x/programmers/caching/caching-setting-up/index.html +++ b/4.x/programmers/caching/caching-setting-up/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/caching/index.html b/4.x/programmers/caching/index.html index 941813ee..5c599aad 100644 --- a/4.x/programmers/caching/index.html +++ b/4.x/programmers/caching/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/charset/index.html b/4.x/programmers/charset/index.html index 3a173315..de44eedc 100644 --- a/4.x/programmers/charset/index.html +++ b/4.x/programmers/charset/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/index.html b/4.x/programmers/plugins/index.html index 78e3b82d..61eb0fb1 100644 --- a/4.x/programmers/plugins/index.html +++ b/4.x/programmers/plugins/index.html @@ -187,16 +187,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -312,19 +313,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-block-functions/index.html b/4.x/programmers/plugins/plugins-block-functions/index.html index 9b5d971e..d7425fc9 100644 --- a/4.x/programmers/plugins/plugins-block-functions/index.html +++ b/4.x/programmers/plugins/plugins-block-functions/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-compiler-functions/index.html b/4.x/programmers/plugins/plugins-compiler-functions/index.html index 878c2317..4914ae6d 100644 --- a/4.x/programmers/plugins/plugins-compiler-functions/index.html +++ b/4.x/programmers/plugins/plugins-compiler-functions/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-functions/index.html b/4.x/programmers/plugins/plugins-functions/index.html index 03c73ee2..df448394 100644 --- a/4.x/programmers/plugins/plugins-functions/index.html +++ b/4.x/programmers/plugins/plugins-functions/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-howto/index.html b/4.x/programmers/plugins/plugins-howto/index.html index 126f4ce9..7bb6416e 100644 --- a/4.x/programmers/plugins/plugins-howto/index.html +++ b/4.x/programmers/plugins/plugins-howto/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-inserts/index.html b/4.x/programmers/plugins/plugins-inserts/index.html index 084c9caf..9f061759 100644 --- a/4.x/programmers/plugins/plugins-inserts/index.html +++ b/4.x/programmers/plugins/plugins-inserts/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-modifiers/index.html b/4.x/programmers/plugins/plugins-modifiers/index.html index 70e5cd20..7b614427 100644 --- a/4.x/programmers/plugins/plugins-modifiers/index.html +++ b/4.x/programmers/plugins/plugins-modifiers/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-naming-conventions/index.html b/4.x/programmers/plugins/plugins-naming-conventions/index.html index f0ffc438..4b8478cf 100644 --- a/4.x/programmers/plugins/plugins-naming-conventions/index.html +++ b/4.x/programmers/plugins/plugins-naming-conventions/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-outputfilters/index.html b/4.x/programmers/plugins/plugins-outputfilters/index.html index a1b37964..cfe32c1f 100644 --- a/4.x/programmers/plugins/plugins-outputfilters/index.html +++ b/4.x/programmers/plugins/plugins-outputfilters/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-prefilters-postfilters/index.html b/4.x/programmers/plugins/plugins-prefilters-postfilters/index.html index 7ae960e4..f38099f9 100644 --- a/4.x/programmers/plugins/plugins-prefilters-postfilters/index.html +++ b/4.x/programmers/plugins/plugins-prefilters-postfilters/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-resources/index.html b/4.x/programmers/plugins/plugins-resources/index.html index 68d3b2c3..be1a2b35 100644 --- a/4.x/programmers/plugins/plugins-resources/index.html +++ b/4.x/programmers/plugins/plugins-resources/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/plugins/plugins-writing/index.html b/4.x/programmers/plugins/plugins-writing/index.html index 9e21c8c8..1cd272e3 100644 --- a/4.x/programmers/plugins/plugins-writing/index.html +++ b/4.x/programmers/plugins/plugins-writing/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/index.html b/4.x/programmers/resources/index.html index 34e3848b..d67e750f 100644 --- a/4.x/programmers/resources/index.html +++ b/4.x/programmers/resources/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/resources-custom/index.html b/4.x/programmers/resources/resources-custom/index.html index 9f40e73f..ae8ea2e0 100644 --- a/4.x/programmers/resources/resources-custom/index.html +++ b/4.x/programmers/resources/resources-custom/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/resources-extends/index.html b/4.x/programmers/resources/resources-extends/index.html index e14fe66d..d35229b4 100644 --- a/4.x/programmers/resources/resources-extends/index.html +++ b/4.x/programmers/resources/resources-extends/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/resources-file/index.html b/4.x/programmers/resources/resources-file/index.html index c7a1dd6b..e53fd09d 100644 --- a/4.x/programmers/resources/resources-file/index.html +++ b/4.x/programmers/resources/resources-file/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/resources-streams/index.html b/4.x/programmers/resources/resources-streams/index.html index db904171..10524488 100644 --- a/4.x/programmers/resources/resources-streams/index.html +++ b/4.x/programmers/resources/resources-streams/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/resources-string/index.html b/4.x/programmers/resources/resources-string/index.html index e8e756d2..6b4ec011 100644 --- a/4.x/programmers/resources/resources-string/index.html +++ b/4.x/programmers/resources/resources-string/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/resources/template-resources/index.html b/4.x/programmers/resources/template-resources/index.html index 380dfe61..fcf04507 100644 --- a/4.x/programmers/resources/template-resources/index.html +++ b/4.x/programmers/resources/template-resources/index.html @@ -185,16 +185,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -308,19 +309,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/programmers/smarty-constants/index.html b/4.x/programmers/smarty-constants/index.html index 27b2d721..742a9afc 100644 --- a/4.x/programmers/smarty-constants/index.html +++ b/4.x/programmers/smarty-constants/index.html @@ -189,16 +189,17 @@ -
  • - - - + +
  • + + Getting started - -
    • + + + @@ -314,19 +315,88 @@ -
  • - + + + + + + + + +
  • + + + + + + + + + + +
    • + + diff --git a/4.x/search/search_index.json b/4.x/search/search_index.json index 573c869f..7a6a73f1 100644 --- a/4.x/search/search_index.json +++ b/4.x/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Smarty 4 Documentation","text":"

    Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.

    It allows you to write templates, using variables, modifiers, functions and comments, like this: 

    <h1>{$title|escape}</h1>\n\n<p>\n    The number of pixels is: {math equation=\"x * y\" x=$height y=$width}.\n</p>\n

    When this template is rendered, with the value \"Hello world\" for the variable $title, 640 for $width, and 480 for $height, the result is: 

    <h1>Hello world</h1>\n\n<p>\n    The number of pixels is: 307200.\n</p>\n

    "},{"location":"#introduction","title":"Introduction","text":""},{"location":"#smarty-for-template-designers","title":"Smarty for template designers","text":""},{"location":"#smarty-for-php-developers","title":"Smarty for php developers","text":""},{"location":"#other","title":"Other","text":""},{"location":"features/","title":"Features","text":"

    Some of Smarty's features: - It is extremely fast. - It is efficient since the PHP parser does the dirty work. - No template parsing overhead, only compiles once. - It is smart about recompiling only the template files that have changed. - You can easily create your own custom functions and variable modifiers, so the template language is extremely extensible. - Configurable template {delimiter} tag syntax, so you can use {$foo}, {{$foo}}, <!--{$foo}-->, etc. - The {if}..{elseif}..{else}..{/if} constructs are passed to the PHP parser, so the {if...} expression syntax can be as simple or as complex an evaluation as you like. - Allows unlimited nesting of sections, if's etc. - Built-in caching support - Arbitrary template sources - Template Inheritance for easy management of template content. - Plugin architecture

    "},{"location":"features/#separation-of-presentation-from-application-code","title":"Separation of presentation from application code","text":""},{"location":"features/#how-does-it-work","title":"How does it work?","text":"

    Under the hood, Smarty \"compiles\" (basically copies and converts) the templates into PHP scripts. This happens once when each template is first invoked, and then the compiled versions are used from that point forward. Smarty takes care of this for you, so the template designer just edits the Smarty templates and never has to manage the compiled versions. This approach keeps the templates easy to maintain, and yet keeps execution times extremely fast since the compiled code is just PHP. And of course, all PHP scripts take advantage of PHP op-code caches such as APC.

    "},{"location":"features/#template-inheritance","title":"Template Inheritance","text":"

    Template inheritance was introduced in Smarty 3. Before template inheritance, we managed our templates in pieces such as header and footer templates. This organization lends itself to many problems that require some hoop-jumping, such as managing content within the header/footer on a per-page basis. With template inheritance, instead of including other templates we maintain our templates as single pages. We can then manipulate blocks of content within by inheriting them. This makes templates intuitive, efficient and easy to manage. See Template Inheritance for more info.

    "},{"location":"features/#why-not-use-xmlxslt-syntax","title":"Why not use XML/XSLT syntax?","text":"

    There are a couple of good reasons. First, Smarty can be used for more than just XML/HTML based templates, such as generating emails, javascript, CSV, and PDF documents. Second, XML/XSLT syntax is even more verbose and fragile than PHP code! It is perfect for computers, but horrible for humans. Smarty is about being easy to read, understand and maintain.

    "},{"location":"features/#template-security","title":"Template Security","text":"

    Although Smarty insulates you from PHP, you still have the option to use it in certain ways if you wish. Template security forces the restriction of PHP (and select Smarty functions.) This is useful if you have third parties editing templates, and you don't want to unleash the full power of PHP or Smarty to them.

    "},{"location":"features/#integration","title":"Integration","text":"

    Sometimes Smarty gets compared to Model-View-Controller (MVC) frameworks. Smarty is not an MVC, it is just the presentation layer, much like the View (V) part of an MVC. As a matter of fact, Smarty can easily be integrated as the view layer of an MVC. Many of the more popular ones have integration instructions for Smarty, or you may find some help here in the forums and documentation.

    "},{"location":"features/#other-template-engines","title":"Other Template Engines","text":"

    Smarty is not the only engine following the \"Separate Programming Code from Presentation\" philosophy. For instance, Python has template engines built around the same principles such as Django Templates and CheetahTemplate. Note: Languages such as Python do not mix with HTML natively, which give them the advantage of proper programming code separation from the outset. There are libraries available to mix Python with HTML, but they are typically avoided.

    "},{"location":"features/#what-smarty-is-not","title":"What Smarty is Not","text":"

    Smarty is not an application development framework. Smarty is not an MVC. Smarty is not an alternative to Laravel, Symfony, CodeIgniter, or any of the other application development frameworks for PHP.

    Smarty is a template engine, and works as the (V)iew component of your application. Smarty can easily be coupled to any of the engines listed above as the view component. No different than any other software, Smarty has a learning curve. Smarty does not guarantee good application design or proper separation of presentation, this still needs to be addressed by a competent developer and web designer.

    "},{"location":"features/#is-smarty-right-for-me","title":"Is Smarty Right for Me?","text":"

    Smarty is not meant to be a tool for every job. The important thing is to identify if Smarty fits your needs. There are some important questions to ask yourself:

    "},{"location":"features/#template-syntax","title":"Template Syntax","text":"

    Are you content with PHP tags mixed with HTML? Are your web designers comfortable with PHP? Would your web designers prefer a tag-based syntax designed for presentation? Some experience working with both Smarty and PHP helps answer these questions.

    "},{"location":"features/#the-business-case","title":"The Business Case","text":"

    Is there a requirement to insulate the templates from PHP? Do you have untrusted parties editing templates that you do not wish to unleash the power of PHP to? Do you need to programmatically control what is and is not available within the templates? Smarty supplies these capabilities by design.

    "},{"location":"features/#feature-set","title":"Feature set","text":"

    Does Smarty's features such as caching, template inheritance and plugin architecture save development cycles writing code that would be needed otherwise? Does the codebase or framework you plan on using have the features you need for the presentation component?

    "},{"location":"features/#sites-using-smarty","title":"Sites using Smarty","text":"

    Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, Tiki CMS/Groupware and X-Cart to name a few.

    "},{"location":"features/#summary","title":"Summary","text":"

    Whether you are using Smarty for a small website or massive enterprise solution, it can accommodate your needs. There are numerous features that make Smarty a great choice:

    "},{"location":"getting-started/","title":"Getting started","text":""},{"location":"getting-started/#requirements","title":"Requirements","text":"

    Smarty can be run with PHP 7.1 to PHP 8.3.

    "},{"location":"getting-started/#installation","title":"Installation","text":"

    Smarty can be installed with Composer.

    To get the latest stable version of Smarty use: 

    composer require smarty/smarty\n

    To get the latest, unreleased version, use: 

    composer require smarty/smarty:dev-master\n

    To get the previous stable version of Smarty, Smarty 3, use: 

    composer require smarty/smarty:^3\n

    Here's how you create an instance of Smarty in your PHP scripts: 

    <?php\n\nrequire 'vendor/autoload.php';\n$smarty = new Smarty();\n

    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 templates, configs, templates_c and cache relative to the current working directory.

    The defaults can be changed as follows: 

    $smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\n

    The compile dir and cache dir need to be writable for the user running the PHP script.

    Note

    This is usually user \"nobody\" and group \"nobody\". For OS X users, the default is user \"www\" and group \"www\". If you are using Apache, you can look in your httpd.conf file to see what user and group are being used.

    chown nobody:nobody /web/www.example.com/guestbook/templates_c/\nchmod 770 /web/www.example.com/guestbook/templates_c/\n\nchown nobody:nobody /web/www.example.com/guestbook/cache/\nchmod 770 /web/www.example.com/guestbook/cache/\n

    You can verify if your system has the correct access rights for these directories with testInstall():

    $smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\n$smarty->testInstall();\n

    Now, let's create the index.tpl file that Smarty will display. This needs to be located in the $template_dir.

    {* Smarty *}\nHello {$name}, welcome to Smarty!\n

    Note

    {* Smarty *} is a template comment. It is not required, but it is good practice to start all your template files with this comment. It makes the file easy to recognize regardless of the file extension. For example, text editors could recognize the file and turn on special syntax highlighting.

    Now lets edit our php file. We'll create an instance of Smarty, assign() a template variable and display() the index.tpl file.

    <?php\n\nrequire 'vendor/autoload.php';\n\n$smarty = new Smarty();\n\n$smarty->setTemplateDir('/web/www.example.com/guestbook/templates/');\n$smarty->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n$smarty->setConfigDir('/web/www.example.com/guestbook/configs/');\n$smarty->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\n

    Note

    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!\"

    You have completed the basic setup for Smarty!

    "},{"location":"getting-started/#extended-setup","title":"Extended Setup","text":"

    This is a continuation of the basic installation, please read that first!

    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.

    <?php\n\nclass Smarty_GuestBook extends Smarty {\n\n   public function __construct()\n   {\n        parent::__construct();\n\n        $this->setTemplateDir('/web/www.example.com/guestbook/templates/');\n        $this->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n        $this->setConfigDir('/web/www.example.com/guestbook/configs/');\n        $this->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n        $this->caching = Smarty::CACHING_LIFETIME_CURRENT;\n        $this->assign('app_name', 'Guest Book');\n   }\n\n}\n

    Now, we can use Smarty_GuestBook instead of Smarty in our scripts: 

    <?php\n$smarty = new Smarty_GuestBook();\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\n

    "},{"location":"philosophy/","title":"Philosophy","text":""},{"location":"philosophy/#what-is-smarty","title":"What is Smarty?","text":"

    Smarty is a template engine for PHP. More specifically, it facilitates a manageable way to separate application logic and content from its presentation. This is best described in a situation where the application programmer and the template designer play different roles, or in most cases are not the same person.

    For example, let\\'s say you are creating a web page that is displaying a newspaper article.

    "},{"location":"philosophy/#goals","title":"Goals","text":"

    The Smarty design was largely driven by these goals: - clean separation of presentation from application code - PHP backend, Smarty template frontend - complement PHP, not replace it - fast development/deployment for programmers and designers - quick and easy to maintain - syntax easy to understand, no PHP knowledge necessary - flexibility for custom development - security: insulation from PHP - free, open source

    "},{"location":"philosophy/#two-camps-of-thought","title":"Two camps of thought","text":"

    When it comes to templating in PHP, there are basically two camps of thought. The first camp exclaims that \\\"PHP is a template engine\\\". This approach simply mixes PHP code with HTML. Although this approach is fastest from a pure script-execution point of view, many would argue that the PHP syntax is messy and complicated when mixed with tagged markup such as HTML.

    The second camp exclaims that presentation should be void of all programming code, and instead use simple tags to indicate where application content is revealed. This approach is common with other template engines (even in other programming languages), and is also the approach that Smarty takes. The idea is to keep the templates focused squarely on presentation, void of application code, and with as little overhead as possible.

    "},{"location":"philosophy/#why-is-separating-php-from-templates-important","title":"Why is separating PHP from templates important?","text":"

    Two major benefits:

    "},{"location":"philosophy/#web-designers-and-php","title":"Web designers and PHP","text":"

    A common question: \"Web designers have to learn a syntax anyway, why not PHP?\" Of course web designers can learn PHP, and they may already be familiar with it. The issue isn't their ability to learn PHP, it is about the consequences of mixing PHP with HTML. If designers use PHP, it is too easy to add code into templates that doesn't belong there (you just handed them a swiss-army knife when they just needed a knife.) You can teach them the rules of application design, but this is probably something they don't really need to learn (now they are developers!) The PHP manual is also an overwhelming pile of information to sift through. It is like handing the owner of a car the factory assembly manual when all they need is the owners manual. Smarty gives web designers exactly the tools they need, and gives developers fine-grained control over those tools. The simplicity of the tag-based syntax is also a huge welcome for designers, it helps them streamline the organization and management of templates.

    "},{"location":"appendixes/tips/","title":"Tips & Tricks","text":""},{"location":"appendixes/tips/#blank-variable-handling","title":"Blank Variable Handling","text":"

    There may be times when you want to print a default value for an empty variable instead of printing nothing, such as printing &nbsp; so that html table backgrounds work properly. Many would use an {if} statement to handle this, but there is a shorthand way with Smarty, using the default variable modifier.

    Note

    \"Undefined variable\" errors will show an E_NOTICE if not disabled in PHP's error_reporting() level or Smarty's $error_reporting property and a variable had not been assigned to Smarty.

        {* the long way *}\n    {if $title eq ''}\n       &nbsp;\n    {else}\n       {$title}\n    {/if}\n\n    {* the short way *}\n    {$title|default:'&nbsp;'}\n

    See also default modifier and default variable handling.

    "},{"location":"appendixes/tips/#default-variable-handling","title":"Default Variable Handling","text":"

    If a variable is used frequently throughout your templates, applying the default modifier every time it is mentioned can get a bit ugly. You can remedy this by assigning the variable its default value with the {assign} function.

    {* do this somewhere at the top of your template *}\n{assign var='title' value=$title|default:'no title'}\n\n{* if $title was empty, it now contains the value \"no title\" when you use it *}\n{$title}\n

    See also default modifier and blank variable handling.

    "},{"location":"appendixes/tips/#passing-variable-title-to-header-template","title":"Passing variable title to header template","text":"

    When the majority of your templates use the same headers and footers, it is common to split those out into their own templates and {include} them. But what if the header needs to have a different title, depending on what page you are coming from? You can pass the title to the header as an attribute when it is included.

    mainpage.tpl - When the main page is drawn, the title of \"Main Page\" is passed to the header.tpl, and will subsequently be used as the title.

    {include file='header.tpl' title='Main Page'}\n{* template body goes here *}\n{include file='footer.tpl'}\n

    archives.tpl - When the archives page is drawn, the title will be \"Archives\". Notice in the archive example, we are using a variable from the archives_page.conf file instead of a hard coded variable.

    {config_load file='archive_page.conf'}\n\n{include file='header.tpl' title=#archivePageTitle#}\n{* template body goes here *}\n{include file='footer.tpl'}\n

    header.tpl - Notice that \"Smarty News\" is printed if the $title variable is not set, using the default variable modifier.

    <html>\n    <head>\n        <title>{$title|default:'Smarty News'}</title>\n    </head>\n<body>\n

    footer.tpl

        </body>\n</html>\n
    "},{"location":"appendixes/tips/#dates","title":"Dates","text":"

    As a rule of thumb, always pass dates to Smarty as timestamps. This allows template designers to use the date_format modifier for full control over date formatting, and also makes it easy to compare dates if necessary.

    {$startDate|date_format}\n

    This will output:

    Jan 4, 2009\n
    {$startDate|date_format:\"%Y/%m/%d\"}\n

    This will output:

    2009/01/04\n

    Dates can be compared in the template by timestamps with:

    {if $order_date < $invoice_date}\n   ...do something..\n{/if}\n

    When using {html_select_date} in a template, the programmer will most likely want to convert the output from the form back into timestamp format. Here is a function to help you with that.

    <?php\n\n// this assumes your form elements are named\n// startDate_Day, startDate_Month, startDate_Year\n\n$startDate = makeTimeStamp($startDate_Year, $startDate_Month, $startDate_Day);\n\nfunction makeTimeStamp($year='', $month='', $day='')\n{\n   if(empty($year)) {\n       $year = strftime('%Y');\n   }\n   if(empty($month)) {\n       $month = strftime('%m');\n   }\n   if(empty($day)) {\n       $day = strftime('%d');\n   }\n\n   return mktime(0, 0, 0, $month, $day, $year);\n}\n

    See also {html_select_date}, {html_select_time}, date_format and $smarty.now,

    "},{"location":"appendixes/tips/#componentized-templates","title":"Componentized Templates","text":"

    Traditionally, programming templates into your applications goes as follows: First, you accumulate your variables within your PHP application, (maybe with database queries.) Then, you instantiate your Smarty object, assign() the variables and display() the template. So lets say for example we have a stock ticker on our template. We would collect the stock data in our application, then assign these variables in the template and display it. Now wouldn't it be nice if you could add this stock ticker to any application by merely including the template, and not worry about fetching the data up front?

    You can do this by writing a custom plugin for fetching the content and assigning it to a template variable.

    function.load_ticker.php - drop file in $plugins directory

    <?php\n\n// setup our function for fetching stock data\nfunction fetch_ticker($symbol)\n{\n   // put logic here that fetches $ticker_info\n   // from some ticker resource\n   return $ticker_info;\n}\n\nfunction smarty_function_load_ticker($params, $smarty)\n{\n   // call the function\n   $ticker_info = fetch_ticker($params['symbol']);\n\n   // assign template variable\n   $smarty->assign($params['assign'], $ticker_info);\n}\n

    index.tpl

    {load_ticker symbol='SMARTY' assign='ticker'}\n\nStock Name: {$ticker.name} Stock Price: {$ticker.price}\n

    See also: {include}.

    "},{"location":"appendixes/tips/#obfuscating-e-mail-addresses","title":"Obfuscating E-mail Addresses","text":"

    Do you ever wonder how your email address gets on so many spam mailing lists? One way spammers collect email addresses is from web pages. To help combat this problem, you can make your email address show up in scrambled javascript in the HTML source, yet it it will look and work correctly in the browser. This is done with the {mailto} plugin.

    <div id=\"contact\">Send inquiries to\n{mailto address=$EmailAddress encode='javascript' subject='Hello'}\n</div>\n

    Note

    This method isn\\'t 100% foolproof. A spammer could conceivably program his e-mail collector to decode these values, but not likely.... hopefully..yet ... wheres that quantum computer :-?.

    See also escape modifier and {mailto}.

    "},{"location":"appendixes/troubleshooting/","title":"Troubleshooting","text":""},{"location":"appendixes/troubleshooting/#smartyphp-errors","title":"Smarty/PHP errors","text":"

    Smarty can catch many errors such as missing tag attributes or malformed variable names. If this happens, you will see an error similar to the following:

    Warning: Smarty: [in index.tpl line 4]: syntax error: unknown tag - '%blah'\n       in /path/to/smarty/Smarty.class.php on line 1041\n\nFatal error: Smarty: [in index.tpl line 28]: syntax error: missing section name\n       in /path/to/smarty/Smarty.class.php on line 1041\n

    Smarty shows you the template name, the line number and the error. After that, the error consists of the actual line number in the Smarty class that the error occurred.

    There are certain errors that Smarty cannot catch, such as missing close tags. These types of errors usually end up in PHP compile-time parsing errors.

    Parse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75

    When you encounter a PHP parsing error, the error line number will correspond to the compiled PHP script, NOT the template itself. Usually you can look at the template and spot the syntax error. Here are some common things to look for: missing close tags for {if}{/if} or {section}{/section}, or syntax of logic within an {if} tag. If you can\\'t find the error, you might have to open the compiled PHP file and go to the line number to figure out where the corresponding error is in the template.

    Warning: Smarty error: unable to read resource: \"index.tpl\" in...\n
    or 
    Warning: Smarty error: unable to read resource: \"site.conf\" in...\n

    Fatal error: Smarty error: the $compile_dir 'templates_c' does not exist,\nor is not a directory...\n
    Fatal error: Smarty error: unable to write to $compile_dir '....\n
    Fatal error: Smarty error: the $cache_dir 'cache' does not exist,\nor is not a directory. in /..\n
    Fatal error: Smarty error: unable to write to $cache_dir '/...\n
    Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php \nin /path/to/smarty/libs/sysplugins/smarty_resource.php\n

    See also debugging.

    "},{"location":"designers/chapter-debugging-console/","title":"Debugging Console","text":"

    There is a debugging console included with Smarty. The console informs you of all the included templates, assigned variables and config file variables for the current invocation of the template. A template file named debug.tpl is included with the distribution of Smarty which controls the formatting of the console.

    Set $debugging to TRUE in Smarty, and if needed set $debug_tpl to the template resource path to debug.tpl (this is in SMARTY_DIR by default). When you load the page, a Javascript console window will pop up and give you the names of all the included templates and assigned variables for the current page.

    To see the available variables for a particular template, see the {debug} template function. To disable the debugging console, set $debugging to FALSE. You can also temporarily turn on the debugging console by putting SMARTY_DEBUG in the URL if you enable this option with $debugging_ctrl.

    Note

    The debugging console does not work when you use the fetch() API, only when using display(). It is a set of javascript statements added to the very bottom of the generated template. If you do not like javascript, you can edit the debug.tpl template to format the output however you like. Debug data is not cached and debug.tpl info is not included in the output of the debug console.

    Note

    The load times of each template and config file are in seconds, or fractions thereof.

    See also troubleshooting.

    "},{"location":"designers/config-files/","title":"Config Files","text":"

    Config files are handy for designers to manage global template variables from one file. One example is template colors. Normally if you wanted to change the color scheme of an application, you would have to go through each and every template file and change the colors. With a config file, the colors can be kept in one place, and only one file needs to be updated.

    # global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n[Customer]\npageTitle = \"Customer Info\"\n\n[Login]\npageTitle = \"Login\"\nfocus = \"username\"\nIntro = \"\"\"This is a value that spans more\n           than one line. you must enclose\n           it in triple quotes.\"\"\"\n\n# hidden section\n[.Database]\nhost=my.example.com\ndb=ADDRESSBOOK\nuser=php-user\npass=foobar\n

    Values of config file variables can be in quotes, but not necessary. You can use either single or double quotes. If you have a value that spans more than one line, enclose the entire value with triple quotes (\"\"\"). You can put comments into config files by any syntax that is not a valid config file syntax. We recommend using a # (hash) at the beginning of the line.

    The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing [ or ] symbols. The four variables at the top are global variables, or variables not within a section. These variables are always loaded from the config file. If a particular section is loaded, then the global variables and the variables from that section are also loaded. If a variable exists both as a global and in a section, the section variable is used. If you name two variables the same within a section, the last one will be used unless $config_overwrite is disabled.

    Config files are loaded into templates with the built-in template function {config_load} or the API configLoad() function.

    You can hide variables or entire sections by prepending the variable name or section name with a period(.) eg [.hidden]. This is useful if your application reads the config files and gets sensitive data from them that the template engine does not need. If you have third parties doing template editing, you can be certain that they cannot read sensitive data from the config file by loading it into the template.

    Config files (or resources) are loaded by the same resource facilities as templates. That means that a config file can also be loaded from a db $smarty->configLoad(\"db:my.conf\").

    See also {config_load}, $config_overwrite, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()

    "},{"location":"designers/language-combining-modifiers/","title":"Combining Modifiers","text":"

    You can apply any number of modifiers to a variable. They will be applied in the order they are combined, from left to right. They must be separated with a | (pipe) character.

    <?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\n

    where template is:

    {$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\n

    The above example will output:

    Smokers are Productive, but Death Cuts Efficiency.\nS M O K E R S   A R ....snip....  H   C U T S   E F F I C I E N C Y .\ns m o k e r s   a r ....snip....  b u t   d e a t h   c u t s...\ns m o k e r s   a r e   p r o d u c t i v e ,   b u t . . .\ns m o k e r s   a r e   p. . .\n
    "},{"location":"designers/language-basic-syntax/","title":"Basic Syntax","text":"

    A simple Smarty template could look like this: 

    <h1>{$title|escape}</h1>\n<ul>\n    {foreach $cities as $city}\n        <li>{$city.name|escape} ({$city.population})</li>\n    {foreachelse}\n        <li>no cities found</li>        \n    {/foreach}\n</ul>\n

    All Smarty template tags are enclosed within delimiters. By default these are { and }, but they can be changed.

    For the examples in this manual, we will assume that you are using the default delimiters. In Smarty, all content outside of delimiters is displayed as static content, or unchanged. When Smarty encounters template tags, it attempts to interpret them, and displays the appropriate output in their place.

    The basis components of the Smarty syntax are:

    "},{"location":"designers/language-basic-syntax/language-escaping/","title":"Escaping Smarty parsing","text":"

    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 for Smarty.

    Note

    A good practice for avoiding escapement altogether is by separating your Javascript/CSS into their own files and use standard HTML methods to access them. This will also take advantage of browser script caching. When you need to embed Smarty variables/functions into your Javascript/CSS, then the following applies.

    In Smarty templates, the { and } braces will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting the Smarty class variable $auto_literal to false.

    "},{"location":"designers/language-basic-syntax/language-escaping/#examples","title":"Examples","text":"
    <script>\n   // the following braces are ignored by Smarty\n   // since they are surrounded by whitespace\n   function foobar {\n    alert('foobar!');\n   }\n   // this one will need literal escapement\n   {literal}\n    function bazzy {alert('foobar!');}\n   {/literal}\n</script>\n

    {literal}..{/literal} blocks are used for escaping blocks of template logic. You can also escape the braces individually with {ldelim}, {rdelim} tags or {$smarty.ldelim},{$smarty.rdelim} 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 and $right_delimiter values.

    Note

    Changing delimiters affects ALL template syntax and escapement. Be sure to clear out cache and compiled files if you decide to change them.

    <?php\n\n$smarty->left_delimiter = '<!--{';\n$smarty->right_delimiter = '}-->';\n\n$smarty->assign('foo', 'bar');\n$smarty->assign('name', 'Albert');\n$smarty->display('example.tpl');\n

    Where the template is:

    Welcome <!--{$name}--> to Smarty\n<script language=\"javascript\">\n  var foo = <!--{$foo}-->;\n  function dosomething() {\n    alert(\"foo is \" + foo);\n  }\n  dosomething();\n</script>\n
    "},{"location":"designers/language-basic-syntax/language-math/","title":"Math","text":"

    Math can be applied directly to variable values.

    "},{"location":"designers/language-basic-syntax/language-math/#examples","title":"Examples","text":"
    {$foo+1}\n\n{$foo*$bar}\n\n{* some more complicated examples *}\n\n{$foo->bar-$bar[1]*$baz->foo->bar()-3*7}\n\n{if ($foo+$bar.test%$baz*134232+10+$b+10)}\n\n{$foo|truncate:\"`$fooTruncCount/$barTruncFactor-1`\"}\n\n{assign var=\"foo\" value=\"`$foo+$bar`\"}\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    "},{"location":"designers/language-basic-syntax/language-syntax-attributes/","title":"Attributes","text":"

    Most of the functions take attributes that specify or modify their behavior. Attributes to Smarty functions are much like HTML attributes. Static values don't have to be enclosed in quotes, but it is required for literal strings. Variables with or without modifiers may also be used, and should not be in quotes. You can even use PHP function results, plugin results and complex expressions.

    Some attributes require boolean values (TRUE or FALSE). These can be specified as true and false. If an attribute has no value assigned it gets the default boolean value of true.

    "},{"location":"designers/language-basic-syntax/language-syntax-attributes/#examples","title":"Examples","text":"
    {include file=\"header.tpl\"}\n\n{include file=\"header.tpl\" nocache}  // is equivalent to nocache=true\n\n{include file=\"header.tpl\" attrib_name=\"attrib value\"}\n\n{include file=$includeFile}\n\n{include file=#includeFile# title=\"My Title\"}\n\n{assign var=foo value={counter}}  // plugin result\n\n{assign var=foo value=substr($bar,2,5)}  // PHP function result\n\n{assign var=foo value=$bar|strlen}  // using modifier\n\n{assign var=foo value=$buh+$bar|strlen}  // more complex expression\n\n{html_select_date display_days=true}\n\n{mailto address=\"smarty@example.com\"}\n\n<select name=\"company_id\">\n  {html_options options=$companies selected=$company_id}\n</select>\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    "},{"location":"designers/language-basic-syntax/language-syntax-comments/","title":"Comments","text":"

    Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so:

    "},{"location":"designers/language-basic-syntax/language-syntax-comments/#examples","title":"Examples","text":"
    {* this is a comment *}\n

    Smarty comments are NOT displayed in the final output of the template, unlike <!-- HTML comments -->. These are useful for making internal notes in the templates which no one will see ;-)

    {* I am a Smarty comment, I don't exist in the compiled output  *}\n<html>\n    <head>\n     <title>{$title}</title>\n    </head>\n<body>\n\n    {* another single line smarty comment  *}\n    <!-- HTML comment that is sent to the browser -->\n\n    {* this multiline smarty\n       comment is\n       not sent to browser\n    *}\n\n    {*********************************************************\n    Multi line comment block with credits block\n      @ author:         bg@example.com\n      @ maintainer:     support@example.com\n      @ para:           var that sets block style\n      @ css:            the style output\n    **********************************************************}\n\n    {* The header file with the main logo and stuff  *}\n    {include file='header.tpl'}\n\n\n    {* Dev note:  the $includeFile var is assigned in foo.php script  *}\n    <!-- Displays main content block -->\n    {include file=$includeFile}\n\n    {* this <select> block is redundant *}\n    {*\n    <select name=\"company\">\n      {html_options options=$vals selected=$selected_id}\n    </select>\n    *}\n\n    <!-- Show header from affiliate is disabled -->\n    {* $affiliate|upper *}\n\n    {* you cannot nest comments *}\n    {*\n    <select name=\"company\">\n      {* <option value=\"0\">-- none -- </option> *}\n      {html_options options=$vals selected=$selected_id}\n    </select>\n    *}\n\n    </body>\n</html>\n
    "},{"location":"designers/language-basic-syntax/language-syntax-functions/","title":"Functions","text":"

    Every Smarty tag either prints a variable or invokes some sort of function. These are processed and displayed by enclosing the function and its attributes within delimiters like so: {funcname attr1=\"val1\" attr2=\"val2\"}.

    "},{"location":"designers/language-basic-syntax/language-syntax-functions/#examples","title":"Examples","text":"
    {config_load file=\"colors.conf\"}\n\n{include file=\"header.tpl\"}\n{insert file=\"banner_ads.tpl\" title=\"My Site\"}\n\n{if $logged_in}\n    Welcome, <span style=\"color:{#fontColor#}\">{$name}!</span>\n{else}\n    hi, {$name}\n{/if}\n\n{include file=\"footer.tpl\"}\n

    See also registerPlugin()

    "},{"location":"designers/language-basic-syntax/language-syntax-quotes/","title":"Embedding Vars in Double Quotes","text":""},{"location":"designers/language-basic-syntax/language-syntax-quotes/#examples","title":"Examples","text":"
    {func var=\"test $foo test\"}              // sees $foo\n{func var=\"test $foo_bar test\"}          // sees $foo_bar\n{func var=\"test `$foo[0]` test\"}         // sees $foo[0]\n{func var=\"test `$foo[bar]` test\"}       // sees $foo[bar]\n{func var=\"test $foo.bar test\"}          // sees $foo (not $foo.bar)\n{func var=\"test `$foo.bar` test\"}        // sees $foo.bar\n{func var=\"test `$foo.bar` test\"|escape} // modifiers outside quotes!\n{func var=\"test {$foo|escape} test\"}     // modifiers inside quotes!\n{func var=\"test {time()} test\"}          // PHP function result\n{func var=\"test {counter} test\"}         // plugin result\n{func var=\"variable foo is {if !$foo}not {/if} defined\"} // Smarty block function\n\n{* will replace $tpl_name with value *}\n{include file=\"subdir/$tpl_name.tpl\"}\n\n{* does NOT replace $tpl_name *}\n{include file='subdir/$tpl_name.tpl'} // vars require double quotes!\n\n{* must have backticks as it contains a dot \".\" *}\n{cycle values=\"one,two,`$smarty.config.myval`\"}\n\n{* must have backticks as it contains a dot \".\" *}\n{include file=\"`$module.contact`.tpl\"}\n\n{* can use variable with dot syntax *}\n{include file=\"`$module.$view`.tpl\"}\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    See also escape.

    "},{"location":"designers/language-basic-syntax/language-syntax-variables/","title":"Variables","text":"

    Template variables start with the $dollar sign. They can contain numbers, letters and underscores, much like a PHP variable. You can reference arrays by index numerically or non-numerically. Also reference object properties and methods.

    Config file variables are an exception to the \\$dollar syntax and are instead referenced with surrounding #hashmarks#, or via the $smarty.config variable.

    "},{"location":"designers/language-basic-syntax/language-syntax-variables/#examples","title":"Examples","text":"
    {$foo}        <-- displaying a simple variable (non array/object)\n{$foo[4]}     <-- display the 5th element of a zero-indexed array\n{$foo.bar}    <-- display the \"bar\" key value of an array, similar to PHP $foo['bar']\n{$foo.$bar}   <-- display variable key value of an array, similar to PHP $foo[$bar]\n{$foo->bar}   <-- display the object property \"bar\"\n{$foo->bar()} <-- display the return value of object method \"bar\"\n{#foo#}       <-- display the config file variable \"foo\"\n{$smarty.config.foo} <-- synonym for {#foo#}\n{$foo[bar]}   <-- syntax only valid in a section loop, see {section}\n{assign var=foo value='baa'}{$foo} <--  displays \"baa\", see {assign}\n\nMany other combinations are allowed\n\n{$foo.bar.baz}\n{$foo.$bar.$baz}\n{$foo[4].baz}\n{$foo[4].$baz}\n{$foo.bar.baz[4]}\n{$foo->bar($baz,2,$bar)} <-- passing parameters\n{\"foo\"}       <-- static values are allowed\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\nMath and embedding tags:\n\n{$x+$y}                             // will output the sum of x and y.\n{assign var=foo value=$x+$y}        // in attributes \n{$foo[$x+3]}                        // as array index\n{$foo={counter}+3}                  // tags within tags\n{$foo=\"this is message {counter}\"}  // tags within double quoted strings\n\nDefining Arrays:\n\n{assign var=foo value=[1,2,3]}\n{assign var=foo value=['y'=>'yellow','b'=>'blue']}\n{assign var=foo value=[1,[9,8],3]}   // can be nested\n\nShort variable assignment:\n\n{$foo=$bar+2}\n{$foo = strlen($bar)}               // function in assignment\n{$foo = myfunct( ($x+$y)*3 )}       // as function parameter \n{$foo.bar=1}                        // assign to specific array element\n{$foo.bar.baz=1}                    \n{$foo[]=1}                          // appending to an array\n\nSmarty \"dot\" syntax (note: embedded {} are used to address ambiguities):\n\n{$foo.a.b.c}        =>  $foo['a']['b']['c'] \n{$foo.a.$b.c}       =>  $foo['a'][$b]['c']         // with variable index\n{$foo.a.{$b+4}.c}   =>  $foo['a'][$b+4]['c']       // with expression as index\n{$foo.a.{$b.c}}     =>  $foo['a'][$b['c']]         // with nested index\n\nPHP-like syntax, alternative to \"dot\" syntax:\n\n{$foo[1]}             // normal access\n{$foo['bar']}\n{$foo['bar'][1]}\n{$foo[$x+$x]}         // index may contain any expression\n{$foo[$bar[1]]}       // nested index\n{$foo[section_name]}  // smarty {section} access, not array access!\n\nVariable variables:\n\n$foo                     // normal variable\n$foo_{$bar}              // variable name containing other variable \n$foo_{$x+$y}             // variable name containing expressions \n$foo_{$bar}_buh_{$blar}  // variable name with multiple segments\n{$foo_{$x}}              // will output the variable $foo_1 if $x has a value of 1.\n\nObject chaining:\n\n{$object->method1($x)->method2($y)}\n\nDirect PHP function access:\n\n{time()}\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    Request variables such as $_GET, $_SESSION, etc are available via the reserved $smarty variable.

    See also $smarty, config variables {assign} and assign().

    "},{"location":"designers/language-builtin-functions/","title":"Built-in Functions","text":"

    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 with the same name; and you should not need to modify the built-in functions.

    A few of these functions have an assign attribute which collects the result the function to a named template variable instead of being output; much like the {assign} function.

    "},{"location":"designers/language-builtin-functions/language-function-append/","title":"{append}","text":"

    {append} is used for creating or appending template variable arrays during the execution of a template.

    "},{"location":"designers/language-builtin-functions/language-function-append/#attributes","title":"Attributes","text":"Attribute Required Description var The name of the variable being assigned value The value being assigned index (optional) The index for the new array element. If not specified the value is append to the end of the array. scope (optional) The scope of the assigned variable: parent, root or global. Defaults to local if omitted."},{"location":"designers/language-builtin-functions/language-function-append/#option-flags","title":"Option Flags","text":"Name Description nocache Assigns the variable with the 'nocache' attribute

    Note

    Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.

    "},{"location":"designers/language-builtin-functions/language-function-append/#examples","title":"Examples","text":"
    {append var='name' value='Bob' index='first'}\n{append var='name' value='Meyer' index='last'}\n// or \n{append 'name' 'Bob' index='first'} {* short-hand *}\n{append 'name' 'Meyer' index='last'} {* short-hand *}\n\nThe first name is {$name.first}.<br>\nThe last name is {$name.last}.\n

    The above example will output:

    The first name is Bob.\nThe last name is Meyer.\n

    See also append() and getTemplateVars().

    "},{"location":"designers/language-builtin-functions/language-function-assign/","title":"{assign}, {$var=...}","text":"

    {assign} or {$var=...} is used for assigning template variables during the execution of a template.

    "},{"location":"designers/language-builtin-functions/language-function-assign/#attributes-of-the-assign-syntax","title":"Attributes of the {assign} syntax","text":"Attribute Name Required Description var The name of the variable being assigned value The value being assigned scope (optional) The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'"},{"location":"designers/language-builtin-functions/language-function-assign/#attributes-of-the-var-syntax","title":"Attributes of the {$var=...} syntax","text":"Attribute Name Required Description scope (optional) The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'"},{"location":"designers/language-builtin-functions/language-function-assign/#option-flags","title":"Option Flags","text":"Name Description nocache Assigns the variable with the 'nocache' attribute

    Note

    Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.

    "},{"location":"designers/language-builtin-functions/language-function-assign/#examples","title":"Examples","text":"
    {assign var=\"name\" value=\"Bob\"}  {* or *}\n{assign \"name\" \"Bob\"} {* short-hand, or *}\n{$name='Bob'}\n\nThe value of $name is {$name}.\n

    The above example will output:

    The value of $name is Bob.\n

    {assign var=\"name\" value=\"Bob\" nocache}  {* or *}\n{assign \"name\" \"Bob\" nocache} {* short-hand, or *}\n{$name='Bob' nocache}\n\nThe value of $name is {$name}.\n
    The above example will output: 
    The value of $name is Bob.\n

    {assign var=running_total value=$running_total+$some_array[$row].some_value}  {* or *}\n{$running_total=$running_total+$some_array[row].some_value}\n

    Variables assigned in the included template will be seen in the including template.

    {include file=\"sub_template.tpl\"}\n\n{* display variable assigned in sub_template *}\n{$foo}<br>\n

    The template above includes the example sub_template.tpl below:

    {* foo will be known also in the including template *}\n{assign var=\"foo\" value=\"something\" scope=parent}\n{$foo=\"something\" scope=parent}\n\n{* bar is assigned only local in the including template *}\n{assign var=\"bar\" value=\"value\"} {* or *}\n{$var=\"value\"}\n

    You can assign a variable to root of the current root tree. The variable is seen by all templates using the same root tree.

    {assign var=foo value=\"bar\" scope=\"root\"}\n

    A global variable is seen by all templates.

    {assign var=foo value=\"bar\" scope=\"global\"} {* or *}\n{assign \"foo\" \"bar\" scope=\"global\"} {* short-hand, or *}\n{$foo=\"bar\" scope=\"global\"}\n

    To access {assign} variables from a php script use getTemplateVars(). Here's the template that creates the variable $foo.

    {assign var=\"foo\" value=\"Smarty\"} {* or *}\n{$foo=\"Smarty\"}\n

    The template variables are only available after/during template execution as in the following script.

    <?php\n\n// this will output nothing as the template has not been executed\necho $smarty->getTemplateVars('foo');\n\n// fetch the template to a variable\n$whole_page = $smarty->fetch('index.tpl');\n\n// this will output 'smarty' as the template has been executed\necho $smarty->getTemplateVars('foo');\n\n$smarty->assign('foo','Even smarter');\n\n// this will output 'Even smarter'\necho $smarty->getTemplateVars('foo');\n

    The following functions can also optionally assign template variables: {capture}, {include}, {insert}, {counter}, {cycle}, {eval}, {fetch}, {math} and {textformat}.

    See also {append}, assign() and getTemplateVars().

    "},{"location":"designers/language-builtin-functions/language-function-block/","title":"{block}","text":"

    {block} is used to define a named area of template source for template inheritance. For details see section of Template Inheritance.

    The {block} template source area of a child template will replace the corresponding areas in the parent template(s).

    Optionally {block} areas of child and parent templates can be merged into each other. You can append or prepend the parent {block} content by using the append or prepend option flag with the child's {block} definition. With {$smarty.block.parent} the {block} content of the parent template can be inserted at any location of the child {block} content. {$smarty.block.child} inserts the {block} content of the child template at any location of the parent {block}.

    {blocks}'s can be nested.

    "},{"location":"designers/language-builtin-functions/language-function-block/#attributes","title":"Attributes","text":"Attribute Name Required Description name yes The name of the template source block assign no The name of variable to assign the output of the block to.

    Note

    The assign attribute only works on the block that actually gets executed, so you may need to add it to each child block as well.

    "},{"location":"designers/language-builtin-functions/language-function-block/#option-flags-in-child-templates-only","title":"Option Flags (in child templates only):","text":"Name Description append The {block} content will be appended to the content of the parent template {block} prepend The {block} content will be prepended to the content of the parent template {block} hide Ignore the block content if no child block of same name is existing. nocache Disables caching of the {block} content"},{"location":"designers/language-builtin-functions/language-function-block/#examples","title":"Examples","text":"

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}Default Title{/block}</title>\n        <title>{block \"title\"}Default Title{/block}</title>  {* short-hand  *}\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\"}\n    Page Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>Page Title</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}Title - {/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\" append}\n        Page Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>Title - Page Title</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"} is my title{/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\" prepend}\n    Page Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>Page title is my titel</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}The {$smarty.block.child} was inserted here{/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\"}\n        Child Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>The Child Title was inserted here</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}Parent Title{/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\"}\n        You will see now - {$smarty.block.parent} - here\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>You will see now - Parent Title - here</title>\n      </head>\n    </html>\n

    See also Template Inheritance, $smarty.block.parent, $smarty.block.child, and {extends}

    "},{"location":"designers/language-builtin-functions/language-function-call/","title":"{call}","text":"

    {call} is used to call a template function defined by the {function} tag just like a plugin function.

    Note

    Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise you can directly use the function as {funcname ...} in the template.

    "},{"location":"designers/language-builtin-functions/language-function-call/#attributes","title":"Attributes","text":"Attribute Name Required Description name Yes The name of the template function assign No The name of the variable that the output of called template function will be assigned to [var ...] No variable to pass local to template function"},{"location":"designers/language-builtin-functions/language-function-call/#option-flags","title":"Option Flags","text":"Name Description nocache Call the template function in nocache mode"},{"location":"designers/language-builtin-functions/language-function-call/#examples","title":"Examples","text":"
        {* define the function *}\n    {function name=menu level=0}\n      <ul class=\"level{$level}\">\n      {foreach $data as $entry}\n        {if is_array($entry)}\n          <li>{$entry@key}</li>\n          {call name=menu data=$entry level=$level+1}\n        {else}\n          <li>{$entry}</li>\n        {/if}\n      {/foreach}\n      </ul>\n    {/function}\n\n    {* create an array to demonstrate *}\n    {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n    ['item3-3-1','item3-3-2']],'item4']}\n\n    {* run the array through the function *}\n    {call name=menu data=$menu}\n    {call menu data=$menu} {* short-hand *}\n

    Will generate the following output

        * item1\n    * item2\n    * item3\n          o item3-1\n          o item3-2\n          o item3-3\n                + item3-3-1\n                + item3-3-2\n    * item4\n

    See also {function}.

    "},{"location":"designers/language-builtin-functions/language-function-capture/","title":"{capture}","text":"

    {capture} is used to collect the output of the template between the tags into a variable instead of displaying it. Any content between {capture name='foo'} and {/capture} is collected into the variable specified in the name attribute.

    The captured content can be used in the template from the variable $smarty.capture.foo where \"foo\" is the value passed in the name attribute. If you do not supply the name attribute, then \"default\" will be used as the name ie $smarty.capture.default.

    {capture}'s can be nested.

    "},{"location":"designers/language-builtin-functions/language-function-capture/#attributes","title":"Attributes","text":"Attribute Name Required Description name Yes The name of the captured block assign No The variable name where to assign the captured output to append No The name of an array variable where to append the captured output to"},{"location":"designers/language-builtin-functions/language-function-capture/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of this captured block

    Note

    Be careful when capturing {insert} output. If you have $caching enabled and you have {insert} commands that you expect to run within cached content, do not capture this content.

    "},{"location":"designers/language-builtin-functions/language-function-capture/#examples","title":"Examples","text":"
    {* we don't want to print a div tag unless content is displayed *}\n{capture name=\"banner\"}\n{capture \"banner\"} {* short-hand *}\n  {include file=\"get_banner.tpl\"}\n{/capture}\n\n{if $smarty.capture.banner ne \"\"}\n<div id=\"banner\">{$smarty.capture.banner}</div>\n{/if}\n

    This example demonstrates the capture function. 

    {capture name=some_content assign=popText}\n{capture some_content assign=popText} {* short-hand *}\nThe server is {$my_server_name|upper} at {$my_server_addr}<br>\nYour ip is {$my_ip}.\n{/capture}\n<a href=\"#\">{$popText}</a>\n

    This example also demonstrates how multiple calls of capture can be used to create an array with captured content.

    {capture append=\"foo\"}hello{/capture}I say just {capture append=\"foo\"}world{/capture}\n{foreach $foo as $text}{$text} {/foreach}\n

    The above example will output:

    I say just hello world\n

    See also $smarty.capture, {eval}, {fetch}, fetch() and {assign}.

    "},{"location":"designers/language-builtin-functions/language-function-config-load/","title":"{config_load}","text":"

    {config_load} is used for loading config #variables# from a configuration file into the template.

    "},{"location":"designers/language-builtin-functions/language-function-config-load/#attributes","title":"Attributes","text":"Attribute Name Required Description file Yes The name of the config file to include 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."},{"location":"designers/language-builtin-functions/language-function-config-load/#examples","title":"Examples","text":"

    The example.conf file.

    #this is config file comment\n\n# global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n#customer variables section\n[Customer]\npageTitle = \"Customer Info\"\n

    and the template

    {config_load file=\"example.conf\"}\n{config_load \"example.conf\"}  {* short-hand *}\n\n<html>\n    <title>{#pageTitle#|default:\"No title\"}</title>\n    <body bgcolor=\"{#bodyBgColor#}\">\n        <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n           <tr bgcolor=\"{#rowBgColor#}\">\n              <td>First</td>\n              <td>Last</td>\n              <td>Address</td>\n           </tr>\n        </table>\n    </body>\n</html>\n

    Config Files may also contain sections. You can load variables from within a section with the added attribute section. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.

    Note

    Config file sections and the built-in template function called {section} have nothing to do with each other, they just happen to share a common naming convention.

    {config_load file='example.conf' section='Customer'}\n{config_load 'example.conf' 'Customer'} {* short-hand *}\n\n<html>\n    <title>{#pageTitle#}</title>\n    <body bgcolor=\"{#bodyBgColor#}\">\n        <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n           <tr bgcolor=\"{#rowBgColor#}\">\n              <td>First</td>\n              <td>Last</td>\n              <td>Address</td>\n           </tr>\n        </table>\n    </body>\n</html>\n

    See $config_overwrite to create arrays of config file variables.

    See also the config files page, config variables page, $config_dir, getConfigVars() and configLoad().

    "},{"location":"designers/language-builtin-functions/language-function-debug/","title":"{debug}","text":"

    {debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned variables; not the templates that are in use. However, you can see all the currently available variables within the scope of a template.

    If caching is enabled and a page is loaded from cache {debug} does show only the variables which assigned for the cached page.

    In order to see also the variables which have been locally assigned within the template it does make sense to place the {debug} tag at the end of the template.

    See also the debugging console page.

    "},{"location":"designers/language-builtin-functions/language-function-extends/","title":"{extends}","text":"

    {extends} tags are used in child templates in template inheritance for extending parent templates. For details see section of Template Inheritance.

    "},{"location":"designers/language-builtin-functions/language-function-extends/#attributes","title":"Attributes","text":"Attribute Required Description file Yes The name of the template file which is extended

    Note

    When extending a variable parent like {extends file=$parent_file}, make sure you include $parent_file in the $compile_id. Otherwise, Smarty cannot distinguish between different $parent_files.

    "},{"location":"designers/language-builtin-functions/language-function-extends/#examples","title":"Examples","text":"
    {extends file='parent.tpl'}\n{extends 'parent.tpl'}  {* short-hand *}\n

    See also Template Inheritance and {block}.

    "},{"location":"designers/language-builtin-functions/language-function-for/","title":"{for}","text":"

    The {for}{forelse} tag is used to create simple loops. The following different formats are supported:

    {forelse} is executed when the loop is not iterated.

    "},{"location":"designers/language-builtin-functions/language-function-for/#attributes","title":"Attributes","text":"Attribute Required Description max No Limit the number of iterations"},{"location":"designers/language-builtin-functions/language-function-for/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of the {for} loop"},{"location":"designers/language-builtin-functions/language-function-for/#examples","title":"Examples","text":"
    <ul>\n    {for $foo=1 to 3}\n        <li>{$foo}</li>\n    {/for}\n</ul>\n

    The above example will output:

    <ul>\n    <li>1</li>\n    <li>2</li>\n    <li>3</li>\n</ul>\n
    <?php\n$smarty->assign('to',10);\n
    <ul>\n    {for $foo=3 to $to max=3}\n        <li>{$foo}</li>\n    {/for}\n</ul>\n

    The above example will output:

    <ul>\n    <li>3</li>\n    <li>4</li>\n    <li>5</li>\n</ul>\n
    <?php\n$smarty->assign('start',10);\n$smarty->assign('to',5);\n
    <ul>\n    {for $foo=$start to $to}\n        <li>{$foo}</li>\n    {forelse}\n      no iteration\n    {/for}\n</ul>\n

    The above example will output:

       no iteration\n

    See also {foreach}, {section} and {while}

    "},{"location":"designers/language-builtin-functions/language-function-foreach/","title":"{foreach},{foreachelse}","text":"

    {foreach} is used for looping over arrays of data. {foreach} has a simpler and cleaner syntax than the {section} loop, and can also loop over associative arrays.

    "},{"location":"designers/language-builtin-functions/language-function-foreach/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of the {foreach} loop"},{"location":"designers/language-builtin-functions/language-function-foreach/#examples","title":"Examples","text":"
    {foreach $arrayvar as $itemvar}\n  {$itemvar|escape}\n{/foreach}\n\n{foreach $arrayvar as $keyvar=>$itemvar}\n  {$keyvar}: {$itemvar|escape}\n{/foreach}\n

    Note

    This foreach syntax does not accept any named attributes. This syntax is new to Smarty 3, however the Smarty 2.x syntax {foreach from=$myarray key=\"mykey\" item=\"myitem\"} is still supported.

    Note

    The $var@property syntax is new to Smarty 3, however when using the Smarty 2 {foreach from=$myarray key=\"mykey\" item=\"myitem\"} style syntax, the $smarty.foreach.name.property syntax is still supported.

    Note

    Although you can retrieve the array key with the syntax {foreach $myArray as $myKey => $myValue}, the key is always available as $myValue@key within the foreach loop.

    <?php\n$arr = array('red', 'green', 'blue');\n$smarty->assign('myColors', $arr);\n

    Template to output $myColors in an un-ordered list

    <ul>\n    {foreach $myColors as $color}\n        <li>{$color}</li>\n    {/foreach}\n</ul>\n

    The above example will output:

    <ul>\n    <li>red</li>\n    <li>green</li>\n    <li>blue</li>\n</ul>\n
    <?php\n$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');\n$smarty->assign('myPeople', $people);\n

    Template to output $myArray as key/value pairs.

    <ul>\n    {foreach $myPeople as $value}\n       <li>{$value@key}: {$value}</li>\n    {/foreach}\n</ul>\n

    The above example will output:

    <ul>\n    <li>fname: John</li>\n    <li>lname: Doe</li>\n    <li>email: j.doe@example.com</li>\n</ul>\n

    Assign an array to Smarty, the key contains the key for each looped value.

    <?php\n $smarty->assign(\n    'contacts', \n    [\n         ['phone' => '555-555-1234', 'fax' => '555-555-5678', 'cell' => '555-555-0357'],\n         ['phone' => '800-555-4444', 'fax' => '800-555-3333', 'cell' => '800-555-2222'],\n     ]\n );\n

    The template to output $contact.

    {* key always available as a property *}\n{foreach $contacts as $contact}\n  {foreach $contact as $value}\n    {$value@key}: {$value}\n  {/foreach}\n{/foreach}\n\n{* accessing key the PHP syntax alternate *}\n{foreach $contacts as $contact}\n  {foreach $contact as $key => $value}\n    {$key}: {$value}\n  {/foreach}\n{/foreach}\n

    Either of the above examples will output:

      phone: 555-555-1234\n  fax: 555-555-5678\n  cell: 555-555-0357\n  phone: 800-555-4444\n  fax: 800-555-3333\n  cell: 800-555-2222\n

    A database (PDO) example of looping over search results. This example is looping over a PHP iterator instead of an array().

    <?php \n  include('Smarty.class.php'); \n\n  $smarty = new Smarty; \n\n  $dsn = 'mysql:host=localhost;dbname=test'; \n  $login = 'test'; \n  $passwd = 'test'; \n\n  // setting PDO to use buffered queries in mysql is \n  // important if you plan on using multiple result cursors \n  // in the template. \n\n  $db = new PDO($dsn, $login, $passwd, array( \n     PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true)); \n\n  $res = $db->prepare(\"select * from users\"); \n  $res->execute(); \n  $res->setFetchMode(PDO::FETCH_LAZY); \n\n  // assign to smarty \n  $smarty->assign('res',$res); \n\n  $smarty->display('index.tpl');?>\n
    {foreach $res as $r} \n  {$r.id} \n  {$r.name}\n{foreachelse}\n  .. no results .. \n{/foreach}\n

    The above is assuming the results contain the columns named id and name.

    What is the advantage of an iterator vs. looping over a plain old array? With an array, all the results are accumulated into memory before being looped. With an iterator, each result is loaded/released within the loop. This saves processing time and memory, especially for very large result sets.

    "},{"location":"designers/language-builtin-functions/language-function-foreach/#index","title":"@index","text":"

    index contains the current array index, starting with zero.

    {* output empty row on the 4th iteration (when index is 3) *}\n<table>\n    {foreach $items as $i}\n      {if $i@index eq 3}\n         {* put empty table row *}\n         <tr><td>nbsp;</td></tr>\n      {/if}\n      <tr><td>{$i.label}</td></tr>\n    {/foreach}\n</table>\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#iteration","title":"@iteration","text":"

    iteration contains the current loop iteration and always starts at one, unlike index. It is incremented by one on each iteration.

    The \"is div by\" operator can be used to detect a specific iteration. Here we bold-face the name every 4th iteration.

    {foreach $myNames as $name}\n  {if $name@iteration is div by 4}\n    <b>{$name}</b>\n  {/if}\n  {$name}\n{/foreach}\n

    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}\n   {if $name@iteration is even by 3}\n     <span style=\"color: #000\">{$name}</span>\n   {else}\n     <span style=\"color: #eee\">{$name}</span>\n   {/if}\n {/foreach}\n

    This will output something similar to this:

    <span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n...\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#first","title":"@first","text":"

    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 *}\n<table>\n    {foreach $items as $i}\n      {if $i@first}\n        <tr>\n          <th>key</td>\n          <th>name</td>\n        </tr>\n      {/if}\n      <tr>\n        <td>{$i@key}</td>\n        <td>{$i.name}</td>\n      </tr>\n    {/foreach}\n</table>\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#last","title":"@last","text":"

    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 *}\n{foreach $items as $item}\n  <a href=\"#{$item.id}\">{$item.name}</a>{if $item@last}<hr>{else},{/if}\n{foreachelse}\n  ... no items to loop ...\n{/foreach}\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#show","title":"@show","text":"

    The show show property can be used after the execution of a {foreach} loop to detect if data has been displayed or not. show is a boolean value.

    <ul>\n    {foreach $myArray as $name}\n        <li>{$name}</li>\n    {/foreach}\n</ul>\n{if $name@show} do something here if the array contained data {/if}\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#total","title":"@total","text":"

    total contains the number of iterations that this {foreach} will loop. This can be used inside or after the {foreach}.

    {* show number of rows at end *}\n{foreach $items as $item}\n  {$item.name}<hr/>\n  {if $item@last}\n    <div id=\"total\">{$item@total} items</div>\n  {/if}\n{foreachelse}\n ... no items to loop ...\n{/foreach}\n

    See also {section}, {for} and {while}

    "},{"location":"designers/language-builtin-functions/language-function-foreach/#break","title":"{break}","text":"

    {break} aborts the iteration of the array

      {$data = [1,2,3,4,5]}\n  {foreach $data as $value}\n    {if $value == 3}\n      {* abort iterating the array *}\n      {break}\n    {/if}\n    {$value}\n  {/foreach}\n  {*\n    prints: 1 2\n  *}\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#continue","title":"{continue}","text":"

    {continue} leaves the current iteration and begins with the next iteration.

      {$data = [1,2,3,4,5]}\n  {foreach $data as $value}\n    {if $value == 3}\n      {* skip this iteration *}\n      {continue}\n    {/if}\n    {$value}\n  {/foreach}\n  {*\n    prints: 1 2 4 5\n  *}\n
    "},{"location":"designers/language-builtin-functions/language-function-function/","title":"{function}","text":"

    {function} is used to create functions within a template and call them just like a plugin function. Instead of writing a plugin that generates presentational content, keeping it in the template is often a more manageable choice. It also simplifies data traversal, such as deeply nested menus.

    Note

    Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise, you can directly use the function as {funcname ...} in the template.

    "},{"location":"designers/language-builtin-functions/language-function-function/#attributes","title":"Attributes","text":"Attribute Name Required Description name Yes The name of the template function [var ...] No default variable value to pass local to the template function

    Note

    You can pass any number of parameter to the template function when it is called. The parameter variables must not be declared in the {funcname ...} tag unless you what to use default values. Default values must be scalar and can not be variable. Variables must be passed when the template is called.

    "},{"location":"designers/language-builtin-functions/language-function-function/#examples","title":"Examples","text":"
    {* define the function *}\n{function name=menu level=0}\n{function menu level=0}          {* short-hand *}\n  <ul class=\"level{$level}\">\n  {foreach $data as $entry}\n    {if is_array($entry)}\n      <li>{$entry@key}</li>\n      {menu data=$entry level=$level+1}\n    {else}\n      <li>{$entry}</li>\n    {/if}\n  {/foreach}\n  </ul>\n{/function}\n\n{* create an array to demonstrate *}\n{$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n['item3-3-1','item3-3-2']],'item4']}\n\n{* run the array through the function *}\n{menu data=$menu}\n

    Will generate the following output

    * item1\n* item2\n* item3\n      o item3-1\n      o item3-2\n      o item3-3\n            + item3-3-1\n            + item3-3-2\n* item4\n

    See also {call}

    "},{"location":"designers/language-builtin-functions/language-function-if/","title":"{if},{elseif},{else}","text":"

    {if} statements in Smarty have much the same flexibility as PHP if statements, with a few added features for the template engine. Every {if} must be paired with a matching {/if}. {else} and {elseif} are also permitted. All PHP conditionals and functions are recognized, such as ||, or, &&, and, is_array(), etc.

    If security is enabled, only PHP functions from $php_functions property of the security policy are allowed. See the Security section for details.

    The following is a list of recognized qualifiers, which must be separated from surrounding elements by spaces. Note that items listed in [brackets] are optional. PHP equivalents are shown where applicable.

    "},{"location":"designers/language-builtin-functions/language-function-if/#qualifiers","title":"Qualifiers","text":"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"},{"location":"designers/language-builtin-functions/language-function-if/#examples","title":"Examples","text":"
    {if $name eq 'Fred'}\n    Welcome Sir.\n{elseif $name eq 'Wilma'}\n    Welcome Ma'am.\n{else}\n    Welcome, whatever you are.\n{/if}\n\n{* an example with \"or\" logic *}\n{if $name eq 'Fred' or $name eq 'Wilma'}\n   ...\n{/if}\n\n{* same as above *}\n{if $name == 'Fred' || $name == 'Wilma'}\n   ...\n{/if}\n\n\n{* parenthesis are allowed *}\n{if ( $amount < 0 or $amount > 1000 ) and $volume >= #minVolAmt#}\n   ...\n{/if}\n\n\n{* you can also embed php function calls *}\n{if count($var) gt 0}\n   ...\n{/if}\n\n{* check for array. *}\n{if is_array($foo) }\n   .....\n{/if}\n\n{* check for not null. *}\n{if isset($foo) }\n   .....\n{/if}\n\n\n{* test if values are even or odd *}\n{if $var is even}\n   ...\n{/if}\n{if $var is odd}\n   ...\n{/if}\n{if $var is not odd}\n   ...\n{/if}\n\n\n{* test if var is divisible by 4 *}\n{if $var is div by 4}\n   ...\n{/if}\n\n\n{*\n  test if var is even, grouped by two. i.e.,\n  0=even, 1=even, 2=odd, 3=odd, 4=even, 5=even, etc.\n*}\n{if $var is even by 2}\n   ...\n{/if}\n\n{* 0=even, 1=even, 2=even, 3=odd, 4=odd, 5=odd, etc. *}\n{if $var is even by 3}\n   ...\n{/if}\n\n{if isset($name) && $name == 'Blog'}\n     {* do something *}\n{elseif $name == $foo}\n    {* do something *}\n{/if}\n\n{if is_array($foo) && count($foo) > 0}\n    {* do a foreach loop *}\n{/if}\n
    "},{"location":"designers/language-builtin-functions/language-function-include/","title":"{include}","text":"

    {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.

    "},{"location":"designers/language-builtin-functions/language-function-include/#attributes","title":"Attributes","text":"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 "},{"location":"designers/language-builtin-functions/language-function-include/#option-flags","title":"Option Flags","text":"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"},{"location":"designers/language-builtin-functions/language-function-include/#examples","title":"Examples","text":"
    <html>\n    <head>\n      <title>{$title}</title>\n    </head>\n    <body>\n    {include file='page_header.tpl'}\n\n    {* body of template goes here, the $tpl_name variable\n       is replaced with a value eg 'contact.tpl'\n    *}\n    {include file=\"$tpl_name.tpl\"}\n\n    {* using shortform file attribute *}\n    {include 'page_footer.tpl'}\n    </body>\n</html>\n
    {include 'links.tpl' title='Newest links' links=$link_array}\n{* body of template goes here *}\n{include 'footer.tpl' foo='bar'}\n

    The template above includes the example links.tpl below

    <div id=\"box\">\n    <h3>{$title}{/h3>\n    <ul>\n        {foreach from=$links item=l}\n            .. do stuff  ...\n        </foreach}\n    </ul>\n</div>\n
    Variables assigned in the included template will be seen in the including template.

    {include 'sub_template.tpl' scope=parent}\n...\n{* display variables assigned in sub_template *}\n{$foo}<br>\n{$bar}<br>\n...\n

    The template above includes the example sub_template.tpl below

    ...\n{assign var=foo value='something'}\n{assign var=bar value='value'}\n...\n

    The included template will not be cached.

    {include 'sub_template.tpl' nocache}\n...\n

    In this example included template will be cached with an individual cache lifetime of 500 seconds.

    {include 'sub_template.tpl' cache_lifetime=500}\n...\n

    In this example included template will be cached independent of the global caching setting.

    {include 'sub_template.tpl' caching}\n...\n

    This example assigns the contents of nav.tpl to the $navbar variable, which is then output at both the top and bottom of the page.

    <body>\n  {include 'nav.tpl' assign=navbar}\n  {include 'header.tpl' title='Smarty is cool'}\n    {$navbar}\n    {* body of template goes here *}\n    {$navbar}\n  {include 'footer.tpl'}\n</body>\n

    This example includes another template relative to the directory of the current template.

    {include 'template-in-a-template_dir-directory.tpl'}\n{include './template-in-same-directory.tpl'}\n{include '../template-in-parent-directory.tpl'}\n
    {* absolute filepath *}\n{include file='/usr/local/include/templates/header.tpl'}\n\n{* absolute filepath (same thing) *}\n{include file='file:/usr/local/include/templates/header.tpl'}\n\n{* windows absolute filepath (MUST use \"file:\" prefix) *}\n{include file='file:C:/www/pub/templates/header.tpl'}\n\n{* include from template resource named \"db\" *}\n{include file='db:header.tpl'}\n\n{* include a $variable template - eg $module = 'contacts' *}\n{include file=\"$module.tpl\"}\n\n{* wont work as its single quotes ie no variable substitution *}\n{include file='$module.tpl'}\n\n{* include a multi $variable template - eg amber/links.view.tpl *}\n{include file=\"$style_dir/$module.$view.tpl\"}\n

    See also {insert}, template resources and componentized templates.

    "},{"location":"designers/language-builtin-functions/language-function-insert/","title":"{insert}","text":"

    Note

    {insert} tags are deprecated from Smarty, and should not be used. Put your PHP logic in PHP scripts or plugin functions instead. As of Smarty 3.1 the {insert} tags are only available from SmartyBC.

    {insert} tags work much like {include} tags, except that {insert} tags are NOT cached when template caching is enabled. They will be executed on every invocation of the template.

    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"},{"location":"designers/language-builtin-functions/language-function-insert/#examples","title":"Examples","text":"

    Let's say you have a template with a banner slot at the top of the page. The banner can contain any mixture of HTML, images, flash, etc. so we can't just use a static link here, and we don't want this contents cached with the page. In comes the {insert} tag: the template knows #banner_location_id# and #site_id# values (gathered from a config file), and needs to call a function to get the banner contents.

        {* example of fetching a banner *}\n    {insert name=\"getBanner\" lid=#banner_location_id# sid=#site_id#}\n    {insert \"getBanner\" lid=#banner_location_id# sid=#site_id#} {* short-hand *}\n

    In this example, we are using the name \"getBanner\" and passing the parameters #banner_location_id# and #site_id#. Smarty will look for a function named insert_getBanner() in your PHP application, passing the values of #banner_location_id# and #site_id# as the first argument in an associative array. All {insert} function names in your application must be prepended with \"insert_\" to remedy possible function name-space conflicts. Your insert_getBanner() function should do something with the passed values and return the results. These results are then displayed in the template in place of the {insert} tag. In this example, Smarty would call this function: insert_getBanner(array(\"lid\" => \"12345\",\"sid\" => \"67890\")); and display the returned results in place of the {insert} tag.

    The Smarty object is passed as the second argument. This way you can reference and modify information in the Smarty object from within the {insert} function.

    If no PHP script can be found Smarty is looking for a corresponding insert plugin.

    Note

    It is possible to have portions of the template not cached. If you have caching 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}

    "},{"location":"designers/language-builtin-functions/language-function-ldelim/","title":"{ldelim}, {rdelim}","text":"

    {ldelim} and {rdelim} are used for escaping template delimiters, by default { and }. You can also use {literal}{/literal} to escape blocks of text eg Javascript or CSS. See also the complementary {$smarty.ldelim}.

    {* this will print literal delimiters out of the template *}\n\n{ldelim}funcname{rdelim} is how functions look in Smarty!\n

    The above example will output:

    {funcname} is how functions look in Smarty!\n

    Another example with some Javascript

    <script>\nfunction foo() {ldelim}\n    ... code ...\n{rdelim}\n</script>\n

    will output

    <script>\nfunction foo() {\n    .... code ...\n}\n</script>\n
    <script>\n    function myJsFunction(){ldelim}\n        alert(\"The server name\\n{$smarty.server.SERVER_NAME|escape:javascript}\\n{$smarty.server.SERVER_ADDR|escape:javascript}\");\n    {rdelim}\n</script>\n<a href=\"javascript:myJsFunction()\">Click here for Server Info</a>\n

    See also {literal} and escaping Smarty parsing.

    "},{"location":"designers/language-builtin-functions/language-function-literal/","title":"{literal}","text":"

    {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 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} to escape the individual delimiters instead.

    Note

    {literal}{/literal} tags are normally not necessary, as Smarty ignores delimiters that are surrounded by whitespace. Be sure your javascript and CSS curly braces are surrounded by whitespace. This is new behavior to Smarty 3.

    <script>\n   // the following braces are ignored by Smarty\n   // since they are surrounded by whitespace\n   function myFoo {\n     alert('Foo!');\n   }\n   // this one will need literal escapement\n   {literal}\n     function myBar {alert('Bar!');}\n   {/literal}\n</script>\n

    See also {ldelim} {rdelim} and the escaping Smarty parsing page.

    "},{"location":"designers/language-builtin-functions/language-function-nocache/","title":"{nocache}","text":"

    {nocache} is used to disable caching of a template section. Every {nocache} must be paired with a matching {/nocache}.

    Note

    Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache.

    Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n

    The above code will output the current date on a cached page.

    See also the caching section.

    "},{"location":"designers/language-builtin-functions/language-function-section/","title":"{section}, {sectionelse}","text":"

    A {section} is for looping over sequentially indexed arrays of data, unlike {foreach} which is used to loop over a single associative array. Every {section} tag must be paired with a closing {/section} tag.

    Note

    The {foreach} loop can do everything a {section} loop can do, and has a simpler and easier syntax. It is usually preferred over the {section} loop.

    Note

    {section} loops cannot loop over associative arrays, they must be numerically indexed, and sequential (0,1,2,...). For associative arrays, use the {foreach} loop.

    "},{"location":"designers/language-builtin-functions/language-function-section/#attributes","title":"Attributes","text":"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)"},{"location":"designers/language-builtin-functions/language-function-section/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of the {section} loop

    assign() an array to Smarty

    "},{"location":"designers/language-builtin-functions/language-function-section/#examples","title":"Examples","text":"
    <?php\n$data = [1000, 1001, 1002];\n$smarty->assign('custid', $data);\n

    The template that outputs the array

    {* this example will print out all the values of the $custid array *}\n{section name=customer loop=$custid}\n{section customer $custid} {* short-hand *}\n  id: {$custid[customer]}<br />\n{/section}\n<hr />\n{*  print out all the values of the $custid array reversed *}\n{section name=foo loop=$custid step=-1}\n{section foo $custid step=-1} {* short-hand *}\n  {$custid[foo]}<br />\n{/section}\n

    The above example will output:

    id: 1000<br />\nid: 1001<br />\nid: 1002<br />\n<hr />\nid: 1002<br />\nid: 1001<br />\nid: 1000<br />\n
    {section name=foo start=10 loop=20 step=2}\n  {$smarty.section.foo.index}\n{/section}\n<hr />\n{section name=bar loop=21 max=6 step=-2}\n  {$smarty.section.bar.index}\n{/section}\n

    The above example will output:

    10 12 14 16 18\n<hr />\n20 18 16 14 12 10\n

    The name of the {section} can be anything you like, see PHP variables. It is used to reference the data within the {section}.

    {section name=anything loop=$myArray}\n  {$myArray[anything].foo}\n  {$name[anything]}\n  {$address[anything].bar}\n{/section}\n

    This is an example of printing an associative array of data with a {section}. Following is the php script to assign the $contacts array to Smarty.

    <?php\n$data = [\n      ['name' => 'John Smith', 'home' => '555-555-5555',\n            'cell' => '666-555-5555', 'email' => 'john@myexample.com'],\n      ['name' => 'Jack Jones', 'home' => '777-555-5555',\n            'cell' => '888-555-5555', 'email' => 'jack@myexample.com'],\n      ['name' => 'Jane Munson', 'home' => '000-555-5555',\n            'cell' => '123456', 'email' => 'jane@myexample.com']\n];\n$smarty->assign('contacts',$data);\n

    The template to output $contacts

    {section name=customer loop=$contacts}\n<p>\n  name: {$contacts[customer].name}<br />\n  home: {$contacts[customer].home}<br />\n  cell: {$contacts[customer].cell}<br />\n  e-mail: {$contacts[customer].email}\n</p>\n{/section}\n

    The above example will output:

    <p>\n  name: John Smith<br />\n  home: 555-555-5555<br />\n  cell: 666-555-5555<br />\n  e-mail: john@myexample.com\n</p>\n<p>\n  name: Jack Jones<br />\n  home phone: 777-555-5555<br />\n  cell phone: 888-555-5555<br />\n  e-mail: jack@myexample.com\n</p>\n<p>\n  name: Jane Munson<br />\n  home phone: 000-555-5555<br />\n  cell phone: 123456<br />\n  e-mail: jane@myexample.com\n</p>\n

    This example assumes that $custid, $name and $address are all arrays containing the same number of values. First the php script that assign's the arrays to Smarty.

    <?php\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 Abbey road', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\n

    The loop variable only determines the number of times to loop. You can access ANY variable from the template within the {section}. This is useful for looping multiple arrays. You can pass an array which will determine the loop count by the array size, or you can pass an integer to specify the number of loops.

    {section name=customer loop=$custid}\n<p>\n  id: {$custid[customer]}<br />\n  name: {$name[customer]}<br />\n  address: {$address[customer]}\n</p>\n{/section}\n

    The above example will output:

    <p>\n  id: 1000<br />\n  name: John Smith<br />\n  address: 253 Abbey road\n</p>\n<p>\n  id: 1001<br />\n  name: Jack Jones<br />\n  address: 417 Mulberry ln\n</p>\n<p>\n  id: 1002<br />\n  name: Jane Munson<br />\n  address: 5605 apple st\n</p>\n

    {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\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 N 45th', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\n\n$types = [\n           [ 'home phone', 'cell phone', 'e-mail'],\n           [ 'home phone', 'web'],\n           [ 'cell phone']\n         ];\n$smarty->assign('contact_type', $types);\n\n$info = [\n           ['555-555-5555', '666-555-5555', 'john@myexample.com'],\n           [ '123-456-4', 'www.example.com'],\n           [ '0457878']\n        ];\n$smarty->assign('contact_info', $info);\n

    In this template, $contact_type[customer] is an array of contact types for the current customer.

    {section name=customer loop=$custid}\n<hr>\n  id: {$custid[customer]}<br />\n  name: {$name[customer]}<br />\n  address: {$address[customer]}<br />\n  {section name=contact loop=$contact_type[customer]}\n    {$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br />\n  {/section}\n{/section}\n

    The above example will output:

    <hr>\n  id: 1000<br />\n  name: John Smith<br />\n  address: 253 N 45th<br />\n    home phone: 555-555-5555<br />\n    cell phone: 666-555-5555<br />\n    e-mail: john@myexample.com<br />\n<hr>\n  id: 1001<br />\n  name: Jack Jones<br />\n  address: 417 Mulberry ln<br />\n    home phone: 123-456-4<br />\n    web: www.example.com<br />\n<hr>\n  id: 1002<br />\n  name: Jane Munson<br />\n  address: 5605 apple st<br />\n    cell phone: 0457878<br />\n

    Results of a database search (eg ADODB or PEAR) are assigned to Smarty

    <?php\n$sql = 'select id, name, home, cell, email from contacts '\n      .\"where name like '$foo%' \";\n$smarty->assign('contacts', $db->getAll($sql));\n

    The template to output the database result in a HTML table

    <table>\n    <tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>\n    {section name=co loop=$contacts}\n      <tr>\n        <td><a href=\"view.php?id={$contacts[co].id}\">view<a></td>\n        <td>{$contacts[co].name}</td>\n        <td>{$contacts[co].home}</td>\n        <td>{$contacts[co].cell}</td>\n        <td>{$contacts[co].email}</td>\n      <tr>\n    {sectionelse}\n      <tr><td colspan=\"5\">No items found</td></tr>\n    {/section}\n</table>\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#index","title":".index","text":"

    index contains the current array index, starting with zero or the start attribute if given. It increments by one or by the step attribute if given.

    Note

    If the step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.

    Note

    $custid[customer.index] and $custid[customer] are identical.

    {section name=customer loop=$custid}\n  {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\n

    The above example will output:

    0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#index_prev","title":".index_prev","text":"

    index_prev is the previous loop index. On the first loop, this is set to -1.

    "},{"location":"designers/language-builtin-functions/language-function-section/#index_next","title":".index_next","text":"

    index_next is the next loop index. On the last loop, this is still one more than the current index, respecting the setting of the step attribute, if given.

    <?php\n    $data = [1001,1002,1003,1004,1005];\n    $smarty->assign('rows',$data);\n

    Template to output the above array in a table

    {* $rows[row.index] and $rows[row] are identical in meaning *}\n<table>\n  <tr>\n    <th>index</th><th>id</th>\n    <th>index_prev</th><th>prev_id</th>\n    <th>index_next</th><th>next_id</th>\n  </tr>\n{section name=row loop=$rows}\n  <tr>\n    <td>{$smarty.section.row.index}</td><td>{$rows[row]}</td>\n    <td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td>\n    <td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td>\n  </tr>\n{/section}\n</table>\n

    The above example will output a table containing the following:

        index  id    index_prev prev_id index_next next_id\n    0      1001  -1                 1          1002\n    1      1002  0          1001    2          1003\n    2      1003  1          1002    3          1004\n    3      1004  2          1003    4          1005\n    4      1005  3          1004    5\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#iteration","title":".iteration","text":"

    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 property. iteration also starts with one instead of zero unlike index. rownum is an alias to iteration, they are identical.

    <?php\n// array of 3000 to 3015\n$id = range(3000,3015);\n$smarty->assign('arr', $id);\n

    Template to output every other element of the $arr array as step=2

    {section name=cu loop=$arr start=5 step=2}\n  iteration={$smarty.section.cu.iteration}\n  index={$smarty.section.cu.index}\n  id={$custid[cu]}<br />\n{/section}\n

    The above example will output:

    iteration=1 index=5 id=3005<br />\niteration=2 index=7 id=3007<br />\niteration=3 index=9 id=3009<br />\niteration=4 index=11 id=3011<br />\niteration=5 index=13 id=3013<br />\niteration=6 index=15 id=3015<br />\n

    Another example that uses the iteration property to output a table header block every five rows.

    <table>\n    {section name=co loop=$contacts}\n      {if $smarty.section.co.iteration is div by 5}\n        <tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>\n      {/if}\n      <tr>\n        <td><a href=\"view.php?id={$contacts[co].id}\">view<a></td>\n        <td>{$contacts[co].name}</td>\n        <td>{$contacts[co].home}</td>\n        <td>{$contacts[co].cell}</td>\n        <td>{$contacts[co].email}</td>\n      <tr>\n    {/section}\n</table>\n

    An example that uses the iteration property to alternate a text color every third row.

    <table>\n  {section name=co loop=$contacts}\n    {if $smarty.section.co.iteration is even by 3}\n      <span style=\"color: #ffffff\">{$contacts[co].name}</span>\n    {else}\n      <span style=\"color: #dddddd\">{$contacts[co].name}</span>\n    {/if}\n  {/section}\n</table>\n

    Note

    The \"is div by\" syntax is a simpler alternative to the PHP mod operator syntax. The mod operator is allowed: {if $smarty.section.co.iteration % 5 == 1} will work just the same.

    Note

    You can also use \"is odd by\" to reverse the alternating.

    "},{"location":"designers/language-builtin-functions/language-function-section/#first","title":".first","text":"

    first is set to TRUE if the current {section} iteration is the initial one.

    "},{"location":"designers/language-builtin-functions/language-function-section/#last","title":".last","text":"

    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 property.

    {section name=customer loop=$customers}\n  {if $smarty.section.customer.first}\n    <table>\n    <tr><th>id</th><th>customer</th></tr>\n  {/if}\n\n  <tr>\n    <td>{$customers[customer].id}}</td>\n    <td>{$customers[customer].name}</td>\n  </tr>\n\n  {if $smarty.section.customer.last}\n    <tr><td></td><td>{$smarty.section.customer.total} customers</td></tr>\n    </table>\n  {/if}\n{/section}\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#rownum","title":".rownum","text":"

    rownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.

    "},{"location":"designers/language-builtin-functions/language-function-section/#loop","title":".loop","text":"

    loop contains the last index number that this {section} looped. This can be used inside or after the {section}.

    {section name=customer loop=$custid}\n  {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\nThere are {$smarty.section.customer.loop} customers shown above.\n

    The above example will output:

    0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nThere are 3 customers shown above.\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#show","title":".show","text":"

    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 this section shows.

    {section name=customer loop=$customers show=$show_customer_info}\n  {$smarty.section.customer.rownum} id: {$customers[customer]}<br />\n{/section}\n\n{if $smarty.section.customer.show}\n  the section was shown.\n{else}\n  the section was not shown.\n{/if}\n

    The above example will output:

    1 id: 1000<br />\n2 id: 1001<br />\n3 id: 1002<br />\n\nthe section was shown.\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#total","title":".total","text":"

    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}\n  {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\n   There are {$smarty.section.customer.total} customers shown above.\n

    See also {foreach}, {for}, {while} and $smarty.section.

    "},{"location":"designers/language-builtin-functions/language-function-setfilter/","title":"{setfilter}","text":"

    The {setfilter}...{/setfilter} block tag allows the definition of template instance's variable filters.

    SYNTAX: {setfilter filter1\\|filter2\\|filter3\\....}\\...{/setfilter}

    The filter can be:

    {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.

    Note

    The setting of template instance filters does not affect the output of included subtemplates.

    "},{"location":"designers/language-builtin-functions/language-function-setfilter/#examples","title":"Examples","text":"
    <script>\n    {setfilter filter1}\n      {$foo} {* filter1 runs on output of $foo *}\n      {setfilter filter2|mod:true}\n        {$bar} {* filter2 and modifier mod runs on output of $bar *}\n      {/setfilter}\n      {$buh} {* filter1 runs on output of $buh *}\n    {/setfilter}\n    {$blar} {* no template instance filter runs on output of $blar}\n</script>\n
    "},{"location":"designers/language-builtin-functions/language-function-strip/","title":"{strip}","text":"

    Many times web designers run into the issue where white space and carriage returns affect the output of the rendered HTML (browser \"features\"), so you must run all your tags together in the template to get the desired results. This usually ends up in unreadable or unmanageable templates.

    Anything within {strip}{/strip} tags are stripped of the extra spaces or carriage returns at the beginnings and ends of the lines before they are displayed. This way you can keep your templates readable, and not worry about extra white space causing problems.

    Note

    {strip}{/strip} does not affect the contents of template variables, see the strip modifier instead.

    {* the following will be all run into one line upon output *}\n{strip}\n    <table>\n     <tr>\n      <td>\n       <a href=\"#\">\n        This is a test\n       </a>\n      </td>\n     </tr>\n    </table>\n{/strip}\n

    The above example will output:

    <table><tr><td><a href=\"#\">This is a test</a></td></tr></table>\n

    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 modifier.

    "},{"location":"designers/language-builtin-functions/language-function-while/","title":"{while}","text":"

    {while} loops in Smarty have much the same flexibility as PHP while statements, with a few added features for the template engine. Every {while} must be paired with a matching {/while}. All PHP conditionals and functions are recognized, such as ||, or, &&, and, is_array(), etc.

    The following is a list of recognized qualifiers, which must be separated from surrounding elements by spaces. Note that items listed in [brackets] are optional. PHP equivalents are shown where applicable.

    "},{"location":"designers/language-builtin-functions/language-function-while/#qualifiers","title":"Qualifiers","text":"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"},{"location":"designers/language-builtin-functions/language-function-while/#examples","title":"Examples","text":"
    {while $foo > 0}\n  {$foo--}\n{/while}\n

    The above example will count down the value of $foo until 1 is reached.

    See also {foreach}, {for} and {section}.

    "},{"location":"designers/language-custom-functions/","title":"Custom Functions","text":"

    Smarty comes with several custom plugin functions that you can use in the templates.

    "},{"location":"designers/language-custom-functions/language-function-counter/","title":"{counter}","text":"

    {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 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.

    "},{"location":"designers/language-custom-functions/language-function-counter/#attributes","title":"Attributes","text":"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.

    "},{"location":"designers/language-custom-functions/language-function-counter/#examples","title":"Examples","text":"
    {* initialize the count *}\n{counter start=0 skip=2}<br />\n{counter}<br />\n{counter}<br />\n{counter}<br />\n

    this will output:

    0<br />\n2<br />\n4<br />\n6<br />\n
    "},{"location":"designers/language-custom-functions/language-function-cycle/","title":"{cycle}","text":"

    {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.

    "},{"location":"designers/language-custom-functions/language-function-cycle/#attributes","title":"Attributes","text":"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) "},{"location":"designers/language-custom-functions/language-function-cycle/#examples","title":"Examples","text":"
    {section name=rows loop=$data}\n    <tr class=\"{cycle values=\"odd,even\"}\">\n       <td>{$data[rows]}</td>\n    </tr>\n{/section}\n

    The above template would output:

        <tr class=\"odd\">\n       <td>1</td>\n    </tr>\n    <tr class=\"even\">\n       <td>2</td>\n    </tr>\n    <tr class=\"odd\">\n       <td>3</td>\n    </tr>\n
    "},{"location":"designers/language-custom-functions/language-function-debug/","title":"{debug}","text":"

    {debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned 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 Required Description output No output type, html or javascript (defaults to 'javascript')

    See also the debugging console page.

    "},{"location":"designers/language-custom-functions/language-function-eval/","title":"{eval}","text":"

    {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.

    "},{"location":"designers/language-custom-functions/language-function-eval/#attributes","title":"Attributes","text":"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.

    Note

    "},{"location":"designers/language-custom-functions/language-function-eval/#examples","title":"Examples","text":"

    The contents of the config file, setup.conf.

    emphstart = <strong>\nemphend = </strong>\ntitle = Welcome to {$company}'s home page!\nErrorCity = You must supply a {#emphstart#}city{#emphend#}.\nErrorState = You must supply a {#emphstart#}state{#emphend#}.\n

    Where the template is:

    {config_load file='setup.conf'}\n\n{eval var=$foo}\n{eval var=#title#}\n{eval var=#ErrorCity#}\n{eval var=#ErrorState# assign='state_error'}\n{$state_error}\n

    The above template will output:

    This is the contents of foo.\nWelcome to Foobar Pub & Grill's home page!\nYou must supply a <strong>city</strong>.\nYou must supply a <strong>state</strong>.\n

    This outputs the server name (in uppercase) and IP. The assigned variable $str could be from a database query.

    <?php\n    $str = 'The server name is {$smarty.server.SERVER_NAME|upper} '\n           .'at {$smarty.server.SERVER_ADDR}';\n    $smarty->assign('foo',$str);\n

    Where the template is:

    {eval var=$foo}\n
    "},{"location":"designers/language-custom-functions/language-function-fetch/","title":"{fetch}","text":"

    {fetch} is used to retrieve files from the local file system, http, or ftp and display the contents.

    "},{"location":"designers/language-custom-functions/language-function-fetch/#attributes","title":"Attributes","text":"Attribute Required Description file Yes The file, http or ftp site to fetch assign No The template variable the output will be assigned to "},{"location":"designers/language-custom-functions/language-function-fetch/#examples","title":"Examples","text":"
    {* include some javascript in your template *}\n{fetch file='/export/httpd/www.example.com/docs/navbar.js'}\n\n{* embed some weather text in your template from another web site *}\n{fetch file='http://www.myweather.com/68502/'}\n\n{* fetch a news headline file via ftp *}\n{fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'}\n{* as above but with variables *}\n{fetch file=\"ftp://`$user`:`$password`@`$server`/`$path`\"}\n\n{* assign the fetched contents to a template variable *}\n{fetch file='http://www.myweather.com/68502/' assign='weather'}\n{if $weather ne ''}\n  <div id=\"weather\">{$weather}</div>\n{/if}\n

    See also {capture}, {eval}, {assign} and fetch().

    "},{"location":"designers/language-custom-functions/language-function-html-checkboxes/","title":"{html_checkboxes}","text":"

    {html_checkboxes} is a custom function that creates an html checkbox group with provided data. It takes care of which item(s) are selected by default as well.

    "},{"location":"designers/language-custom-functions/language-function-html-checkboxes/#attributes","title":"Attributes","text":"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 <label>-tags to the output (defaults to true) label_ids No Add id-attributes to <label> and <input> 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) "},{"location":"designers/language-custom-functions/language-function-html-checkboxes/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n                                'Joe Schmoe',\n                                'Jack Smith',\n                                'Jane Johnson',\n                                'Charlie Brown')\n                              );\n$smarty->assign('customer_id', 1001);\n

    where template is

    {html_checkboxes name='id' values=$cust_ids output=$cust_names selected=$customer_id  separator='<br />'}\n

    or where PHP code is:

    <?php\n\n$smarty->assign(\n    'cust_checkboxes', \n    [\n     1000 => 'Joe Schmoe',\n     1001 => 'Jack Smith',\n     1002 => 'Jane Johnson',\n     1003 => 'Charlie Brown',\n    ]\n);\n$smarty->assign('customer_id', 1001);\n

    and the template is

    {html_checkboxes name='id' options=$cust_checkboxes selected=$customer_id separator='<br />'}\n

    both examples will output:

    <label><input type=\"checkbox\" name=\"id[]\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1001\" checked=\"checked\" />Jack Smith</label>\n<br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1003\" />Charlie Brown</label><br />\n
    <?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, contact_type_id, contact '\n       .'from contacts where contact_id=12';\n$smarty->assign('contact',$db->getRow($sql));\n

    The results of the database queries above would be output with.

    {html_checkboxes name='contact_type_id' options=$contact_types selected=$contact.contact_type_id separator='<br />'}\n

    See also {html_radios} and {html_options}

    "},{"location":"designers/language-custom-functions/language-function-html-image/","title":"{html_image}","text":"

    {html_image} is a custom function that generates an HTML <img> tag. The height and width are automatically calculated from the image file if they are not supplied.

    "},{"location":"designers/language-custom-functions/language-function-html-image/#attributes","title":"Attributes","text":"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

    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, it is generally better to avoid {html_image} and leave image tags static for optimal performance.

    "},{"location":"designers/language-custom-functions/language-function-html-image/#examples","title":"Examples","text":"
    {html_image file='pumpkin.jpg'}\n{html_image file='/path/from/docroot/pumpkin.jpg'}\n{html_image file='../path/relative/to/currdir/pumpkin.jpg'}\n

    Example output of the above template would be:

    <img src=\"pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"/path/from/docroot/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"../path/relative/to/currdir/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n
    "},{"location":"designers/language-custom-functions/language-function-html-options/","title":"{html_options}","text":"

    {html_options} is a custom function that creates the html <select><option> group with the assigned data. It takes care of which item(s) are selected by default as well.

    "},{"location":"designers/language-custom-functions/language-function-html-options/#attributes","title":"Attributes","text":"Attribute Name Required Description values Yes, unless using options attribute An array of values for dropdown output Yes, unless using options attribute An array of output for dropdown selected No The selected option element(s) as a string or array options Yes, unless using values and output An associative array of values and output name No Name of select group 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) "},{"location":"designers/language-custom-functions/language-function-html-options/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('myOptions', [\n                                1800 => 'Joe Schmoe',\n                                9904 => 'Jack Smith',\n                                2003 => 'Charlie Brown']\n                                );\n$smarty->assign('mySelect', 9904);\n

    The following template will generate a drop-down list. Note the presence of the name attribute which creates the <select> tags.

    {html_options name=foo options=$myOptions selected=$mySelect}\n

    Output of the above example would be:

    <select name=\"foo\">\n    <option value=\"1800\">Joe Schmoe</option>\n    <option value=\"9904\" selected=\"selected\">Jack Smith</option>\n    <option value=\"2003\">Charlie Brown</option>\n</select>   \n
    <?php\n$smarty->assign('cust_ids', [56,92,13]);\n$smarty->assign('cust_names', [\n                              'Joe Schmoe',\n                              'Jane Johnson',\n                              'Charlie Brown']);\n$smarty->assign('customer_id', 92);\n

    The above arrays would be output with the following template (note the use of the php count() function as a modifier to set the select size).

    <select name=\"customer_id\" size=\"{$cust_names|@count}\">\n   {html_options values=$cust_ids output=$cust_names selected=$customer_id}\n</select>\n

    The above example would output:

    <select name=\"customer_id\" size=\"3\">\n    <option value=\"56\">Joe Schmoe</option>\n    <option value=\"92\" selected=\"selected\">Jane Johnson</option>\n    <option value=\"13\">Charlie Brown</option>\n</select>\n
    <?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id\n        from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\n

    Where a template could be as follows. Note the use of the truncate modifier.

    <select name=\"type_id\">\n    <option value='null'>-- none --</option>\n    {html_options options=$contact_types|truncate:20 selected=$contact.type_id}\n</select>\n
    <?php\n$arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim');\n$arr['Rest']  = array(3 => 'Sauna',1 => 'Massage');\n$smarty->assign('lookups', $arr);\n$smarty->assign('fav', 7);\n

    The script above and the following template

    {html_options name=foo options=$lookups selected=$fav}\n

    would output:

    <select name=\"foo\">\n    <optgroup label=\"Sport\">\n        <option value=\"6\">Golf</option>\n        <option value=\"9\">Cricket</option>\n        <option value=\"7\" selected=\"selected\">Swim</option>\n    </optgroup>\n    <optgroup label=\"Rest\">\n        <option value=\"3\">Sauna</option>\n        <option value=\"1\">Massage</option>\n    </optgroup>\n</select>\n

    See also {html_checkboxes} and {html_radios}

    "},{"location":"designers/language-custom-functions/language-function-html-radios/","title":"{html_radios}","text":"

    {html_radios} is a custom function that creates an HTML radio button group. It also takes care of which item is selected by default as well.

    "},{"location":"designers/language-custom-functions/language-function-html-radios/#attributes","title":"Attributes","text":"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 -tags to the output (defaults to true) label_ids No Add id-attributes to <label> and <input> 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) "},{"location":"designers/language-custom-functions/language-function-html-radios/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n                              'Joe Schmoe',\n                              'Jack Smith',\n                              'Jane Johnson',\n                              'Charlie Brown')\n                              );\n$smarty->assign('customer_id', 1001);\n

    Where template is:

    {html_radios name='id' values=$cust_ids output=$cust_names\n       selected=$customer_id separator='<br />'}\n
    <?php\n$smarty->assign('cust_radios', array(\n                               1000 => 'Joe Schmoe',\n                               1001 => 'Jack Smith',\n                               1002 => 'Jane Johnson',\n                               1003 => 'Charlie Brown'));\n$smarty->assign('customer_id', 1001);\n

    Where template is:

    {html_radios name='id' options=$cust_radios\n     selected=$customer_id separator='<br />'}\n

    Both examples will output:

    <label><input type=\"radio\" name=\"id\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1001\" checked=\"checked\" />Jack Smith</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1003\" />Charlie Brown</label><br />\n
    <?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id '\n        .'from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\n

    The variable assigned from the database above would be output with the template:

    {html_radios name='contact_type_id' options=$contact_types\n     selected=$contact.contact_type_id separator='<br />'}\n

    See also {html_checkboxes} and {html_options}

    "},{"location":"designers/language-custom-functions/language-function-html-select-date/","title":"{html_select_date}","text":"

    {html_select_date} is a custom function that creates date dropdowns. It can display any or all of: year, month, and day. All parameters that are not in the list below are printed as name/value-pairs inside the <select> tags of day, month and year.

    "},{"location":"designers/language-custom-functions/language-function-html-select-date/#attributes","title":"Attributes","text":"Attribute Name Default Description prefix Date_ What to prefix the var name with time What date/time to pre-select. Accepts timestamps, DateTime objects or any string parseable by strtotime(). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL. start_year current year The first year in the dropdown, either year number, or relative to current year (+/- N) end_year same as start_year The last year in the dropdown, either year number, or relative to current year (+/- N) display_days TRUE Whether to display days or not display_months TRUE Whether to display months or not display_years TRUE Whether to display years or not month_names List of strings to display for months. array(1 => 'Jan', ..., 12 => 'Dec') month_format \\%B What format the month should be in (strftime) day_format \\%02d What format the day output should be in (sprintf) day_value_format \\%d What format the day value should be in (sprintf) year_as_text FALSE Whether or not to display the year as text reverse_years FALSE Display years in reverse order field_array If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name[Day], name[Year], name[Month]. day_size Adds size attribute to select tag if given month_size Adds size attribute to select tag if given year_size Adds size attribute to select tag if given all_extra Adds extra attributes to all select/input tags if given day_extra Adds extra attributes to select/input tags if given month_extra Adds extra attributes to select/input tags if given year_extra Adds extra attributes to select/input tags if given all_id Adds id-attribute to all select/input tags if given day_id Adds id-attribute to select/input tags if given month_id Adds id-attribute to select/input tags if given year_id Adds id-attribute to select/input tags if given field_order MDY The order in which to display the fields field_separator \\n String printed between different fields month_value_format \\%m strftime() format of the month values, default is %m for month numbers. all_empty If supplied then the first element of any select-box has this value as it's label and \"\" as it's value. This is useful to make the select-boxes read \"Please select\" for example. year_empty If supplied then the first element of the year's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select a year\" for example. Note that you can use values like \"-MM-DD\" as time-attribute to indicate an unselected year. month_empty If supplied then the first element of the month's select-box has this value as it's label and \"\" as it's value. . Note that you can use values like \"YYYY--DD\" as time-attribute to indicate an unselected month. day_empty If supplied then the first element of the day's select-box has this value as it's label and \"\" as it's value. Note that you can use values like \"YYYY-MM-\" as time-attribute to indicate an unselected day.

    Note

    There is an useful php function on the date tips page for converting {html_select_date} form values to a timestamp.

    "},{"location":"designers/language-custom-functions/language-function-html-select-date/#exaples","title":"Exaples","text":"

    Template code

    {html_select_date}\n

    This will output:

    <select name=\"Date_Month\">\n    <option value=\"1\">January</option>\n    <option value=\"2\">February</option>\n    <option value=\"3\">March</option>\n      ..... snipped .....\n    <option value=\"10\">October</option>\n    <option value=\"11\">November</option>\n    <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"Date_Day\">\n    <option value=\"1\">01</option>\n    <option value=\"2\">02</option>\n    <option value=\"3\">03</option>\n      ..... snipped .....\n    <option value=\"11\">11</option>\n    <option value=\"12\">12</option>\n    <option value=\"13\" selected=\"selected\">13</option>\n    <option value=\"14\">14</option>\n    <option value=\"15\">15</option>\n      ..... snipped .....\n    <option value=\"29\">29</option>\n    <option value=\"30\">30</option>\n    <option value=\"31\">31</option>\n</select>\n<select name=\"Date_Year\">\n    <option value=\"2006\" selected=\"selected\">2006</option>\n</select>\n
    {* start and end year can be relative to current year *}\n{html_select_date prefix='StartDate' time=$time start_year='-5'\n       end_year='+1' display_days=false}\n

    With 2000 as the current year the output:

    <select name=\"StartDateMonth\">\n    <option value=\"1\">January</option>\n    <option value=\"2\">February</option>\n    .... snipped ....\n    <option value=\"11\">November</option>\n    <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"StartDateYear\">\n    <option value=\"1995\">1995</option>\n    .... snipped ....\n    <option value=\"1999\">1999</option>\n    <option value=\"2000\" selected=\"selected\">2000</option>\n    <option value=\"2001\">2001</option>\n</select>\n

    See also {html_select_time}, date_format, $smarty.now and the date tips page.

    "},{"location":"designers/language-custom-functions/language-function-html-select-time/","title":"{html_select_time}","text":"

    {html_select_time} is a custom function that creates time dropdowns for you. It can display any or all of: hour, minute, second and meridian.

    The time attribute can have different formats. It can be a unique timestamp, a string of the format YYYYMMDDHHMMSS or a string that is parseable by PHP's strtotime().

    "},{"location":"designers/language-custom-functions/language-function-html-select-time/#attributes","title":"Attributes","text":"Attribute Name Default Description prefix Time_ What to prefix the var name with time current timestamp What date/time to pre-select. Accepts timestamp, DateTime, mysql timestamp or any string parsable by strtotime(). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. display_hours TRUE Whether or not to display hours display_minutes TRUE Whether or not to display minutes display_seconds TRUE Whether or not to display seconds display_meridian TRUE Whether or not to display meridian (am/pm) use_24_hours TRUE Whether or not to use 24 hour clock minute_interval 1 Number interval in minute dropdown second_interval 1 Number interval in second dropdown hour_format \\%02d What format the hour label should be in (sprintf) hour_value_format \\%20d What format the hour value should be in (sprintf) minute_format \\%02d What format the minute label should be in (sprintf) minute_value_format \\%20d What format the minute value should be in (sprintf) second_format \\%02d What format the second label should be in (sprintf) second_value_format \\%20d What format the second value should be in (sprintf) field_array n/a Outputs values to array of this name all_extra null Adds extra attributes to select/input tags if given hour_extra null Adds extra attributes to select/input tags if given minute_extra null Adds extra attributes to select/input tags if given second_extra null Adds extra attributes to select/input tags if given meridian_extra null Adds extra attributes to select/input tags if given field_separator \\n String printed between different fields option_separator \\n String printed between different options of a field all_id null Adds id-attribute to all select/input tags if given hour_id null Adds id-attribute to select/input tags if given minute_id null Adds id-attribute to select/input tags if given second_id null Adds id-attribute to select/input tags if given meridian_id null Adds id-attribute to select/input tags if given all_empty null If supplied then the first element of any select-box has this value as it's label and \"\" as it's value. This is useful to make the select-boxes read \"Please select\" for example. hour_empty null If supplied then the first element of the hour's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an hour\" for example. minute_empty null If supplied then the first element of the minute's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an minute\" for example. second_empty null If supplied then the first element of the second's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an second\" for example. meridian_empty null If supplied then the first element of the meridian's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an meridian\" for example."},{"location":"designers/language-custom-functions/language-function-html-select-time/#examples","title":"Examples","text":"
    {html_select_time use_24_hours=true}\n

    At 9:20 and 23 seconds in the morning the template above would output:

    <select name=\"Time_Hour\">\n    <option value=\"00\">00</option>\n    <option value=\"01\">01</option>\n    ... snipped ....\n    <option value=\"08\">08</option>\n    <option value=\"09\" selected>09</option>\n    <option value=\"10\">10</option>\n    ... snipped ....\n    <option value=\"22\">22</option>\n    <option value=\"23\">23</option>\n</select>\n<select name=\"Time_Minute\">\n    <option value=\"00\">00</option>\n    <option value=\"01\">01</option>\n    ... snipped ....\n    <option value=\"19\">19</option>\n    <option value=\"20\" selected>20</option>\n    <option value=\"21\">21</option>\n    ... snipped ....\n    <option value=\"58\">58</option>\n    <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Second\">\n    <option value=\"00\">00</option>\n    <option value=\"01\">01</option>\n    ... snipped ....\n    <option value=\"22\">22</option>\n    <option value=\"23\" selected>23</option>\n    <option value=\"24\">24</option>\n    ... snipped ....\n    <option value=\"58\">58</option>\n    <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Meridian\">\n    <option value=\"am\" selected>AM</option>\n    <option value=\"pm\">PM</option>\n</select>\n

    See also $smarty.now, {html_select_date} and the date tips page.

    "},{"location":"designers/language-custom-functions/language-function-html-table/","title":"{html_table}","text":"

    {html_table} is a custom function that dumps an array of data into an HTML <table>.

    "},{"location":"designers/language-custom-functions/language-function-html-table/#attributes","title":"Attributes","text":"Attribute Name Required Description loop Yes Array of data to loop through cols No Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array. rows No Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements. inner No Direction of consecutive elements in the loop-array to be rendered. cols means elements are displayed col-by-col. rows means elements are displayed row-by-row. caption No Text to be used for the <caption> element of the table table_attr No Attributes for <table> tag (defaults to 'border=\"1\"') th_attr No Attributes for <th> tag (arrays are cycled) tr_attr No attributes for <tr> tag (arrays are cycled) td_attr No Attributes for <td> tag (arrays are cycled) trailpad No Value to pad the trailing cells on last row with (if any) (defaults to '\u00a0') hdir No Direction of each row to be rendered. possible values: right (left-to-right), and left (right-to-left) (defaults to 'right') vdir No Direction of each column to be rendered. possible values: down (top-to-bottom), up (bottom-to-top) (defaults to 'down') "},{"location":"designers/language-custom-functions/language-function-html-table/#examples","title":"Examples","text":"
    <?php\n$smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) );\n$smarty->assign( 'tr', array('bgcolor=\"#eeeeee\"','bgcolor=\"#dddddd\"') );\n$smarty->display('index.tpl');\n

    The variables assigned from php could be displayed as these three examples demonstrate. Each example shows the template followed by output.

    ** Example 1 ** 

    {html_table loop=$data}\n
    <table border=\"1\">\n    <tbody>\n        <tr><td>1</td><td>2</td><td>3</td></tr>\n        <tr><td>4</td><td>5</td><td>6</td></tr>\n        <tr><td>7</td><td>8</td><td>9</td></tr>\n    </tbody>\n</table>\n

    ** Example 2 ** 

    {html_table loop=$data cols=4 table_attr='border=\"0\"'}\n
    <table border=\"0\">\n    <tbody>\n        <tr><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n        <tr><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n        <tr><td>9</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n    </tbody>\n</table>\n

    ** Example 3 ** 

    {html_table loop=$data cols=\"first,second,third,fourth\" tr_attr=$tr}\n
    <table border=\"1\">\n    <thead>\n        <tr>\n        <th>first</th><th>second</th><th>third</th><th>fourth</th>\n        </tr>\n    </thead>\n    <tbody>\n        <tr bgcolor=\"#eeeeee\"><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n        <tr bgcolor=\"#dddddd\"><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n        <tr bgcolor=\"#eeeeee\"><td>9</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n    </tbody>\n</table>\n

    "},{"location":"designers/language-custom-functions/language-function-mailto/","title":"{mailto}","text":"

    {mailto} automates the creation of a mailto: anchor links and optionally encodes them. Encoding emails makes it more difficult for web spiders to lift email addresses off of a site.

    "},{"location":"designers/language-custom-functions/language-function-mailto/#attributes","title":"Attributes","text":"Attribute Name Required Description address Yes The e-mail address text No The text to display, default is the e-mail address encode No How to encode the e-mail. Can be one of none, hex, javascript or javascript_charcode. cc No Email addresses to carbon copy, separate entries by a comma. bcc No Email addresses to blind carbon copy, separate entries by a comma subject No Email subject newsgroups No Newsgroups to post to, separate entries by a comma. followupto No Addresses to follow up to, separate entries by a comma. extra No Any extra information you want passed to the link, such as style sheet classes

    Note

    Javascript is probably the most thorough form of encoding, although you can use hex encoding too.

    "},{"location":"designers/language-custom-functions/language-function-mailto/#examples","title":"Examples","text":"
    {mailto address=\"me@example.com\"}\n<a href=\"mailto:me@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" text=\"send me some mail\"}\n<a href=\"mailto:me@example.com\" >send me some mail</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript\"}\n<script type=\"text/javascript\" language=\"javascript\">\n   eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))\n</script>\n\n{mailto address=\"me@example.com\" encode=\"hex\"}\n<a href=\"mailto:%6d%65.. snipped..3%6f%6d\">&#x6d;&..snipped...#x6f;&#x6d;</a>\n\n{mailto address=\"me@example.com\" subject=\"Hello to you!\"}\n<a href=\"mailto:me@example.com?subject=Hello%20to%20you%21\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" cc=\"you@example.com,they@example.com\"}\n<a href=\"mailto:me@example.com?cc=you@example.com,they@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" extra='class=\"email\"'}\n<a href=\"mailto:me@example.com\" class=\"email\">me@example.com</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript_charcode\"}\n<script type=\"text/javascript\" language=\"javascript\">\n    {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}\n</script>\n

    See also escape, {textformat} and obfuscating email addresses.

    "},{"location":"designers/language-custom-functions/language-function-math/","title":"{math}","text":"

    {math} allows the template designer to do math equations in the template.

    "},{"location":"designers/language-custom-functions/language-function-math/#attributes","title":"Attributes","text":"Attribute Name Required Description equation Yes The equation to execute format No The format of the result (sprintf) var Yes Equation variable value assign No Template variable the output will be assigned to [var ...] Yes Equation variable value

    Note

    {math} is an expensive function in performance due to its use of the php eval() function. Doing the math in PHP is much more efficient, so whenever possible do the math calculations in the script and assign() the results to the template. Definitely avoid repetitive {math} function calls, eg within {section} loops.

    "},{"location":"designers/language-custom-functions/language-function-math/#examples","title":"Examples","text":"

    Example 1 

    {* $height=4, $width=5 *}\n\n{math equation=\"x + y\" x=$height y=$width}\n

    The above example will output:

    9\n

    Example 2

    {* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *}\n\n{math equation=\"height * width / division\"\n    height=$row_height\n    width=$row_width\n    division=#col_div#}\n

    The above example will output:

    100\n

    Example 3

    {* you can use parenthesis *}\n\n{math equation=\"(( x + y ) / z )\" x=2 y=10 z=2}\n

    The above example will output:

    6\n

    Example 4

    {* you can supply a format parameter in sprintf format *}\n\n{math equation=\"x + y\" x=4.4444 y=5.0000 format=\"%.2f\"}\n

    The above example will output: 

    9.44\n

    "},{"location":"designers/language-custom-functions/language-function-textformat/","title":"{textformat}","text":"

    {textformat} is a block function used to format text. It basically cleans up spaces and special characters, and formats paragraphs by wrapping at a boundary and indenting lines.

    You can set the parameters explicitly, or use a preset style. Currently, \"email\" is the only available style.

    "},{"location":"designers/language-custom-functions/language-function-textformat/#attributes","title":"Attributes","text":"Attribute Name Default Description style n/a Preset style indent 0 The number of chars to indent every line indent_first 0 The number of chars to indent the first line indent_char (single space) The character (or string of chars) to indent with wrap 80 How many characters to wrap each line to wrap_char \\n The character (or string of chars) to break each line with wrap_cut FALSE If TRUE, wrap will break the line at the exact character instead of at a word boundary assign n/a The template variable the output will be assigned to"},{"location":"designers/language-custom-functions/language-function-textformat/#examples","title":"Examples","text":"
    {textformat wrap=40}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

    This is foo. This is foo. This is foo.\nThis is foo. This is foo. This is foo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo\nfoo. bar foo bar foo foo. bar foo bar\nfoo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo.\n
    {textformat wrap=40 indent=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

        This is foo. This is foo. This is\n    foo. This is foo. This is foo. This\n    is foo.\n\n    This is bar.\n\n    bar foo bar foo foo. bar foo bar foo\n    foo. bar foo bar foo foo. bar foo\n    bar foo foo. bar foo bar foo foo.\n    bar foo bar foo foo. bar foo bar\n    foo foo.\n
    {textformat wrap=40 indent=4 indent_first=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

       This is foo. This is foo. This\n   is foo. This is foo. This is foo.\n   This is foo.\n\n   This is bar.\n\n   bar foo bar foo foo. bar foo bar\n   foo foo. bar foo bar foo foo. bar\n   foo bar foo foo. bar foo bar foo\n   foo. bar foo bar foo foo. bar foo\n   bar foo foo.\n
    {textformat style=\"email\"}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

    This is foo. This is foo. This is foo. This is foo. This is foo. This is\nfoo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo\nfoo.\n

    See also {strip} and wordwrap.

    "},{"location":"designers/language-modifiers/","title":"Variable Modifiers","text":"

    Variable modifiers can be applied to variables, custom functions or strings. To apply a modifier, specify the value followed by a | (pipe) and the modifier name. A modifier may accept additional parameters that affect its behavior. These parameters follow the modifier name and are separated by a : (colon). Also, all php-functions can be used as modifiers implicitly (more below) and modifiers can be combined.

    "},{"location":"designers/language-modifiers/#examples","title":"Examples","text":"
    {* apply modifier to a variable *}\n{$title|upper}\n\n{* modifier with parameters *}\n{$title|truncate:40:\"...\"}\n\n{* apply modifier to a function parameter *}\n{html_table loop=$myvar|upper}\n\n{* with parameters *}\n{html_table loop=$myvar|truncate:40:\"...\"}\n\n{* apply modifier to literal string *}\n{\"foobar\"|upper}\n\n{* using date_format to format the current date *}\n{$smarty.now|date_format:\"%Y/%m/%d\"}\n\n{* apply modifier to a custom function *}\n{mailto|upper address=\"smarty@example.com\"}\n\n{* using  php's str_repeat *}\n{\"=\"|str_repeat:80}\n\n{* php's count *}\n{$myArray|@count}\n\n{* this will uppercase and truncate the whole array *}\n<select name=\"name_id\">\n{html_options output=$my_array|upper|truncate:20}\n</select>\n

    See also registerPlugin(), combining modifiers. and extending smarty with plugins

    "},{"location":"designers/language-modifiers/language-modifier-capitalize/","title":"capitalize","text":"

    This is used to capitalize the first letter of all words in a variable. This is similar to the PHP ucwords() function.

    "},{"location":"designers/language-modifiers/language-modifier-capitalize/#basic-usage","title":"Basic usage","text":"
    {$myVar|capitalize}\n
    "},{"location":"designers/language-modifiers/language-modifier-capitalize/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 boolean No This determines whether or not words with digits will be uppercased 2 boolean No This determines whether or not Capital letters within words should be lowercased, e.g. \"aAa\" to \"Aaa\""},{"location":"designers/language-modifiers/language-modifier-capitalize/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'next x-men film, x3, delayed.');\n

    Where the template is:

        {$articleTitle}\n    {$articleTitle|capitalize}\n    {$articleTitle|capitalize:true}\n

    Will output:

        next x-men film, x3, delayed.\n    Next X-Men Film, x3, Delayed.\n    Next X-Men Film, X3, Delayed.\n

    See also lower and upper

    "},{"location":"designers/language-modifiers/language-modifier-cat/","title":"cat","text":"

    This value is concatenated to the given variable.

    "},{"location":"designers/language-modifiers/language-modifier-cat/#basic-usage","title":"Basic usage","text":"
    {$myVar|cat:' units'}\n
    "},{"location":"designers/language-modifiers/language-modifier-cat/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 string No This value to concatenate to the given variable."},{"location":"designers/language-modifiers/language-modifier-cat/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', \"Psychics predict world didn't end\");\n

    Where template is:

        {$articleTitle|cat:' yesterday.'}\n

    Will output:

        Psychics predict world didn't end yesterday.\n
    "},{"location":"designers/language-modifiers/language-modifier-count-characters/","title":"count_characters","text":"

    This is used to count the number of characters in a variable.

    "},{"location":"designers/language-modifiers/language-modifier-count-characters/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_characters}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-characters/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 boolean No This determines whether to include whitespace characters in the count."},{"location":"designers/language-modifiers/language-modifier-count-characters/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.');\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_characters}\n    {$articleTitle|count_characters:true}\n

    Will output:

        Cold Wave Linked to Temperatures.\n    29\n    33\n

    See also count_words, count_sentences and count_paragraphs.

    "},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/","title":"count_paragraphs","text":"

    This is used to count the number of paragraphs in a variable.

    "},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_paragraphs}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle',\n                     \"War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\\n\\n\n                     Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\"\n                    );\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_paragraphs}\n

    Will output:

        War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\n    Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\n    2\n

    See also count_characters, count_sentences and count_words.

    "},{"location":"designers/language-modifiers/language-modifier-count-sentences/","title":"count_sentences","text":"

    This is used to count the number of sentences in a variable. A sentence being delimited by a dot, question- or exclamation-mark (.?!).

    "},{"location":"designers/language-modifiers/language-modifier-count-sentences/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_sentences}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-sentences/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle',\n                     'Two Soviet Ships Collide - One Dies.\n                     Enraged Cow Injures Farmer with Axe.'\n                     );\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_sentences}\n

    Will output:

        Two Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe.\n    2\n

    See also count_characters, count_paragraphs and count_words.

    "},{"location":"designers/language-modifiers/language-modifier-count-words/","title":"count_words","text":"

    This is used to count the number of words in a variable.

    "},{"location":"designers/language-modifiers/language-modifier-count-words/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_words}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-words/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_words}\n

    This will output:

        Dealers Will Hear Car Talk at Noon.\n    7\n

    See also count_characters, count_paragraphs and count_sentences.

    "},{"location":"designers/language-modifiers/language-modifier-date-format/","title":"date_format","text":"

    This formats a date and time into the given strftime() format. Dates can be passed to Smarty as unix timestamps, DateTime objects, mysql timestamps or any string made up of month day year, parsable by php\\'s strtotime(). Designers can then use date_format to have complete control of the formatting of the date. If the date passed to date_format is empty and a second parameter is passed, that will be used as the date to format.

    "},{"location":"designers/language-modifiers/language-modifier-date-format/#basic-usage","title":"Basic usage","text":"
    {$myVar|date_format:\"%Y-%m-%d\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-date-format/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 string No %b %e, %Y This is the format for the outputted date. 2 string No n/a This is the default date if the input is empty.

    Note

    Since Smarty-2.6.10 numeric values passed to date_format are always (except for mysql timestamps, see below) interpreted as a unix timestamp.

    Before Smarty-2.6.10 numeric strings that where also parsable by strtotime() in php (like YYYYMMDD) where sometimes (depending on the underlying implementation of strtotime()) interpreted as date strings and NOT as timestamps.

    The only exception are mysql timestamps: They are also numeric only and 14 characters long (YYYYMMDDHHMMSS), mysql timestamps have precedence over unix timestamps.

    Note

    date_format is essentially a wrapper to PHP's strftime() function. You may have more or less conversion specifiers available depending on your system's strftime() function where PHP was compiled. Check your system\\'s manpage for a full list of valid specifiers. However, a few of the specifiers are emulated on Windows. These are: %D, %e, %h, %l, %n, %r, %R, %t, %T.

    "},{"location":"designers/language-modifiers/language-modifier-date-format/#examples","title":"Examples","text":"
    <?php\n\n$config['date'] = '%I:%M %p';\n$config['time'] = '%H:%M:%S';\n$smarty->assign('config', $config);\n$smarty->assign('yesterday', strtotime('-1 day'));\n

    This template uses $smarty.now to get the current time:

    {$smarty.now|date_format}\n{$smarty.now|date_format:\"%D\"}\n{$smarty.now|date_format:$config.date}\n{$yesterday|date_format}\n{$yesterday|date_format:\"%A, %B %e, %Y\"}\n{$yesterday|date_format:$config.time}\n

    This above will output:

    Jan 1, 2022\n01/01/22\n02:33 pm\nDec 31, 2021\nMonday, December 1, 2021\n14:33:00\n
    "},{"location":"designers/language-modifiers/language-modifier-date-format/#conversion-specifiers","title":"Conversion specifiers","text":"

    date_format conversion specifiers:

    See also $smarty.now, strftime(), {html_select_date} and the date tips page.

    "},{"location":"designers/language-modifiers/language-modifier-default/","title":"default","text":"

    This is used to set a default value for a variable. If the variable is unset or an empty string, the given default value is printed instead. Default takes the one argument.

    "},{"location":"designers/language-modifiers/language-modifier-default/#basic-usage","title":"Basic usage","text":"
    {$myVar|default:\"(none)\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-default/#parameters","title":"Parameters","text":"Parameter Type Required Default Description 1 string No empty This is the default value to output if the variable is empty."},{"location":"designers/language-modifiers/language-modifier-default/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n    $smarty->assign('email', '');\n

    Where template is:

    {$articleTitle|default:'no title'}\n{$myTitle|default:'no title'}\n{$email|default:'No email address available'}\n

    Will output:

    Dealers Will Hear Car Talk at Noon.\nno title\nNo email address available\n

    See also the default variable handling and the blank variable handling pages.

    "},{"location":"designers/language-modifiers/language-modifier-escape/","title":"escape","text":"

    escape is used to encode or escape a variable to html, url, single quotes, hex, hexentity, javascript and mail. By default its html.

    "},{"location":"designers/language-modifiers/language-modifier-escape/#basic-usage","title":"Basic usage","text":"
    {$myVar|escape}\n
    "},{"location":"designers/language-modifiers/language-modifier-escape/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No html, htmlall, url, urlpathinfo, quotes, hex, hexentity, javascript, mail html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to htmlentities() et. al. 3 boolean No FALSE TRUE Double encode entities from & to &amp; (applies to html and htmlall only)"},{"location":"designers/language-modifiers/language-modifier-escape/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"'Stiff Opposition Expected to Casketless Funeral Plan'\"\n                );\n$smarty->assign('EmailAddress','smarty@example.com');\n

    These are example escape template lines followed by the output

    {$articleTitle}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape}\n&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;\n\n{$articleTitle|escape:'html'}    {* escapes  & \" ' < > *}\n&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;\n\n{$articleTitle|escape:'htmlall'} {* escapes ALL html entities *}\n&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;\n\n<a href=\"?title={$articleTitle|escape:'url'}\">click here</a>\n<a\nhref=\"?title=%27Stiff%20Opposition%20Expected%20to%20Casketless%20Funeral%20Plan%27\">click here</a>\n\n{$articleTitle|escape:'quotes'}\n\\'Stiff Opposition Expected to Casketless Funeral Plan\\'\n\n<a href=\"mailto:{$EmailAddress|escape:\"hex\"}\">{$EmailAddress|escape:\"hexentity\"}</a>\n{$EmailAddress|escape:'mail'}    {* this converts to email to text *}\n<a href=\"mailto:%62%6f%..snip..%65%74\">&#x62;&#x6f;&#x62..snip..&#x65;&#x74;</a>\n\n{'mail@example.com'|escape:'mail'}\nsmarty [AT] example [DOT] com\n\n{* the \"rewind\" parameter registers the current location *}\n<a href=\"$my_path?page=foo&rewind={$my_uri|escape:url}\">click here</a>\n

    This snippet is useful for emails, but see also {mailto}

    {* email address mangled *}\n<a href=\"mailto:{$EmailAddress|escape:'hex'}\">{$EmailAddress|escape:'mail'}</a>\n

    See also escaping smarty parsing, {mailto} and the obfuscating email addresses page.

    "},{"location":"designers/language-modifiers/language-modifier-from-charset/","title":"from_charset","text":"

    from_charset is used to transcode a string from a given charset to the internal charset. This is the exact opposite of the to_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-from-charset/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be decoded from

    Note

    Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.

    See also Charset Encoding, to_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-indent/","title":"indent","text":"

    This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to indent with. For example: use \"\\t\" for a tab.

    "},{"location":"designers/language-modifiers/language-modifier-indent/#basic-usage","title":"Basic usage","text":"
    {$myVar|indent:4}\n
    "},{"location":"designers/language-modifiers/language-modifier-indent/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 integer No 4 This determines how many characters to indent to. 2 string No (one space) This is the character used to indent with."},{"location":"designers/language-modifiers/language-modifier-indent/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                'NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.'\n                );\n

    Where template is:

    {$articleTitle}\n\n{$articleTitle|indent}\n\n{$articleTitle|indent:10}\n\n{$articleTitle|indent:1:\"\\t\"}\n

    Will output:

    NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.\n\n    NJ judge to rule on nude beach.\n    Sun or rain expected today, dark tonight.\n    Statistics show that teen pregnancy drops off significantly after 25.\n\n          NJ judge to rule on nude beach.\n          Sun or rain expected today, dark tonight.\n          Statistics show that teen pregnancy drops off significantly after 25.\n\n        NJ judge to rule on nude beach.\n        Sun or rain expected today, dark tonight.\n        Statistics show that teen pregnancy drops off significantly after 25.\n

    See also strip, wordwrap and spacify.

    "},{"location":"designers/language-modifiers/language-modifier-lower/","title":"lower","text":"

    This is used to lowercase a variable. This is equivalent to the PHP strtolower() function.

    "},{"location":"designers/language-modifiers/language-modifier-lower/#basic-usage","title":"Basic usage","text":"
    {$myVar|lower}\n
    "},{"location":"designers/language-modifiers/language-modifier-lower/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');\n

    Where template is:

    {$articleTitle}\n{$articleTitle|lower}\n

    This will output:

    Two Convicts Evade Noose, Jury Hung.\ntwo convicts evade noose, jury hung.\n

    See also upper and capitalize.

    "},{"location":"designers/language-modifiers/language-modifier-nl2br/","title":"nl2br","text":"

    All \"\\n\" line breaks will be converted to html <br /> tags in the given variable. This is equivalent to the PHP\\'s nl2br() function.

    "},{"location":"designers/language-modifiers/language-modifier-nl2br/#basic-usage","title":"Basic usage","text":"
    {$myVar|nl2br}\n
    "},{"location":"designers/language-modifiers/language-modifier-nl2br/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Sun or rain expected\\ntoday, dark tonight\"\n                );\n

    Where the template is:

    {$articleTitle|nl2br}\n

    Will output:

    Sun or rain expected<br />today, dark tonight\n

    See also word_wrap, count_paragraphs and count_sentences.

    "},{"location":"designers/language-modifiers/language-modifier-regex-replace/","title":"regex_replace","text":"

    A regular expression search and replace on a variable. Use the preg_replace() syntax from the PHP manual.

    "},{"location":"designers/language-modifiers/language-modifier-regex-replace/#basic-usage","title":"Basic usage","text":"
    {$myVar|regex_replace:\"/foo/\":\"bar\"}\n

    Note

    Although Smarty supplies this regex convenience modifier, it is usually better to apply regular expressions in PHP, either via custom functions or modifiers. Regular expressions are considered application code and are not part of presentation logic.

    "},{"location":"designers/language-modifiers/language-modifier-regex-replace/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is the regular expression to be replaced. 2 string Yes This is the string of text to replace with."},{"location":"designers/language-modifiers/language-modifier-regex-replace/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', \"Infertility unlikely to\\nbe passed on, experts say.\");\n

    Where template is:

    {* replace each carriage return, tab and new line with a space *}\n\n{$articleTitle}\n{$articleTitle|regex_replace:\"/[\\r\\t\\n]/\":\" \"}\n

    Will output:

    Infertility unlikely to\nbe passed on, experts say.\nInfertility unlikely to be passed on, experts say.\n

    See also replace and escape.

    "},{"location":"designers/language-modifiers/language-modifier-replace/","title":"replace","text":"

    A simple search and replace on a variable. This is equivalent to the PHP's str_replace() function.

    "},{"location":"designers/language-modifiers/language-modifier-replace/#basic-usage","title":"Basic usage","text":"
    {$myVar|replace:\"foo\":\"bar\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-replace/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is the string of text to be replaced. 2 string Yes This is the string of text to replace with."},{"location":"designers/language-modifiers/language-modifier-replace/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', \"Child's Stool Great for Use in Garden.\");\n

    Where template is:

    {$articleTitle}\n{$articleTitle|replace:'Garden':'Vineyard'}\n{$articleTitle|replace:' ':'   '}\n

    Will output:

    Child's Stool Great for Use in Garden.\nChild's Stool Great for Use in Vineyard.\nChild's   Stool   Great   for   Use   in   Garden.\n

    See also regex_replace and escape.

    "},{"location":"designers/language-modifiers/language-modifier-spacify/","title":"spacify","text":"

    spacify is a way to insert a space between every character of a variable. You can optionally pass a different character or string to insert.

    "},{"location":"designers/language-modifiers/language-modifier-spacify/#basic-usage","title":"Basic usage","text":"
    {$myVar|spacify}\n
    "},{"location":"designers/language-modifiers/language-modifier-spacify/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 string No one space This what gets inserted between each character of the variable."},{"location":"designers/language-modifiers/language-modifier-spacify/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.');\n

    Where template is:

    {$articleTitle}\n{$articleTitle|spacify}\n{$articleTitle|spacify:\"^^\"}\n

    Will output:

    Something Went Wrong in Jet Crash, Experts Say.\nS o m e t h i n g   W .... snip ....  s h ,   E x p e r t s   S a y .\nS^^o^^m^^e^^t^^h^^i^^n^^g^^ .... snip .... ^^e^^r^^t^^s^^ ^^S^^a^^y^^.\n

    See also wordwrap and nl2br.

    "},{"location":"designers/language-modifiers/language-modifier-string-format/","title":"string_format","text":"

    This is a way to format strings, such as decimal numbers and such. Use the syntax for sprintf() for the formatting.

    "},{"location":"designers/language-modifiers/language-modifier-string-format/#basic-usage","title":"Basic usage","text":"
    {$myVar|string_format:\"%d\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-string-format/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is what format to use. (sprintf)"},{"location":"designers/language-modifiers/language-modifier-string-format/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('number', 23.5787446);\n

    Where template is:

    {$number}\n{$number|string_format:\"%.2f\"}\n{$number|string_format:\"%d\"}\n

    Will output:

    23.5787446\n23.58\n23\n

    See also date_format.

    "},{"location":"designers/language-modifiers/language-modifier-strip-tags/","title":"strip_tags","text":"

    This strips out HTML markup tags, basically anything between < and >.

    "},{"location":"designers/language-modifiers/language-modifier-strip-tags/#basic-usage","title":"Basic usage","text":"
    {$myVar|strip_tags}\n
    "},{"location":"designers/language-modifiers/language-modifier-strip-tags/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 bool No TRUE This determines whether the tags are replaced by ' ' or ''"},{"location":"designers/language-modifiers/language-modifier-strip-tags/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Blind Woman Gets <font face=\\\"helvetica\\\">New\nKidney</font> from Dad she Hasn't Seen in <b>years</b>.\"\n               );\n

    Where template is:

    {$articleTitle}\n{$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *}\n{$articleTitle|strip_tags:false}\n

    Will output:

    Blind Woman Gets <font face=\"helvetica\">New Kidney</font> from Dad she Hasn't Seen in <b>years</b>.\nBlind Woman Gets  New Kidney  from Dad she Hasn't Seen in  years .\nBlind Woman Gets New Kidney from Dad she Hasn't Seen in years.\n

    See also replace and regex_replace.

    "},{"location":"designers/language-modifiers/language-modifier-strip/","title":"strip","text":"

    This replaces all spaces, newlines and tabs with a single space, or with the supplied string.

    "},{"location":"designers/language-modifiers/language-modifier-strip/#basic-usage","title":"Basic usage","text":"
    {$myVar|strip}\n

    Note

    If you want to strip blocks of template text, use the built-in {strip} function.

    "},{"location":"designers/language-modifiers/language-modifier-strip/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('articleTitle', \"Grandmother of\\neight makes\\t    hole in one.\");\n$smarty->display('index.tpl');\n

    Where template is:

    {$articleTitle}\n{$articleTitle|strip}\n{$articleTitle|strip:'&nbsp;'}\n

    Will output:

    Grandmother of\neight makes        hole in one.\nGrandmother of eight makes hole in one.\nGrandmother&nbsp;of&nbsp;eight&nbsp;makes&nbsp;hole&nbsp;in&nbsp;one.\n

    See also {strip} and truncate.

    "},{"location":"designers/language-modifiers/language-modifier-to-charset/","title":"to_charset","text":"

    to_charset is used to transcode a string from the internal charset to a given charset. This is the exact opposite of the from_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-to-charset/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be encoded to

    Note

    Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.

    See also Charset Encoding, from_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-truncate/","title":"truncate","text":"

    This truncates a variable to a character length, the default is 80. As an optional second parameter, you can specify a string of text to display at the end if the variable was truncated. The characters in the string are included with the original truncation length. By default, truncate will attempt to cut off at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter of TRUE.

    "},{"location":"designers/language-modifiers/language-modifier-truncate/#basic-usage","title":"Basic usage","text":"
    {$myVar|truncate:40:\"...\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-truncate/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 integer No 80 This determines how many characters to truncate to. 2 string No ... This is a text string that replaces the truncated text. Its length is included in the truncation length setting. 3 boolean No FALSE This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE. 4 boolean No FALSE This determines whether the truncation happens at the end of the string with FALSE, or in the middle of the string with TRUE. Note that if this setting is TRUE, then word boundaries are ignored."},{"location":"designers/language-modifiers/language-modifier-truncate/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');\n

    where template is:

    {$articleTitle}\n{$articleTitle|truncate}\n{$articleTitle|truncate:30}\n{$articleTitle|truncate:30:\"\"}\n{$articleTitle|truncate:30:\"---\"}\n{$articleTitle|truncate:30:\"\":true}\n{$articleTitle|truncate:30:\"...\":true}\n{$articleTitle|truncate:30:'..':true:true}\n

    This will output:

    Two Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after...\nTwo Sisters Reunite after\nTwo Sisters Reunite after---\nTwo Sisters Reunite after Eigh\nTwo Sisters Reunite after E...\nTwo Sisters Re..ckout Counter.\n
    "},{"location":"designers/language-modifiers/language-modifier-unescape/","title":"unescape","text":"

    unescape is used to decode entity, html and htmlall. It counters the effects of the escape modifier for the given types.

    "},{"location":"designers/language-modifiers/language-modifier-unescape/#basic-usage","title":"Basic usage","text":"
    {$myVar|unescape}\n
    "},{"location":"designers/language-modifiers/language-modifier-unescape/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No html, htmlall, entity, html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to html_entity_decode() or htmlspecialchars_decode() or mb_convert_encoding() et. al."},{"location":"designers/language-modifiers/language-modifier-unescape/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Germans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro\"\n                );\n

    These are example unescape template lines followed by the output

    {$articleTitle}\nGermans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro\n\n{$articleTitle|unescape:\"html\"}\nGermans use \"&Uuml;mlauts\" and pay in &euro;uro\n\n{$articleTitle|unescape:\"htmlall\"}\nGermans use \"\u00dcmlauts\" and pay in \u20acuro\n

    See also escaping smarty parsing, escape modifier.

    "},{"location":"designers/language-modifiers/language-modifier-upper/","title":"upper","text":"

    This is used to uppercase a variable. This is equivalent to the PHP strtoupper() function.

    "},{"location":"designers/language-modifiers/language-modifier-upper/#basic-usage","title":"Basic usage","text":"
    {$myVar|upper}\n
    "},{"location":"designers/language-modifiers/language-modifier-upper/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('articleTitle', \"If Strike isn't Settled Quickly it may Last a While.\");\n

    Where template is:

    {$articleTitle}\n{$articleTitle|upper}\n

    Will output:

    If Strike isn't Settled Quickly it may Last a While.\nIF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE.\n

    See also lower and capitalize.

    "},{"location":"designers/language-modifiers/language-modifier-wordwrap/","title":"wordwrap","text":"

    Wraps a string to a column width, the default is 80. As an optional second parameter, you can specify a string of text to wrap the text to the next line, the default is a carriage return \"\\n\". By default, wordwrap will attempt to wrap at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter as TRUE. This is equivalent to the PHP wordwrap() function.

    "},{"location":"designers/language-modifiers/language-modifier-wordwrap/#basic-usage","title":"Basic usage","text":"
    {$myVar|wordwrap:30}\n
    "},{"location":"designers/language-modifiers/language-modifier-wordwrap/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 integer No 80 This determines how many columns to wrap to. 2 string No \\n This is the string used to wrap words with. 3 boolean No FALSE This determines whether to wrap at a word boundary (FALSE), or at the exact character (TRUE)."},{"location":"designers/language-modifiers/language-modifier-wordwrap/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Blind woman gets new kidney from dad she hasn't seen in years.\"\n               );\n

    Where template is

    {$articleTitle}\n\n{$articleTitle|wordwrap:30}\n\n{$articleTitle|wordwrap:20}\n\n{$articleTitle|wordwrap:30:\"<br />\\n\"}\n\n{$articleTitle|wordwrap:26:\"\\n\":true}\n

    Will output:

    Blind woman gets new kidney from dad she hasn't seen in years.\n\nBlind woman gets new kidney\nfrom dad she hasn't seen in\nyears.\n\nBlind woman gets new\nkidney from dad she\nhasn't seen in\nyears.\n\nBlind woman gets new kidney<br />\nfrom dad she hasn't seen in<br />\nyears.\n\nBlind woman gets new kidn\ney from dad she hasn't se\nen in years.\n

    See also nl2br and {textformat}.

    "},{"location":"designers/language-variables/","title":"Variables","text":"

    Smarty has several 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, attributes and modifiers, inside conditional expressions, etc. To print a variable, simply enclose it in the delimiters so that it is the only thing contained between them.

    {$Name}\n\n{$product.part_no} <b>{$product.description}</b>\n\n{$Contacts[row].Phone}\n\n<body bgcolor=\"{#bgcolor#}\">\n
    "},{"location":"designers/language-variables/#scopes","title":"Scopes","text":"

    You can assign variables to specific variable scopes.

    Note

    An easy way to examine assigned Smarty variables is with the debugging console.

    "},{"location":"designers/language-variables/language-assigned-variables/","title":"Variables assigned from PHP","text":"

    Variables assigned from PHP are referenced by preceding them with a dollar ($) sign.

    "},{"location":"designers/language-variables/language-assigned-variables/#examples","title":"Examples","text":"
    <?php\n\n$smarty = new Smarty();\n\n$smarty->assign('firstname', 'Doug');\n$smarty->assign('lastname', 'Evans');\n$smarty->assign('meetingPlace', 'New York');\n\n$smarty->display('index.tpl');\n

    index.tpl source:

    Hello {$firstname} {$lastname}, glad to see you can make it.\n<br />\n{* this will not work as $variables are case sensitive *}\nThis weeks meeting is in {$meetingplace}.\n{* this will work *}\nThis weeks meeting is in {$meetingPlace}.\n

    This above would output:

    Hello Doug Evans, glad to see you can make it.\n<br />\nThis weeks meeting is in .\nThis weeks meeting is in New York.\n
    "},{"location":"designers/language-variables/language-assigned-variables/#associative-arrays","title":"Associative arrays","text":"

    You can also reference associative array variables by specifying the key after a dot \".\" symbol.

    <?php\n$smarty->assign('Contacts',\n    array('fax' => '555-222-9876',\n          'email' => 'zaphod@slartibartfast.example.com',\n          'phone' => array('home' => '555-444-3333',\n                           'cell' => '555-111-1234')\n                           )\n         );\n$smarty->display('index.tpl');\n

    index.tpl source:

    {$Contacts.fax}<br />\n{$Contacts.email}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts.phone.home}<br />\n{$Contacts.phone.cell}<br />\n

    this will output:

    555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n
    "},{"location":"designers/language-variables/language-assigned-variables/#array-indexes","title":"Array indexes","text":"

    You can reference arrays by their index, much like native PHP syntax.

    <?php\n$smarty->assign('Contacts', array(\n                           '555-222-9876',\n                           'zaphod@slartibartfast.example.com',\n                            array('555-444-3333',\n                                  '555-111-1234')\n                            ));\n$smarty->display('index.tpl');\n

    index.tpl source:

    {$Contacts[0]}<br />\n{$Contacts[1]}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts[2][0]}<br />\n{$Contacts[2][1]}<br />\n

    This will output:

    555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n
    "},{"location":"designers/language-variables/language-assigned-variables/#objects","title":"Objects","text":"

    Properties of objects assigned from PHP can be referenced by specifying the property name after the -> symbol.

    name:  {$person->name}<br />\nemail: {$person->email}<br />\n

    this will output:

    name:  Zaphod Beeblebrox<br />\nemail: zaphod@slartibartfast.example.com<br />\n
    "},{"location":"designers/language-variables/language-config-variables/","title":"Variables loaded from config files","text":"

    Variables that are loaded from the config files are referenced by enclosing them within #hash_marks#, or with the smarty variable $smarty.config. The later syntax is useful for embedding into quoted attribute values, or accessing variable values such as $smarty.config.$foo.

    "},{"location":"designers/language-variables/language-config-variables/#examples","title":"Examples","text":"

    Example config file - foo.conf: 

    pageTitle = \"This is mine\"\nbodyBgColor = '#eeeeee'\ntableBorderSize = 3\ntableBgColor = \"#bbbbbb\"\nrowBgColor = \"#cccccc\"\n

    A template demonstrating the #hash# method:

    {config_load file='foo.conf'}\n<html>\n    <title>{#pageTitle#}</title>\n    <body bgcolor=\"{#bodyBgColor#}\">\n        <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n            <tr bgcolor=\"{#rowBgColor#}\">\n                <td>First</td>\n                <td>Last</td>\n                <td>Address</td>\n            </tr>\n        </table>\n    </body>\n</html>\n

    A template demonstrating the $smarty.config method:

    {config_load file='foo.conf'}\n<html>\n<title>{$smarty.config.pageTitle}</title>\n    <body bgcolor=\"{$smarty.config.bodyBgColor}\">\n        <table border=\"{$smarty.config.tableBorderSize}\" bgcolor=\"{$smarty.config.tableBgColor}\">\n            <tr bgcolor=\"{$smarty.config.rowBgColor}\">\n                <td>First</td>\n                <td>Last</td>\n                <td>Address</td>\n            </tr>\n        </table>\n    </body>\n</html>\n

    Both examples would output:

    <html>\n    <title>This is mine</title>\n    <body bgcolor=\"#eeeeee\">\n        <table border=\"3\" bgcolor=\"#bbbbbb\">\n            <tr bgcolor=\"#cccccc\">\n                <td>First</td>\n                <td>Last</td>\n                <td>Address</td>\n            </tr>\n        </table>\n    </body>\n</html>\n

    Config file variables cannot be used until after they are loaded in from a config file. This procedure is explained later in this document under {config_load}.

    See also variables and $smarty reserved variables.

    "},{"location":"designers/language-variables/language-variable-scopes/","title":"Variable scopes","text":"

    You have the choice to assign variables to the scope of the main Smarty object, data objects created with createData(), and template objects created with createTemplate(). These objects can be chained. A template sees all the variables of its own object and all variables assigned to the objects in its chain of parent objects.

    By default, templates which are rendered by $smarty->display(...) or $smarty->fetch(...) calls are automatically linked to the Smarty object variable scope.

    By assigning variables to individual data or template objects you have full control which variables can be seen by a template.

    <?php\n// assign variable to Smarty object scope\n$smarty->assign('foo','smarty');\n\n// assign variables to data object scope\n$data = $smarty->createData();\n$data->assign('foo','data');\n$data->assign('bar','bar-data');\n\n// assign variables to other data object scope\n$data2 = $smarty->createData($data);\n$data2->assign('bar','bar-data2');\n\n// assign variable to template object scope\n$tpl = $smarty->createTemplate('index.tpl');\n$tpl->assign('bar','bar-template');\n\n// assign variable to template object scope with link to Smarty object\n$tpl2 = $smarty->createTemplate('index.tpl',$smarty);\n$tpl2->assign('bar','bar-template2');\n\n// This display() does see $foo='smarty' from the $smarty object\n$smarty->display('index.tpl');\n\n// This display() does see $foo='data' and $bar='bar-data' from the data object $data\n$smarty->display('index.tpl',$data);\n\n// This display() does see $foo='data' from the data object $data \n// and $bar='bar-data2' from the data object $data2\n$smarty->display('index.tpl',$data2);\n\n// This display() does see $bar='bar-template' from the template object $tpl\n$tpl->display();  // or $smarty->display($tpl);\n\n// This display() does see $bar='bar-template2' from the template object $tpl2\n// and $foo='smarty' form the Smarty object $foo\n$tpl2->display();  // or $smarty->display($tpl2);\n

    See also assign(), createData() and createTemplate().

    "},{"location":"designers/language-variables/language-variables-smarty/","title":"{$smarty} reserved variable","text":"

    The PHP reserved {$smarty} variable can be used to access several environment and request variables. The full list of them follows.

    "},{"location":"designers/language-variables/language-variables-smarty/#request-variables","title":"Request variables","text":"

    The request variables such as $_GET, $_POST, $_COOKIE, $_SERVER, $_ENV and $_SESSION can be accessed as demonstrated in the examples below:

    {* display value of page from URL ($_GET) http://www.example.com/index.php?page=foo *}\n{$smarty.get.page}\n\n{* display the variable \"page\" from a form ($_POST['page']) *}\n{$smarty.post.page}\n\n{* display the value of the cookie \"username\" ($_COOKIE['username']) *}\n{$smarty.cookies.username}\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\n{* display the system environment variable \"PATH\" *}\n{$smarty.env.PATH}\n\n{* display the php session variable \"id\" ($_SESSION['id']) *}\n{$smarty.session.id}\n\n{* display the variable \"username\" from merged get/post/cookies/server/env *}\n{$smarty.request.username}\n

    Note

    For historical reasons {$SCRIPT_NAME} is shorthand for {$smarty.server.SCRIPT_NAME}.

    <a href=\"{$SCRIPT_NAME}?page=smarty\">click me</a>\n<a href=\"{$smarty.server.SCRIPT_NAME}?page=smarty\">click me</a>\n

    Note

    Although Smarty provides direct access to PHP super globals for convenience, it should be used with caution. Directly accessing super globals mixes underlying application code structure with templates. A good practice is to assign specific needed values to template vars.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartynow","title":"{$smarty.now}","text":"

    The current timestamp can be accessed with {$smarty.now}. The value reflects the number of seconds passed since the so-called Epoch on January 1, 1970, and can be passed directly to the date_format modifier for display. Note that time() is called on each invocation; eg a script that takes three seconds to execute with a call to $smarty.now at start and end will show the three-second difference.

    {* use the date_format modifier to show current date and time *}\n{$smarty.now|date_format:'%Y-%m-%d %H:%M:%S'}\n
    "},{"location":"designers/language-variables/language-variables-smarty/#smartyconst","title":"{$smarty.const}","text":"

    You can access PHP constant values directly. See also smarty constants.

    <?php\n// the constant defined in php\ndefine('MY_CONST_VAL','CHERRIES');\n

    Output the constant in a template with

    {$smarty.const.MY_CONST_VAL}\n

    Note

    Although Smarty provides direct access to PHP constants for convenience, it is typically avoided as this is mixing underlying application code structure into the templates. A good practice is to assign specific needed values to template vars.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartycapture","title":"{$smarty.capture}","text":"

    Template output captured via the built-in {capture}..{/capture} function can be accessed using the {$smarty.capture} variable. See the {capture} page for more information.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyconfig","title":"{$smarty.config}","text":"

    {$smarty.config} variable can be used to refer to loaded config variables. {$smarty.config.foo} is a synonym for {#foo#}. See the {config_load} page for more info.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartysection","title":"{$smarty.section}","text":"

    The {$smarty.section} variables can be used to refer to {section} loop properties. These have some very useful values such as .first, .index, etc.

    Note

    The {$smarty.foreach} variable is no longer used with the new {foreach} syntax, but is still supported with Smarty 2.x style foreach syntax.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartytemplate","title":"{$smarty.template}","text":"

    Returns the name of the current template being processed (without the directory).

    "},{"location":"designers/language-variables/language-variables-smarty/#smartytemplate_object","title":"{$smarty.template_object}","text":"

    Returns the template object of the current template being processed.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartycurrent_dir","title":"{$smarty.current_dir}","text":"

    Returns the name of the directory for the current template being processed if it is loaded from the filesystem (the default).

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyversion","title":"{$smarty.version}","text":"

    Returns the version of Smarty the template was compiled with.

    <div id=\"footer\">Powered by Smarty {$smarty.version}</div>\n
    "},{"location":"designers/language-variables/language-variables-smarty/#smartyblockchild","title":"{$smarty.block.child}","text":"

    Returns block text from child template. See Template inheritance.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyblockparent","title":"{$smarty.block.parent}","text":"

    Returns block text from parent template. See Template inheritance

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyldelim-smartyrdelim","title":"{$smarty.ldelim}, {$smarty.rdelim}","text":"

    These variables are used for printing the left-delimiter and right-delimiter value literally, the same as {ldelim},{rdelim}.

    See also assigned variables and config variables

    "},{"location":"programmers/advanced-features/","title":"Advanced Features {#advanced.features}","text":""},{"location":"programmers/advanced-features/#table-of-contents","title":"Table of contents","text":""},{"location":"programmers/api-functions/","title":"Smarty Class Methods {#api.functions}","text":""},{"location":"programmers/api-functions/#table-of-contents","title":"Table of contents","text":"

    Note

    See Changing settings by template section for how to use the functions for individual templates.

    "},{"location":"programmers/api-variables/","title":"Smarty Class Variables {#api.variables}","text":"

    These are all of the available Smarty class variables. You can access them directly, or use the corresponding setter/getter methods.

    Note

    All class variables have magic setter/getter methods available. setter/getter methods are camelCaseFormat, unlike the variable itself. So for example, you can set and get the \\$smarty->template_dir variable with \\$smarty->setTemplateDir(\\$dir) and \\$dir = \\$smarty->getTemplateDir() respectively.

    Note

    See Changing settings by template section for how to change Smarty class variables for individual templates.

    "},{"location":"programmers/caching/","title":"Caching","text":"

    Caching is used to speed up a call to display() or fetch() by saving its output to a file. If a cached version of the call is available, that is displayed instead of regenerating the output. Caching can speed things up tremendously, especially templates with longer computation times. Since the output of display() or fetch() is cached, one cache file could conceivably be made up of several template files, config files, etc.

    Since templates are dynamic, it is important to be careful what you are caching and for how long. For instance, if you are displaying the front page of your website that does not change its content very often, it might work well to cache this page for an hour or more. On the other hand, if you are displaying a page with a timetable containing new information by the minute, it would not make sense to cache this page.

    "},{"location":"programmers/caching/#table-of-contents","title":"Table of contents","text":""},{"location":"programmers/charset/","title":"Charset Encoding {#charset}","text":""},{"location":"programmers/charset/#charset-encoding-charsetencoding","title":"Charset Encoding {#charset.encoding}","text":"

    There are a variety of encodings for textual data, ISO-8859-1 (Latin1) and UTF-8 being the most popular. Unless you change Smarty::$_CHARSET, Smarty recognizes UTF-8 as the internal charset if Multibyte String is available, ISO-8859-1 if not.

    Note

    ISO-8859-1 has been PHP\\'s default internal charset since the beginning. Unicode has been evolving since 1991. Since then it has become the one charset to conquer them all, as it is capable of encoding most of the known characters even across different character systems (latin, cyrillic, japanese, ...). UTF-8 is unicode\\'s most used encoding, as it allows referencing the thousands of character with the smallest size overhead possible.

    Since unicode and UTF-8 are very wide spread nowadays, their use is strongly encouraged.

    Note

    Smarty\\'s internals and core plugins are truly UTF-8 compatible since Smarty 3.1. To achieve unicode compatibility, the Multibyte String PECL is required. Unless your PHP environment offers this package, Smarty will not be able to offer full-scale UTF-8 compatibility.

    // use japanese character encoding\nif (function_exists('mb_internal_charset')) {\n  mb_internal_charset('EUC-JP');\n}\n\nrequire_once 'libs/Smarty.class.php';\nSmarty::$_CHARSET = 'EUC-JP';\n$smarty = new Smarty();\n
    "},{"location":"programmers/plugins/","title":"Extending Smarty With Plugins {#plugins}","text":""},{"location":"programmers/plugins/#table-of-contents","title":"Table of contents","text":"

    Version 2.0 introduced the plugin architecture that is used for almost all the customizable functionality of Smarty. This includes:

    With the exception of resources, backwards compatibility with the old way of registering handler functions via register_* API is preserved. If you did not use the API but instead modified the class variables $custom_funcs, $custom_mods, and other ones directly, then you will need to adjust your scripts to either use the API or convert your custom functionality into plugins.

    "},{"location":"programmers/resources/","title":"Resources","text":"

    The templates may come from a variety of sources. When you display() or fetch() a template, or when you include a template from within another template, you supply a resource type, followed by the appropriate path and template name. If a resource is not explicitly given, the value of $default_resource_type (default: \\\"file\\\") is assumed.

    "},{"location":"programmers/resources/#table-of-contents","title":"Table of contents","text":""},{"location":"programmers/smarty-constants/","title":"Constants {#smarty.constants}","text":""},{"location":"programmers/smarty-constants/#smarty_dir-constantsmartydir","title":"SMARTY_DIR {#constant.smarty.dir}","text":"

    This is the full system path to the location of the Smarty class files. If this is not defined in your script, then Smarty will attempt to determine the appropriate value automatically. If defined, the path must end with a trailing slash/.

    <?php\n// set path to Smarty directory *nix style\ndefine('SMARTY_DIR', '/usr/local/lib/php/Smarty-v.e.r/libs/');\n\n// path to Smarty windows style\ndefine('SMARTY_DIR', 'c:/webroot/libs/Smarty-v.e.r/libs/');\n\n// include the smarty class, note 'S' is upper case\nrequire_once(SMARTY_DIR . 'Smarty.class.php');\n?>\n

    See also $smarty.const.

    "},{"location":"programmers/advanced-features/advanced-features-objects/","title":"Objects {#advanced.features.objects}","text":"

    Smarty allows access to PHP objects through the templates.

    Note

    When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.

    There are two ways to access them.

    The first method has a much nicer template syntax. It is also more secure, as a registered object can be restricted to certain methods or properties. However, a registered object cannot be looped over or assigned in arrays of objects, etc. The method you choose will be determined by your needs, but use the first method whenever possible to keep template syntax to a minimum.

    If security is enabled, no private methods or functions can be accessed (beginning with \\'_\\'). If a method and property of the same name exist, the method will be used.

    You can restrict the methods and properties that can be accessed by listing them in an array as the third registration parameter.

    By default, parameters passed to objects through the templates are passed the same way custom functions get them. An associative array is passed as the first parameter, and the smarty object as the second. If you want the parameters passed one at a time for each argument like traditional object parameter passing, set the fourth registration parameter to FALSE.

    The optional fifth parameter has only effect with format being TRUE and contains a list of methods that should be treated as blocks. That means these methods have a closing tag in the template ({foobar->meth2}...{/foobar->meth2}) and the parameters to the methods have the same synopsis as the parameters for block-function-plugins: They get the four parameters $params, $content, $smarty and &$repeat and they also behave like block-function-plugins.

    <?php\n// the object\n\nclass My_Object {\n    function meth1($params, $smarty_obj) {\n        return 'this is my meth1';\n    }\n}\n\n$myobj = new My_Object;\n\n// registering the object (will be by reference)\n$smarty->registerObject('foobar',$myobj);\n\n// if we want to restrict access to certain methods or properties, list them\n$smarty->registerObject('foobar',$myobj,array('meth1','meth2','prop1'));\n\n// if you want to use the traditional object parameter format, pass a boolean of false\n$smarty->registerObject('foobar',$myobj,null,false);\n\n// We can also assign objects. assign_by_ref when possible.\n$smarty->assign_by_ref('myobj', $myobj);\n\n$smarty->display('index.tpl');\n?>\n

    And here\\'s how to access your objects in index.tpl:

    {* access our registered object *}\n{foobar->meth1 p1='foo' p2=$bar}\n\n{* you can also assign the output *}\n{foobar->meth1 p1='foo' p2=$bar assign='output'}\nthe output was {$output}\n\n{* access our assigned object *}\n{$myobj->meth1('foo',$bar)}\n

    See also registerObject() and assign().

    "},{"location":"programmers/advanced-features/advanced-features-outputfilters/","title":"Output Filters {#advanced.features.outputfilters}","text":"

    When the template is invoked via display() or fetch(), its output can be sent through one or more output filters. This differs from postfilters because postfilters operate on compiled templates before they are saved to the disk, whereas output filters operate on the template output when it is executed.

    Output filters can be either registered or loaded from the plugins directory by using the loadFilter() method or by setting the $autoload_filters variable. Smarty will pass the template output as the first argument, and expect the function to return the result of the processing.

    <?php\n// put this in your application\nfunction protect_email($tpl_output, Smarty_Internal_Template $template)\n{\n    $tpl_output =\n       preg_replace('!(\\S+)@([a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',\n                    '$1%40$2', $tpl_output);\n    return $tpl_output;\n}\n\n// register the outputfilter\n$smarty->registerFilter(\"output\",\"protect_email\");\n$smarty->display(\"index.tpl');\n\n// now any occurrence of an email address in the template output will have\n// a simple protection against spambots\n?>\n

    See also registerFilter(), loadFilter(), $autoload_filters, postfilters and $plugins_dir.

    "},{"location":"programmers/advanced-features/advanced-features-postfilters/","title":"Postfilters {#advanced.features.postfilters}","text":"

    Template postfilters are PHP functions that your templates are ran through after they are compiled. Postfilters can be either registered or loaded from the plugins directory by using the loadFilter() function or by setting the $autoload_filters variable. Smarty will pass the compiled template code as the first argument, and expect the function to return the result of the processing.

    <?php\n// put this in your application\nfunction add_header_comment($tpl_source, Smarty_Internal_Template $template)\n{\n    return \"<?php echo \\\"<!-- Created by Smarty! -->\\n\\\"; ?>\\n\".$tpl_source;\n}\n\n// register the postfilter\n$smarty->registerFilter('post','add_header_comment');\n$smarty->display('index.tpl');\n?>\n

    The postfilter above will make the compiled Smarty template index.tpl look like:

    <!-- Created by Smarty! -->\n{* rest of template content... *}\n

    See also registerFilter(), prefilters, outputfilters, and loadFilter().

    "},{"location":"programmers/advanced-features/advanced-features-prefilters/","title":"Prefilters {#advanced.features.prefilters}","text":"

    Template prefilters are PHP functions that your templates are ran through before they are compiled. This is good for preprocessing your templates to remove unwanted comments, keeping an eye on what people are putting in their templates, etc.

    Prefilters can be either registered or loaded from the plugins directory by using loadFilter() function or by setting the $autoload_filters variable.

    Smarty will pass the template source code as the first argument, and expect the function to return the resulting template source code.

    This will remove all the html comments in the template source.

    <?php\n// put this in your application\nfunction remove_dw_comments($tpl_source, Smarty_Internal_Template $template)\n{\n    return preg_replace(\"/<!--#.*-->/U\",'',$tpl_source);\n}\n\n// register the prefilter\n$smarty->registerFilter('pre','remove_dw_comments');\n$smarty->display('index.tpl');\n?>\n

    See also registerFilter(), postfilters and loadFilter().

    "},{"location":"programmers/advanced-features/advanced-features-security/","title":"Security {#advanced.features.security}","text":"

    Security is good for situations when you have untrusted parties editing the templates e.g. via ftp, and you want to reduce the risk of system security compromises through the template language.

    The settings of the security policy are defined by properties of an instance of the Smarty_Security class. These are the possible settings:

    If security is enabled, no private methods, functions or properties of static classes or assigned objects can be accessed (beginning with \\'_\\') by the template.

    To customize the security policy settings you can extend the Smarty_Security class or create an instance of it.

    <?php\nrequire 'Smarty.class.php';\n\nclass My_Security_Policy extends Smarty_Security {\n  // disable all PHP functions\n  public $php_functions = null;\n  // allow everthing as modifier\n  public $php_modifiers = array();\n}\n$smarty = new Smarty();\n// enable security\n$smarty->enableSecurity('My_Security_Policy');\n?>\n\n\n<?php\nrequire 'Smarty.class.php';\n$smarty = new Smarty();\n$my_security_policy = new Smarty_Security($smarty);\n// disable all PHP functions\n$my_security_policy->php_functions = null;\n// allow everthing as modifier\n$my_security_policy->php_modifiers = array();\n// enable security\n$smarty->enableSecurity($my_security_policy);\n?>\n\n\n<?php\nrequire 'Smarty.class.php';\n$smarty = new Smarty();\n// enable default security\n$smarty->enableSecurity();\n?>\n

    Note

    Most security policy settings are only checked when the template gets compiled. For that reason you should delete all cached and compiled template files when you change your security settings.

    "},{"location":"programmers/advanced-features/advanced-features-static-classes/","title":"Static Classes {#advanced.features.static.classes}","text":"

    You can directly access static classes. The syntax is the same as in PHP.

    Note

    Direct access to PHP classes is not recommended. This ties the underlying application code structure directly to the presentation, and also complicates template syntax. It is recommended to register plugins which insulate templates from PHP classes/objects. Use at your own discretion. See the Best Practices section of the Smarty website.

    {assign var=foo value=myclass::BAR}  <--- class constant BAR\n\n{assign var=foo value=myclass::method()}  <--- method result\n\n{assign var=foo value=myclass::method1()->method2}  <--- method chaining\n\n{assign var=foo value=myclass::$bar}  <--- property bar of class myclass\n\n{assign var=foo value=$bar::method}  <--- using Smarty variable bar as class name\n
    "},{"location":"programmers/advanced-features/advanced-features-streams/","title":"Streams {#advanced.features.streams}","text":"

    You can also use streams to call variables. {\\$foo:bar} will use the foo://bar stream to get the template variable.

    Using a PHP stream for a template variable resource from within a template.

    {$foo:bar}\n

    See also Template Resources

    "},{"location":"programmers/advanced-features/advanced-features-template-inheritance/","title":"Template Inheritance {#advanced.features.template.inheritance}","text":"

    Inheritance brings the concept of Object Oriented Programming to templates, allowing you to define one (or more) base templates that can be extended by child templates. Extending means that the child template can override all or some of the parent named block areas.

    Note

    When $compile_check is enabled, all files in the inheritance tree are checked for modifications upon each invocation. You may want to disable $compile_check on production servers for this reason.

    Note

    If you have a subtemplate which is included with {include} and it contains {block} areas it works only if the {include} itself is called from within a surrounding {block}. In the final parent template you may need a dummy {block} for it.

    layout.tpl (parent)

    <html>\n<head>\n  <title>{block name=title}Default Page Title{/block}</title>\n  {block name=head}{/block}\n</head>\n<body>\n{block name=body}{/block}\n</body>\n</html>\n

    myproject.tpl (child)

    {extends file='layout.tpl'}\n{block name=head}\n  <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n  <script src=\"/js/mypage.js\"></script>\n{/block}\n

    mypage.tpl (grandchild)

    {extends file='myproject.tpl'}\n{block name=title}My Page Title{/block}\n{block name=head}\n  <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n  <script src=\"/js/mypage.js\"></script>\n{/block}\n{block name=body}My HTML Page Body goes here{/block}\n

    To render the above use

     $smarty->display('mypage.tpl');\n

    The resulting output is

    <html>\n<head>\n  <title>My Page Title</title>\n  <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n  <script src=\"/js/mypage.js\"></script>\n</head>\n<body>\nMy HTML Page Body goes here\n</body>\n</html>\n

    Instead of using {extends} tags in the template files you can define the inheritance tree in your PHP script by using the extends: resource type.

    The code below will return same result as the example above.

    <?php\n$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); \n?>\n

    See also {block}, {extends} and extends: resource

    "},{"location":"programmers/advanced-features/advanced-features-template-settings/","title":"Changing settings by template {#advanced.features.template.settings}","text":"

    Normally you configure the Smarty settings by modifying the Smarty class variables. Furthermore you can register plugins, filters etc. with Smarty functions. Modifications done to the Smarty object will be global for all templates.

    However the Smarty class variables and functions can be accessed or called by individual template objects. Modification done to a template object will apply only for that template and its included subtemplates.

    <?php\n$tpl = $smarty->createTemplate('index.tpl);\n$tpl->cache_lifetime = 600;\n//or\n$tpl->setCacheLifetime(600);\n$smarty->display($tpl);\n?>\n\n\n\n\n<?php\n$tpl = $smarty->createTemplate('index.tpl);\n$tpl->registerPlugin('modifier','mymodifier');\n$smarty->display($tpl);\n?>\n
    "},{"location":"programmers/api-functions/api-add-config-dir/","title":"Api add config dir","text":"

    addConfigDir()

    add a directory to the list of directories where config files are stored

    "},{"location":"programmers/api-functions/api-add-config-dir/#description","title":"Description","text":"

    Smarty

    addConfigDir

    string|array

    config_dir

    string

    key

    <?php\n\n// add directory where config files are stored\n$smarty->addConfigDir('./config_1');\n\n// add directory where config files are stored and specify array-key\n$smarty->addConfigDir('./config_1', 'one');\n\n// add multiple directories where config files are stored and specify array-keys\n$smarty->addTemplateDir(array(\n    'two' => './config_2',\n    'three' => './config_3',\n));\n\n// view the template dir chain\nvar_dump($smarty->getConfigDir());\n\n// chaining of method calls\n$smarty->setConfigDir('./config')\n       ->addConfigDir('./config_1', 'one')\n       ->addConfigDir('./config_2', 'two');\n\n?>\n

    See also getConfigDir(), setConfigDir() and $config_dir.

    "},{"location":"programmers/api-functions/api-add-plugins-dir/","title":"Api add plugins dir","text":"

    addPluginsDir()

    add a directory to the list of directories where plugins are stored

    "},{"location":"programmers/api-functions/api-add-plugins-dir/#description","title":"Description","text":"

    Smarty

    addPluginsDir

    string|array

    plugins_dir

    <?php\n\n// add directory where plugins are stored\n$smarty->addPluginsDir('./plugins_1');\n\n// add multiple directories where plugins are stored\n$smarty->setPluginsDir(array(\n    './plugins_2',\n    './plugins_3',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setPluginsDir('./plugins')\n       ->addPluginsDir('./plugins_1')\n       ->addPluginsDir('./plugins_2');\n\n?>\n

    See also getPluginsDir(), setPluginsDir() and $plugins_dir.

    "},{"location":"programmers/api-functions/api-add-template-dir/","title":"Api add template dir","text":"

    addTemplateDir()

    add a directory to the list of directories where templates are stored

    "},{"location":"programmers/api-functions/api-add-template-dir/#description","title":"Description","text":"

    Smarty

    addTemplateDir

    string|array

    template_dir

    string

    key

    <?php\n\n// add directory where templates are stored\n$smarty->addTemplateDir('./templates_1');\n\n// add directory where templates are stored and specify array-key\n$smarty->addTemplateDir('./templates_1', 'one');\n\n// add multiple directories where templates are stored and specify array-keys\n$smarty->addTemplateDir(array(\n    'two' => './templates_2',\n    'three' => './templates_3',\n));\n\n// view the template dir chain\nvar_dump($smarty->getTemplateDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->addTemplateDir('./templates_1', 'one')\n       ->addTemplateDir('./templates_2', 'two');\n\n?>\n

    See also getTemplateDir(), setTemplateDir() and $template_dir.

    "},{"location":"programmers/api-functions/api-append-by-ref/","title":"Api append by ref","text":"

    appendByRef()

    append values by reference

    "},{"location":"programmers/api-functions/api-append-by-ref/#description","title":"Description","text":"

    void

    appendByRef

    string

    varname

    mixed

    var

    bool

    merge

    This is used to append() values to the templates by reference.

    Note

    With the introduction of PHP5, appendByRef() is not necessary for most intents and purposes. appendByRef() is useful if you want a PHP array index value to be affected by its reassignment from a template. Assigned object properties behave this way by default.

    NOTE.PARAMETER.MERGE

    <?php\n// appending name/value pairs\n$smarty->appendByRef('Name', $myname);\n$smarty->appendByRef('Address', $address);\n?>\n

    See also append(), assign() and getTemplateVars().

    "},{"location":"programmers/api-functions/api-append/","title":"Api append","text":"

    append()

    append an element to an assigned array

    "},{"location":"programmers/api-functions/api-append/#description","title":"Description","text":"

    void

    append

    mixed

    var

    void

    append

    string

    varname

    mixed

    var

    bool

    merge

    If you append to a string value, it is converted to an array value and then appended to. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs. If you pass the optional third parameter of TRUE, the value will be merged with the current array instead of appended.

    NOTE.PARAMETER.MERGE

    <?php\n// This is effectively the same as assign()\n$smarty->append('foo', 'Fred');\n// After this line, foo will now be seen as an array in the template\n$smarty->append('foo', 'Albert');\n\n$array = array(1 => 'one', 2 => 'two');\n$smarty->append('X', $array);\n$array2 = array(3 => 'three', 4 => 'four');\n// The following line will add a second element to the X array\n$smarty->append('X', $array2);\n\n// passing an associative array\n$smarty->append(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n?>\n

    See also appendByRef(), assign() and getTemplateVars()

    "},{"location":"programmers/api-functions/api-assign-by-ref/","title":"Api assign by ref","text":"

    assignByRef()

    assign values by reference

    "},{"location":"programmers/api-functions/api-assign-by-ref/#description","title":"Description","text":"

    void

    assignByRef

    string

    varname

    mixed

    var

    This is used to assign() values to the templates by reference.

    Note

    With the introduction of PHP5, assignByRef() is not necessary for most intents and purposes. assignByRef() is useful if you want a PHP array index value to be affected by its reassignment from a template. Assigned object properties behave this way by default.

    <?php\n// passing name/value pairs\n$smarty->assignByRef('Name', $myname);\n$smarty->assignByRef('Address', $address);\n?>\n

    See also assign(), clearAllAssign(), append(), {assign} and getTemplateVars().

    "},{"location":"programmers/api-functions/api-assign/","title":"Api assign","text":"

    assign()

    assign variables/objects to the templates

    "},{"location":"programmers/api-functions/api-assign/#description","title":"Description","text":"

    void

    assign

    mixed

    var

    void

    assign

    string

    varname

    mixed

    var

    bool

    nocache

    You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs.

    If you pass the optional third nocache parameter of TRUE, the variable is assigned as nocache variable. See Cacheability of Variables for details.

    Note

    When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.

    <?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// passing an associative array\n$smarty->assign(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n\n// passing an array\n$myArray = array('no' => 10, 'label' => 'Peanuts');\n$smarty->assign('foo',$myArray);\n\n// passing a row from a database (eg adodb)\n$sql = 'select id, name, email from contacts where contact ='.$id;\n$smarty->assign('contact', $db->getRow($sql));\n?>\n

    These are accessed in the template with

    {* note the vars are case sensitive like php *}\n{$Name}\n{$Address}\n{$city}\n{$state}\n\n{$foo.no}, {$foo.label}\n{$contact.id}, {$contact.name},{$contact.email}\n

    To access more complex array assignments see {foreach} and {section}

    See also assignByRef(), getTemplateVars(), clearAssign(), append() and {assign}

    "},{"location":"programmers/api-functions/api-clear-all-assign/","title":"Api clear all assign","text":"

    clearAllAssign()

    clears the values of all assigned variables

    "},{"location":"programmers/api-functions/api-clear-all-assign/#description","title":"Description","text":"

    void

    clearAllAssign

    <?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// will output above\nprint_r( $smarty->getTemplateVars() );\n\n// clear all assigned variables\n$smarty->clearAllAssign();\n\n// will output nothing\nprint_r( $smarty->getTemplateVars() );\n\n?>\n

    See also clearAssign(), clearConfig(), getTemplateVars(), assign() and append()

    "},{"location":"programmers/api-functions/api-clear-all-cache/","title":"Api clear all cache","text":"

    clearAllCache()

    clears the entire template cache

    "},{"location":"programmers/api-functions/api-clear-all-cache/#description","title":"Description","text":"

    void

    clearAllCache

    int

    expire_time

    As an optional parameter, you can supply a minimum age in seconds the cache files must be before they will get cleared.

    Note

    Since Smarty version 3.1.14 it is possible to delete cache files by their individual expiration time at creation by passing constant SMARTY::CLEAR_EXPIRED as expire_time parameter.

    <?php\n// clear the entire cache\n$smarty->clearAllCache();\n\n// clears all files over one hour old\n$smarty->clearAllCache(3600);\n?>\n

    See also clearCache(), isCached() and the caching page.

    "},{"location":"programmers/api-functions/api-clear-assign/","title":"Api clear assign","text":"

    clearAssign()

    clears the value of an assigned variable

    "},{"location":"programmers/api-functions/api-clear-assign/#description","title":"Description","text":"

    void

    clearAssign

    mixed

    var

    This can be a single value, or an array of values.

    <?php\n// clear a single variable\n$smarty->clearAssign('Name');\n\n// clears multiple variables\n$smarty->clearAssign(array('Name', 'Address', 'Zip'));\n?>\n

    See also clearAllAssign(), clearConfig(), getTemplateVars(), assign() and append()

    "},{"location":"programmers/api-functions/api-clear-cache/","title":"Api clear cache","text":"

    clearCache()

    clears the cache for a specific template

    "},{"location":"programmers/api-functions/api-clear-cache/#description","title":"Description","text":"

    void

    clearCache

    string

    template

    string

    cache_id

    string

    compile_id

    int

    expire_time

    <?php\n// clear the cache for a template\n$smarty->clearCache('index.tpl');\n\n// clear the cache for a particular cache id in an multiple-cache template\n$smarty->clearCache('index.tpl', 'MY_CACHE_ID');\n?>\n

    See also clearAllCache() and caching section.

    "},{"location":"programmers/api-functions/api-clear-compiled-tpl/","title":"Api clear compiled tpl","text":"

    clearCompiledTemplate()

    clears the compiled version of the specified template resource

    "},{"location":"programmers/api-functions/api-clear-compiled-tpl/#description","title":"Description","text":"

    void

    clearCompiledTemplate

    string

    tpl_file

    string

    compile_id

    int

    exp_time

    This clears the compiled version of the specified template resource, or all compiled template files if one is not specified. If you pass a $compile_id only the compiled template for this specific $compile_id is cleared. If you pass an exp_time, then only compiled templates older than exp_time seconds are cleared, by default all compiled templates are cleared regardless of their age. This function is for advanced use only, not normally needed.

    <?php\n// clear a specific template resource\n$smarty->clearCompiledTemplate('index.tpl');\n\n// clear entire compile directory\n$smarty->clearCompiledTemplate();\n?>\n

    See also clearCache().

    "},{"location":"programmers/api-functions/api-clear-config/","title":"Api clear config","text":"

    clearConfig()

    clears assigned config variables

    "},{"location":"programmers/api-functions/api-clear-config/#description","title":"Description","text":"

    void

    clearConfig

    string

    var

    This clears all assigned config variables. If a variable name is supplied, only that variable is cleared.

    <?php\n// clear all assigned config variables.\n$smarty->clearConfig();\n\n// clear one variable\n$smarty->clearConfig('foobar');\n?>\n

    See also getConfigVars(), config variables, config files, {config_load}, configLoad() and clearAssign().

    "},{"location":"programmers/api-functions/api-compile-all-config/","title":"Api compile all config","text":"

    compileAllConfig()

    compiles all known config files

    "},{"location":"programmers/api-functions/api-compile-all-config/#description","title":"Description","text":"

    string

    compileAllConfig

    string

    extension

    boolean

    force

    integer

    timelimit

    integer

    maxerror

    This function compiles config files found in the $config_dir folder. It uses the following parameters:

    Note

    This function may not create desired results in all configurations. Use is on own risk.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// force compilation of all config files\n$smarty->compileAllConfig('.config',true);\n\n?>\n
    "},{"location":"programmers/api-functions/api-compile-all-templates/","title":"Api compile all templates","text":"

    compileAllTemplates()

    compiles all known templates

    "},{"location":"programmers/api-functions/api-compile-all-templates/#description","title":"Description","text":"

    string

    compileAllTemplates

    string

    extension

    boolean

    force

    integer

    timelimit

    integer

    maxerror

    This function compiles template files found in the $template_dir folder. It uses the following parameters:

    Note

    This function may not create desired results in all configurations. Use is on own risk.

    Note

    If any template requires registered plugins, filters or objects you must register all of them before running this function.

    Note

    If you are using template inheritance this function will create compiled files of parent templates which will never be used.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// force compilation of all template files\n$smarty->compileAllTemplates('.tpl',true);\n\n?>\n
    "},{"location":"programmers/api-functions/api-config-load/","title":"Api config load","text":"

    configLoad()

    loads config file data and assigns it to the template

    "},{"location":"programmers/api-functions/api-config-load/#description","title":"Description","text":"

    void

    configLoad

    string

    file

    string

    section

    This loads config file data and assigns it to the template. This works identically to the template {config_load} function.

    Note

    As of Smarty 2.4.0, assigned template variables are kept across invocations of fetch() and display(). Config vars loaded from configLoad() are always global in scope. Config files are also compiled for faster execution, and respect the $force_compile and $compile_check settings.

    <?php\n// load config variables and assign them\n$smarty->configLoad('my.conf');\n\n// load a section\n$smarty->configLoad('my.conf', 'foobar');\n?>\n

    See also {config_load}, getConfigVars(), clearConfig(), and config variables

    "},{"location":"programmers/api-functions/api-create-data/","title":"Api create data","text":"

    createData()

    creates a data object

    "},{"location":"programmers/api-functions/api-create-data/#description","title":"Description","text":"

    string

    createData

    object

    parent

    string

    createData

    This creates a data object which will hold assigned variables. It uses the following parameters:

    Data objects are used to create scopes for assigned variables. They can be used to control which variables are seen by which templates.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// create data object with its private variable scope\n$data = $smarty->createData();\n\n// assign variable to data scope\n$data->assign('foo','bar');\n\n// create template object which will use variables from data object\n$tpl = $smarty->createTemplate('index.tpl',$data);\n\n// display the template\n$tpl->display();\n?>\n

    See also display(), and createTemplate(),

    "},{"location":"programmers/api-functions/api-create-template/","title":"Api create template","text":"

    createTemplate()

    returns a template object

    "},{"location":"programmers/api-functions/api-create-template/#description","title":"Description","text":"

    Smarty_Internal_Template

    createTemplate

    string

    template

    object

    parent

    Smarty_Internal_Template

    createTemplate

    string

    template

    array

    data

    Smarty_Internal_Template

    createTemplate

    string

    template

    string

    cache_id

    string

    compile_id

    object

    parent

    Smarty_Internal_Template

    createTemplate

    string

    template

    string

    cache_id

    string

    compile_id

    array

    data

    This creates a template object which later can be rendered by the display or fetch method. It uses the following parameters:

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// create template object with its private variable scope\n$tpl = $smarty->createTemplate('index.tpl');\n\n// assign variable to template scope\n$tpl->assign('foo','bar');\n\n// display the template\n$tpl->display();\n?>\n

    See also display(), and templateExists().

    "},{"location":"programmers/api-functions/api-disable-security/","title":"Api disable security","text":"

    disableSecurity()

    disables template security

    "},{"location":"programmers/api-functions/api-disable-security/#description","title":"Description","text":"

    string

    disableSecurity

    This disables security checking on templates.

    See also enableSecurity(), and Security.

    "},{"location":"programmers/api-functions/api-display/","title":"Api display","text":"

    display()

    displays the template

    "},{"location":"programmers/api-functions/api-display/#description","title":"Description","text":"

    void

    display

    string

    template

    string

    cache_id

    string

    compile_id

    This displays the contents of a template. To return the contents of a template into a variable, use fetch(). Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache_id, see the caching section for more information.

    PARAMETER.COMPILEID

    <?php\ninclude(SMARTY_DIR.'Smarty.class.php');\n$smarty = new Smarty();\n$smarty->setCaching(true);\n\n// only do db calls if cache doesn't exist\nif(!$smarty->isCached('index.tpl')) {\n\n  // dummy up some data\n  $address = '245 N 50th';\n  $db_data = array(\n               'City' => 'Lincoln',\n               'State' => 'Nebraska',\n               'Zip' => '68502'\n             );\n\n  $smarty->assign('Name', 'Fred');\n  $smarty->assign('Address', $address);\n  $smarty->assign('data', $db_data);\n\n}\n\n// display the output\n$smarty->display('index.tpl');\n?>\n

    Use the syntax for template resources to display files outside of the $template_dir directory.

    <?php\n// absolute filepath\n$smarty->display('/usr/local/include/templates/header.tpl');\n\n// absolute filepath (same thing)\n$smarty->display('file:/usr/local/include/templates/header.tpl');\n\n// windows absolute filepath (MUST use \"file:\" prefix)\n$smarty->display('file:C:/www/pub/templates/header.tpl');\n\n// include from template resource named \"db\"\n$smarty->display('db:header.tpl');\n?>\n

    See also fetch() and templateExists().

    "},{"location":"programmers/api-functions/api-enable-security/","title":"Api enable security","text":"

    enableSecurity()

    enables template security

    "},{"location":"programmers/api-functions/api-enable-security/#description","title":"Description","text":"

    string

    enableSecurity

    string

    securityclass

    string

    enableSecurity

    object

    securityobject

    string

    enableSecurity

    This enables security checking on templates. It uses the following parameters:

    For the details how to setup a security policy see the Security section.

    See also disableSecurity(), and Security.

    "},{"location":"programmers/api-functions/api-fetch/","title":"Api fetch","text":"

    fetch()

    returns the template output

    "},{"location":"programmers/api-functions/api-fetch/#description","title":"Description","text":"

    string

    fetch

    string

    template

    string

    cache_id

    string

    compile_id

    This returns the template output instead of displaying it. Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache id, see the caching section for more information.

    PARAMETER.COMPILEID

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(true);\n\n// set a separate cache_id for each unique URL\n$cache_id = md5($_SERVER['REQUEST_URI']);\n\n// capture the output\n$output = $smarty->fetch('index.tpl', $cache_id);\n\n// do something with $output here\necho $output;\n?>\n

    The email_body.tpl template

    Dear {$contact_info.name},\n\nWelcome and thank you for signing up as a member of our user group.\n\nClick on the link below to login with your user name\nof '{$contact_info.username}' so you can post in our forums.\n\n{$login_url}\n\nList master\n\n{textformat wrap=40}\nThis is some long-winded disclaimer text that would automatically get wrapped\nat 40 characters. This helps make the text easier to read in mail programs that\ndo not wrap sentences for you.\n{/textformat}\n

    The php script using the PHP mail() function

    <?php\n\n// get $contact_info from db or other resource here\n\n$smarty->assign('contact_info',$contact_info);\n$smarty->assign('login_url',\"http://{$_SERVER['SERVER_NAME']}/login\");\n\nmail($contact_info['email'], 'Thank You', $smarty->fetch('email_body.tpl'));\n\n?>\n

    See also {fetch} display(), {eval}, and templateExists().

    "},{"location":"programmers/api-functions/api-get-cache-dir/","title":"Api get cache dir","text":"

    getCacheDir()

    return the directory where the rendered template\\'s output is stored

    "},{"location":"programmers/api-functions/api-get-cache-dir/#description","title":"Description","text":"

    string

    getCacheDir

    <?php\n\n// get directory where compiled templates are stored\n$cacheDir = $smarty->getCacheDir();\n\n?>\n

    See also setCacheDir() and $cache_dir.

    "},{"location":"programmers/api-functions/api-get-compile-dir/","title":"Api get compile dir","text":"

    getCompileDir()

    returns the directory where compiled templates are stored

    "},{"location":"programmers/api-functions/api-get-compile-dir/#description","title":"Description","text":"

    string

    getCompileDir

    <?php\n\n// get directory where compiled templates are stored\n$compileDir = $smarty->getCompileDir();\n\n?>\n

    See also setCompileDir() and $compile_dir.

    "},{"location":"programmers/api-functions/api-get-config-dir/","title":"Api get config dir","text":"

    getConfigDir()

    return the directory where config files are stored

    "},{"location":"programmers/api-functions/api-get-config-dir/#description","title":"Description","text":"

    string|array

    getConfigDir

    string

    key

    <?php\n\n// set some config directories\n$smarty->setConfigDir(array(\n    'one' => './config',\n    'two' => './config_2',\n    'three' => './config_3',\n));\n\n// get all directories where config files are stored\n$config_dir = $smarty->getConfigDir();\nvar_dump($config_dir); // array\n\n// get directory identified by key\n$config_dir = $smarty->getConfigDir('one');\nvar_dump($config_dir); // string\n\n?>\n

    See also setConfigDir(), addConfigDir() and $config_dir.

    "},{"location":"programmers/api-functions/api-get-config-vars/","title":"Api get config vars","text":"

    getConfigVars()

    returns the given loaded config variable value

    "},{"location":"programmers/api-functions/api-get-config-vars/#description","title":"Description","text":"

    array

    getConfigVars

    string

    varname

    If no parameter is given, an array of all loaded config variables is returned.

    <?php\n\n// get loaded config template var #foo#\n$myVar = $smarty->getConfigVars('foo');\n\n// get all loaded config template vars\n$all_config_vars = $smarty->getConfigVars();\n\n// take a look at them\nprint_r($all_config_vars);\n?>\n

    See also clearConfig(), {config_load}, configLoad() and getTemplateVars().

    "},{"location":"programmers/api-functions/api-get-plugins-dir/","title":"Api get plugins dir","text":"

    getPluginsDir()

    return the directory where plugins are stored

    "},{"location":"programmers/api-functions/api-get-plugins-dir/#description","title":"Description","text":"

    array

    getPluginsDir

    <?php\n\n// set some plugins directories\n$smarty->setPluginsDir(array(\n    './plugins',\n    './plugins_2',\n));\n\n// get all directories where plugins are stored\n$config_dir = $smarty->getPluginsDir();\nvar_dump($config_dir); // array\n\n?>\n

    See also setPluginsDir(), addPluginsDir() and $plugins_dir.

    "},{"location":"programmers/api-functions/api-get-registered-object/","title":"Api get registered object","text":"

    getRegisteredObject()

    returns a reference to a registered object

    "},{"location":"programmers/api-functions/api-get-registered-object/#description","title":"Description","text":"

    array

    getRegisteredObject

    string

    object_name

    This is useful from within a custom function when you need direct access to a registered object. See the objects page for more info.

    <?php\nfunction smarty_block_foo($params, $smarty)\n{\n  if (isset($params['object'])) {\n    // get reference to registered object\n    $obj_ref = $smarty->getRegisteredObject($params['object']);\n    // use $obj_ref is now a reference to the object\n  }\n}\n?>\n

    See also registerObject(), unregisterObject() and objects page

    "},{"location":"programmers/api-functions/api-get-tags/","title":"Api get tags","text":"

    getTags()

    return tags used by template

    "},{"location":"programmers/api-functions/api-get-tags/#description","title":"Description","text":"

    string

    getTags

    object

    template

    This function returns an array of tagname/attribute pairs for all tags used by the template. It uses the following parameters:

    Note

    This function is experimental.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// create template object\n$tpl = $smarty->createTemplate('index.tpl');\n\n// get tags\n$tags = $smarty->getTags($tpl);\n\nprint_r($tags);\n\n?>\n
    "},{"location":"programmers/api-functions/api-get-template-dir/","title":"Api get template dir","text":"

    getTemplateDir()

    return the directory where templates are stored

    "},{"location":"programmers/api-functions/api-get-template-dir/#description","title":"Description","text":"

    string|array

    getTemplateDir

    string

    key

    <?php\n\n// set some template directories\n$smarty->setTemplateDir(array(\n    'one' => './templates',\n    'two' => './templates_2',\n    'three' => './templates_3',\n));\n\n// get all directories where templates are stored\n$template_dir = $smarty->getTemplateDir();\nvar_dump($template_dir); // array\n\n// get directory identified by key\n$template_dir = $smarty->getTemplateDir('one');\nvar_dump($template_dir); // string\n\n?>\n

    See also setTemplateDir(), addTemplateDir() and $template_dir.

    "},{"location":"programmers/api-functions/api-get-template-vars/","title":"Api get template vars","text":"

    getTemplateVars()

    returns assigned variable value(s)

    "},{"location":"programmers/api-functions/api-get-template-vars/#description","title":"Description","text":"

    array

    getTemplateVars

    string

    varname

    If no parameter is given, an array of all assigned variables are returned.

    <?php\n// get assigned template var 'foo'\n$myVar = $smarty->getTemplateVars('foo');\n\n// get all assigned template vars\n$all_tpl_vars = $smarty->getTemplateVars();\n\n// take a look at them\nprint_r($all_tpl_vars);\n?>\n

    See also assign(), {assign}, append(), clearAssign(), clearAllAssign() and getConfigVars()

    "},{"location":"programmers/api-functions/api-is-cached/","title":"Api is cached","text":"

    isCached()

    returns true if there is a valid cache for this template

    "},{"location":"programmers/api-functions/api-is-cached/#description","title":"Description","text":"

    bool

    isCached

    string

    template

    string

    cache_id

    string

    compile_id

    Note

    If isCached() returns TRUE it actually loads the cached output and stores it internally. Any subsequent call to display() or fetch() will return this internally stored output and does not try to reload the cache file. This prevents a race condition that may occur when a second process clears the cache between the calls to isCached() and to display() in the example above. This also means calls to clearCache() and other changes of the cache-settings may have no effect after isCached() returned TRUE.

    <?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl')) {\n// do database calls, assign vars here\n}\n\n$smarty->display('index.tpl');\n?>\n\n\n\n\n<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl', 'FrontPage')) {\n  // do database calls, assign vars here\n}\n\n$smarty->display('index.tpl', 'FrontPage');\n?>\n

    See also clearCache(), clearAllCache(), and caching section.

    "},{"location":"programmers/api-functions/api-load-filter/","title":"Api load filter","text":"

    loadFilter()

    load a filter plugin

    "},{"location":"programmers/api-functions/api-load-filter/#description","title":"Description","text":"

    void

    loadFilter

    string

    type

    string

    name

    The first argument specifies the type of the filter to load and can be one of the following: pre, post or output. The second argument specifies the name of the filter plugin.

    <?php\n\n// load prefilter named 'trim'\n$smarty->loadFilter('pre', 'trim');\n\n// load another prefilter named 'datefooter'\n$smarty->loadFilter('pre', 'datefooter');\n\n// load output filter named 'compress'\n$smarty->loadFilter('output', 'compress');\n\n?>\n

    See also registerFilter(), $autoload_filters and advanced features.

    "},{"location":"programmers/api-functions/api-mute-expected-errors/","title":"Api mute expected errors","text":"

    mutes expected warnings and notices deliberately generated by Smarty

    "},{"location":"programmers/api-functions/api-mute-expected-errors/#description","title":"Description","text":"

    string

    muteExpectedErrors

    muteExpectedErrors() registers a custom error handler using set_error_handler(). The error handler merely inspects $errno and $errfile to determine if the given error was produced deliberately and must be ignored, or should be passed on to the next error handler.

    Smarty::unmuteExpectedErrors() removes the current error handler. Please note, that if you\\'ve registered any custom error handlers after the muteExpectedErrors() call, the unmute will not remove Smarty\\'s muting error handler, but the one registered last.

    "},{"location":"programmers/api-functions/api-register-cacheresource/","title":"Api register cacheresource","text":"

    registerCacheResource()

    dynamically register CacheResources

    "},{"location":"programmers/api-functions/api-register-cacheresource/#description","title":"Description","text":"

    void

    registerCacheResource

    string

    name

    Smarty_CacheResource

    resource_handler

    Use this to dynamically register a CacheResource plugin with Smarty. Pass in the name of the CacheResource and the object extending Smarty_CacheResource. See Custom Cache Implementation for more information on how to create custom CacheResources.

    Note

    In Smarty2 this used to be a callback function called $cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.

    <?php\n$smarty->registerCacheResource('mysql', new Smarty_CacheResource_Mysql());\n?>\n

    See also unregisterCacheResource() and the Custom CacheResource Implementation section.

    "},{"location":"programmers/api-functions/api-register-class/","title":"Api register class","text":"

    registerClass()

    register a class for use in the templates

    "},{"location":"programmers/api-functions/api-register-class/#description","title":"Description","text":"

    void

    registerClass

    string

    class_name

    string

    class_impl

    Smarty allows you to access static classes from templates as long as the Security Policy does not tell it otherwise. If security is enabled, classes registered with registerClass() are accessible to templates.

    <?php\n\nclass Bar {\n  $property = \"hello world\";\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"Bar\");\n\n\n\n\n{* Smarty will access this class as long as it's not prohibited by security *}\n{Bar::$property}\n{* Foo translates to the real class Bar *}\n{Foo::$property}\n\n\n\n\n<?php\nnamespace my\\php\\application {\n  class Bar {\n    $property = \"hello world\";\n  }\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"\\my\\php\\application\\Bar\");\n\n\n\n\n{* Foo translates to the real class \\my\\php\\application\\Bar *}\n{Foo::$property}\n

    See also registerObject(), and Security.

    "},{"location":"programmers/api-functions/api-register-default-plugin-handler/","title":"Api register default plugin handler","text":"

    registerDefaultPluginHandler()

    register a function which gets called on undefined tags

    "},{"location":"programmers/api-functions/api-register-default-plugin-handler/#description","title":"Description","text":"

    void

    registerDefaultPluginHandler

    mixed

    callback

    Register a default plugin handler which gets called if the compiler can not find a definition for a tag otherwise. It uses the following parameters:

    If during compilation Smarty encounters tag which is not defined internal, registered or located in the plugins folder it tries to resolve it by calling the registered default plugin handler. The handler may be called several times for same undefined tag looping over valid plugin types.

    <?php\n\n$smarty = new Smarty();\n$smarty->registerDefaultPluginHandler('my_plugin_handler');\n\n/**\n * Default Plugin Handler\n *\n * called when Smarty encounters an undefined tag during compilation\n * \n * @param string                     $name      name of the undefined tag\n * @param string                     $type     tag type (e.g. Smarty::PLUGIN_FUNCTION, Smarty::PLUGIN_BLOCK, \n                                               Smarty::PLUGIN_COMPILER, Smarty::PLUGIN_MODIFIER, Smarty::PLUGIN_MODIFIERCOMPILER)\n * @param Smarty_Internal_Template   $template     template object\n * @param string                     &$callback    returned function name \n * @param string                     &$script      optional returned script filepath if function is external\n * @param bool                       &$cacheable    true by default, set to false if plugin is not cachable (Smarty >= 3.1.8)\n * @return bool                      true if successfull\n */\nfunction my_plugin_handler ($name, $type, $template, &$callback, &$script, &$cacheable)\n{\n    switch ($type) {\n        case Smarty::PLUGIN_FUNCTION:\n            switch ($name) {\n                case 'scriptfunction':\n                    $script = './scripts/script_function_tag.php';\n                    $callback = 'default_script_function_tag';\n                    return true;\n                case 'localfunction':\n                    $callback = 'default_local_function_tag';\n                    return true;\n                default:\n                return false;\n            }\n        case Smarty::PLUGIN_COMPILER:\n            switch ($name) {\n                case 'scriptcompilerfunction':\n                    $script = './scripts/script_compiler_function_tag.php';\n                    $callback = 'default_script_compiler_function_tag';\n                    return true;\n                default:\n                return false;\n            }\n        case Smarty::PLUGIN_BLOCK:\n            switch ($name) {\n                case 'scriptblock':\n                    $script = './scripts/script_block_tag.php';\n                    $callback = 'default_script_block_tag';\n                    return true;\n                default:\n                return false;\n            }\n        default:\n        return false;\n    }\n }\n\n?>\n

    Note

    The return callback must be static; a function name or an array of class and method name.

    Dynamic callbacks like objects methods are not supported.

    "},{"location":"programmers/api-functions/api-register-filter/","title":"Api register filter","text":"

    registerFilter()

    dynamically register filters

    "},{"location":"programmers/api-functions/api-register-filter/#description","title":"Description","text":"

    void

    registerFilter

    string

    type

    mixed

    callback

    Use this to dynamically register filters to operate on a templates. It uses the following parameters:

    NOTE.PARAMETER.FUNCTION

    A prefilter runs through the template source before it gets compiled. See template prefilters for more information on how to setup a prefiltering function.

    A postfilter runs through the template code after it was compiled to PHP. See template postfilters for more information on how to setup a postfiltering function.

    A outputfilter operates on a template\\'s output before it is displayed. See template output filters for more information on how to set up an output filter function.

    See also unregisterFilter(), loadFilter(), $autoload_filters, template pre filters template post filters template output filters section.

    "},{"location":"programmers/api-functions/api-register-object/","title":"Api register object","text":"

    registerObject()

    register an object for use in the templates

    "},{"location":"programmers/api-functions/api-register-object/#description","title":"Description","text":"

    void

    registerObject

    string

    object_name

    object

    object

    array

    allowed_methods_properties

    boolean

    format

    array

    block_methods

    Note

    When you register/assign objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.

    See the objects section for more information.

    See also getRegisteredObject(), and unregisterObject().

    "},{"location":"programmers/api-functions/api-register-plugin/","title":"Api register plugin","text":"

    registerPlugin()

    dynamically register plugins

    "},{"location":"programmers/api-functions/api-register-plugin/#description","title":"Description","text":"

    void

    registerPlugin

    string

    type

    string

    name

    mixed

    callback

    bool

    cacheable

    mixed

    cache_attrs

    This method registers functions or methods defined in your script as plugin. It uses the following parameters:

    <?php\n$smarty->registerPlugin(\"function\",\"date_now\", \"print_current_date\");\n\nfunction print_current_date($params, $smarty)\n{\n  if(empty($params[\"format\"])) {\n    $format = \"%b %e, %Y\";\n  } else {\n    $format = $params[\"format\"];\n  }\n  return strftime($format,time());\n}\n?>\n

    And in the template

    {date_now}\n\n{* or to format differently *}\n{date_now format=\"%Y/%m/%d\"}\n\n\n<?php\n// function declaration\nfunction do_translation ($params, $content, $smarty, &$repeat, $template)\n{\n  if (isset($content)) {\n    $lang = $params[\"lang\"];\n    // do some translation with $content\n    return $translation;\n  }\n}\n\n// register with smarty\n$smarty->registerPlugin(\"block\",\"translate\", \"do_translation\");\n?>\n

    Where the template is:

    {translate lang=\"br\"}Hello, world!{/translate}\n\n\n\n\n<?php\n\n// let's map PHP's stripslashes function to a Smarty modifier.\n$smarty->registerPlugin(\"modifier\",\"ss\", \"stripslashes\");\n\n?>\n

    In the template, use ss to strip slashes.

    <?php\n{$var|ss}\n?>\n

    See also unregisterPlugin(), plugin functions, plugin block functions, plugin compiler functions, and the creating plugin modifiers section.

    "},{"location":"programmers/api-functions/api-register-resource/","title":"Api register resource","text":"

    registerResource()

    dynamically register resources

    "},{"location":"programmers/api-functions/api-register-resource/#description","title":"Description","text":"

    void

    registerResource

    string

    name

    Smarty_resource

    resource_handler

    Use this to dynamically register a Resource plugin with Smarty. Pass in the name of the Resource and the object extending Smarty_Resource. See template resources for more information on how to setup a function for fetching templates.

    Note

    A resource name must be at least two characters in length. One character resource names will be ignored and used as part of the file path, such as $smarty->display('c:/path/to/index.tpl');

    Note

    Prior to Smarty 3.1 registerResource() accepted an array of callback functions. While this is still possible for backward compatibility reasons, it is strongly discouraged as callback functions have been deprecated as of Smarty 3.1.

    <?php\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n?>\n

    See also unregisterResource() and the template resources section.

    "},{"location":"programmers/api-functions/api-set-cache-dir/","title":"Api set cache dir","text":"

    setCacheDir()

    set the directory where the rendered template\\'s output is stored

    "},{"location":"programmers/api-functions/api-set-cache-dir/#description","title":"Description","text":"

    Smarty

    setCacheDir

    string

    cache_dir

    <?php\n\n// set directory where rendered template's output is stored\n$smarty->setCacheDir('./cache');\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getCacheDir() and $cache_dir.

    "},{"location":"programmers/api-functions/api-set-compile-dir/","title":"Api set compile dir","text":"

    setCompileDir()

    set the directory where compiled templates are stored

    "},{"location":"programmers/api-functions/api-set-compile-dir/#description","title":"Description","text":"

    Smarty

    setCompileDir

    string

    compile_dir

    <?php\n\n// set directory where compiled templates are stored\n$smarty->setCompileDir('./templates_c');\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getCompileDir() and $compile_dir.

    "},{"location":"programmers/api-functions/api-set-config-dir/","title":"Api set config dir","text":"

    setConfigDir()

    set the directories where config files are stored

    "},{"location":"programmers/api-functions/api-set-config-dir/#description","title":"Description","text":"

    Smarty

    setConfigDir

    string|array

    config_dir

    <?php\n\n// set a single directory where the config files are stored\n$smarty->setConfigDir('./config');\n\n// view the config dir chain\nvar_dump($smarty->getConfigDir());\n\n// set multiple director\u00edes where config files are stored\n$smarty->setConfigDir(array(\n    'one' => './config',\n    'two' => './config_2',\n    'three' => './config_3',\n));\n\n// view the config dir chain\nvar_dump($smarty->getConfigDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setConfigDir('./config')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getConfigDir(), addConfigDir() and $config_dir.

    "},{"location":"programmers/api-functions/api-set-plugins-dir/","title":"Api set plugins dir","text":"

    setPluginsDir()

    set the directories where plugins are stored

    "},{"location":"programmers/api-functions/api-set-plugins-dir/#description","title":"Description","text":"

    Smarty

    setPluginsDir

    string|array

    plugins_dir

    <?php\n\n// set a single directory where the plugins are stored\n$smarty->setPluginsDir('./plugins');\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// set multiple director\u00edes where plugins are stored\n$smarty->setPluginsDir(array(\n    './plugins',\n    './plugins_2',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setPluginsDir('./plugins')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getPluginsDir(), addPluginsDir() and $plugins_dir.

    "},{"location":"programmers/api-functions/api-set-template-dir/","title":"Api set template dir","text":"

    setTemplateDir()

    set the directories where templates are stored

    "},{"location":"programmers/api-functions/api-set-template-dir/#description","title":"Description","text":"

    Smarty

    setTemplateDir

    string|array

    template_dir

    <?php\n\n// set a single directory where the templates are stored\n$smarty->setTemplateDir('./cache');\n\n// view the template dir chain\nvar_dump($smarty->getTemplateDir());\n\n// set multiple director\u00edes where templates are stored\n$smarty->setTemplateDir(array(\n    'one' => './templates',\n    'two' => './templates_2',\n    'three' => './templates_3',\n));\n\n// view the template dir chain\nvar_dump($smarty->getTemplateDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getTemplateDir(), addTemplateDir() and $template_dir.

    "},{"location":"programmers/api-functions/api-template-exists/","title":"Api template exists","text":"

    templateExists()

    checks whether the specified template exists

    "},{"location":"programmers/api-functions/api-template-exists/#description","title":"Description","text":"

    bool

    templateExists

    string

    template

    It can accept either a path to the template on the filesystem or a resource string specifying the template.

    This example uses $_GET['page'] to {include} a content template. If the template does not exist then an error page is displayed instead. First the page_container.tpl

    <html>\n<head><title>{$title}</title></head>\n<body>\n{include file='page_top.tpl'}\n\n{* include middle content page *}\n{include file=$content_template}\n\n{include file='page_footer.tpl'}\n</body>\n

    And the php script

    <?php\n\n// set the filename eg index.inc.tpl\n$mid_template = $_GET['page'].'.inc.tpl';\n\nif( !$smarty->templateExists($mid_template) ){\n    $mid_template = 'page_not_found.tpl';\n}\n$smarty->assign('content_template', $mid_template);\n\n$smarty->display('page_container.tpl');\n\n?>\n

    See also display(), fetch(), {include} and {insert}

    "},{"location":"programmers/api-functions/api-test-install/","title":"Api test install","text":"

    testInstall()

    checks Smarty installation

    "},{"location":"programmers/api-functions/api-test-install/#description","title":"Description","text":"

    void

    testInstall

    This function verifies that all required working folders of the Smarty installation can be accessed. It does output a corresponding protocol.

    <?php\nrequire_once('Smarty.class.php');\n$smarty  = new Smarty();\n$smarty->testInstall();\n?>\n
    "},{"location":"programmers/api-functions/api-unregister-cacheresource/","title":"Api unregister cacheresource","text":"

    unregisterCacheResource()

    dynamically unregister a CacheResource plugin

    "},{"location":"programmers/api-functions/api-unregister-cacheresource/#description","title":"Description","text":"

    void

    unregisterCacheResource

    string

    name

    Pass in the name of the CacheResource.

    <?php\n\n$smarty->unregisterCacheResource('mysql');\n\n?>\n

    See also registerCacheResource() and the Custom CacheResource Implementation section.

    "},{"location":"programmers/api-functions/api-unregister-filter/","title":"Api unregister filter","text":"

    unregisterFilter()

    dynamically unregister a filter

    "},{"location":"programmers/api-functions/api-unregister-filter/#description","title":"Description","text":"

    void

    unregisterFilter

    string

    type

    string|array

    callback

    Use this to dynamically unregister filters. It uses the following parameters:

    See also registerFilter().

    "},{"location":"programmers/api-functions/api-unregister-object/","title":"Api unregister object","text":"

    unregisterObject()

    dynamically unregister an object

    "},{"location":"programmers/api-functions/api-unregister-object/#description","title":"Description","text":"

    void

    unregisterObject

    string

    object_name

    See also registerObject() and objects section

    "},{"location":"programmers/api-functions/api-unregister-plugin/","title":"Api unregister plugin","text":"

    unregisterPlugin

    dynamically unregister plugins

    "},{"location":"programmers/api-functions/api-unregister-plugin/#description","title":"Description","text":"

    void

    unregisterPlugin

    string

    type

    string

    name

    This method unregisters plugins which previously have been registered by registerPlugin(), It uses the following parameters:

    <?php\n\n// we don't want template designers to have access to function plugin \"date_now\" \n$smarty->unregisterPlugin(\"function\",\"date_now\");\n\n?>\n

    See also registerPlugin().

    "},{"location":"programmers/api-functions/api-unregister-resource/","title":"Api unregister resource","text":"

    unregisterResource()

    dynamically unregister a resource plugin

    "},{"location":"programmers/api-functions/api-unregister-resource/#description","title":"Description","text":"

    void

    unregisterResource

    string

    name

    Pass in the name of the resource.

    <?php\n\n$smarty->unregisterResource('db');\n\n?>\n

    See also registerResource() and template resources

    "},{"location":"programmers/api-variables/variable-allow-php-templates/","title":"\\$allow_php_templates {#variable.allow.php.templates}","text":"

    By default the PHP template file resource is disabled. Setting $allow_php_templates to TRUE will enable PHP template files.

    ::: {.informalexample}

    <?php\n$smarty->allow_php_templates = true;\n?>\n

    :::

    Note

    The PHP template file resource is an undocumented deprecated feature.

    "},{"location":"programmers/api-variables/variable-auto-literal/","title":"\\$auto_literal {#variable.auto.literal}","text":"

    The Smarty delimiter tags { and } will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting auto_literal to false.

    ::: {.informalexample}

    <?php\n$smarty->auto_literal = false;\n?>\n

    :::

    See also Escaping Smarty parsing,

    "},{"location":"programmers/api-variables/variable-autoload-filters/","title":"\\$autoload_filters {#variable.autoload.filters}","text":"

    If there are some filters that you wish to load on every template invocation, you can specify them using this variable and Smarty will automatically load them for you. The variable is an associative array where keys are filter types and values are arrays of the filter names. For example:

    ::: {.informalexample}

    <?php\n$smarty->autoload_filters = array('pre' => array('trim', 'stamp'),\n                                  'output' => array('convert'));\n?>\n

    :::

    See also registerFilter() and loadFilter()

    "},{"location":"programmers/api-variables/variable-cache-dir/","title":"\\$cache_dir {#variable.cache.dir}","text":"

    This is the name of the directory where template caches are stored. By default this is ./cache, meaning that Smarty will look for the cache/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.

    You can also use your own custom cache implementation to control cache files, which will ignore this setting. See also $use_sub_dirs.

    Note

    This setting must be either a relative or absolute path. include_path is not used for writing files.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    As of Smarty 3.1 the attribute \\$cache_dir is no longer accessible directly. Use getCacheDir() and setCacheDir() instead.

    See also getCacheDir(), setCacheDir(), $caching, $use_sub_dirs, $cache_lifetime, $cache_modified_check and the caching section.

    "},{"location":"programmers/api-variables/variable-cache-id/","title":"\\$cache_id {#variable.cache.id}","text":"

    Persistent cache_id identifier. As an alternative to passing the same $cache_id to each and every function call, you can set this $cache_id and it will be used implicitly thereafter.

    With a $cache_id you can have multiple cache files for a single call to display() or fetch() depending for example from different content of the same template. See the caching section for more information.

    "},{"location":"programmers/api-variables/variable-cache-lifetime/","title":"\\$cache_lifetime {#variable.cache.lifetime}","text":"

    This is the length of time in seconds that a template cache is valid. Once this time has expired, the cache will be regenerated.

    If $force_compile is enabled, the cache files will be regenerated every time, effectively disabling caching. You can clear all the cache files with the clear_all_cache() function, or individual cache files (or groups) with the clear_cache() function.

    "},{"location":"programmers/api-variables/variable-cache-locking/","title":"\\$cache_locking {#variable.cache.locking}","text":"

    Cache locking avoids concurrent cache generation. This means resource intensive pages can be generated only once, even if they\\'ve been requested multiple times in the same moment.

    Cache locking is disabled by default. To enable it set $cache_locking to TRUE.

    See also $locking_timeout

    "},{"location":"programmers/api-variables/variable-cache-modified-check/","title":"\\$cache_modified_check {#variable.cache.modified.check}","text":"

    If set to TRUE, Smarty will respect the If-Modified-Since header sent from the client. If the cached file timestamp has not changed since the last visit, then a '304: Not Modified' header will be sent instead of the content. This works only on cached content without {insert} tags.

    See also $caching, $cache_lifetime, and the caching section.

    "},{"location":"programmers/api-variables/variable-caching-type/","title":"\\$caching_type {#variable.caching.type}","text":"

    This property specifies the name of the caching handler to use. It defaults to file, enabling the internal filesystem based cache handler.

    See Custom Cache Implementation for pointers on setting up your own cache handler.

    "},{"location":"programmers/api-variables/variable-caching/","title":"\\$caching {#variable.caching}","text":"

    This tells Smarty whether or not to cache the output of the templates to the $cache_dir. By default this is set to the constant Smarty::CACHING_OFF. If your templates consistently generate the same content, it is advisable to turn on $caching, as this may result in significant performance gains.

    You can also have multiple caches for the same template.

    See also $cache_dir, $cache_lifetime, $cache_modified_check, is_cached() and the caching section.

    "},{"location":"programmers/api-variables/variable-compile-check/","title":"\\$compile_check {#variable.compile.check}","text":"

    Upon each invocation of the PHP application, Smarty tests to see if the current template has changed (different timestamp) since the last time it was compiled. If it has changed, it recompiles that template. If the template has yet not been compiled at all, it will compile regardless of this setting. By default this variable is set to TRUE.

    Once an application is put into production (ie the templates won\\'t be changing), the compile check step is no longer needed. Be sure to set $compile_check to FALSE for maximum performance. Note that if you change this to FALSE and a template file is changed, you will *not* see the change since the template will not get recompiled.

    Note that up to Smarty 4.x, Smarty will check for the existence of the source template even if $compile_check is disabled.

    If $caching is enabled and $compile_check is enabled, then the cache files will get regenerated if an involved template file or config file was updated.

    As of Smarty 3.1 $compile_check can be set to the value Smarty::COMPILECHECK_CACHEMISS. This enables Smarty to revalidate the compiled template, once a cache file is regenerated. So if there was a cached template, but it\\'s expired, Smarty will run a single compile_check before regenerating the cache.

    See $force_compile and clearCompiledTemplate().

    "},{"location":"programmers/api-variables/variable-compile-dir/","title":"\\$compile_dir {#variable.compile.dir}","text":"

    This is the name of the directory where compiled templates are located. By default this is ./templates_c, meaning that Smarty will look for the templates_c/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.

    Note

    This setting must be either a relative or absolute path. include_path is not used for writing files.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    As of Smarty 3.1 the attribute \\$compile_dir is no longer accessible directly. Use getCompileDir() and setCompileDir() instead.

    See also getCompileDir(), setCompileDir(), $compile_id and $use_sub_dirs.

    "},{"location":"programmers/api-variables/variable-compile-id/","title":"\\$compile_id {#variable.compile.id}","text":"

    Persistent compile identifier. As an alternative to passing the same $compile_id to each and every function call, you can set this $compile_id and it will be used implicitly thereafter.

    If you use the same template with different pre- and/or post-filters you must use a unique $compile_id to keep the compiled template files separated.

    For example a prefilter that localizes your templates (that is: translates language dependent parts) at compile time, then you could use the current language as $compile_id and you will get a set of compiled templates for each language you use.

    <?php\n$smarty->compile_id = 'en';\n?>\n

    Another application would be to use the same compile directory across multiple domains / multiple virtual hosts.

    <?php\n\n$smarty->compile_id = $_SERVER['SERVER_NAME'];\n$smarty->compile_dir = '/path/to/shared_compile_dir';\n\n?>\n

    Note

    In Smarty 3 a $compile_id is no longer required to keep templates with same name in different $template_dir folders separated. The $template_dir file path is encoded in the file name of compiled and cached template files.

    "},{"location":"programmers/api-variables/variable-compile-locking/","title":"\\$compile_locking {#variable.compile.locking}","text":"

    Compile locking avoids concurrent compilation of the same template.

    Compile locking is enabled by default. To disable it set $compile_locking to FALSE.

    "},{"location":"programmers/api-variables/variable-compiler-class/","title":"\\$compiler_class {#variable.compiler.class}","text":"

    Specifies the name of the compiler class that Smarty will use to compile the templates. The default is \\'Smarty_Compiler\\'. For advanced users only.

    "},{"location":"programmers/api-variables/variable-config-booleanize/","title":"\\$config_booleanize {#variable.config.booleanize}","text":"

    If set to TRUE, config files values of on/true/yes and off/false/no get converted to boolean values automatically. This way you can use the values in the template like so: {if #foobar#}...{/if}. If foobar was on, true or yes, the {if} statement will execute. Defaults to TRUE.

    "},{"location":"programmers/api-variables/variable-config-dir/","title":"\\$config_dir {#variable.config.dir}","text":"

    This is the directory used to store config files used in the templates. Default is ./configs, meaning that Smarty will look for the configs/ directory in the same directory as the executing php script.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    As of Smarty 3.1 the attribute \\$config_dir is no longer accessible directly. Use getConfigDir(), setConfigDir() and addConfigDir() instead.

    See also getConfigDir(), setConfigDir() and addConfigDir().

    "},{"location":"programmers/api-variables/variable-config-overwrite/","title":"\\$config_overwrite {#variable.config.overwrite}","text":"

    If set to TRUE, the default then variables read in from config files will overwrite each other. Otherwise, the variables will be pushed onto an array. This is helpful if you want to store arrays of data in config files, just list each element multiple times.

    This examples uses {cycle} to output a table with alternating red/green/blue row colors with $config_overwrite = FALSE.

    The config file.

    # row colors\nrowColors = #FF0000\nrowColors = #00FF00\nrowColors = #0000FF\n

    The template with a {section} loop.

    <table>\n  {section name=r loop=$rows}\n  <tr bgcolor=\"{cycle values=#rowColors#}\">\n    <td> ....etc.... </td>\n  </tr>\n  {/section}\n</table>\n

    See also {config_load}, getConfigVars(), clearConfig(), configLoad() and the config files section.

    "},{"location":"programmers/api-variables/variable-config-read-hidden/","title":"\\$config_read_hidden {#variable.config.read.hidden}","text":"

    If set to TRUE, hidden sections ie section names beginning with a period(.) in config files can be read from templates. Typically you would leave this FALSE, that way you can store sensitive data in the config files such as database parameters and not worry about the template loading them. FALSE by default.

    "},{"location":"programmers/api-variables/variable-debug-template/","title":"\\$debug_tpl {#variable.debug_template}","text":"

    This is the name of the template file used for the debugging console. By default, it is named debug.tpl and is located in the SMARTY_DIR.

    See also $debugging and the debugging console section.

    "},{"location":"programmers/api-variables/variable-debugging-ctrl/","title":"\\$debugging_ctrl {#variable.debugging.ctrl}","text":"

    This allows alternate ways to enable debugging. NONE means no alternate methods are allowed. URL means when the keyword SMARTY_DEBUG is found in the QUERY_STRING, debugging is enabled for that invocation of the script. If $debugging is TRUE, this value is ignored.

    <?php\n// shows debug console only on localhost ie\n// http://localhost/script.php?foo=bar&SMARTY_DEBUG\n$smarty->debugging = false; // the default\n$smarty->debugging_ctrl = ($_SERVER['SERVER_NAME'] == 'localhost') ? 'URL' : 'NONE';\n?>\n

    See also debugging console section, $debugging and $smarty_debug_id.

    "},{"location":"programmers/api-variables/variable-debugging/","title":"\\$debugging {#variable.debugging}","text":"

    This enables the debugging console. The console is a javascript popup window that informs you of the included templates, variables assigned from php and config file variables for the current script. It does not show variables assigned within a template with the {assign} function.

    The console can also be enabled from the url with $debugging_ctrl.

    See also {debug}, $debug_tpl, and $debugging_ctrl.

    "},{"location":"programmers/api-variables/variable-default-config-handler-func/","title":"\\$default_config_handler_func {#variable.default.config.handler.func}","text":"

    This function is called when a config file cannot be obtained from its resource.

    Note

    The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a SmartyException is thrown.

    <?php\n\n$smarty = new Smarty();\n$smarty->default_config_handler_func = 'my_default_config_handler_func';\n\n/**\n * Default Config Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string   $type     resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string   $name     resource name (e.g. \"foo/bar.tpl\")\n * @param string  &$content  config's content\n * @param integer &$modified config's modification time\n * @param Smarty   $smarty   Smarty instance\n * @return string|boolean   path to file or boolean true if $content and $modified \n *                          have been filled, boolean false if no default config \n *                          could be loaded\n */\nfunction my_default_config_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n    if (false) {\n        // return corrected filepath\n        return \"/tmp/some/foobar.tpl\";\n    } elseif (false) {\n        // return a config directly\n        $content = 'someVar = \"the config source\"';\n        $modified = time();\n        return true;\n    } else {\n        // tell smarty that we failed\n        return false;\n    }\n}\n\n?>\n
    "},{"location":"programmers/api-variables/variable-default-config-type/","title":"\\$default_config_type {#variable.default.config.type}","text":"

    This tells smarty what resource type to use for config files. The default value is file, meaning that $smarty->configLoad('test.conf') and $smarty->configLoad('file:test.conf') are identical in meaning. See the resource chapter for more details.

    "},{"location":"programmers/api-variables/variable-default-modifiers/","title":"\\$default_modifiers {#variable.default.modifiers}","text":"

    This is an array of modifiers to implicitly apply to every variable in a template. For example, to HTML-escape every variable by default, use array('escape:\"htmlall\"'). To make a variable exempt from default modifiers, add the \\'nofilter\\' attribute to the output tag such as {$var nofilter}.

    "},{"location":"programmers/api-variables/variable-default-resource-type/","title":"\\$default_resource_type {#variable.default.resource.type}","text":"

    This tells smarty what resource type to use implicitly. The default value is file, meaning that $smarty->display('index.tpl') and $smarty->display('file:index.tpl') are identical in meaning. See the resource chapter for more details.

    "},{"location":"programmers/api-variables/variable-default-template-handler-func/","title":"\\$default_template_handler_func {#variable.default.template.handler.func}","text":"

    This function is called when a template cannot be obtained from its resource.

    Note

    The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a SmartyException is thrown.

    <?php\n\n$smarty = new Smarty();\n$smarty->default_template_handler_func = 'my_default_template_handler_func';\n\n/**\n * Default Template Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string   $type     resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string   $name     resource name (e.g. \"foo/bar.tpl\")\n * @param string  &$content  template's content\n * @param integer &$modified template's modification time\n * @param Smarty   $smarty   Smarty instance\n * @return string|boolean   path to file or boolean true if $content and $modified \n *                          have been filled, boolean false if no default template \n *                          could be loaded\n */\nfunction my_default_template_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n    if (false) {\n        // return corrected filepath\n        return \"/tmp/some/foobar.tpl\";\n    } elseif (false) {\n        // return a template directly\n        $content = \"the template source\";\n        $modified = time();\n        return true;\n    } else {\n        // tell smarty that we failed\n        return false;\n    }\n}\n\n?>\n
    "},{"location":"programmers/api-variables/variable-direct-access-security/","title":"\\$direct_access_security {#variable.direct.access.security}","text":"

    Direct access security inhibits direct browser access to compiled or cached template files.

    Direct access security is enabled by default. To disable it set $direct_access_security to FALSE.

    Note

    This is a compile time option. If you change the setting you must make sure that the templates get recompiled.

    "},{"location":"programmers/api-variables/variable-error-reporting/","title":"\\$error_reporting {#variable.error.reporting}","text":"

    When this value is set to a non-null-value it\\'s value is used as php\\'s error_reporting level inside of display() and fetch().

    Smarty 3.1.2 introduced the muteExpectedErrors() function. Calling Smarty::muteExpectedErrors(); after setting up custom error handling will ensure that warnings and notices (deliberately) produced by Smarty will not be passed to other custom error handlers. If your error logs are filling up with warnings regarding filemtime() or unlink() calls, please enable Smarty\\'s error muting.

    See also debugging and troubleshooting.

    "},{"location":"programmers/api-variables/variable-escape-html/","title":"\\$escape_html {#variable.escape.html}","text":"

    Setting $escape_html to TRUE will escape all template variable output by wrapping it in htmlspecialchars({$output}, ENT_QUOTES, $char_set);, which is the same as {$variable|escape:\"html\"}.

    Template designers can choose to selectively disable this feature by adding the nofilter flag: {$variable nofilter}.

    Modifiers and Filters are run in the following order: modifier, default_modifier, \\$escape_html, registered variable filters, autoloaded variable filters, template instance\\'s variable filters. Everything except the individual modifier can be disabled with the nofilter flag.

    Note

    This is a compile time option. If you change the setting you must make sure that the templates get recompiled.

    "},{"location":"programmers/api-variables/variable-force-cache/","title":"\\$force_cache {#variable.force.cache}","text":"

    This forces Smarty to (re)cache templates on every invocation. It does not override the $caching level, but merely pretends the template has never been cached before.

    "},{"location":"programmers/api-variables/variable-force-compile/","title":"\\$force_compile {#variable.force.compile}","text":"

    This forces Smarty to (re)compile templates on every invocation. This setting overrides $compile_check. By default this is FALSE. This is handy for development and debugging. It should never be used in a production environment. If $caching is enabled, the cache file(s) will be regenerated every time.

    "},{"location":"programmers/api-variables/variable-left-delimiter/","title":"\\$left_delimiter {#variable.left.delimiter}","text":"

    This is the left delimiter used by the template language. Default is {.

    See also $right_delimiter and escaping smarty parsing .

    "},{"location":"programmers/api-variables/variable-locking-timeout/","title":"\\$locking_timeout {#variable.locking.timeout}","text":"

    This is maximum time in seconds a cache lock is valid to avoid dead locks. The default value is 10 seconds.

    See also $cache_locking

    "},{"location":"programmers/api-variables/variable-merge-compiled-includes/","title":"\\$merge_compiled_includes {#variable.merge.compiled.includes}","text":"

    By setting $merge_compiled_includes to TRUE Smarty will merge the compiled template code of subtemplates into the compiled code of the main template. This increases rendering speed of templates using a many different sub-templates.

    Individual sub-templates can be merged by setting the inline option flag within the {include} tag. $merge_compiled_includes does not have to be enabled for the inline merge.

    ::: {.informalexample}

    <?php\n$smarty->merge_compiled_includes = true;\n?>\n

    :::

    Note

    This is a compile time option. If you change the setting you must make sure that the templates get recompiled.

    See also {include} tag

    "},{"location":"programmers/api-variables/variable-plugins-dir/","title":"\\$plugins_dir {#variable.plugins.dir}","text":"

    This is the directory or directories where Smarty will look for the plugins that it needs. Default is plugins/ under the SMARTY_DIR. If you supply a relative path, Smarty will first look under the SMARTY_DIR, then relative to the current working directory, then relative to the PHP include_path. If $plugins_dir is an array of directories, Smarty will search for your plugin in each plugin directory in the order they are given.

    Note

    For best performance, do not setup your $plugins_dir to have to use the PHP include path. Use an absolute pathname, or a path relative to SMARTY_DIR or the current working directory.

    Note

    As of Smarty 3.1 the attribute \\$plugins_dir is no longer accessible directly. Use getPluginsDir(), setPluginsDir() and addPluginsDir() instead.

    See also getPluginsDir(), setPluginsDir() and addPluginsDir().

    "},{"location":"programmers/api-variables/variable-right-delimiter/","title":"\\$right_delimiter {#variable.right.delimiter}","text":"

    This is the right delimiter used by the template language. Default is }.

    See also $left_delimiter and escaping smarty parsing.

    "},{"location":"programmers/api-variables/variable-smarty-debug-id/","title":"\\$smarty_debug_id {#variable.smarty.debug.id}","text":"

    The value of $smarty_debug_id defines the URL keyword to enable debugging at browser level. The default value is SMARTY_DEBUG.

    See also debugging console section, $debugging and $debugging_ctrl.

    "},{"location":"programmers/api-variables/variable-template-dir/","title":"\\$template_dir {#variable.template.dir}","text":"

    This is the name of the default template directory. If you do not supply a resource type when including files, they will be found here. By default this is ./templates, meaning that Smarty will look for the templates/ directory in the same directory as the executing php script. \\$template_dir can also be an array of directory paths: Smarty will traverse the directories and stop on the first matching template found.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    If the directories known to $template_dir are relative to directories known to the include_path you need to activate the $use_include_path option.

    Note

    As of Smarty 3.1 the attribute \\$template_dir is no longer accessible directly. Use getTemplateDir(), setTemplateDir() and addTemplateDir() instead.

    See also Template Resources, $use_include_path, getTemplateDir(), setTemplateDir() and addTemplateDir().

    "},{"location":"programmers/api-variables/variable-trusted-dir/","title":"\\$trusted_dir {#variable.trusted.dir}","text":"

    $trusted_dir is only for use when security is enabled. This is an array of all directories that are considered trusted. Trusted directories are where you keep php scripts that are executed directly from the templates with {insert}.

    "},{"location":"programmers/api-variables/variable-use-include-path/","title":"\\$use_include_path {#variable.use.include.path}","text":"

    This tells smarty to respect the include_path within the File Template Resource handler and the plugin loader to resolve the directories known to $template_dir. The flag also makes the plugin loader check the include_path for $plugins_dir.

    Note

    You should not design your applications to rely on the include_path, as this may - depending on your implementation - slow down your system (and Smarty) considerably.

    If use_include_path is enabled, file discovery for $template_dir and $plugins_dir work as follows.

    This means that whenever a directory/file relative to the current working directory is encountered, it is preferred over anything potentially accessible through the include_path.

    Note

    Smarty does not filter elements of the include_path. That means a \\\".:\\\" within your include path will trigger the current working directory lookup twice.

    See also Template Resources and $template_dir

    "},{"location":"programmers/api-variables/variable-use-sub-dirs/","title":"\\$use_sub_dirs {#variable.use.sub.dirs}","text":"

    Smarty will create subdirectories under the compiled templates and cache directories if $use_sub_dirs is set to TRUE, default is FALSE. In an environment where there are potentially tens of thousands of files created, this may help the filesystem speed. On the other hand, some environments do not allow PHP processes to create directories, so this must be disabled which is the default.

    Sub directories are more efficient, so use them if you can. Theoretically you get much better performance on a filesystem with 10 directories each having 100 files, than with 1 directory having 1000 files. This was certainly the case with Solaris 7 (UFS)... with newer filesystems such as ext3 and especially reiserfs, the difference is almost nothing.

    Note

    See also $compile_id, $cache_dir, and $compile_dir.

    "},{"location":"programmers/caching/caching-cacheable/","title":"Controlling Cacheability of Output {#caching.cacheable}","text":"

    If caching is enabled normally the whole final output of the page gets cached. However Smarty3 offers several options how to exclude sections of your output from caching.

    Note

    Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache.

    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-template-section-cacheabilitysections","title":"Cacheability of Template Section {#cacheability.sections}","text":"

    A larger section of your template can easily excluded from caching by using the {nocache} and {/nocache} tags.

    Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n

    The above code will output the current date on a cached page.

    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-tags-cacheabilitytags","title":"Cacheability of Tags {#cacheability.tags}","text":"

    Caching for an individual tag can be disabled by adding the \\\"nocache\\\" option flag to the tag.

    Today's date is\n{$smarty.now|date_format nocache}\n
    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-variables-cacheabilityvariables","title":"Cacheability of Variables {#cacheability.variables}","text":"

    You can assign() variables as not cachable. Any tag which uses such variable will be automatically executed in nocache mode.

    Note

    If a tag is executed in nocache mode you must make sure that all other variables used by that tag are also assigned from PHP when the page is loaded from the cache.

    Note

    The nocache status of an assigned variable will effect the compiled template code. If you change the status you must manually delete existing compiled and cached template files to force a recompile.

    // assign $foo as nocahe variable\n$smarty->assign('foo',time(),true);\n\n\nDynamic time value is {$foo}\n
    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-plugins-cacheabilityplugins","title":"Cacheability of Plugins {#cacheability.plugins}","text":"

    The cacheability of plugins can be declared when registering them. The third parameter to registerPlugin() is called $cacheable and defaults to TRUE.

    When registering a plugin with $cacheable=false the plugin is called everytime the page is displayed, even if the page comes from the cache. The plugin function behaves a little like an {insert} function.

    Note

    The $cacheable status will effect the compiled template code. If you change the status you must manually delete existing compiled and cached template files to force a recompile.

    In contrast to {insert} the attributes to the plugins are not cached by default. They can be declared to be cached with the fourth parameter $cache_attrs. $cache_attrs is an array of attribute-names that should be cached, so the plugin-function get value as it was the time the page was written to cache everytime it is fetched from the cache.

    <?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nfunction remaining_seconds($params, $smarty) {\n    $remain = $params['endtime'] - time();\n    if($remain >= 0){\n        return $remain . ' second(s)';\n    }else{\n        return 'done';\n    }\n}\n\n$smarty->registerPlugin('function','remaining', 'remaining_seconds', false, array('endtime'));\n\nif (!$smarty->isCached('index.tpl')) {\n    // fetch $obj from db and assign...\n    $smarty->assignByRef('obj', $obj);\n}\n\n$smarty->display('index.tpl');\n?>\n

    where index.tpl is:

    Time Remaining: {remaining endtime=$obj->endtime}\n

    The number of seconds till the endtime of $obj is reached changes on each display of the page, even if the page is cached. Since the endtime attribute is cached the object only has to be pulled from the database when page is written to the cache but not on subsequent requests of the page.

    index.php:\n\n<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nfunction smarty_block_dynamic($param, $content, $smarty) {\n    return $content;\n}\n$smarty->registerPlugin('block','dynamic', 'smarty_block_dynamic', false);\n\n$smarty->display('index.tpl');\n?>\n

    where index.tpl is:

    Page created: {'0'|date_format:'%D %H:%M:%S'}\n\n{dynamic}\n\nNow is: {'0'|date_format:'%D %H:%M:%S'}\n\n... do other stuff ...\n\n{/dynamic}\n

    When reloading the page you will notice that both dates differ. One is \"dynamic\" one is \"static\". You can do everything between {dynamic}...{/dynamic} and be sure it will not be cached like the rest of the page.

    Note

    The above example shall just demonstrate how a dynamic block plugins works. See Cacheability of Template Section on how to disable caching of a template section by the built-in {nocache} and {/nocache} tags.

    "},{"location":"programmers/caching/caching-custom/","title":"Custom Cache Implementation {#caching.custom}","text":"

    As an alternative to using the default file-based caching mechanism, you can specify a custom cache implementation that will be used to read, write and clear cached files.

    Note

    In Smarty2 this used to be a callback function called $cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.

    With a custom cache implementation you\\'re likely trying to achieve at least one of the following goals: replace the slow filesystem by a faster storage engine, centralize the cache to be accessible to multiple servers.

    Smarty allows CacheResource implementations to use one of the APIs Smarty_CacheResource_Custom or Smarty_CacheResource_KeyValueStore. Smarty_CacheResource_Custom is a simple API directing all read, write, clear calls to your implementation. This API allows you to store wherever and however you deem fit. The Smarty_CacheResource_KeyValueStore API allows you to turn any \\\"dumb\\\" KeyValue-Store (like APC, Memcache, ...) into a full-featured CacheResource implementation. That is, everything around deep cache-groups like \\\"a|b|c\\\" is being handled for you in way that allows clearing the cache-group \\\"a\\\" and all nested groups are cleared as well - even though KeyValue-Stores don\\'t allow this kind of hierarchy by nature.

    Custom CacheResources may be put in a file cacheresource.foobarxyz.php within your $plugins_dir, or registered on runtime with registerCacheResource(). In either case you need to set $caching_type to invoke your custom CacheResource implementation.

    <?php\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->caching_type = 'mysql';\n\n/**\n * MySQL CacheResource\n *\n * CacheResource Implementation based on the Custom API to use\n * MySQL as the storage resource for Smarty's output caching.\n *\n * Table definition:\n * <pre>CREATE TABLE IF NOT EXISTS `output_cache` (\n *   `id` CHAR(40) NOT NULL COMMENT 'sha1 hash',\n *   `name` VARCHAR(250) NOT NULL,\n *   `cache_id` VARCHAR(250) NULL DEFAULT NULL,\n *   `compile_id` VARCHAR(250) NULL DEFAULT NULL,\n *   `modified` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,\n *   `content` LONGTEXT NOT NULL,\n *   PRIMARY KEY (`id`),\n *   INDEX(`name`),\n *   INDEX(`cache_id`),\n *   INDEX(`compile_id`),\n *   INDEX(`modified`)\n * ) ENGINE = InnoDB;</pre>\n *\n * @package CacheResource-examples\n * @author Rodney Rehm\n */\nclass Smarty_CacheResource_Mysql extends Smarty_CacheResource_Custom {\n    // PDO instance\n    protected $db;\n    protected $fetch;\n    protected $fetchTimestamp;\n    protected $save;\n\n    public function __construct() {\n        try {\n            $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n        } catch (PDOException $e) {\n            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n        }\n        $this->fetch = $this->db->prepare('SELECT modified, content FROM output_cache WHERE id = :id');\n        $this->fetchTimestamp = $this->db->prepare('SELECT modified FROM output_cache WHERE id = :id');\n        $this->save = $this->db->prepare('REPLACE INTO output_cache (id, name, cache_id, compile_id, content)\n            VALUES  (:id, :name, :cache_id, :compile_id, :content)');\n    }\n\n    /**\n     * fetch cached content and its modification time from data source\n     *\n     * @param string $id unique cache content identifier\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @param string $content cached content\n     * @param integer $mtime cache modification timestamp (epoch)\n     * @return void\n     */\n    protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime)\n    {\n        $this->fetch->execute(array('id' => $id));\n        $row = $this->fetch->fetch();\n        $this->fetch->closeCursor();        \n        if ($row) {\n            $content = $row['content'];\n            $mtime = strtotime($row['modified']);\n        } else {\n            $content = null;\n            $mtime = null;\n        }\n    }\n\n    /**\n     * Fetch cached content's modification timestamp from data source\n     *\n     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the complete cached content.\n     * @param string $id unique cache content identifier\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @return integer|boolean timestamp (epoch) the template was modified, or false if not found\n     */\n    protected function fetchTimestamp($id, $name, $cache_id, $compile_id)\n    {\n        $this->fetchTimestamp->execute(array('id' => $id));\n        $mtime = strtotime($this->fetchTimestamp->fetchColumn());\n        $this->fetchTimestamp->closeCursor();\n        return $mtime;\n    }\n\n    /**\n     * Save content to cache\n     *\n     * @param string $id unique cache content identifier\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @param integer|null $exp_time seconds till expiration time in seconds or null\n     * @param string $content content to cache\n     * @return boolean success\n     */\n    protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content)\n    {\n        $this->save->execute(array(\n            'id' => $id,\n            'name' => $name,\n            'cache_id' => $cache_id,\n            'compile_id' => $compile_id,\n            'content' => $content,\n        ));\n        return !!$this->save->rowCount();\n    }\n\n    /**\n     * Delete content from cache\n     *\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @param integer|null $exp_time seconds till expiration or null\n     * @return integer number of deleted caches\n     */\n    protected function delete($name, $cache_id, $compile_id, $exp_time)\n    {\n        // delete the whole cache\n        if ($name === null && $cache_id === null && $compile_id === null && $exp_time === null) {\n            // returning the number of deleted caches would require a second query to count them\n            $query = $this->db->query('TRUNCATE TABLE output_cache');\n            return -1;\n        }\n        // build the filter\n        $where = array();\n        // equal test name\n        if ($name !== null) {\n            $where[] = 'name = ' . $this->db->quote($name);\n        }\n        // equal test compile_id\n        if ($compile_id !== null) {\n            $where[] = 'compile_id = ' . $this->db->quote($compile_id);\n        }\n        // range test expiration time\n        if ($exp_time !== null) {\n            $where[] = 'modified < DATE_SUB(NOW(), INTERVAL ' . intval($exp_time) . ' SECOND)';\n        }\n        // equal test cache_id and match sub-groups\n        if ($cache_id !== null) {\n            $where[] = '(cache_id = '. $this->db->quote($cache_id)\n                . ' OR cache_id LIKE '. $this->db->quote($cache_id .'|%') .')';\n        }\n        // run delete query\n        $query = $this->db->query('DELETE FROM output_cache WHERE ' . join(' AND ', $where));\n        return $query->rowCount();\n    }\n}\n\n\n\n\n<?php\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->caching_type = 'memcache';\n\n/**\n * Memcache CacheResource\n *\n * CacheResource Implementation based on the KeyValueStore API to use\n * memcache as the storage resource for Smarty's output caching.\n *\n * Note that memcache has a limitation of 256 characters per cache-key.\n * To avoid complications all cache-keys are translated to a sha1 hash.\n *\n * @package CacheResource-examples\n * @author Rodney Rehm\n */\nclass Smarty_CacheResource_Memcache extends Smarty_CacheResource_KeyValueStore {\n    /**\n     * memcache instance\n     * @var Memcache\n     */\n    protected $memcache = null;\n\n    public function __construct()\n    {\n        $this->memcache = new Memcache();\n        $this->memcache->addServer( '127.0.0.1', 11211 );\n    }\n\n    /**\n     * Read values for a set of keys from cache\n     *\n     * @param array $keys list of keys to fetch\n     * @return array list of values with the given keys used as indexes\n     * @return boolean true on success, false on failure\n     */\n    protected function read(array $keys)\n    {\n        $_keys = $lookup = array();\n        foreach ($keys as $k) {\n            $_k = sha1($k);\n            $_keys[] = $_k;\n            $lookup[$_k] = $k;\n        }\n        $_res = array();\n        $res = $this->memcache->get($_keys);\n        foreach ($res as $k => $v) {\n            $_res[$lookup[$k]] = $v;\n        }\n        return $_res;\n    }\n\n    /**\n     * Save values for a set of keys to cache\n     *\n     * @param array $keys list of values to save\n     * @param int $expire expiration time\n     * @return boolean true on success, false on failure\n     */\n    protected function write(array $keys, $expire=null)\n    {\n        foreach ($keys as $k => $v) {\n            $k = sha1($k);\n            $this->memcache->set($k, $v, 0, $expire);\n        }\n        return true;\n    }\n\n    /**\n     * Remove values from cache\n     *\n     * @param array $keys list of keys to delete\n     * @return boolean true on success, false on failure\n     */\n    protected function delete(array $keys)\n    {\n        foreach ($keys as $k) {\n            $k = sha1($k);\n            $this->memcache->delete($k);\n        }\n        return true;\n    }\n\n    /**\n     * Remove *all* values from cache\n     *\n     * @return boolean true on success, false on failure\n     */\n    protected function purge()\n    {\n        return $this->memcache->flush();\n    }\n}\n
    "},{"location":"programmers/caching/caching-groups/","title":"Cache Groups {#caching.groups}","text":"

    You can do more elaborate grouping by setting up $cache_id groups. This is accomplished by separating each sub-group with a vertical bar | in the $cache_id value. You can have as many sub-groups as you like.

    Cache grouping should not be confused with your template directory hierarchy, the cache grouping has no knowledge of how your templates are structured. So for example, if you have a template structure like themes/blue/index.tpl and you want to be able to clear all the cache files for the \"blue\" theme, you will need to create a cache group structure that mimics your template file structure, such as display('themes/blue/index.tpl','themes|blue'), then clear them with clearCache(null,'themes|blue').

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with 'sports|basketball' as the first two cache_id groups\n$smarty->clearCache(null,'sports|basketball');\n\n// clear all caches with \"sports\" as the first cache_id group. This would\n// include \"sports|basketball\", or \"sports|(anything)|(anything)|(anything)|...\"\n$smarty->clearCache(null,'sports');\n\n// clear the foo.tpl cache file with \"sports|basketball\" as the cache_id\n$smarty->clearCache('foo.tpl','sports|basketball');\n\n\n$smarty->display('index.tpl','sports|basketball');\n?>\n
    "},{"location":"programmers/caching/caching-multiple-caches/","title":"Multiple Caches Per Page {#caching.multiple.caches}","text":"

    You can have multiple cache files for a single call to display() or fetch(). Let\\'s say that a call to display('index.tpl') may have several different output contents depending on some condition, and you want separate caches for each one. You can do this by passing a $cache_id as the second parameter to the function call.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = $_GET['article_id'];\n\n$smarty->display('index.tpl', $my_cache_id);\n?>\n

    Above, we are passing the variable $my_cache_id to display() as the $cache_id. For each unique value of $my_cache_id, a separate cache will be generated for index.tpl. In this example, article_id was passed in the URL and is used as the $cache_id.

    Note

    Be very cautious when passing values from a client (web browser) into Smarty or any PHP application. Although the above example of using the article_id from the URL looks handy, it could have bad consequences. The $cache_id is used to create a directory on the file system, so if the user decided to pass an extremely large value for article_id, or write a script that sends random article_id\\'s at a rapid pace, this could possibly cause problems at the server level. Be sure to sanitize any data passed in before using it. In this instance, maybe you know the article_id has a length of ten characters and is made up of alpha-numerics only, and must be a valid article_id in the database. Check for this!

    Be sure to pass the same $cache_id as the second parameter to isCached() and clearCache().

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = $_GET['article_id'];\n\nif(!$smarty->isCached('index.tpl',$my_cache_id)) {\n    // No cache available, do variable assignments here.\n    $contents = get_database_contents();\n    $smarty->assign($contents);\n}\n\n$smarty->display('index.tpl',$my_cache_id);\n?>\n

    You can clear all caches for a particular $cache_id by passing NULL as the first parameter to clearCache().

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with \"sports\" as the $cache_id\n$smarty->clearCache(null,'sports');\n\n$smarty->display('index.tpl','sports');\n?>\n

    In this manner, you can \"group\" your caches together by giving them the same $cache_id.

    "},{"location":"programmers/caching/caching-setting-up/","title":"Setting Up Caching {#caching.setting.up}","text":"

    The first thing to do is enable caching by setting $caching to one of Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n// uses the value of $smarty->cacheLifetime() to determine\n// the number of seconds a cache is good for\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$smarty->display('index.tpl');\n?>\n

    With caching enabled, the function call to display('index.tpl') will render the template as usual, but also saves a copy of its output to a file (a cached copy) in the $cache_dir. On the next call to display('index.tpl'), the cached copy will be used instead of rendering the template again.

    Note

    The files in the $cache_dir are named similar to the template name. Although they end in the .php extension, they are not intended to be directly executable. Do not edit these files!

    Each cached page has a limited lifetime determined by $cache_lifetime. The default value is 3600 seconds, or one hour. After that time expires, the cache is regenerated. It is possible to give individual caches their own expiration time by setting $caching to Smarty::CACHING_LIFETIME_SAVED. See $cache_lifetime for more details.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n// retain current cache lifetime for each specific display call\n$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// set the cache_lifetime for index.tpl to 5 minutes\n$smarty->setCacheLifetime(300);\n$smarty->display('index.tpl');\n\n// set the cache_lifetime for home.tpl to 1 hour\n$smarty->setCacheLifetime(3600);\n$smarty->display('home.tpl');\n\n// NOTE: the following $cache_lifetime setting will not work when $caching\n// is set to Smarty::CACHING_LIFETIME_SAVED.\n// The cache lifetime for home.tpl has already been set\n// to 1 hour, and will no longer respect the value of $cache_lifetime.\n// The home.tpl cache will still expire after 1 hour.\n$smarty->setCacheLifetime(30); // 30 seconds\n$smarty->display('home.tpl');\n?>\n

    If $compile_check is enabled (default), every template file and config file that is involved with the cache file is checked for modification. If any of the files have been modified since the cache was generated, the cache is immediately regenerated. This is a computational overhead, so for optimum performance set $compile_check to FALSE.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n$smarty->setCompileCheck(false);\n\n$smarty->display('index.tpl');\n?>\n

    If $force_compile is enabled, the cache files will always be regenerated. This effectively disables caching, however this also seriously degrades performance. $force_compile is meant to be used for debugging purposes. The appropriate way to disable caching is to set $caching to Smarty::CACHING_OFF.

    The isCached() function can be used to test if a template has a valid cache or not. If you have a cached template that requires something like a database fetch, you can use this to skip that process.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl')) {\n    // No cache available, do variable assignments here.\n    $contents = get_database_contents();\n    $smarty->assign($contents);\n}\n\n$smarty->display('index.tpl');\n?>\n

    You can keep parts of a page dynamic (disable caching) with the {nocache}{/nocache} block function, the {insert} function, or by using the nocache parameter for most template functions.

    Let\\'s say the whole page can be cached except for a banner that is displayed down the side of the page. By using the {insert} function for the banner, you can keep this element dynamic within the cached content. See the documentation on {insert} for more details and examples.

    You can clear all the cache files with the clearAllCache() function, or individual cache files and groups with the clearCache() function.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear only cache for index.tpl\n$smarty->clearCache('index.tpl');\n\n// clear out all cache files\n$smarty->clearAllCache();\n\n$smarty->display('index.tpl');\n?>\n
    "},{"location":"programmers/plugins/plugins-block-functions/","title":"Block Functions {#plugins.block.functions}","text":"

    void

    smarty_block_

    name

    array

    \\$params

    mixed

    \\$content

    object

    \\$template

    boolean

    &\\$repeat

    Block functions are functions of the form: {func} .. {/func}. In other words, they enclose a template block and operate on the contents of this block. Block functions take precedence over custom functions of the same name, that is, you cannot have both custom function {func} and block function {func}..{/func}.

    If you have nested block functions, it\\'s possible to find out what the parent block function is by accessing $smarty->_tag_stack variable. Just do a var_dump() on it and the structure should be apparent.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     block.translate.php\n * Type:     block\n * Name:     translate\n * Purpose:  translate a block of text\n * -------------------------------------------------------------\n */\nfunction smarty_block_translate($params, $content, Smarty_Internal_Template $template, &$repeat)\n{\n    // only output on the closing tag\n    if(!$repeat){\n        if (isset($content)) {\n            $lang = $params['lang'];\n            // do some intelligent translation thing here with $content\n            return $translation;\n        }\n    }\n}\n?>\n

    See also: registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-compiler-functions/","title":"Compiler Functions {#plugins.compiler.functions}","text":"

    Compiler functions are called only during compilation of the template. They are useful for injecting PHP code or time-sensitive static content into the template. If there is both a compiler function and a custom function registered under the same name, the compiler function has precedence.

    mixed

    smarty_compiler_

    name

    array

    \\$params

    object

    \\$smarty

    The compiler function is passed two parameters: the params array which contains precompiled strings for the attribute values and the Smarty object. It\\'s supposed to return the code to be injected into the compiled template including the surrounding PHP tags.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     compiler.tplheader.php\n * Type:     compiler\n * Name:     tplheader\n * Purpose:  Output header containing the source file name and\n *           the time it was compiled.\n * -------------------------------------------------------------\n */\nfunction smarty_compiler_tplheader($params, Smarty $smarty)\n{\n    return \"<?php\\necho '\" . $smarty->_current_file . \" compiled at \" . date('Y-m-d H:M'). \"';\\n?>\";\n}\n?>\n

    This function can be called from the template as:

    {* this function gets executed at compile time only *}\n{tplheader}\n

    The resulting PHP code in the compiled template would be something like this:

    <?php\necho 'index.tpl compiled at 2002-02-20 20:02';\n?>\n

    See also registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-functions/","title":"Template Functions {#plugins.functions}","text":"

    void

    smarty_function_

    name

    array

    \\$params

    object

    \\$template

    All attributes passed to template functions from the template are contained in the $params as an associative array.

    The output (return value) of the function will be substituted in place of the function tag in the template, eg the {fetch} function. Alternatively, the function can simply perform some other task without any output, eg the {assign} function.

    If the function needs to assign some variables to the template or use some other Smarty-provided functionality, it can use the supplied $template object to do so eg $template->foo().

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     function.eightball.php\n * Type:     function\n * Name:     eightball\n * Purpose:  outputs a random magic answer\n * -------------------------------------------------------------\n */\nfunction smarty_function_eightball($params, Smarty_Internal_Template $template)\n{\n    $answers = array('Yes',\n                     'No',\n                     'No way',\n                     'Outlook not so good',\n                     'Ask again soon',\n                     'Maybe in your reality');\n\n    $result = array_rand($answers);\n    return $answers[$result];\n}\n?>\n

    which can be used in the template as:

    Question: Will we ever have time travel?\nAnswer: {eightball}.\n\n\n\n<?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     function.assign.php\n * Type:     function\n * Name:     assign\n * Purpose:  assign a value to a template variable\n * -------------------------------------------------------------\n */\nfunction smarty_function_assign($params, Smarty_Internal_Template $template)\n{\n    if (empty($params['var'])) {\n        trigger_error(\"assign: missing 'var' parameter\");\n        return;\n    }\n\n    if (!in_array('value', array_keys($params))) {\n        trigger_error(\"assign: missing 'value' parameter\");\n        return;\n    }\n\n    $template->assign($params['var'], $params['value']);\n\n}\n?>\n

    See also: registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-howto/","title":"How Plugins Work {#plugins.howto}","text":"

    Plugins are always loaded on demand. Only the specific modifiers, functions, resources, etc invoked in the templates scripts will be loaded. Moreover, each plugin is loaded only once, even if you have several different instances of Smarty running within the same request.

    Pre/postfilters and output filters are a bit of a special case. Since they are not mentioned in the templates, they must be registered or loaded explicitly via API functions before the template is processed. The order in which multiple filters of the same type are executed depends on the order in which they are registered or loaded.

    The plugins directory can be a string containing a path or an array containing multiple paths. To install a plugin, simply place it in one of the directories and Smarty will use it automatically.

    "},{"location":"programmers/plugins/plugins-inserts/","title":"Inserts {#plugins.inserts}","text":"

    Insert plugins are used to implement functions that are invoked by {insert} tags in the template.

    string

    smarty_insert_

    name

    array

    \\$params

    object

    \\$template

    The first parameter to the function is an associative array of attributes passed to the insert.

    The insert function is supposed to return the result which will be substituted in place of the {insert} tag in the template.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     insert.time.php\n * Type:     time\n * Name:     time\n * Purpose:  Inserts current date/time according to format\n * -------------------------------------------------------------\n */\nfunction smarty_insert_time($params, Smarty_Internal_Template $template)\n{\n    if (empty($params['format'])) {\n        trigger_error(\"insert time: missing 'format' parameter\");\n        return;\n    }\n    return strftime($params['format']);\n}\n?>\n
    "},{"location":"programmers/plugins/plugins-modifiers/","title":"Modifiers {#plugins.modifiers}","text":"

    Modifiers are little functions that are applied to a variable in the template before it is displayed or used in some other context. Modifiers can be chained together.

    mixed

    smarty_modifier_

    name

    mixed

    \\$value

    [mixed

    \\$param1

    , ...]

    The first parameter to the modifier plugin is the value on which the modifier is to operate. The rest of the parameters are optional, depending on what kind of operation is to be performed.

    The modifier has to return the result of its processing.

    This plugin basically aliases one of the built-in PHP functions. It does not have any additional parameters.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     modifier.capitalize.php\n * Type:     modifier\n * Name:     capitalize\n * Purpose:  capitalize words in the string\n * -------------------------------------------------------------\n */\nfunction smarty_modifier_capitalize($string)\n{\n    return ucwords($string);\n}\n?>\n\n\n<?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     modifier.truncate.php\n * Type:     modifier\n * Name:     truncate\n * Purpose:  Truncate a string to a certain length if necessary,\n *           optionally splitting in the middle of a word, and\n *           appending the $etc string.\n * -------------------------------------------------------------\n */\nfunction smarty_modifier_truncate($string, $length = 80, $etc = '...',\n                                  $break_words = false)\n{\n    if ($length == 0)\n        return '';\n\n    if (strlen($string) > $length) {\n        $length -= strlen($etc);\n        $fragment = substr($string, 0, $length+1);\n        if ($break_words)\n            $fragment = substr($fragment, 0, -1);\n        else\n            $fragment = preg_replace('/\\s+(\\S+)?$/', '', $fragment);\n        return $fragment.$etc;\n    } else\n        return $string;\n}\n?>\n

    See also registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-naming-conventions/","title":"Naming Conventions {#plugins.naming.conventions}","text":"

    Plugin files and functions must follow a very specific naming convention in order to be located by Smarty.

    plugin files must be named as follows:

    type.name.php

    plugin functions inside the PHP files must be named as follows:

    smarty_type_name

    Smarty will output appropriate error messages if the plugin file it needs is not found, or if the file or the plugin function are named improperly.

    "},{"location":"programmers/plugins/plugins-outputfilters/","title":"Output Filters {#plugins.outputfilters}","text":"

    Output filter plugins operate on a template\\'s output, after the template is loaded and executed, but before the output is displayed.

    string

    smarty_outputfilter_

    name

    string

    \\$template_output

    object

    \\$template

    The first parameter to the output filter function is the template output that needs to be processed, and the second parameter is the instance of Smarty invoking the plugin. The plugin is supposed to do the processing and return the results.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     outputfilter.protect_email.php\n * Type:     outputfilter\n * Name:     protect_email\n * Purpose:  Converts @ sign in email addresses to %40 as\n *           a simple protection against spambots\n * -------------------------------------------------------------\n */\n function smarty_outputfilter_protect_email($output, Smarty_Internal_Template $template)\n {\n     return preg_replace('!(\\S+)@([a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',\n                         '$1%40$2', $output);\n }\n?>\n

    See also registerFilter(), unregisterFilter().

    "},{"location":"programmers/plugins/plugins-prefilters-postfilters/","title":"Prefilters/Postfilters {#plugins.prefilters.postfilters}","text":"

    Prefilter and postfilter plugins are very similar in concept; where they differ is in the execution -- more precisely the time of their execution.

    string

    smarty_prefilter_

    name

    string

    \\$source

    object

    \\$template

    Prefilters are used to process the source of the template immediately before compilation. The first parameter to the prefilter function is the template source, possibly modified by some other prefilters. The plugin is supposed to return the modified source. Note that this source is not saved anywhere, it is only used for compilation.

    string

    smarty_postfilter_

    name

    string

    \\$compiled

    object

    \\$template

    Postfilters are used to process the compiled output of the template (the PHP code) immediately after the compilation is done but before the compiled template is saved to the filesystem. The first parameter to the postfilter function is the compiled template code, possibly modified by other postfilters. The plugin is supposed to return the modified version of this code.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     prefilter.pre01.php\n * Type:     prefilter\n * Name:     pre01\n * Purpose:  Convert html tags to be lowercase.\n * -------------------------------------------------------------\n */\n function smarty_prefilter_pre01($source, Smarty_Internal_Template $template)\n {\n     return preg_replace('!<(\\w+)[^>]+>!e', 'strtolower(\"$1\")', $source);\n }\n?>\n\n\n\n\n<?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     postfilter.post01.php\n * Type:     postfilter\n * Name:     post01\n * Purpose:  Output code that lists all current template vars.\n * -------------------------------------------------------------\n */\n function smarty_postfilter_post01($compiled, Smarty_Internal_Template $template)\n {\n     $compiled = \"<pre>\\n<?php print_r(\\$template->getTemplateVars()); ?>\\n</pre>\" . $compiled;\n     return $compiled;\n }\n?>\n

    See also registerFilter() and unregisterFilter().

    "},{"location":"programmers/plugins/plugins-resources/","title":"Resources {#plugins.resources}","text":"

    Resource plugins are meant as a generic way of providing template sources or PHP script components to Smarty. Some examples of resources: databases, LDAP, shared memory, sockets, and so on.

    Custom Resources may be put in a file resource.foobarxyz.php within your $plugins_dir, or registered on runtime with registerResource(). In either case you will be able to access that resource by prepending its name to the template you\\'re addressing: foobarxyz:yourtemplate.tpl.

    If a Resource\\'s templates should not be run through the Smarty compiler, the Custom Resource may extend Smarty_Resource_Uncompiled. The Resource Handler must then implement the function renderUncompiled(Smarty_Internal_Template $_template). $_template is a reference to the current template and contains all assigned variables which the implementor can access via $_template->smarty->getTemplateVars(). These Resources simply echo their rendered content to the output stream. The rendered output will be output-cached if the Smarty instance was configured accordingly. See libs/sysplugins/smarty_internal_resource_php.php for an example.

    If the Resource\\'s compiled templates should not be cached on disk, the Custom Resource may extend Smarty_Resource_Recompiled. These Resources are compiled every time they are accessed. This may be an expensive overhead. See libs/sysplugins/smarty_internal_resource_eval.php for an example.

    <?php\n\n/**\n * MySQL Resource\n *\n * Resource Implementation based on the Custom API to use\n * MySQL as the storage resource for Smarty's templates and configs.\n *\n * Table definition:\n * <pre>CREATE TABLE IF NOT EXISTS `templates` (\n *   `name` varchar(100) NOT NULL,\n *   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\n *   `source` text,\n *   PRIMARY KEY (`name`)\n * ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>\n *\n * Demo data:\n * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', \"2010-12-25 22:00:00\", '{$x=\"hello world\"}{$x}');</pre>\n *\n * @package Resource-examples\n * @author Rodney Rehm\n */\nclass Smarty_Resource_Mysql extends Smarty_Resource_Custom {\n    // PDO instance\n    protected $db;\n    // prepared fetch() statement\n    protected $fetch;\n    // prepared fetchTimestamp() statement\n    protected $mtime;\n\n    public function __construct() {\n        try {\n            $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n        } catch (PDOException $e) {\n            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n        }\n        $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');\n        $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');\n    }\n\n    /**\n     * Fetch a template and its modification time from database\n     *\n     * @param string $name template name\n     * @param string $source template source\n     * @param integer $mtime template modification timestamp (epoch)\n     * @return void\n     */\n    protected function fetch($name, &$source, &$mtime)\n    {\n        $this->fetch->execute(array('name' => $name));\n        $row = $this->fetch->fetch();\n        $this->fetch->closeCursor();\n        if ($row) {\n            $source = $row['source'];\n            $mtime = strtotime($row['modified']);\n        } else {\n            $source = null;\n            $mtime = null;\n        }\n    }\n\n    /**\n     * Fetch a template's modification time from database\n     *\n     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the comple template source.\n     * @param string $name template name\n     * @return integer timestamp (epoch) the template was modified\n     */\n    protected function fetchTimestamp($name) {\n        $this->mtime->execute(array('name' => $name));\n        $mtime = $this->mtime->fetchColumn();\n        $this->mtime->closeCursor();\n        return strtotime($mtime);\n    }\n}\n\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n\n// using resource from php script\n$smarty->display(\"mysql:index.tpl\");\n?>\n

    And from within Smarty template:

    {include file='mysql:extras/navigation.tpl'}\n

    See also registerResource(), unregisterResource().

    "},{"location":"programmers/plugins/plugins-writing/","title":"Writing Plugins {#plugins.writing}","text":"

    Plugins can be either loaded by Smarty automatically from the filesystem or they can be registered at runtime via one of the register_* API functions. They can also be unregistered by using unregister_* API functions.

    For the plugins that are registered at runtime, the name of the plugin function(s) does not have to follow the naming convention.

    If a plugin depends on some functionality provided by another plugin (as is the case with some plugins bundled with Smarty), then the proper way to load the needed plugin is this:

    <?php\nfunction smarty_function_yourPlugin(array $params, Smarty_Internal_Template $template)\n{\n  // load plugin depended upon\n  $template->smarty->loadPlugin('smarty_shared_make_timestamp');\n  // plugin code\n}\n?>\n

    As a general rule, the currently evaluated template\\'s Smarty_Internal_Template object is always passed to the plugins as the last parameter with two exceptions:

    "},{"location":"programmers/resources/resources-custom/","title":"Custom Template Resources {#resources.custom}","text":"

    You can retrieve templates using whatever possible source you can access with PHP: databases, sockets, files, etc. You do this by writing resource plugin functions and registering them with Smarty.

    See resource plugins section for more information on the functions you are supposed to provide.

    Note

    Note that you cannot override the built-in file: resource, but you can provide a resource that fetches templates from the file system in some other way by registering under another resource name.

    <?php\n\n/**\n* MySQL Resource\n*\n* Resource Implementation based on the Custom API to use\n* MySQL as the storage resource for Smarty's templates and configs.\n*\n* Table definition:\n* <pre>CREATE TABLE IF NOT EXISTS `templates` (\n*   `name` varchar(100) NOT NULL,\n*   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\n*   `source` text,\n*   PRIMARY KEY (`name`)\n* ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>\n*\n* Demo data:\n* <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', \"2010-12-25 22:00:00\", '{$x=\"hello world\"}{$x}');</pre>\n*\n* @package Resource-examples\n* @author Rodney Rehm\n*/\nclass Smarty_Resource_Mysql extends Smarty_Resource_Custom {\n // PDO instance\n protected $db;\n // prepared fetch() statement\n protected $fetch;\n // prepared fetchTimestamp() statement\n protected $mtime;\n\n public function __construct() {\n     try {\n         $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n     } catch (PDOException $e) {\n         throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n     }\n     $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');\n     $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');\n }\n\n /**\n  * Fetch a template and its modification time from database\n  *\n  * @param string $name template name\n  * @param string $source template source\n  * @param integer $mtime template modification timestamp (epoch)\n  * @return void\n  */\n protected function fetch($name, &$source, &$mtime)\n {\n     $this->fetch->execute(array('name' => $name));\n     $row = $this->fetch->fetch();\n     $this->fetch->closeCursor();\n     if ($row) {\n         $source = $row['source'];\n         $mtime = strtotime($row['modified']);\n     } else {\n         $source = null;\n         $mtime = null;\n     }\n }\n\n /**\n  * Fetch a template's modification time from database\n  *\n  * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the comple template source.\n  * @param string $name template name\n  * @return integer timestamp (epoch) the template was modified\n  */\n protected function fetchTimestamp($name) {\n     $this->mtime->execute(array('name' => $name));\n     $mtime = $this->mtime->fetchColumn();\n     $this->mtime->closeCursor();\n     return strtotime($mtime);\n }\n}\n\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n\n// using resource from php script\n$smarty->display(\"mysql:index.tpl\");\n?>\n

    And from within Smarty template:

    {include file='mysql:extras/navigation.tpl'}\n
    "},{"location":"programmers/resources/resources-extends/","title":"Extends Template Resources {#resources.extends}","text":"

    The extends: resource is used to define child/parent relationships for template inheritance from the PHP script. For details see section of Template Inheritance.

    As of Smarty 3.1 the extends: resource may use any available template resource, including string: and eval:. When templates from strings are used, make sure they are properly (url or base64) encoded. Is an eval: resource found within an inheritance chain, its \\\"don\\'t save a compile file\\\" property is superseded by the extends: resource. The templates within an inheritance chain are not compiled separately, though. Only a single compiled template will be generated.

    Note

    Use this when inheritance is required programmatically. When inheriting within PHP, it is not obvious from the child template what inheritance took place. If you have a choice, it is normally more flexible and intuitive to handle inheritance chains from within the templates.

    <?php\n$smarty->display('extends:parent.tpl|child.tpl|grandchild.tpl');\n\n// inheritance from multiple template sources\n$smarty->display('extends:db:parent.tpl|file:child.tpl|grandchild.tpl|eval:{block name=\"fooBazVar_\"}hello world{/block}'); \n?>\n

    See also Template Inheritance {block} and {extends}.

    "},{"location":"programmers/resources/resources-file/","title":"File Template Resources {#resources.file}","text":"

    Smarty ships with a built-in template resource for the filesystem. The file: is the default resource. The resource key file: must only be specified, if the $default_resource_type has been changed.

    If the file resource cannot find the requested template, the $default_template_handler_func is invoked.

    Note

    As of Smarty 3.1 the file resource no longer walks through the include_path unless $use_include_path is activated

    "},{"location":"programmers/resources/resources-file/#templates-from-template_dir-templatesfromtemplatedir","title":"Templates from \\$template_dir {#templates.from.template.dir}","text":"

    The file resource pulls templates source files from the directories specified in $template_dir. The list of directories is traversed in the order they appear in the array. The first template found is the one to process.

    <?php\n$smarty->display('index.tpl');\n$smarty->display('file:index.tpl'); // same as above\n?>\n

    From within a Smarty template

    {include file='index.tpl'}\n{include file='file:index.tpl'} {* same as above *}\n
    "},{"location":"programmers/resources/resources-file/#templates-from-a-specific-template_dir-templatesfromspecifiedtemplatedir","title":"Templates from a specific \\$template_dir {#templates.from.specified.template.dir}","text":"

    Smarty 3.1 introduced the bracket-syntax for specifying an element from $template_dir. This allows websites employing multiple sets of templates better control over which template to access.

    The bracket-syntax can be used from anywhere you can specify the file: resource type.

    <?php\n\n// setup template directories\n$smarty->setTemplateDir(array(\n    './templates',            // element: 0, index: 0\n    './templates_2',          // element: 1, index: 1\n    '10' => 'templates_10',   // element: 2, index: '10'\n    'foo' => 'templates_foo', // element: 3, index: 'foo'\n));\n\n/*\n  assume the template structure\n  ./templates/foo.tpl\n  ./templates_2/foo.tpl\n  ./templates_2/bar.tpl\n  ./templates_10/foo.tpl\n  ./templates_10/bar.tpl\n  ./templates_foo/foo.tpl\n*/\n\n// regular access\n$smarty->display('file:foo.tpl'); \n// will load ./templates/foo.tpl\n\n// using numeric index\n$smarty->display('file:[1]foo.tpl'); \n// will load ./templates_2/foo.tpl\n\n// using numeric string index\n$smarty->display('file:[10]foo.tpl'); \n// will load ./templates_10/foo.tpl\n\n// using string index\n$smarty->display('file:[foo]foo.tpl'); \n// will load ./templates_foo/foo.tpl\n\n// using \"unknown\" numeric index (using element number)\n$smarty->display('file:[2]foo.tpl'); \n// will load ./templates_10/foo.tpl\n\n?>\n

    From within a Smarty template

    {include file=\"file:foo.tpl\"}\n{* will load ./templates/foo.tpl *}\n\n{include file=\"file:[1]foo.tpl\"}\n{* will load ./templates_2/foo.tpl *}\n\n{include file=\"file:[foo]foo.tpl\"}\n{* will load ./templates_foo/foo.tpl *}\n
    "},{"location":"programmers/resources/resources-file/#templates-from-any-directory-templatesfromanydir","title":"Templates from any directory {#templates.from.any.dir}","text":"

    Templates outside of the $template_dir require the file: template resource type, followed by the absolute path to the template (with leading slash.)

    Note

    With Security enabled, access to templates outside of the $template_dir is not allowed unless you list those directories in $secure_dir.

    <?php\n$smarty->display('file:/export/templates/index.tpl');\n$smarty->display('file:/path/to/my/templates/menu.tpl');\n?>\n

    And from within a Smarty template:

    {include file='file:/usr/local/share/templates/navigation.tpl'}\n
    "},{"location":"programmers/resources/resources-file/#windows-filepaths-templateswindowsfilepath","title":"Windows Filepaths {#templates.windows.filepath}","text":"

    If you are using a Windows machine, filepaths usually include a drive letter (C:) at the beginning of the pathname. Be sure to use file: in the path to avoid namespace conflicts and get the desired results.

    <?php\n$smarty->display('file:C:/export/templates/index.tpl');\n$smarty->display('file:F:/path/to/my/templates/menu.tpl');\n?>\n

    And from within Smarty template:

    {include file='file:D:/usr/local/share/templates/navigation.tpl'}\n
    "},{"location":"programmers/resources/resources-streams/","title":"Stream Template Resources {#resources.streams}","text":"

    Streams allow you to use PHP streams as a template resource. The syntax is much the same a traditional template resource names.

    Smarty will first look for a registered template resource. If nothing is found, it will check if a PHP stream is available. If a stream is available, Smarty will use it to fetch the template.

    Note

    You can further define allowed streams with security enabled.

    Using a PHP stream for a template resource from the display() function.

     $smarty->display('foo:bar.tpl');\n

    Using a PHP stream for a template resource from within a template.

     {include file=\"foo:bar.tpl\"}\n
    "},{"location":"programmers/resources/resources-string/","title":"String Template Resources {#resources.string}","text":"

    Smarty can render templates from a string by using the string: or eval: resource.

    Note

    With a string: resource type, each unique string generates a compiled file. Smarty cannot detect a string that has changed, and therefore will generate a new compiled file for each unique string. It is important to choose the correct resource so that you do not fill your disk space with wasted compiled strings.

    <?php\n$smarty->assign('foo','value');\n$template_string = 'display {$foo} here';\n$smarty->display('string:'.$template_string); // compiles for later reuse\n$smarty->display('eval:'.$template_string); // compiles every time\n?>\n

    From within a Smarty template

    {include file=\"string:$template_string\"} {* compiles for later reuse *}\n{include file=\"eval:$template_string\"} {* compiles every time *}\n

    Both string: and eval: resources may be encoded with urlencode() or base64_encode(). This is not necessary for the usual use of string: and eval:, but is required when using either of them in conjunction with Extends Template Resource

     <?php\n $smarty->assign('foo','value');\n $template_string_urlencode = urlencode('display {$foo} here');\n $template_string_base64 = base64_encode('display {$foo} here');\n $smarty->display('eval:urlencode:'.$template_string_urlencode); // will decode string using urldecode()\n $smarty->display('eval:base64:'.$template_string_base64); // will decode string using base64_decode()\n ?>\n

    From within a Smarty template

     {include file=\"string:urlencode:$template_string_urlencode\"} {* will decode string using urldecode() *}\n {include file=\"eval:base64:$template_string_base64\"} {* will decode string using base64_decode() *}\n
    "},{"location":"programmers/resources/template-resources/","title":"Resources {#resasdources}","text":"

    The templates may come from a variety of sources. When you display() or fetch() a template, or when you include a template from within another template, you supply a resource type, followed by the appropriate path and template name. If a resource is not explicitly given, the value of $default_resource_type is assumed.

    "},{"location":"programmers/resources/template-resources/#templates-from-other-sources-templatesfromelsewhere","title":"Templates from other sources {#templates.from.elsewhere}","text":"

    You can retrieve templates using whatever possible source you can access with PHP: databases, sockets, files, etc. You do this by writing resource plugin functions and registering them with Smarty.

    See resource plugins section for more information on the functions you are supposed to provide.

    Note

    Note that you cannot override the built-in file: resource, but you can provide a resource that fetches templates from the file system in some other way by registering under another resource name.

    <?php\n\n/**\n * MySQL Resource\n *\n * Resource Implementation based on the Custom API to use\n * MySQL as the storage resource for Smarty's templates and configs.\n *\n * Table definition:\n * <pre>CREATE TABLE IF NOT EXISTS `templates` (\n *   `name` varchar(100) NOT NULL,\n *   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\n *   `source` text,\n *   PRIMARY KEY (`name`)\n * ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>\n *\n * Demo data:\n * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', \"2010-12-25 22:00:00\", '{$x=\"hello world\"}{$x}');</pre>\n *\n * @package Resource-examples\n * @author Rodney Rehm\n */\nclass Smarty_Resource_Mysql extends Smarty_Resource_Custom {\n    // PDO instance\n    protected $db;\n    // prepared fetch() statement\n    protected $fetch;\n    // prepared fetchTimestamp() statement\n    protected $mtime;\n\n    public function __construct() {\n        try {\n            $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n        } catch (PDOException $e) {\n            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n        }\n        $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');\n        $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');\n    }\n\n    /**\n     * Fetch a template and its modification time from database\n     *\n     * @param string $name template name\n     * @param string $source template source\n     * @param integer $mtime template modification timestamp (epoch)\n     * @return void\n     */\n    protected function fetch($name, &$source, &$mtime)\n    {\n        $this->fetch->execute(array('name' => $name));\n        $row = $this->fetch->fetch();\n        $this->fetch->closeCursor();\n        if ($row) {\n            $source = $row['source'];\n            $mtime = strtotime($row['modified']);\n        } else {\n            $source = null;\n            $mtime = null;\n        }\n    }\n\n    /**\n     * Fetch a template's modification time from database\n     *\n     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the comple template source.\n     * @param string $name template name\n     * @return integer timestamp (epoch) the template was modified\n     */\n    protected function fetchTimestamp($name) {\n        $this->mtime->execute(array('name' => $name));\n        $mtime = $this->mtime->fetchColumn();\n        $this->mtime->closeCursor();\n        return strtotime($mtime);\n    }\n}\n\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n\n// using resource from php script\n$smarty->display(\"mysql:index.tpl\");\n?>\n

    And from within Smarty template:

    {include file='mysql:extras/navigation.tpl'}\n
    "},{"location":"programmers/resources/template-resources/#default-template-handler-function-defaulttemplatehandlerfunction","title":"Default template handler function {#default.template.handler.function}","text":"

    You can specify a function that is used to retrieve template contents in the event the template cannot be retrieved from its resource. One use of this is to create templates that do not exist on-the-fly.

    See also Streams

    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Smarty 4 Documentation","text":"

    Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.

    It allows you to write templates, using variables, modifiers, functions and comments, like this: 

    <h1>{$title|escape}</h1>\n\n<p>\n    The number of pixels is: {math equation=\"x * y\" x=$height y=$width}.\n</p>\n

    When this template is rendered, with the value \"Hello world\" for the variable $title, 640 for $width, and 480 for $height, the result is: 

    <h1>Hello world</h1>\n\n<p>\n    The number of pixels is: 307200.\n</p>\n

    "},{"location":"#introduction","title":"Introduction","text":""},{"location":"#smarty-for-template-designers","title":"Smarty for template designers","text":""},{"location":"#smarty-for-php-developers","title":"Smarty for php developers","text":""},{"location":"#other","title":"Other","text":""},{"location":"features/","title":"Features","text":"

    Some of Smarty's features: - It is extremely fast. - It is efficient since the PHP parser does the dirty work. - No template parsing overhead, only compiles once. - It is smart about recompiling only the template files that have changed. - You can easily create your own custom functions and variable modifiers, so the template language is extremely extensible. - Configurable template {delimiter} tag syntax, so you can use {$foo}, {{$foo}}, <!--{$foo}-->, etc. - The {if}..{elseif}..{else}..{/if} constructs are passed to the PHP parser, so the {if...} expression syntax can be as simple or as complex an evaluation as you like. - Allows unlimited nesting of sections, if's etc. - Built-in caching support - Arbitrary template sources - Template Inheritance for easy management of template content. - Plugin architecture

    "},{"location":"features/#separation-of-presentation-from-application-code","title":"Separation of presentation from application code","text":""},{"location":"features/#how-does-it-work","title":"How does it work?","text":"

    Under the hood, Smarty \"compiles\" (basically copies and converts) the templates into PHP scripts. This happens once when each template is first invoked, and then the compiled versions are used from that point forward. Smarty takes care of this for you, so the template designer just edits the Smarty templates and never has to manage the compiled versions. This approach keeps the templates easy to maintain, and yet keeps execution times extremely fast since the compiled code is just PHP. And of course, all PHP scripts take advantage of PHP op-code caches such as APC.

    "},{"location":"features/#template-inheritance","title":"Template Inheritance","text":"

    Template inheritance was introduced in Smarty 3. Before template inheritance, we managed our templates in pieces such as header and footer templates. This organization lends itself to many problems that require some hoop-jumping, such as managing content within the header/footer on a per-page basis. With template inheritance, instead of including other templates we maintain our templates as single pages. We can then manipulate blocks of content within by inheriting them. This makes templates intuitive, efficient and easy to manage. See Template Inheritance for more info.

    "},{"location":"features/#why-not-use-xmlxslt-syntax","title":"Why not use XML/XSLT syntax?","text":"

    There are a couple of good reasons. First, Smarty can be used for more than just XML/HTML based templates, such as generating emails, javascript, CSV, and PDF documents. Second, XML/XSLT syntax is even more verbose and fragile than PHP code! It is perfect for computers, but horrible for humans. Smarty is about being easy to read, understand and maintain.

    "},{"location":"features/#template-security","title":"Template Security","text":"

    Although Smarty insulates you from PHP, you still have the option to use it in certain ways if you wish. Template security forces the restriction of PHP (and select Smarty functions.) This is useful if you have third parties editing templates, and you don't want to unleash the full power of PHP or Smarty to them.

    "},{"location":"features/#integration","title":"Integration","text":"

    Sometimes Smarty gets compared to Model-View-Controller (MVC) frameworks. Smarty is not an MVC, it is just the presentation layer, much like the View (V) part of an MVC. As a matter of fact, Smarty can easily be integrated as the view layer of an MVC. Many of the more popular ones have integration instructions for Smarty, or you may find some help here in the forums and documentation.

    "},{"location":"features/#other-template-engines","title":"Other Template Engines","text":"

    Smarty is not the only engine following the \"Separate Programming Code from Presentation\" philosophy. For instance, Python has template engines built around the same principles such as Django Templates and CheetahTemplate. Note: Languages such as Python do not mix with HTML natively, which give them the advantage of proper programming code separation from the outset. There are libraries available to mix Python with HTML, but they are typically avoided.

    "},{"location":"features/#what-smarty-is-not","title":"What Smarty is Not","text":"

    Smarty is not an application development framework. Smarty is not an MVC. Smarty is not an alternative to Laravel, Symfony, CodeIgniter, or any of the other application development frameworks for PHP.

    Smarty is a template engine, and works as the (V)iew component of your application. Smarty can easily be coupled to any of the engines listed above as the view component. No different than any other software, Smarty has a learning curve. Smarty does not guarantee good application design or proper separation of presentation, this still needs to be addressed by a competent developer and web designer.

    "},{"location":"features/#is-smarty-right-for-me","title":"Is Smarty Right for Me?","text":"

    Smarty is not meant to be a tool for every job. The important thing is to identify if Smarty fits your needs. There are some important questions to ask yourself:

    "},{"location":"features/#template-syntax","title":"Template Syntax","text":"

    Are you content with PHP tags mixed with HTML? Are your web designers comfortable with PHP? Would your web designers prefer a tag-based syntax designed for presentation? Some experience working with both Smarty and PHP helps answer these questions.

    "},{"location":"features/#the-business-case","title":"The Business Case","text":"

    Is there a requirement to insulate the templates from PHP? Do you have untrusted parties editing templates that you do not wish to unleash the power of PHP to? Do you need to programmatically control what is and is not available within the templates? Smarty supplies these capabilities by design.

    "},{"location":"features/#feature-set","title":"Feature set","text":"

    Does Smarty's features such as caching, template inheritance and plugin architecture save development cycles writing code that would be needed otherwise? Does the codebase or framework you plan on using have the features you need for the presentation component?

    "},{"location":"features/#sites-using-smarty","title":"Sites using Smarty","text":"

    Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, Tiki CMS/Groupware and X-Cart to name a few.

    "},{"location":"features/#summary","title":"Summary","text":"

    Whether you are using Smarty for a small website or massive enterprise solution, it can accommodate your needs. There are numerous features that make Smarty a great choice:

    "},{"location":"getting-started/","title":"Getting started","text":""},{"location":"getting-started/#requirements","title":"Requirements","text":"

    Smarty can be run with PHP 7.1 to PHP 8.3.

    "},{"location":"getting-started/#installation","title":"Installation","text":"

    Smarty can be installed with Composer.

    To get the latest stable version of Smarty use: 

    composer require smarty/smarty\n

    To get the latest, unreleased version, use: 

    composer require smarty/smarty:dev-master\n

    To get the previous stable version of Smarty, Smarty 3, use: 

    composer require smarty/smarty:^3\n

    Here's how you create an instance of Smarty in your PHP scripts: 

    <?php\n\nrequire 'vendor/autoload.php';\n$smarty = new Smarty();\n

    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 templates, configs, templates_c and cache relative to the current working directory.

    The defaults can be changed as follows: 

    $smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\n

    The compile dir and cache dir need to be writable for the user running the PHP script.

    Note

    This is usually user \"nobody\" and group \"nobody\". For OS X users, the default is user \"www\" and group \"www\". If you are using Apache, you can look in your httpd.conf file to see what user and group are being used.

    chown nobody:nobody /web/www.example.com/guestbook/templates_c/\nchmod 770 /web/www.example.com/guestbook/templates_c/\n\nchown nobody:nobody /web/www.example.com/guestbook/cache/\nchmod 770 /web/www.example.com/guestbook/cache/\n

    You can verify if your system has the correct access rights for these directories with testInstall():

    $smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\n$smarty->testInstall();\n

    Now, let's create the index.tpl file that Smarty will display. This needs to be located in the $template_dir.

    {* Smarty *}\nHello {$name}, welcome to Smarty!\n

    Note

    {* Smarty *} is a template comment. It is not required, but it is good practice to start all your template files with this comment. It makes the file easy to recognize regardless of the file extension. For example, text editors could recognize the file and turn on special syntax highlighting.

    Now lets edit our php file. We'll create an instance of Smarty, assign() a template variable and display() the index.tpl file.

    <?php\n\nrequire 'vendor/autoload.php';\n\n$smarty = new Smarty();\n\n$smarty->setTemplateDir('/web/www.example.com/guestbook/templates/');\n$smarty->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n$smarty->setConfigDir('/web/www.example.com/guestbook/configs/');\n$smarty->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\n

    Note

    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!\"

    You have completed the basic setup for Smarty!

    "},{"location":"getting-started/#extended-setup","title":"Extended Setup","text":"

    This is a continuation of the basic installation, please read that first!

    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.

    <?php\n\nclass Smarty_GuestBook extends Smarty {\n\n   public function __construct()\n   {\n        parent::__construct();\n\n        $this->setTemplateDir('/web/www.example.com/guestbook/templates/');\n        $this->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n        $this->setConfigDir('/web/www.example.com/guestbook/configs/');\n        $this->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n        $this->caching = Smarty::CACHING_LIFETIME_CURRENT;\n        $this->assign('app_name', 'Guest Book');\n   }\n\n}\n

    Now, we can use Smarty_GuestBook instead of Smarty in our scripts: 

    <?php\n$smarty = new Smarty_GuestBook();\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\n

    "},{"location":"philosophy/","title":"Philosophy","text":""},{"location":"philosophy/#what-is-smarty","title":"What is Smarty?","text":"

    Smarty is a template engine for PHP. More specifically, it facilitates a manageable way to separate application logic and content from its presentation. This is best described in a situation where the application programmer and the template designer play different roles, or in most cases are not the same person.

    For example, let\\'s say you are creating a web page that is displaying a newspaper article.

    "},{"location":"philosophy/#goals","title":"Goals","text":"

    The Smarty design was largely driven by these goals: - clean separation of presentation from application code - PHP backend, Smarty template frontend - complement PHP, not replace it - fast development/deployment for programmers and designers - quick and easy to maintain - syntax easy to understand, no PHP knowledge necessary - flexibility for custom development - security: insulation from PHP - free, open source

    "},{"location":"philosophy/#two-camps-of-thought","title":"Two camps of thought","text":"

    When it comes to templating in PHP, there are basically two camps of thought. The first camp exclaims that \\\"PHP is a template engine\\\". This approach simply mixes PHP code with HTML. Although this approach is fastest from a pure script-execution point of view, many would argue that the PHP syntax is messy and complicated when mixed with tagged markup such as HTML.

    The second camp exclaims that presentation should be void of all programming code, and instead use simple tags to indicate where application content is revealed. This approach is common with other template engines (even in other programming languages), and is also the approach that Smarty takes. The idea is to keep the templates focused squarely on presentation, void of application code, and with as little overhead as possible.

    "},{"location":"philosophy/#why-is-separating-php-from-templates-important","title":"Why is separating PHP from templates important?","text":"

    Two major benefits:

    "},{"location":"philosophy/#web-designers-and-php","title":"Web designers and PHP","text":"

    A common question: \"Web designers have to learn a syntax anyway, why not PHP?\" Of course web designers can learn PHP, and they may already be familiar with it. The issue isn't their ability to learn PHP, it is about the consequences of mixing PHP with HTML. If designers use PHP, it is too easy to add code into templates that doesn't belong there (you just handed them a swiss-army knife when they just needed a knife.) You can teach them the rules of application design, but this is probably something they don't really need to learn (now they are developers!) The PHP manual is also an overwhelming pile of information to sift through. It is like handing the owner of a car the factory assembly manual when all they need is the owners manual. Smarty gives web designers exactly the tools they need, and gives developers fine-grained control over those tools. The simplicity of the tag-based syntax is also a huge welcome for designers, it helps them streamline the organization and management of templates.

    "},{"location":"upgrading/","title":"Upgrading from an older version","text":""},{"location":"upgrading/#upgrading-from-v3-to-v4","title":"Upgrading from v3 to v4","text":"

    Smarty 4 is mostly identical to Smarty 3. Most notably, it adds support for PHP8 and drops support for PHP7.0 and below. Additionally, some deprecated features that have long been discouraged have been dropped from the language.

    "},{"location":"upgrading/#muting-php8-warnings","title":"Muting PHP8 warnings","text":"

    If you simultaneously upgrade Smarty to v4 van PHP to v8, you may notice your error logs filling up with warnings about undefined or null template vars due to a change in how PHP handles these. This may be helpful to spot errors, but if you find this annoying, you can use $smarty->muteUndefinedOrNullWarnings() to make Smarty convert these warnings into notices.

    "},{"location":"upgrading/#asp-tags","title":"ASP tags","text":"

    You can no longer user ASP-style tags like <% %> and <%= %> in your templates. Replace them with {...} tags.

    "},{"location":"upgrading/#smartybc","title":"SmartyBC","text":"

    Check your codebase for SmartyBC. We have dropped deprecated API calls that where only accessible through the SmartyBC class.

    "},{"location":"upgrading/#no-more-embedded-php","title":"No more embedded PHP","text":"

    We have completely dropped support for {php} and {include_php} tags and embedded PHP in templates. Check your templates for this, and rewrite any embedded PHP blocks, by moving logic to your PHP files or by creating a plugin function.

    "},{"location":"upgrading/#other-changes","title":"Other changes","text":"

    Search your code for the following changes:

    "},{"location":"appendixes/tips/","title":"Tips & Tricks","text":""},{"location":"appendixes/tips/#blank-variable-handling","title":"Blank Variable Handling","text":"

    There may be times when you want to print a default value for an empty variable instead of printing nothing, such as printing &nbsp; so that html table backgrounds work properly. Many would use an {if} statement to handle this, but there is a shorthand way with Smarty, using the default variable modifier.

    Note

    \"Undefined variable\" errors will show an E_NOTICE if not disabled in PHP's error_reporting() level or Smarty's $error_reporting property and a variable had not been assigned to Smarty.

        {* the long way *}\n    {if $title eq ''}\n       &nbsp;\n    {else}\n       {$title}\n    {/if}\n\n    {* the short way *}\n    {$title|default:'&nbsp;'}\n

    See also default modifier and default variable handling.

    "},{"location":"appendixes/tips/#default-variable-handling","title":"Default Variable Handling","text":"

    If a variable is used frequently throughout your templates, applying the default modifier every time it is mentioned can get a bit ugly. You can remedy this by assigning the variable its default value with the {assign} function.

    {* do this somewhere at the top of your template *}\n{assign var='title' value=$title|default:'no title'}\n\n{* if $title was empty, it now contains the value \"no title\" when you use it *}\n{$title}\n

    See also default modifier and blank variable handling.

    "},{"location":"appendixes/tips/#passing-variable-title-to-header-template","title":"Passing variable title to header template","text":"

    When the majority of your templates use the same headers and footers, it is common to split those out into their own templates and {include} them. But what if the header needs to have a different title, depending on what page you are coming from? You can pass the title to the header as an attribute when it is included.

    mainpage.tpl - When the main page is drawn, the title of \"Main Page\" is passed to the header.tpl, and will subsequently be used as the title.

    {include file='header.tpl' title='Main Page'}\n{* template body goes here *}\n{include file='footer.tpl'}\n

    archives.tpl - When the archives page is drawn, the title will be \"Archives\". Notice in the archive example, we are using a variable from the archives_page.conf file instead of a hard coded variable.

    {config_load file='archive_page.conf'}\n\n{include file='header.tpl' title=#archivePageTitle#}\n{* template body goes here *}\n{include file='footer.tpl'}\n

    header.tpl - Notice that \"Smarty News\" is printed if the $title variable is not set, using the default variable modifier.

    <html>\n    <head>\n        <title>{$title|default:'Smarty News'}</title>\n    </head>\n<body>\n

    footer.tpl

        </body>\n</html>\n
    "},{"location":"appendixes/tips/#dates","title":"Dates","text":"

    As a rule of thumb, always pass dates to Smarty as timestamps. This allows template designers to use the date_format modifier for full control over date formatting, and also makes it easy to compare dates if necessary.

    {$startDate|date_format}\n

    This will output:

    Jan 4, 2009\n
    {$startDate|date_format:\"%Y/%m/%d\"}\n

    This will output:

    2009/01/04\n

    Dates can be compared in the template by timestamps with:

    {if $order_date < $invoice_date}\n   ...do something..\n{/if}\n

    When using {html_select_date} in a template, the programmer will most likely want to convert the output from the form back into timestamp format. Here is a function to help you with that.

    <?php\n\n// this assumes your form elements are named\n// startDate_Day, startDate_Month, startDate_Year\n\n$startDate = makeTimeStamp($startDate_Year, $startDate_Month, $startDate_Day);\n\nfunction makeTimeStamp($year='', $month='', $day='')\n{\n   if(empty($year)) {\n       $year = strftime('%Y');\n   }\n   if(empty($month)) {\n       $month = strftime('%m');\n   }\n   if(empty($day)) {\n       $day = strftime('%d');\n   }\n\n   return mktime(0, 0, 0, $month, $day, $year);\n}\n

    See also {html_select_date}, {html_select_time}, date_format and $smarty.now,

    "},{"location":"appendixes/tips/#componentized-templates","title":"Componentized Templates","text":"

    Traditionally, programming templates into your applications goes as follows: First, you accumulate your variables within your PHP application, (maybe with database queries.) Then, you instantiate your Smarty object, assign() the variables and display() the template. So lets say for example we have a stock ticker on our template. We would collect the stock data in our application, then assign these variables in the template and display it. Now wouldn't it be nice if you could add this stock ticker to any application by merely including the template, and not worry about fetching the data up front?

    You can do this by writing a custom plugin for fetching the content and assigning it to a template variable.

    function.load_ticker.php - drop file in $plugins directory

    <?php\n\n// setup our function for fetching stock data\nfunction fetch_ticker($symbol)\n{\n   // put logic here that fetches $ticker_info\n   // from some ticker resource\n   return $ticker_info;\n}\n\nfunction smarty_function_load_ticker($params, $smarty)\n{\n   // call the function\n   $ticker_info = fetch_ticker($params['symbol']);\n\n   // assign template variable\n   $smarty->assign($params['assign'], $ticker_info);\n}\n

    index.tpl

    {load_ticker symbol='SMARTY' assign='ticker'}\n\nStock Name: {$ticker.name} Stock Price: {$ticker.price}\n

    See also: {include}.

    "},{"location":"appendixes/tips/#obfuscating-e-mail-addresses","title":"Obfuscating E-mail Addresses","text":"

    Do you ever wonder how your email address gets on so many spam mailing lists? One way spammers collect email addresses is from web pages. To help combat this problem, you can make your email address show up in scrambled javascript in the HTML source, yet it it will look and work correctly in the browser. This is done with the {mailto} plugin.

    <div id=\"contact\">Send inquiries to\n{mailto address=$EmailAddress encode='javascript' subject='Hello'}\n</div>\n

    Note

    This method isn\\'t 100% foolproof. A spammer could conceivably program his e-mail collector to decode these values, but not likely.... hopefully..yet ... wheres that quantum computer :-?.

    See also escape modifier and {mailto}.

    "},{"location":"appendixes/troubleshooting/","title":"Troubleshooting","text":""},{"location":"appendixes/troubleshooting/#smartyphp-errors","title":"Smarty/PHP errors","text":"

    Smarty can catch many errors such as missing tag attributes or malformed variable names. If this happens, you will see an error similar to the following:

    Warning: Smarty: [in index.tpl line 4]: syntax error: unknown tag - '%blah'\n       in /path/to/smarty/Smarty.class.php on line 1041\n\nFatal error: Smarty: [in index.tpl line 28]: syntax error: missing section name\n       in /path/to/smarty/Smarty.class.php on line 1041\n

    Smarty shows you the template name, the line number and the error. After that, the error consists of the actual line number in the Smarty class that the error occurred.

    There are certain errors that Smarty cannot catch, such as missing close tags. These types of errors usually end up in PHP compile-time parsing errors.

    Parse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75

    When you encounter a PHP parsing error, the error line number will correspond to the compiled PHP script, NOT the template itself. Usually you can look at the template and spot the syntax error. Here are some common things to look for: missing close tags for {if}{/if} or {section}{/section}, or syntax of logic within an {if} tag. If you can\\'t find the error, you might have to open the compiled PHP file and go to the line number to figure out where the corresponding error is in the template.

    Warning: Smarty error: unable to read resource: \"index.tpl\" in...\n
    or 
    Warning: Smarty error: unable to read resource: \"site.conf\" in...\n

    Fatal error: Smarty error: the $compile_dir 'templates_c' does not exist,\nor is not a directory...\n
    Fatal error: Smarty error: unable to write to $compile_dir '....\n
    Fatal error: Smarty error: the $cache_dir 'cache' does not exist,\nor is not a directory. in /..\n
    Fatal error: Smarty error: unable to write to $cache_dir '/...\n
    Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php \nin /path/to/smarty/libs/sysplugins/smarty_resource.php\n

    See also debugging.

    "},{"location":"designers/chapter-debugging-console/","title":"Debugging Console","text":"

    There is a debugging console included with Smarty. The console informs you of all the included templates, assigned variables and config file variables for the current invocation of the template. A template file named debug.tpl is included with the distribution of Smarty which controls the formatting of the console.

    Set $debugging to TRUE in Smarty, and if needed set $debug_tpl to the template resource path to debug.tpl (this is in SMARTY_DIR by default). When you load the page, a Javascript console window will pop up and give you the names of all the included templates and assigned variables for the current page.

    To see the available variables for a particular template, see the {debug} template function. To disable the debugging console, set $debugging to FALSE. You can also temporarily turn on the debugging console by putting SMARTY_DEBUG in the URL if you enable this option with $debugging_ctrl.

    Note

    The debugging console does not work when you use the fetch() API, only when using display(). It is a set of javascript statements added to the very bottom of the generated template. If you do not like javascript, you can edit the debug.tpl template to format the output however you like. Debug data is not cached and debug.tpl info is not included in the output of the debug console.

    Note

    The load times of each template and config file are in seconds, or fractions thereof.

    See also troubleshooting.

    "},{"location":"designers/config-files/","title":"Config Files","text":"

    Config files are handy for designers to manage global template variables from one file. One example is template colors. Normally if you wanted to change the color scheme of an application, you would have to go through each and every template file and change the colors. With a config file, the colors can be kept in one place, and only one file needs to be updated.

    # global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n[Customer]\npageTitle = \"Customer Info\"\n\n[Login]\npageTitle = \"Login\"\nfocus = \"username\"\nIntro = \"\"\"This is a value that spans more\n           than one line. you must enclose\n           it in triple quotes.\"\"\"\n\n# hidden section\n[.Database]\nhost=my.example.com\ndb=ADDRESSBOOK\nuser=php-user\npass=foobar\n

    Values of config file variables can be in quotes, but not necessary. You can use either single or double quotes. If you have a value that spans more than one line, enclose the entire value with triple quotes (\"\"\"). You can put comments into config files by any syntax that is not a valid config file syntax. We recommend using a # (hash) at the beginning of the line.

    The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing [ or ] symbols. The four variables at the top are global variables, or variables not within a section. These variables are always loaded from the config file. If a particular section is loaded, then the global variables and the variables from that section are also loaded. If a variable exists both as a global and in a section, the section variable is used. If you name two variables the same within a section, the last one will be used unless $config_overwrite is disabled.

    Config files are loaded into templates with the built-in template function {config_load} or the API configLoad() function.

    You can hide variables or entire sections by prepending the variable name or section name with a period(.) eg [.hidden]. This is useful if your application reads the config files and gets sensitive data from them that the template engine does not need. If you have third parties doing template editing, you can be certain that they cannot read sensitive data from the config file by loading it into the template.

    Config files (or resources) are loaded by the same resource facilities as templates. That means that a config file can also be loaded from a db $smarty->configLoad(\"db:my.conf\").

    See also {config_load}, $config_overwrite, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()

    "},{"location":"designers/language-combining-modifiers/","title":"Combining Modifiers","text":"

    You can apply any number of modifiers to a variable. They will be applied in the order they are combined, from left to right. They must be separated with a | (pipe) character.

    <?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\n

    where template is:

    {$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\n

    The above example will output:

    Smokers are Productive, but Death Cuts Efficiency.\nS M O K E R S   A R ....snip....  H   C U T S   E F F I C I E N C Y .\ns m o k e r s   a r ....snip....  b u t   d e a t h   c u t s...\ns m o k e r s   a r e   p r o d u c t i v e ,   b u t . . .\ns m o k e r s   a r e   p. . .\n
    "},{"location":"designers/language-basic-syntax/","title":"Basic Syntax","text":"

    A simple Smarty template could look like this: 

    <h1>{$title|escape}</h1>\n<ul>\n    {foreach $cities as $city}\n        <li>{$city.name|escape} ({$city.population})</li>\n    {foreachelse}\n        <li>no cities found</li>        \n    {/foreach}\n</ul>\n

    All Smarty template tags are enclosed within delimiters. By default these are { and }, but they can be changed.

    For the examples in this manual, we will assume that you are using the default delimiters. In Smarty, all content outside of delimiters is displayed as static content, or unchanged. When Smarty encounters template tags, it attempts to interpret them, and displays the appropriate output in their place.

    The basis components of the Smarty syntax are:

    "},{"location":"designers/language-basic-syntax/language-escaping/","title":"Escaping Smarty parsing","text":"

    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 for Smarty.

    Note

    A good practice for avoiding escapement altogether is by separating your Javascript/CSS into their own files and use standard HTML methods to access them. This will also take advantage of browser script caching. When you need to embed Smarty variables/functions into your Javascript/CSS, then the following applies.

    In Smarty templates, the { and } braces will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting the Smarty class variable $auto_literal to false.

    "},{"location":"designers/language-basic-syntax/language-escaping/#examples","title":"Examples","text":"
    <script>\n   // the following braces are ignored by Smarty\n   // since they are surrounded by whitespace\n   function foobar {\n    alert('foobar!');\n   }\n   // this one will need literal escapement\n   {literal}\n    function bazzy {alert('foobar!');}\n   {/literal}\n</script>\n

    {literal}..{/literal} blocks are used for escaping blocks of template logic. You can also escape the braces individually with {ldelim}, {rdelim} tags or {$smarty.ldelim},{$smarty.rdelim} 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 and $right_delimiter values.

    Note

    Changing delimiters affects ALL template syntax and escapement. Be sure to clear out cache and compiled files if you decide to change them.

    <?php\n\n$smarty->left_delimiter = '<!--{';\n$smarty->right_delimiter = '}-->';\n\n$smarty->assign('foo', 'bar');\n$smarty->assign('name', 'Albert');\n$smarty->display('example.tpl');\n

    Where the template is:

    Welcome <!--{$name}--> to Smarty\n<script language=\"javascript\">\n  var foo = <!--{$foo}-->;\n  function dosomething() {\n    alert(\"foo is \" + foo);\n  }\n  dosomething();\n</script>\n
    "},{"location":"designers/language-basic-syntax/language-math/","title":"Math","text":"

    Math can be applied directly to variable values.

    "},{"location":"designers/language-basic-syntax/language-math/#examples","title":"Examples","text":"
    {$foo+1}\n\n{$foo*$bar}\n\n{* some more complicated examples *}\n\n{$foo->bar-$bar[1]*$baz->foo->bar()-3*7}\n\n{if ($foo+$bar.test%$baz*134232+10+$b+10)}\n\n{$foo|truncate:\"`$fooTruncCount/$barTruncFactor-1`\"}\n\n{assign var=\"foo\" value=\"`$foo+$bar`\"}\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    "},{"location":"designers/language-basic-syntax/language-syntax-attributes/","title":"Attributes","text":"

    Most of the functions take attributes that specify or modify their behavior. Attributes to Smarty functions are much like HTML attributes. Static values don't have to be enclosed in quotes, but it is required for literal strings. Variables with or without modifiers may also be used, and should not be in quotes. You can even use PHP function results, plugin results and complex expressions.

    Some attributes require boolean values (TRUE or FALSE). These can be specified as true and false. If an attribute has no value assigned it gets the default boolean value of true.

    "},{"location":"designers/language-basic-syntax/language-syntax-attributes/#examples","title":"Examples","text":"
    {include file=\"header.tpl\"}\n\n{include file=\"header.tpl\" nocache}  // is equivalent to nocache=true\n\n{include file=\"header.tpl\" attrib_name=\"attrib value\"}\n\n{include file=$includeFile}\n\n{include file=#includeFile# title=\"My Title\"}\n\n{assign var=foo value={counter}}  // plugin result\n\n{assign var=foo value=substr($bar,2,5)}  // PHP function result\n\n{assign var=foo value=$bar|strlen}  // using modifier\n\n{assign var=foo value=$buh+$bar|strlen}  // more complex expression\n\n{html_select_date display_days=true}\n\n{mailto address=\"smarty@example.com\"}\n\n<select name=\"company_id\">\n  {html_options options=$companies selected=$company_id}\n</select>\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    "},{"location":"designers/language-basic-syntax/language-syntax-comments/","title":"Comments","text":"

    Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so:

    "},{"location":"designers/language-basic-syntax/language-syntax-comments/#examples","title":"Examples","text":"
    {* this is a comment *}\n

    Smarty comments are NOT displayed in the final output of the template, unlike <!-- HTML comments -->. These are useful for making internal notes in the templates which no one will see ;-)

    {* I am a Smarty comment, I don't exist in the compiled output  *}\n<html>\n    <head>\n     <title>{$title}</title>\n    </head>\n<body>\n\n    {* another single line smarty comment  *}\n    <!-- HTML comment that is sent to the browser -->\n\n    {* this multiline smarty\n       comment is\n       not sent to browser\n    *}\n\n    {*********************************************************\n    Multi line comment block with credits block\n      @ author:         bg@example.com\n      @ maintainer:     support@example.com\n      @ para:           var that sets block style\n      @ css:            the style output\n    **********************************************************}\n\n    {* The header file with the main logo and stuff  *}\n    {include file='header.tpl'}\n\n\n    {* Dev note:  the $includeFile var is assigned in foo.php script  *}\n    <!-- Displays main content block -->\n    {include file=$includeFile}\n\n    {* this <select> block is redundant *}\n    {*\n    <select name=\"company\">\n      {html_options options=$vals selected=$selected_id}\n    </select>\n    *}\n\n    <!-- Show header from affiliate is disabled -->\n    {* $affiliate|upper *}\n\n    {* you cannot nest comments *}\n    {*\n    <select name=\"company\">\n      {* <option value=\"0\">-- none -- </option> *}\n      {html_options options=$vals selected=$selected_id}\n    </select>\n    *}\n\n    </body>\n</html>\n
    "},{"location":"designers/language-basic-syntax/language-syntax-functions/","title":"Functions","text":"

    Every Smarty tag either prints a variable or invokes some sort of function. These are processed and displayed by enclosing the function and its attributes within delimiters like so: {funcname attr1=\"val1\" attr2=\"val2\"}.

    "},{"location":"designers/language-basic-syntax/language-syntax-functions/#examples","title":"Examples","text":"
    {config_load file=\"colors.conf\"}\n\n{include file=\"header.tpl\"}\n{insert file=\"banner_ads.tpl\" title=\"My Site\"}\n\n{if $logged_in}\n    Welcome, <span style=\"color:{#fontColor#}\">{$name}!</span>\n{else}\n    hi, {$name}\n{/if}\n\n{include file=\"footer.tpl\"}\n

    See also registerPlugin()

    "},{"location":"designers/language-basic-syntax/language-syntax-quotes/","title":"Embedding Vars in Double Quotes","text":""},{"location":"designers/language-basic-syntax/language-syntax-quotes/#examples","title":"Examples","text":"
    {func var=\"test $foo test\"}              // sees $foo\n{func var=\"test $foo_bar test\"}          // sees $foo_bar\n{func var=\"test `$foo[0]` test\"}         // sees $foo[0]\n{func var=\"test `$foo[bar]` test\"}       // sees $foo[bar]\n{func var=\"test $foo.bar test\"}          // sees $foo (not $foo.bar)\n{func var=\"test `$foo.bar` test\"}        // sees $foo.bar\n{func var=\"test `$foo.bar` test\"|escape} // modifiers outside quotes!\n{func var=\"test {$foo|escape} test\"}     // modifiers inside quotes!\n{func var=\"test {time()} test\"}          // PHP function result\n{func var=\"test {counter} test\"}         // plugin result\n{func var=\"variable foo is {if !$foo}not {/if} defined\"} // Smarty block function\n\n{* will replace $tpl_name with value *}\n{include file=\"subdir/$tpl_name.tpl\"}\n\n{* does NOT replace $tpl_name *}\n{include file='subdir/$tpl_name.tpl'} // vars require double quotes!\n\n{* must have backticks as it contains a dot \".\" *}\n{cycle values=\"one,two,`$smarty.config.myval`\"}\n\n{* must have backticks as it contains a dot \".\" *}\n{include file=\"`$module.contact`.tpl\"}\n\n{* can use variable with dot syntax *}\n{include file=\"`$module.$view`.tpl\"}\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    See also escape.

    "},{"location":"designers/language-basic-syntax/language-syntax-variables/","title":"Variables","text":"

    Template variables start with the $dollar sign. They can contain numbers, letters and underscores, much like a PHP variable. You can reference arrays by index numerically or non-numerically. Also reference object properties and methods.

    Config file variables are an exception to the \\$dollar syntax and are instead referenced with surrounding #hashmarks#, or via the $smarty.config variable.

    "},{"location":"designers/language-basic-syntax/language-syntax-variables/#examples","title":"Examples","text":"
    {$foo}        <-- displaying a simple variable (non array/object)\n{$foo[4]}     <-- display the 5th element of a zero-indexed array\n{$foo.bar}    <-- display the \"bar\" key value of an array, similar to PHP $foo['bar']\n{$foo.$bar}   <-- display variable key value of an array, similar to PHP $foo[$bar]\n{$foo->bar}   <-- display the object property \"bar\"\n{$foo->bar()} <-- display the return value of object method \"bar\"\n{#foo#}       <-- display the config file variable \"foo\"\n{$smarty.config.foo} <-- synonym for {#foo#}\n{$foo[bar]}   <-- syntax only valid in a section loop, see {section}\n{assign var=foo value='baa'}{$foo} <--  displays \"baa\", see {assign}\n\nMany other combinations are allowed\n\n{$foo.bar.baz}\n{$foo.$bar.$baz}\n{$foo[4].baz}\n{$foo[4].$baz}\n{$foo.bar.baz[4]}\n{$foo->bar($baz,2,$bar)} <-- passing parameters\n{\"foo\"}       <-- static values are allowed\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\nMath and embedding tags:\n\n{$x+$y}                             // will output the sum of x and y.\n{assign var=foo value=$x+$y}        // in attributes \n{$foo[$x+3]}                        // as array index\n{$foo={counter}+3}                  // tags within tags\n{$foo=\"this is message {counter}\"}  // tags within double quoted strings\n\nDefining Arrays:\n\n{assign var=foo value=[1,2,3]}\n{assign var=foo value=['y'=>'yellow','b'=>'blue']}\n{assign var=foo value=[1,[9,8],3]}   // can be nested\n\nShort variable assignment:\n\n{$foo=$bar+2}\n{$foo = strlen($bar)}               // function in assignment\n{$foo = myfunct( ($x+$y)*3 )}       // as function parameter \n{$foo.bar=1}                        // assign to specific array element\n{$foo.bar.baz=1}                    \n{$foo[]=1}                          // appending to an array\n\nSmarty \"dot\" syntax (note: embedded {} are used to address ambiguities):\n\n{$foo.a.b.c}        =>  $foo['a']['b']['c'] \n{$foo.a.$b.c}       =>  $foo['a'][$b]['c']         // with variable index\n{$foo.a.{$b+4}.c}   =>  $foo['a'][$b+4]['c']       // with expression as index\n{$foo.a.{$b.c}}     =>  $foo['a'][$b['c']]         // with nested index\n\nPHP-like syntax, alternative to \"dot\" syntax:\n\n{$foo[1]}             // normal access\n{$foo['bar']}\n{$foo['bar'][1]}\n{$foo[$x+$x]}         // index may contain any expression\n{$foo[$bar[1]]}       // nested index\n{$foo[section_name]}  // smarty {section} access, not array access!\n\nVariable variables:\n\n$foo                     // normal variable\n$foo_{$bar}              // variable name containing other variable \n$foo_{$x+$y}             // variable name containing expressions \n$foo_{$bar}_buh_{$blar}  // variable name with multiple segments\n{$foo_{$x}}              // will output the variable $foo_1 if $x has a value of 1.\n\nObject chaining:\n\n{$object->method1($x)->method2($y)}\n\nDirect PHP function access:\n\n{time()}\n

    Note

    Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.

    Request variables such as $_GET, $_SESSION, etc are available via the reserved $smarty variable.

    See also $smarty, config variables {assign} and assign().

    "},{"location":"designers/language-builtin-functions/","title":"Built-in Functions","text":"

    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 with the same name; and you should not need to modify the built-in functions.

    A few of these functions have an assign attribute which collects the result the function to a named template variable instead of being output; much like the {assign} function.

    "},{"location":"designers/language-builtin-functions/language-function-append/","title":"{append}","text":"

    {append} is used for creating or appending template variable arrays during the execution of a template.

    "},{"location":"designers/language-builtin-functions/language-function-append/#attributes","title":"Attributes","text":"Attribute Required Description var The name of the variable being assigned value The value being assigned index (optional) The index for the new array element. If not specified the value is append to the end of the array. scope (optional) The scope of the assigned variable: parent, root or global. Defaults to local if omitted."},{"location":"designers/language-builtin-functions/language-function-append/#option-flags","title":"Option Flags","text":"Name Description nocache Assigns the variable with the 'nocache' attribute

    Note

    Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.

    "},{"location":"designers/language-builtin-functions/language-function-append/#examples","title":"Examples","text":"
    {append var='name' value='Bob' index='first'}\n{append var='name' value='Meyer' index='last'}\n// or \n{append 'name' 'Bob' index='first'} {* short-hand *}\n{append 'name' 'Meyer' index='last'} {* short-hand *}\n\nThe first name is {$name.first}.<br>\nThe last name is {$name.last}.\n

    The above example will output:

    The first name is Bob.\nThe last name is Meyer.\n

    See also append() and getTemplateVars().

    "},{"location":"designers/language-builtin-functions/language-function-assign/","title":"{assign}, {$var=...}","text":"

    {assign} or {$var=...} is used for assigning template variables during the execution of a template.

    "},{"location":"designers/language-builtin-functions/language-function-assign/#attributes-of-the-assign-syntax","title":"Attributes of the {assign} syntax","text":"Attribute Name Required Description var The name of the variable being assigned value The value being assigned scope (optional) The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'"},{"location":"designers/language-builtin-functions/language-function-assign/#attributes-of-the-var-syntax","title":"Attributes of the {$var=...} syntax","text":"Attribute Name Required Description scope (optional) The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'"},{"location":"designers/language-builtin-functions/language-function-assign/#option-flags","title":"Option Flags","text":"Name Description nocache Assigns the variable with the 'nocache' attribute

    Note

    Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.

    "},{"location":"designers/language-builtin-functions/language-function-assign/#examples","title":"Examples","text":"
    {assign var=\"name\" value=\"Bob\"}  {* or *}\n{assign \"name\" \"Bob\"} {* short-hand, or *}\n{$name='Bob'}\n\nThe value of $name is {$name}.\n

    The above example will output:

    The value of $name is Bob.\n

    {assign var=\"name\" value=\"Bob\" nocache}  {* or *}\n{assign \"name\" \"Bob\" nocache} {* short-hand, or *}\n{$name='Bob' nocache}\n\nThe value of $name is {$name}.\n
    The above example will output: 
    The value of $name is Bob.\n

    {assign var=running_total value=$running_total+$some_array[$row].some_value}  {* or *}\n{$running_total=$running_total+$some_array[row].some_value}\n

    Variables assigned in the included template will be seen in the including template.

    {include file=\"sub_template.tpl\"}\n\n{* display variable assigned in sub_template *}\n{$foo}<br>\n

    The template above includes the example sub_template.tpl below:

    {* foo will be known also in the including template *}\n{assign var=\"foo\" value=\"something\" scope=parent}\n{$foo=\"something\" scope=parent}\n\n{* bar is assigned only local in the including template *}\n{assign var=\"bar\" value=\"value\"} {* or *}\n{$var=\"value\"}\n

    You can assign a variable to root of the current root tree. The variable is seen by all templates using the same root tree.

    {assign var=foo value=\"bar\" scope=\"root\"}\n

    A global variable is seen by all templates.

    {assign var=foo value=\"bar\" scope=\"global\"} {* or *}\n{assign \"foo\" \"bar\" scope=\"global\"} {* short-hand, or *}\n{$foo=\"bar\" scope=\"global\"}\n

    To access {assign} variables from a php script use getTemplateVars(). Here's the template that creates the variable $foo.

    {assign var=\"foo\" value=\"Smarty\"} {* or *}\n{$foo=\"Smarty\"}\n

    The template variables are only available after/during template execution as in the following script.

    <?php\n\n// this will output nothing as the template has not been executed\necho $smarty->getTemplateVars('foo');\n\n// fetch the template to a variable\n$whole_page = $smarty->fetch('index.tpl');\n\n// this will output 'smarty' as the template has been executed\necho $smarty->getTemplateVars('foo');\n\n$smarty->assign('foo','Even smarter');\n\n// this will output 'Even smarter'\necho $smarty->getTemplateVars('foo');\n

    The following functions can also optionally assign template variables: {capture}, {include}, {insert}, {counter}, {cycle}, {eval}, {fetch}, {math} and {textformat}.

    See also {append}, assign() and getTemplateVars().

    "},{"location":"designers/language-builtin-functions/language-function-block/","title":"{block}","text":"

    {block} is used to define a named area of template source for template inheritance. For details see section of Template Inheritance.

    The {block} template source area of a child template will replace the corresponding areas in the parent template(s).

    Optionally {block} areas of child and parent templates can be merged into each other. You can append or prepend the parent {block} content by using the append or prepend option flag with the child's {block} definition. With {$smarty.block.parent} the {block} content of the parent template can be inserted at any location of the child {block} content. {$smarty.block.child} inserts the {block} content of the child template at any location of the parent {block}.

    {blocks}'s can be nested.

    "},{"location":"designers/language-builtin-functions/language-function-block/#attributes","title":"Attributes","text":"Attribute Name Required Description name yes The name of the template source block assign no The name of variable to assign the output of the block to.

    Note

    The assign attribute only works on the block that actually gets executed, so you may need to add it to each child block as well.

    "},{"location":"designers/language-builtin-functions/language-function-block/#option-flags-in-child-templates-only","title":"Option Flags (in child templates only):","text":"Name Description append The {block} content will be appended to the content of the parent template {block} prepend The {block} content will be prepended to the content of the parent template {block} hide Ignore the block content if no child block of same name is existing. nocache Disables caching of the {block} content"},{"location":"designers/language-builtin-functions/language-function-block/#examples","title":"Examples","text":"

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}Default Title{/block}</title>\n        <title>{block \"title\"}Default Title{/block}</title>  {* short-hand  *}\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\"}\n    Page Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>Page Title</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}Title - {/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\" append}\n        Page Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>Title - Page Title</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"} is my title{/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\" prepend}\n    Page Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>Page title is my titel</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}The {$smarty.block.child} was inserted here{/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\"}\n        Child Title\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>The Child Title was inserted here</title>\n      </head>\n    </html>\n

    parent.tpl

        <html>\n      <head>\n        <title>{block name=\"title\"}Parent Title{/block}</title>\n      </head>\n    </html>\n

    child.tpl

        {extends file=\"parent.tpl\"} \n    {block name=\"title\"}\n        You will see now - {$smarty.block.parent} - here\n    {/block}\n

    The result would look like

        <html>\n      <head>\n        <title>You will see now - Parent Title - here</title>\n      </head>\n    </html>\n

    See also Template Inheritance, $smarty.block.parent, $smarty.block.child, and {extends}

    "},{"location":"designers/language-builtin-functions/language-function-call/","title":"{call}","text":"

    {call} is used to call a template function defined by the {function} tag just like a plugin function.

    Note

    Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise you can directly use the function as {funcname ...} in the template.

    "},{"location":"designers/language-builtin-functions/language-function-call/#attributes","title":"Attributes","text":"Attribute Name Required Description name Yes The name of the template function assign No The name of the variable that the output of called template function will be assigned to [var ...] No variable to pass local to template function"},{"location":"designers/language-builtin-functions/language-function-call/#option-flags","title":"Option Flags","text":"Name Description nocache Call the template function in nocache mode"},{"location":"designers/language-builtin-functions/language-function-call/#examples","title":"Examples","text":"
        {* define the function *}\n    {function name=menu level=0}\n      <ul class=\"level{$level}\">\n      {foreach $data as $entry}\n        {if is_array($entry)}\n          <li>{$entry@key}</li>\n          {call name=menu data=$entry level=$level+1}\n        {else}\n          <li>{$entry}</li>\n        {/if}\n      {/foreach}\n      </ul>\n    {/function}\n\n    {* create an array to demonstrate *}\n    {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n    ['item3-3-1','item3-3-2']],'item4']}\n\n    {* run the array through the function *}\n    {call name=menu data=$menu}\n    {call menu data=$menu} {* short-hand *}\n

    Will generate the following output

        * item1\n    * item2\n    * item3\n          o item3-1\n          o item3-2\n          o item3-3\n                + item3-3-1\n                + item3-3-2\n    * item4\n

    See also {function}.

    "},{"location":"designers/language-builtin-functions/language-function-capture/","title":"{capture}","text":"

    {capture} is used to collect the output of the template between the tags into a variable instead of displaying it. Any content between {capture name='foo'} and {/capture} is collected into the variable specified in the name attribute.

    The captured content can be used in the template from the variable $smarty.capture.foo where \"foo\" is the value passed in the name attribute. If you do not supply the name attribute, then \"default\" will be used as the name ie $smarty.capture.default.

    {capture}'s can be nested.

    "},{"location":"designers/language-builtin-functions/language-function-capture/#attributes","title":"Attributes","text":"Attribute Name Required Description name Yes The name of the captured block assign No The variable name where to assign the captured output to append No The name of an array variable where to append the captured output to"},{"location":"designers/language-builtin-functions/language-function-capture/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of this captured block

    Note

    Be careful when capturing {insert} output. If you have $caching enabled and you have {insert} commands that you expect to run within cached content, do not capture this content.

    "},{"location":"designers/language-builtin-functions/language-function-capture/#examples","title":"Examples","text":"
    {* we don't want to print a div tag unless content is displayed *}\n{capture name=\"banner\"}\n{capture \"banner\"} {* short-hand *}\n  {include file=\"get_banner.tpl\"}\n{/capture}\n\n{if $smarty.capture.banner ne \"\"}\n<div id=\"banner\">{$smarty.capture.banner}</div>\n{/if}\n

    This example demonstrates the capture function. 

    {capture name=some_content assign=popText}\n{capture some_content assign=popText} {* short-hand *}\nThe server is {$my_server_name|upper} at {$my_server_addr}<br>\nYour ip is {$my_ip}.\n{/capture}\n<a href=\"#\">{$popText}</a>\n

    This example also demonstrates how multiple calls of capture can be used to create an array with captured content.

    {capture append=\"foo\"}hello{/capture}I say just {capture append=\"foo\"}world{/capture}\n{foreach $foo as $text}{$text} {/foreach}\n

    The above example will output:

    I say just hello world\n

    See also $smarty.capture, {eval}, {fetch}, fetch() and {assign}.

    "},{"location":"designers/language-builtin-functions/language-function-config-load/","title":"{config_load}","text":"

    {config_load} is used for loading config #variables# from a configuration file into the template.

    "},{"location":"designers/language-builtin-functions/language-function-config-load/#attributes","title":"Attributes","text":"Attribute Name Required Description file Yes The name of the config file to include 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."},{"location":"designers/language-builtin-functions/language-function-config-load/#examples","title":"Examples","text":"

    The example.conf file.

    #this is config file comment\n\n# global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n#customer variables section\n[Customer]\npageTitle = \"Customer Info\"\n

    and the template

    {config_load file=\"example.conf\"}\n{config_load \"example.conf\"}  {* short-hand *}\n\n<html>\n    <title>{#pageTitle#|default:\"No title\"}</title>\n    <body bgcolor=\"{#bodyBgColor#}\">\n        <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n           <tr bgcolor=\"{#rowBgColor#}\">\n              <td>First</td>\n              <td>Last</td>\n              <td>Address</td>\n           </tr>\n        </table>\n    </body>\n</html>\n

    Config Files may also contain sections. You can load variables from within a section with the added attribute section. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.

    Note

    Config file sections and the built-in template function called {section} have nothing to do with each other, they just happen to share a common naming convention.

    {config_load file='example.conf' section='Customer'}\n{config_load 'example.conf' 'Customer'} {* short-hand *}\n\n<html>\n    <title>{#pageTitle#}</title>\n    <body bgcolor=\"{#bodyBgColor#}\">\n        <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n           <tr bgcolor=\"{#rowBgColor#}\">\n              <td>First</td>\n              <td>Last</td>\n              <td>Address</td>\n           </tr>\n        </table>\n    </body>\n</html>\n

    See $config_overwrite to create arrays of config file variables.

    See also the config files page, config variables page, $config_dir, getConfigVars() and configLoad().

    "},{"location":"designers/language-builtin-functions/language-function-debug/","title":"{debug}","text":"

    {debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned variables; not the templates that are in use. However, you can see all the currently available variables within the scope of a template.

    If caching is enabled and a page is loaded from cache {debug} does show only the variables which assigned for the cached page.

    In order to see also the variables which have been locally assigned within the template it does make sense to place the {debug} tag at the end of the template.

    See also the debugging console page.

    "},{"location":"designers/language-builtin-functions/language-function-extends/","title":"{extends}","text":"

    {extends} tags are used in child templates in template inheritance for extending parent templates. For details see section of Template Inheritance.

    "},{"location":"designers/language-builtin-functions/language-function-extends/#attributes","title":"Attributes","text":"Attribute Required Description file Yes The name of the template file which is extended

    Note

    When extending a variable parent like {extends file=$parent_file}, make sure you include $parent_file in the $compile_id. Otherwise, Smarty cannot distinguish between different $parent_files.

    "},{"location":"designers/language-builtin-functions/language-function-extends/#examples","title":"Examples","text":"
    {extends file='parent.tpl'}\n{extends 'parent.tpl'}  {* short-hand *}\n

    See also Template Inheritance and {block}.

    "},{"location":"designers/language-builtin-functions/language-function-for/","title":"{for}","text":"

    The {for}{forelse} tag is used to create simple loops. The following different formats are supported:

    {forelse} is executed when the loop is not iterated.

    "},{"location":"designers/language-builtin-functions/language-function-for/#attributes","title":"Attributes","text":"Attribute Required Description max No Limit the number of iterations"},{"location":"designers/language-builtin-functions/language-function-for/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of the {for} loop"},{"location":"designers/language-builtin-functions/language-function-for/#examples","title":"Examples","text":"
    <ul>\n    {for $foo=1 to 3}\n        <li>{$foo}</li>\n    {/for}\n</ul>\n

    The above example will output:

    <ul>\n    <li>1</li>\n    <li>2</li>\n    <li>3</li>\n</ul>\n
    <?php\n$smarty->assign('to',10);\n
    <ul>\n    {for $foo=3 to $to max=3}\n        <li>{$foo}</li>\n    {/for}\n</ul>\n

    The above example will output:

    <ul>\n    <li>3</li>\n    <li>4</li>\n    <li>5</li>\n</ul>\n
    <?php\n$smarty->assign('start',10);\n$smarty->assign('to',5);\n
    <ul>\n    {for $foo=$start to $to}\n        <li>{$foo}</li>\n    {forelse}\n      no iteration\n    {/for}\n</ul>\n

    The above example will output:

       no iteration\n

    See also {foreach}, {section} and {while}

    "},{"location":"designers/language-builtin-functions/language-function-foreach/","title":"{foreach},{foreachelse}","text":"

    {foreach} is used for looping over arrays of data. {foreach} has a simpler and cleaner syntax than the {section} loop, and can also loop over associative arrays.

    "},{"location":"designers/language-builtin-functions/language-function-foreach/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of the {foreach} loop"},{"location":"designers/language-builtin-functions/language-function-foreach/#examples","title":"Examples","text":"
    {foreach $arrayvar as $itemvar}\n  {$itemvar|escape}\n{/foreach}\n\n{foreach $arrayvar as $keyvar=>$itemvar}\n  {$keyvar}: {$itemvar|escape}\n{/foreach}\n

    Note

    This foreach syntax does not accept any named attributes. This syntax is new to Smarty 3, however the Smarty 2.x syntax {foreach from=$myarray key=\"mykey\" item=\"myitem\"} is still supported.

    Note

    The $var@property syntax is new to Smarty 3, however when using the Smarty 2 {foreach from=$myarray key=\"mykey\" item=\"myitem\"} style syntax, the $smarty.foreach.name.property syntax is still supported.

    Note

    Although you can retrieve the array key with the syntax {foreach $myArray as $myKey => $myValue}, the key is always available as $myValue@key within the foreach loop.

    <?php\n$arr = array('red', 'green', 'blue');\n$smarty->assign('myColors', $arr);\n

    Template to output $myColors in an un-ordered list

    <ul>\n    {foreach $myColors as $color}\n        <li>{$color}</li>\n    {/foreach}\n</ul>\n

    The above example will output:

    <ul>\n    <li>red</li>\n    <li>green</li>\n    <li>blue</li>\n</ul>\n
    <?php\n$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');\n$smarty->assign('myPeople', $people);\n

    Template to output $myArray as key/value pairs.

    <ul>\n    {foreach $myPeople as $value}\n       <li>{$value@key}: {$value}</li>\n    {/foreach}\n</ul>\n

    The above example will output:

    <ul>\n    <li>fname: John</li>\n    <li>lname: Doe</li>\n    <li>email: j.doe@example.com</li>\n</ul>\n

    Assign an array to Smarty, the key contains the key for each looped value.

    <?php\n $smarty->assign(\n    'contacts', \n    [\n         ['phone' => '555-555-1234', 'fax' => '555-555-5678', 'cell' => '555-555-0357'],\n         ['phone' => '800-555-4444', 'fax' => '800-555-3333', 'cell' => '800-555-2222'],\n     ]\n );\n

    The template to output $contact.

    {* key always available as a property *}\n{foreach $contacts as $contact}\n  {foreach $contact as $value}\n    {$value@key}: {$value}\n  {/foreach}\n{/foreach}\n\n{* accessing key the PHP syntax alternate *}\n{foreach $contacts as $contact}\n  {foreach $contact as $key => $value}\n    {$key}: {$value}\n  {/foreach}\n{/foreach}\n

    Either of the above examples will output:

      phone: 555-555-1234\n  fax: 555-555-5678\n  cell: 555-555-0357\n  phone: 800-555-4444\n  fax: 800-555-3333\n  cell: 800-555-2222\n

    A database (PDO) example of looping over search results. This example is looping over a PHP iterator instead of an array().

    <?php \n  include('Smarty.class.php'); \n\n  $smarty = new Smarty; \n\n  $dsn = 'mysql:host=localhost;dbname=test'; \n  $login = 'test'; \n  $passwd = 'test'; \n\n  // setting PDO to use buffered queries in mysql is \n  // important if you plan on using multiple result cursors \n  // in the template. \n\n  $db = new PDO($dsn, $login, $passwd, array( \n     PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true)); \n\n  $res = $db->prepare(\"select * from users\"); \n  $res->execute(); \n  $res->setFetchMode(PDO::FETCH_LAZY); \n\n  // assign to smarty \n  $smarty->assign('res',$res); \n\n  $smarty->display('index.tpl');?>\n
    {foreach $res as $r} \n  {$r.id} \n  {$r.name}\n{foreachelse}\n  .. no results .. \n{/foreach}\n

    The above is assuming the results contain the columns named id and name.

    What is the advantage of an iterator vs. looping over a plain old array? With an array, all the results are accumulated into memory before being looped. With an iterator, each result is loaded/released within the loop. This saves processing time and memory, especially for very large result sets.

    "},{"location":"designers/language-builtin-functions/language-function-foreach/#index","title":"@index","text":"

    index contains the current array index, starting with zero.

    {* output empty row on the 4th iteration (when index is 3) *}\n<table>\n    {foreach $items as $i}\n      {if $i@index eq 3}\n         {* put empty table row *}\n         <tr><td>nbsp;</td></tr>\n      {/if}\n      <tr><td>{$i.label}</td></tr>\n    {/foreach}\n</table>\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#iteration","title":"@iteration","text":"

    iteration contains the current loop iteration and always starts at one, unlike index. It is incremented by one on each iteration.

    The \"is div by\" operator can be used to detect a specific iteration. Here we bold-face the name every 4th iteration.

    {foreach $myNames as $name}\n  {if $name@iteration is div by 4}\n    <b>{$name}</b>\n  {/if}\n  {$name}\n{/foreach}\n

    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}\n   {if $name@iteration is even by 3}\n     <span style=\"color: #000\">{$name}</span>\n   {else}\n     <span style=\"color: #eee\">{$name}</span>\n   {/if}\n {/foreach}\n

    This will output something similar to this:

    <span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n...\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#first","title":"@first","text":"

    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 *}\n<table>\n    {foreach $items as $i}\n      {if $i@first}\n        <tr>\n          <th>key</td>\n          <th>name</td>\n        </tr>\n      {/if}\n      <tr>\n        <td>{$i@key}</td>\n        <td>{$i.name}</td>\n      </tr>\n    {/foreach}\n</table>\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#last","title":"@last","text":"

    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 *}\n{foreach $items as $item}\n  <a href=\"#{$item.id}\">{$item.name}</a>{if $item@last}<hr>{else},{/if}\n{foreachelse}\n  ... no items to loop ...\n{/foreach}\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#show","title":"@show","text":"

    The show show property can be used after the execution of a {foreach} loop to detect if data has been displayed or not. show is a boolean value.

    <ul>\n    {foreach $myArray as $name}\n        <li>{$name}</li>\n    {/foreach}\n</ul>\n{if $name@show} do something here if the array contained data {/if}\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#total","title":"@total","text":"

    total contains the number of iterations that this {foreach} will loop. This can be used inside or after the {foreach}.

    {* show number of rows at end *}\n{foreach $items as $item}\n  {$item.name}<hr/>\n  {if $item@last}\n    <div id=\"total\">{$item@total} items</div>\n  {/if}\n{foreachelse}\n ... no items to loop ...\n{/foreach}\n

    See also {section}, {for} and {while}

    "},{"location":"designers/language-builtin-functions/language-function-foreach/#break","title":"{break}","text":"

    {break} aborts the iteration of the array

      {$data = [1,2,3,4,5]}\n  {foreach $data as $value}\n    {if $value == 3}\n      {* abort iterating the array *}\n      {break}\n    {/if}\n    {$value}\n  {/foreach}\n  {*\n    prints: 1 2\n  *}\n
    "},{"location":"designers/language-builtin-functions/language-function-foreach/#continue","title":"{continue}","text":"

    {continue} leaves the current iteration and begins with the next iteration.

      {$data = [1,2,3,4,5]}\n  {foreach $data as $value}\n    {if $value == 3}\n      {* skip this iteration *}\n      {continue}\n    {/if}\n    {$value}\n  {/foreach}\n  {*\n    prints: 1 2 4 5\n  *}\n
    "},{"location":"designers/language-builtin-functions/language-function-function/","title":"{function}","text":"

    {function} is used to create functions within a template and call them just like a plugin function. Instead of writing a plugin that generates presentational content, keeping it in the template is often a more manageable choice. It also simplifies data traversal, such as deeply nested menus.

    Note

    Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise, you can directly use the function as {funcname ...} in the template.

    "},{"location":"designers/language-builtin-functions/language-function-function/#attributes","title":"Attributes","text":"Attribute Name Required Description name Yes The name of the template function [var ...] No default variable value to pass local to the template function

    Note

    You can pass any number of parameter to the template function when it is called. The parameter variables must not be declared in the {funcname ...} tag unless you what to use default values. Default values must be scalar and can not be variable. Variables must be passed when the template is called.

    "},{"location":"designers/language-builtin-functions/language-function-function/#examples","title":"Examples","text":"
    {* define the function *}\n{function name=menu level=0}\n{function menu level=0}          {* short-hand *}\n  <ul class=\"level{$level}\">\n  {foreach $data as $entry}\n    {if is_array($entry)}\n      <li>{$entry@key}</li>\n      {menu data=$entry level=$level+1}\n    {else}\n      <li>{$entry}</li>\n    {/if}\n  {/foreach}\n  </ul>\n{/function}\n\n{* create an array to demonstrate *}\n{$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n['item3-3-1','item3-3-2']],'item4']}\n\n{* run the array through the function *}\n{menu data=$menu}\n

    Will generate the following output

    * item1\n* item2\n* item3\n      o item3-1\n      o item3-2\n      o item3-3\n            + item3-3-1\n            + item3-3-2\n* item4\n

    See also {call}

    "},{"location":"designers/language-builtin-functions/language-function-if/","title":"{if},{elseif},{else}","text":"

    {if} statements in Smarty have much the same flexibility as PHP if statements, with a few added features for the template engine. Every {if} must be paired with a matching {/if}. {else} and {elseif} are also permitted. All PHP conditionals and functions are recognized, such as ||, or, &&, and, is_array(), etc.

    If security is enabled, only PHP functions from $php_functions property of the security policy are allowed. See the Security section for details.

    The following is a list of recognized qualifiers, which must be separated from surrounding elements by spaces. Note that items listed in [brackets] are optional. PHP equivalents are shown where applicable.

    "},{"location":"designers/language-builtin-functions/language-function-if/#qualifiers","title":"Qualifiers","text":"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"},{"location":"designers/language-builtin-functions/language-function-if/#examples","title":"Examples","text":"
    {if $name eq 'Fred'}\n    Welcome Sir.\n{elseif $name eq 'Wilma'}\n    Welcome Ma'am.\n{else}\n    Welcome, whatever you are.\n{/if}\n\n{* an example with \"or\" logic *}\n{if $name eq 'Fred' or $name eq 'Wilma'}\n   ...\n{/if}\n\n{* same as above *}\n{if $name == 'Fred' || $name == 'Wilma'}\n   ...\n{/if}\n\n\n{* parenthesis are allowed *}\n{if ( $amount < 0 or $amount > 1000 ) and $volume >= #minVolAmt#}\n   ...\n{/if}\n\n\n{* you can also embed php function calls *}\n{if count($var) gt 0}\n   ...\n{/if}\n\n{* check for array. *}\n{if is_array($foo) }\n   .....\n{/if}\n\n{* check for not null. *}\n{if isset($foo) }\n   .....\n{/if}\n\n\n{* test if values are even or odd *}\n{if $var is even}\n   ...\n{/if}\n{if $var is odd}\n   ...\n{/if}\n{if $var is not odd}\n   ...\n{/if}\n\n\n{* test if var is divisible by 4 *}\n{if $var is div by 4}\n   ...\n{/if}\n\n\n{*\n  test if var is even, grouped by two. i.e.,\n  0=even, 1=even, 2=odd, 3=odd, 4=even, 5=even, etc.\n*}\n{if $var is even by 2}\n   ...\n{/if}\n\n{* 0=even, 1=even, 2=even, 3=odd, 4=odd, 5=odd, etc. *}\n{if $var is even by 3}\n   ...\n{/if}\n\n{if isset($name) && $name == 'Blog'}\n     {* do something *}\n{elseif $name == $foo}\n    {* do something *}\n{/if}\n\n{if is_array($foo) && count($foo) > 0}\n    {* do a foreach loop *}\n{/if}\n
    "},{"location":"designers/language-builtin-functions/language-function-include/","title":"{include}","text":"

    {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.

    "},{"location":"designers/language-builtin-functions/language-function-include/#attributes","title":"Attributes","text":"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 "},{"location":"designers/language-builtin-functions/language-function-include/#option-flags","title":"Option Flags","text":"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"},{"location":"designers/language-builtin-functions/language-function-include/#examples","title":"Examples","text":"
    <html>\n    <head>\n      <title>{$title}</title>\n    </head>\n    <body>\n    {include file='page_header.tpl'}\n\n    {* body of template goes here, the $tpl_name variable\n       is replaced with a value eg 'contact.tpl'\n    *}\n    {include file=\"$tpl_name.tpl\"}\n\n    {* using shortform file attribute *}\n    {include 'page_footer.tpl'}\n    </body>\n</html>\n
    {include 'links.tpl' title='Newest links' links=$link_array}\n{* body of template goes here *}\n{include 'footer.tpl' foo='bar'}\n

    The template above includes the example links.tpl below

    <div id=\"box\">\n    <h3>{$title}{/h3>\n    <ul>\n        {foreach from=$links item=l}\n            .. do stuff  ...\n        </foreach}\n    </ul>\n</div>\n
    Variables assigned in the included template will be seen in the including template.

    {include 'sub_template.tpl' scope=parent}\n...\n{* display variables assigned in sub_template *}\n{$foo}<br>\n{$bar}<br>\n...\n

    The template above includes the example sub_template.tpl below

    ...\n{assign var=foo value='something'}\n{assign var=bar value='value'}\n...\n

    The included template will not be cached.

    {include 'sub_template.tpl' nocache}\n...\n

    In this example included template will be cached with an individual cache lifetime of 500 seconds.

    {include 'sub_template.tpl' cache_lifetime=500}\n...\n

    In this example included template will be cached independent of the global caching setting.

    {include 'sub_template.tpl' caching}\n...\n

    This example assigns the contents of nav.tpl to the $navbar variable, which is then output at both the top and bottom of the page.

    <body>\n  {include 'nav.tpl' assign=navbar}\n  {include 'header.tpl' title='Smarty is cool'}\n    {$navbar}\n    {* body of template goes here *}\n    {$navbar}\n  {include 'footer.tpl'}\n</body>\n

    This example includes another template relative to the directory of the current template.

    {include 'template-in-a-template_dir-directory.tpl'}\n{include './template-in-same-directory.tpl'}\n{include '../template-in-parent-directory.tpl'}\n
    {* absolute filepath *}\n{include file='/usr/local/include/templates/header.tpl'}\n\n{* absolute filepath (same thing) *}\n{include file='file:/usr/local/include/templates/header.tpl'}\n\n{* windows absolute filepath (MUST use \"file:\" prefix) *}\n{include file='file:C:/www/pub/templates/header.tpl'}\n\n{* include from template resource named \"db\" *}\n{include file='db:header.tpl'}\n\n{* include a $variable template - eg $module = 'contacts' *}\n{include file=\"$module.tpl\"}\n\n{* wont work as its single quotes ie no variable substitution *}\n{include file='$module.tpl'}\n\n{* include a multi $variable template - eg amber/links.view.tpl *}\n{include file=\"$style_dir/$module.$view.tpl\"}\n

    See also {insert}, template resources and componentized templates.

    "},{"location":"designers/language-builtin-functions/language-function-insert/","title":"{insert}","text":"

    Note

    {insert} tags are deprecated from Smarty, and should not be used. Put your PHP logic in PHP scripts or plugin functions instead. As of Smarty 3.1 the {insert} tags are only available from SmartyBC.

    {insert} tags work much like {include} tags, except that {insert} tags are NOT cached when template caching is enabled. They will be executed on every invocation of the template.

    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"},{"location":"designers/language-builtin-functions/language-function-insert/#examples","title":"Examples","text":"

    Let's say you have a template with a banner slot at the top of the page. The banner can contain any mixture of HTML, images, flash, etc. so we can't just use a static link here, and we don't want this contents cached with the page. In comes the {insert} tag: the template knows #banner_location_id# and #site_id# values (gathered from a config file), and needs to call a function to get the banner contents.

        {* example of fetching a banner *}\n    {insert name=\"getBanner\" lid=#banner_location_id# sid=#site_id#}\n    {insert \"getBanner\" lid=#banner_location_id# sid=#site_id#} {* short-hand *}\n

    In this example, we are using the name \"getBanner\" and passing the parameters #banner_location_id# and #site_id#. Smarty will look for a function named insert_getBanner() in your PHP application, passing the values of #banner_location_id# and #site_id# as the first argument in an associative array. All {insert} function names in your application must be prepended with \"insert_\" to remedy possible function name-space conflicts. Your insert_getBanner() function should do something with the passed values and return the results. These results are then displayed in the template in place of the {insert} tag. In this example, Smarty would call this function: insert_getBanner(array(\"lid\" => \"12345\",\"sid\" => \"67890\")); and display the returned results in place of the {insert} tag.

    The Smarty object is passed as the second argument. This way you can reference and modify information in the Smarty object from within the {insert} function.

    If no PHP script can be found Smarty is looking for a corresponding insert plugin.

    Note

    It is possible to have portions of the template not cached. If you have caching 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}

    "},{"location":"designers/language-builtin-functions/language-function-ldelim/","title":"{ldelim}, {rdelim}","text":"

    {ldelim} and {rdelim} are used for escaping template delimiters, by default { and }. You can also use {literal}{/literal} to escape blocks of text eg Javascript or CSS. See also the complementary {$smarty.ldelim}.

    {* this will print literal delimiters out of the template *}\n\n{ldelim}funcname{rdelim} is how functions look in Smarty!\n

    The above example will output:

    {funcname} is how functions look in Smarty!\n

    Another example with some Javascript

    <script>\nfunction foo() {ldelim}\n    ... code ...\n{rdelim}\n</script>\n

    will output

    <script>\nfunction foo() {\n    .... code ...\n}\n</script>\n
    <script>\n    function myJsFunction(){ldelim}\n        alert(\"The server name\\n{$smarty.server.SERVER_NAME|escape:javascript}\\n{$smarty.server.SERVER_ADDR|escape:javascript}\");\n    {rdelim}\n</script>\n<a href=\"javascript:myJsFunction()\">Click here for Server Info</a>\n

    See also {literal} and escaping Smarty parsing.

    "},{"location":"designers/language-builtin-functions/language-function-literal/","title":"{literal}","text":"

    {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 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} to escape the individual delimiters instead.

    Note

    {literal}{/literal} tags are normally not necessary, as Smarty ignores delimiters that are surrounded by whitespace. Be sure your javascript and CSS curly braces are surrounded by whitespace. This is new behavior to Smarty 3.

    <script>\n   // the following braces are ignored by Smarty\n   // since they are surrounded by whitespace\n   function myFoo {\n     alert('Foo!');\n   }\n   // this one will need literal escapement\n   {literal}\n     function myBar {alert('Bar!');}\n   {/literal}\n</script>\n

    See also {ldelim} {rdelim} and the escaping Smarty parsing page.

    "},{"location":"designers/language-builtin-functions/language-function-nocache/","title":"{nocache}","text":"

    {nocache} is used to disable caching of a template section. Every {nocache} must be paired with a matching {/nocache}.

    Note

    Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache.

    Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n

    The above code will output the current date on a cached page.

    See also the caching section.

    "},{"location":"designers/language-builtin-functions/language-function-section/","title":"{section}, {sectionelse}","text":"

    A {section} is for looping over sequentially indexed arrays of data, unlike {foreach} which is used to loop over a single associative array. Every {section} tag must be paired with a closing {/section} tag.

    Note

    The {foreach} loop can do everything a {section} loop can do, and has a simpler and easier syntax. It is usually preferred over the {section} loop.

    Note

    {section} loops cannot loop over associative arrays, they must be numerically indexed, and sequential (0,1,2,...). For associative arrays, use the {foreach} loop.

    "},{"location":"designers/language-builtin-functions/language-function-section/#attributes","title":"Attributes","text":"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)"},{"location":"designers/language-builtin-functions/language-function-section/#option-flags","title":"Option Flags","text":"Name Description nocache Disables caching of the {section} loop

    assign() an array to Smarty

    "},{"location":"designers/language-builtin-functions/language-function-section/#examples","title":"Examples","text":"
    <?php\n$data = [1000, 1001, 1002];\n$smarty->assign('custid', $data);\n

    The template that outputs the array

    {* this example will print out all the values of the $custid array *}\n{section name=customer loop=$custid}\n{section customer $custid} {* short-hand *}\n  id: {$custid[customer]}<br />\n{/section}\n<hr />\n{*  print out all the values of the $custid array reversed *}\n{section name=foo loop=$custid step=-1}\n{section foo $custid step=-1} {* short-hand *}\n  {$custid[foo]}<br />\n{/section}\n

    The above example will output:

    id: 1000<br />\nid: 1001<br />\nid: 1002<br />\n<hr />\nid: 1002<br />\nid: 1001<br />\nid: 1000<br />\n
    {section name=foo start=10 loop=20 step=2}\n  {$smarty.section.foo.index}\n{/section}\n<hr />\n{section name=bar loop=21 max=6 step=-2}\n  {$smarty.section.bar.index}\n{/section}\n

    The above example will output:

    10 12 14 16 18\n<hr />\n20 18 16 14 12 10\n

    The name of the {section} can be anything you like, see PHP variables. It is used to reference the data within the {section}.

    {section name=anything loop=$myArray}\n  {$myArray[anything].foo}\n  {$name[anything]}\n  {$address[anything].bar}\n{/section}\n

    This is an example of printing an associative array of data with a {section}. Following is the php script to assign the $contacts array to Smarty.

    <?php\n$data = [\n      ['name' => 'John Smith', 'home' => '555-555-5555',\n            'cell' => '666-555-5555', 'email' => 'john@myexample.com'],\n      ['name' => 'Jack Jones', 'home' => '777-555-5555',\n            'cell' => '888-555-5555', 'email' => 'jack@myexample.com'],\n      ['name' => 'Jane Munson', 'home' => '000-555-5555',\n            'cell' => '123456', 'email' => 'jane@myexample.com']\n];\n$smarty->assign('contacts',$data);\n

    The template to output $contacts

    {section name=customer loop=$contacts}\n<p>\n  name: {$contacts[customer].name}<br />\n  home: {$contacts[customer].home}<br />\n  cell: {$contacts[customer].cell}<br />\n  e-mail: {$contacts[customer].email}\n</p>\n{/section}\n

    The above example will output:

    <p>\n  name: John Smith<br />\n  home: 555-555-5555<br />\n  cell: 666-555-5555<br />\n  e-mail: john@myexample.com\n</p>\n<p>\n  name: Jack Jones<br />\n  home phone: 777-555-5555<br />\n  cell phone: 888-555-5555<br />\n  e-mail: jack@myexample.com\n</p>\n<p>\n  name: Jane Munson<br />\n  home phone: 000-555-5555<br />\n  cell phone: 123456<br />\n  e-mail: jane@myexample.com\n</p>\n

    This example assumes that $custid, $name and $address are all arrays containing the same number of values. First the php script that assign's the arrays to Smarty.

    <?php\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 Abbey road', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\n

    The loop variable only determines the number of times to loop. You can access ANY variable from the template within the {section}. This is useful for looping multiple arrays. You can pass an array which will determine the loop count by the array size, or you can pass an integer to specify the number of loops.

    {section name=customer loop=$custid}\n<p>\n  id: {$custid[customer]}<br />\n  name: {$name[customer]}<br />\n  address: {$address[customer]}\n</p>\n{/section}\n

    The above example will output:

    <p>\n  id: 1000<br />\n  name: John Smith<br />\n  address: 253 Abbey road\n</p>\n<p>\n  id: 1001<br />\n  name: Jack Jones<br />\n  address: 417 Mulberry ln\n</p>\n<p>\n  id: 1002<br />\n  name: Jane Munson<br />\n  address: 5605 apple st\n</p>\n

    {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\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 N 45th', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\n\n$types = [\n           [ 'home phone', 'cell phone', 'e-mail'],\n           [ 'home phone', 'web'],\n           [ 'cell phone']\n         ];\n$smarty->assign('contact_type', $types);\n\n$info = [\n           ['555-555-5555', '666-555-5555', 'john@myexample.com'],\n           [ '123-456-4', 'www.example.com'],\n           [ '0457878']\n        ];\n$smarty->assign('contact_info', $info);\n

    In this template, $contact_type[customer] is an array of contact types for the current customer.

    {section name=customer loop=$custid}\n<hr>\n  id: {$custid[customer]}<br />\n  name: {$name[customer]}<br />\n  address: {$address[customer]}<br />\n  {section name=contact loop=$contact_type[customer]}\n    {$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br />\n  {/section}\n{/section}\n

    The above example will output:

    <hr>\n  id: 1000<br />\n  name: John Smith<br />\n  address: 253 N 45th<br />\n    home phone: 555-555-5555<br />\n    cell phone: 666-555-5555<br />\n    e-mail: john@myexample.com<br />\n<hr>\n  id: 1001<br />\n  name: Jack Jones<br />\n  address: 417 Mulberry ln<br />\n    home phone: 123-456-4<br />\n    web: www.example.com<br />\n<hr>\n  id: 1002<br />\n  name: Jane Munson<br />\n  address: 5605 apple st<br />\n    cell phone: 0457878<br />\n

    Results of a database search (eg ADODB or PEAR) are assigned to Smarty

    <?php\n$sql = 'select id, name, home, cell, email from contacts '\n      .\"where name like '$foo%' \";\n$smarty->assign('contacts', $db->getAll($sql));\n

    The template to output the database result in a HTML table

    <table>\n    <tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>\n    {section name=co loop=$contacts}\n      <tr>\n        <td><a href=\"view.php?id={$contacts[co].id}\">view<a></td>\n        <td>{$contacts[co].name}</td>\n        <td>{$contacts[co].home}</td>\n        <td>{$contacts[co].cell}</td>\n        <td>{$contacts[co].email}</td>\n      <tr>\n    {sectionelse}\n      <tr><td colspan=\"5\">No items found</td></tr>\n    {/section}\n</table>\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#index","title":".index","text":"

    index contains the current array index, starting with zero or the start attribute if given. It increments by one or by the step attribute if given.

    Note

    If the step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.

    Note

    $custid[customer.index] and $custid[customer] are identical.

    {section name=customer loop=$custid}\n  {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\n

    The above example will output:

    0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#index_prev","title":".index_prev","text":"

    index_prev is the previous loop index. On the first loop, this is set to -1.

    "},{"location":"designers/language-builtin-functions/language-function-section/#index_next","title":".index_next","text":"

    index_next is the next loop index. On the last loop, this is still one more than the current index, respecting the setting of the step attribute, if given.

    <?php\n    $data = [1001,1002,1003,1004,1005];\n    $smarty->assign('rows',$data);\n

    Template to output the above array in a table

    {* $rows[row.index] and $rows[row] are identical in meaning *}\n<table>\n  <tr>\n    <th>index</th><th>id</th>\n    <th>index_prev</th><th>prev_id</th>\n    <th>index_next</th><th>next_id</th>\n  </tr>\n{section name=row loop=$rows}\n  <tr>\n    <td>{$smarty.section.row.index}</td><td>{$rows[row]}</td>\n    <td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td>\n    <td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td>\n  </tr>\n{/section}\n</table>\n

    The above example will output a table containing the following:

        index  id    index_prev prev_id index_next next_id\n    0      1001  -1                 1          1002\n    1      1002  0          1001    2          1003\n    2      1003  1          1002    3          1004\n    3      1004  2          1003    4          1005\n    4      1005  3          1004    5\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#iteration","title":".iteration","text":"

    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 property. iteration also starts with one instead of zero unlike index. rownum is an alias to iteration, they are identical.

    <?php\n// array of 3000 to 3015\n$id = range(3000,3015);\n$smarty->assign('arr', $id);\n

    Template to output every other element of the $arr array as step=2

    {section name=cu loop=$arr start=5 step=2}\n  iteration={$smarty.section.cu.iteration}\n  index={$smarty.section.cu.index}\n  id={$custid[cu]}<br />\n{/section}\n

    The above example will output:

    iteration=1 index=5 id=3005<br />\niteration=2 index=7 id=3007<br />\niteration=3 index=9 id=3009<br />\niteration=4 index=11 id=3011<br />\niteration=5 index=13 id=3013<br />\niteration=6 index=15 id=3015<br />\n

    Another example that uses the iteration property to output a table header block every five rows.

    <table>\n    {section name=co loop=$contacts}\n      {if $smarty.section.co.iteration is div by 5}\n        <tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>\n      {/if}\n      <tr>\n        <td><a href=\"view.php?id={$contacts[co].id}\">view<a></td>\n        <td>{$contacts[co].name}</td>\n        <td>{$contacts[co].home}</td>\n        <td>{$contacts[co].cell}</td>\n        <td>{$contacts[co].email}</td>\n      <tr>\n    {/section}\n</table>\n

    An example that uses the iteration property to alternate a text color every third row.

    <table>\n  {section name=co loop=$contacts}\n    {if $smarty.section.co.iteration is even by 3}\n      <span style=\"color: #ffffff\">{$contacts[co].name}</span>\n    {else}\n      <span style=\"color: #dddddd\">{$contacts[co].name}</span>\n    {/if}\n  {/section}\n</table>\n

    Note

    The \"is div by\" syntax is a simpler alternative to the PHP mod operator syntax. The mod operator is allowed: {if $smarty.section.co.iteration % 5 == 1} will work just the same.

    Note

    You can also use \"is odd by\" to reverse the alternating.

    "},{"location":"designers/language-builtin-functions/language-function-section/#first","title":".first","text":"

    first is set to TRUE if the current {section} iteration is the initial one.

    "},{"location":"designers/language-builtin-functions/language-function-section/#last","title":".last","text":"

    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 property.

    {section name=customer loop=$customers}\n  {if $smarty.section.customer.first}\n    <table>\n    <tr><th>id</th><th>customer</th></tr>\n  {/if}\n\n  <tr>\n    <td>{$customers[customer].id}}</td>\n    <td>{$customers[customer].name}</td>\n  </tr>\n\n  {if $smarty.section.customer.last}\n    <tr><td></td><td>{$smarty.section.customer.total} customers</td></tr>\n    </table>\n  {/if}\n{/section}\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#rownum","title":".rownum","text":"

    rownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.

    "},{"location":"designers/language-builtin-functions/language-function-section/#loop","title":".loop","text":"

    loop contains the last index number that this {section} looped. This can be used inside or after the {section}.

    {section name=customer loop=$custid}\n  {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\nThere are {$smarty.section.customer.loop} customers shown above.\n

    The above example will output:

    0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nThere are 3 customers shown above.\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#show","title":".show","text":"

    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 this section shows.

    {section name=customer loop=$customers show=$show_customer_info}\n  {$smarty.section.customer.rownum} id: {$customers[customer]}<br />\n{/section}\n\n{if $smarty.section.customer.show}\n  the section was shown.\n{else}\n  the section was not shown.\n{/if}\n

    The above example will output:

    1 id: 1000<br />\n2 id: 1001<br />\n3 id: 1002<br />\n\nthe section was shown.\n
    "},{"location":"designers/language-builtin-functions/language-function-section/#total","title":".total","text":"

    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}\n  {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\n   There are {$smarty.section.customer.total} customers shown above.\n

    See also {foreach}, {for}, {while} and $smarty.section.

    "},{"location":"designers/language-builtin-functions/language-function-setfilter/","title":"{setfilter}","text":"

    The {setfilter}...{/setfilter} block tag allows the definition of template instance's variable filters.

    SYNTAX: {setfilter filter1\\|filter2\\|filter3\\....}\\...{/setfilter}

    The filter can be:

    {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.

    Note

    The setting of template instance filters does not affect the output of included subtemplates.

    "},{"location":"designers/language-builtin-functions/language-function-setfilter/#examples","title":"Examples","text":"
    <script>\n    {setfilter filter1}\n      {$foo} {* filter1 runs on output of $foo *}\n      {setfilter filter2|mod:true}\n        {$bar} {* filter2 and modifier mod runs on output of $bar *}\n      {/setfilter}\n      {$buh} {* filter1 runs on output of $buh *}\n    {/setfilter}\n    {$blar} {* no template instance filter runs on output of $blar}\n</script>\n
    "},{"location":"designers/language-builtin-functions/language-function-strip/","title":"{strip}","text":"

    Many times web designers run into the issue where white space and carriage returns affect the output of the rendered HTML (browser \"features\"), so you must run all your tags together in the template to get the desired results. This usually ends up in unreadable or unmanageable templates.

    Anything within {strip}{/strip} tags are stripped of the extra spaces or carriage returns at the beginnings and ends of the lines before they are displayed. This way you can keep your templates readable, and not worry about extra white space causing problems.

    Note

    {strip}{/strip} does not affect the contents of template variables, see the strip modifier instead.

    {* the following will be all run into one line upon output *}\n{strip}\n    <table>\n     <tr>\n      <td>\n       <a href=\"#\">\n        This is a test\n       </a>\n      </td>\n     </tr>\n    </table>\n{/strip}\n

    The above example will output:

    <table><tr><td><a href=\"#\">This is a test</a></td></tr></table>\n

    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 modifier.

    "},{"location":"designers/language-builtin-functions/language-function-while/","title":"{while}","text":"

    {while} loops in Smarty have much the same flexibility as PHP while statements, with a few added features for the template engine. Every {while} must be paired with a matching {/while}. All PHP conditionals and functions are recognized, such as ||, or, &&, and, is_array(), etc.

    The following is a list of recognized qualifiers, which must be separated from surrounding elements by spaces. Note that items listed in [brackets] are optional. PHP equivalents are shown where applicable.

    "},{"location":"designers/language-builtin-functions/language-function-while/#qualifiers","title":"Qualifiers","text":"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"},{"location":"designers/language-builtin-functions/language-function-while/#examples","title":"Examples","text":"
    {while $foo > 0}\n  {$foo--}\n{/while}\n

    The above example will count down the value of $foo until 1 is reached.

    See also {foreach}, {for} and {section}.

    "},{"location":"designers/language-custom-functions/","title":"Custom Functions","text":"

    Smarty comes with several custom plugin functions that you can use in the templates.

    "},{"location":"designers/language-custom-functions/language-function-counter/","title":"{counter}","text":"

    {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 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.

    "},{"location":"designers/language-custom-functions/language-function-counter/#attributes","title":"Attributes","text":"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.

    "},{"location":"designers/language-custom-functions/language-function-counter/#examples","title":"Examples","text":"
    {* initialize the count *}\n{counter start=0 skip=2}<br />\n{counter}<br />\n{counter}<br />\n{counter}<br />\n

    this will output:

    0<br />\n2<br />\n4<br />\n6<br />\n
    "},{"location":"designers/language-custom-functions/language-function-cycle/","title":"{cycle}","text":"

    {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.

    "},{"location":"designers/language-custom-functions/language-function-cycle/#attributes","title":"Attributes","text":"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) "},{"location":"designers/language-custom-functions/language-function-cycle/#examples","title":"Examples","text":"
    {section name=rows loop=$data}\n    <tr class=\"{cycle values=\"odd,even\"}\">\n       <td>{$data[rows]}</td>\n    </tr>\n{/section}\n

    The above template would output:

        <tr class=\"odd\">\n       <td>1</td>\n    </tr>\n    <tr class=\"even\">\n       <td>2</td>\n    </tr>\n    <tr class=\"odd\">\n       <td>3</td>\n    </tr>\n
    "},{"location":"designers/language-custom-functions/language-function-debug/","title":"{debug}","text":"

    {debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned 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 Required Description output No output type, html or javascript (defaults to 'javascript')

    See also the debugging console page.

    "},{"location":"designers/language-custom-functions/language-function-eval/","title":"{eval}","text":"

    {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.

    "},{"location":"designers/language-custom-functions/language-function-eval/#attributes","title":"Attributes","text":"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.

    Note

    "},{"location":"designers/language-custom-functions/language-function-eval/#examples","title":"Examples","text":"

    The contents of the config file, setup.conf.

    emphstart = <strong>\nemphend = </strong>\ntitle = Welcome to {$company}'s home page!\nErrorCity = You must supply a {#emphstart#}city{#emphend#}.\nErrorState = You must supply a {#emphstart#}state{#emphend#}.\n

    Where the template is:

    {config_load file='setup.conf'}\n\n{eval var=$foo}\n{eval var=#title#}\n{eval var=#ErrorCity#}\n{eval var=#ErrorState# assign='state_error'}\n{$state_error}\n

    The above template will output:

    This is the contents of foo.\nWelcome to Foobar Pub & Grill's home page!\nYou must supply a <strong>city</strong>.\nYou must supply a <strong>state</strong>.\n

    This outputs the server name (in uppercase) and IP. The assigned variable $str could be from a database query.

    <?php\n    $str = 'The server name is {$smarty.server.SERVER_NAME|upper} '\n           .'at {$smarty.server.SERVER_ADDR}';\n    $smarty->assign('foo',$str);\n

    Where the template is:

    {eval var=$foo}\n
    "},{"location":"designers/language-custom-functions/language-function-fetch/","title":"{fetch}","text":"

    {fetch} is used to retrieve files from the local file system, http, or ftp and display the contents.

    "},{"location":"designers/language-custom-functions/language-function-fetch/#attributes","title":"Attributes","text":"Attribute Required Description file Yes The file, http or ftp site to fetch assign No The template variable the output will be assigned to "},{"location":"designers/language-custom-functions/language-function-fetch/#examples","title":"Examples","text":"
    {* include some javascript in your template *}\n{fetch file='/export/httpd/www.example.com/docs/navbar.js'}\n\n{* embed some weather text in your template from another web site *}\n{fetch file='http://www.myweather.com/68502/'}\n\n{* fetch a news headline file via ftp *}\n{fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'}\n{* as above but with variables *}\n{fetch file=\"ftp://`$user`:`$password`@`$server`/`$path`\"}\n\n{* assign the fetched contents to a template variable *}\n{fetch file='http://www.myweather.com/68502/' assign='weather'}\n{if $weather ne ''}\n  <div id=\"weather\">{$weather}</div>\n{/if}\n

    See also {capture}, {eval}, {assign} and fetch().

    "},{"location":"designers/language-custom-functions/language-function-html-checkboxes/","title":"{html_checkboxes}","text":"

    {html_checkboxes} is a custom function that creates an html checkbox group with provided data. It takes care of which item(s) are selected by default as well.

    "},{"location":"designers/language-custom-functions/language-function-html-checkboxes/#attributes","title":"Attributes","text":"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 <label>-tags to the output (defaults to true) label_ids No Add id-attributes to <label> and <input> 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) "},{"location":"designers/language-custom-functions/language-function-html-checkboxes/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n                                'Joe Schmoe',\n                                'Jack Smith',\n                                'Jane Johnson',\n                                'Charlie Brown')\n                              );\n$smarty->assign('customer_id', 1001);\n

    where template is

    {html_checkboxes name='id' values=$cust_ids output=$cust_names selected=$customer_id  separator='<br />'}\n

    or where PHP code is:

    <?php\n\n$smarty->assign(\n    'cust_checkboxes', \n    [\n     1000 => 'Joe Schmoe',\n     1001 => 'Jack Smith',\n     1002 => 'Jane Johnson',\n     1003 => 'Charlie Brown',\n    ]\n);\n$smarty->assign('customer_id', 1001);\n

    and the template is

    {html_checkboxes name='id' options=$cust_checkboxes selected=$customer_id separator='<br />'}\n

    both examples will output:

    <label><input type=\"checkbox\" name=\"id[]\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1001\" checked=\"checked\" />Jack Smith</label>\n<br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1003\" />Charlie Brown</label><br />\n
    <?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, contact_type_id, contact '\n       .'from contacts where contact_id=12';\n$smarty->assign('contact',$db->getRow($sql));\n

    The results of the database queries above would be output with.

    {html_checkboxes name='contact_type_id' options=$contact_types selected=$contact.contact_type_id separator='<br />'}\n

    See also {html_radios} and {html_options}

    "},{"location":"designers/language-custom-functions/language-function-html-image/","title":"{html_image}","text":"

    {html_image} is a custom function that generates an HTML <img> tag. The height and width are automatically calculated from the image file if they are not supplied.

    "},{"location":"designers/language-custom-functions/language-function-html-image/#attributes","title":"Attributes","text":"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

    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, it is generally better to avoid {html_image} and leave image tags static for optimal performance.

    "},{"location":"designers/language-custom-functions/language-function-html-image/#examples","title":"Examples","text":"
    {html_image file='pumpkin.jpg'}\n{html_image file='/path/from/docroot/pumpkin.jpg'}\n{html_image file='../path/relative/to/currdir/pumpkin.jpg'}\n

    Example output of the above template would be:

    <img src=\"pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"/path/from/docroot/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"../path/relative/to/currdir/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n
    "},{"location":"designers/language-custom-functions/language-function-html-options/","title":"{html_options}","text":"

    {html_options} is a custom function that creates the html <select><option> group with the assigned data. It takes care of which item(s) are selected by default as well.

    "},{"location":"designers/language-custom-functions/language-function-html-options/#attributes","title":"Attributes","text":"Attribute Name Required Description values Yes, unless using options attribute An array of values for dropdown output Yes, unless using options attribute An array of output for dropdown selected No The selected option element(s) as a string or array options Yes, unless using values and output An associative array of values and output name No Name of select group 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) "},{"location":"designers/language-custom-functions/language-function-html-options/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('myOptions', [\n                                1800 => 'Joe Schmoe',\n                                9904 => 'Jack Smith',\n                                2003 => 'Charlie Brown']\n                                );\n$smarty->assign('mySelect', 9904);\n

    The following template will generate a drop-down list. Note the presence of the name attribute which creates the <select> tags.

    {html_options name=foo options=$myOptions selected=$mySelect}\n

    Output of the above example would be:

    <select name=\"foo\">\n    <option value=\"1800\">Joe Schmoe</option>\n    <option value=\"9904\" selected=\"selected\">Jack Smith</option>\n    <option value=\"2003\">Charlie Brown</option>\n</select>   \n
    <?php\n$smarty->assign('cust_ids', [56,92,13]);\n$smarty->assign('cust_names', [\n                              'Joe Schmoe',\n                              'Jane Johnson',\n                              'Charlie Brown']);\n$smarty->assign('customer_id', 92);\n

    The above arrays would be output with the following template (note the use of the php count() function as a modifier to set the select size).

    <select name=\"customer_id\" size=\"{$cust_names|@count}\">\n   {html_options values=$cust_ids output=$cust_names selected=$customer_id}\n</select>\n

    The above example would output:

    <select name=\"customer_id\" size=\"3\">\n    <option value=\"56\">Joe Schmoe</option>\n    <option value=\"92\" selected=\"selected\">Jane Johnson</option>\n    <option value=\"13\">Charlie Brown</option>\n</select>\n
    <?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id\n        from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\n

    Where a template could be as follows. Note the use of the truncate modifier.

    <select name=\"type_id\">\n    <option value='null'>-- none --</option>\n    {html_options options=$contact_types|truncate:20 selected=$contact.type_id}\n</select>\n
    <?php\n$arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim');\n$arr['Rest']  = array(3 => 'Sauna',1 => 'Massage');\n$smarty->assign('lookups', $arr);\n$smarty->assign('fav', 7);\n

    The script above and the following template

    {html_options name=foo options=$lookups selected=$fav}\n

    would output:

    <select name=\"foo\">\n    <optgroup label=\"Sport\">\n        <option value=\"6\">Golf</option>\n        <option value=\"9\">Cricket</option>\n        <option value=\"7\" selected=\"selected\">Swim</option>\n    </optgroup>\n    <optgroup label=\"Rest\">\n        <option value=\"3\">Sauna</option>\n        <option value=\"1\">Massage</option>\n    </optgroup>\n</select>\n

    See also {html_checkboxes} and {html_radios}

    "},{"location":"designers/language-custom-functions/language-function-html-radios/","title":"{html_radios}","text":"

    {html_radios} is a custom function that creates an HTML radio button group. It also takes care of which item is selected by default as well.

    "},{"location":"designers/language-custom-functions/language-function-html-radios/#attributes","title":"Attributes","text":"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 -tags to the output (defaults to true) label_ids No Add id-attributes to <label> and <input> 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) "},{"location":"designers/language-custom-functions/language-function-html-radios/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n                              'Joe Schmoe',\n                              'Jack Smith',\n                              'Jane Johnson',\n                              'Charlie Brown')\n                              );\n$smarty->assign('customer_id', 1001);\n

    Where template is:

    {html_radios name='id' values=$cust_ids output=$cust_names\n       selected=$customer_id separator='<br />'}\n
    <?php\n$smarty->assign('cust_radios', array(\n                               1000 => 'Joe Schmoe',\n                               1001 => 'Jack Smith',\n                               1002 => 'Jane Johnson',\n                               1003 => 'Charlie Brown'));\n$smarty->assign('customer_id', 1001);\n

    Where template is:

    {html_radios name='id' options=$cust_radios\n     selected=$customer_id separator='<br />'}\n

    Both examples will output:

    <label><input type=\"radio\" name=\"id\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1001\" checked=\"checked\" />Jack Smith</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1003\" />Charlie Brown</label><br />\n
    <?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id '\n        .'from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\n

    The variable assigned from the database above would be output with the template:

    {html_radios name='contact_type_id' options=$contact_types\n     selected=$contact.contact_type_id separator='<br />'}\n

    See also {html_checkboxes} and {html_options}

    "},{"location":"designers/language-custom-functions/language-function-html-select-date/","title":"{html_select_date}","text":"

    {html_select_date} is a custom function that creates date dropdowns. It can display any or all of: year, month, and day. All parameters that are not in the list below are printed as name/value-pairs inside the <select> tags of day, month and year.

    "},{"location":"designers/language-custom-functions/language-function-html-select-date/#attributes","title":"Attributes","text":"Attribute Name Default Description prefix Date_ What to prefix the var name with time What date/time to pre-select. Accepts timestamps, DateTime objects or any string parseable by strtotime(). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL. start_year current year The first year in the dropdown, either year number, or relative to current year (+/- N) end_year same as start_year The last year in the dropdown, either year number, or relative to current year (+/- N) display_days TRUE Whether to display days or not display_months TRUE Whether to display months or not display_years TRUE Whether to display years or not month_names List of strings to display for months. array(1 => 'Jan', ..., 12 => 'Dec') month_format \\%B What format the month should be in (strftime) day_format \\%02d What format the day output should be in (sprintf) day_value_format \\%d What format the day value should be in (sprintf) year_as_text FALSE Whether or not to display the year as text reverse_years FALSE Display years in reverse order field_array If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name[Day], name[Year], name[Month]. day_size Adds size attribute to select tag if given month_size Adds size attribute to select tag if given year_size Adds size attribute to select tag if given all_extra Adds extra attributes to all select/input tags if given day_extra Adds extra attributes to select/input tags if given month_extra Adds extra attributes to select/input tags if given year_extra Adds extra attributes to select/input tags if given all_id Adds id-attribute to all select/input tags if given day_id Adds id-attribute to select/input tags if given month_id Adds id-attribute to select/input tags if given year_id Adds id-attribute to select/input tags if given field_order MDY The order in which to display the fields field_separator \\n String printed between different fields month_value_format \\%m strftime() format of the month values, default is %m for month numbers. all_empty If supplied then the first element of any select-box has this value as it's label and \"\" as it's value. This is useful to make the select-boxes read \"Please select\" for example. year_empty If supplied then the first element of the year's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select a year\" for example. Note that you can use values like \"-MM-DD\" as time-attribute to indicate an unselected year. month_empty If supplied then the first element of the month's select-box has this value as it's label and \"\" as it's value. . Note that you can use values like \"YYYY--DD\" as time-attribute to indicate an unselected month. day_empty If supplied then the first element of the day's select-box has this value as it's label and \"\" as it's value. Note that you can use values like \"YYYY-MM-\" as time-attribute to indicate an unselected day.

    Note

    There is an useful php function on the date tips page for converting {html_select_date} form values to a timestamp.

    "},{"location":"designers/language-custom-functions/language-function-html-select-date/#exaples","title":"Exaples","text":"

    Template code

    {html_select_date}\n

    This will output:

    <select name=\"Date_Month\">\n    <option value=\"1\">January</option>\n    <option value=\"2\">February</option>\n    <option value=\"3\">March</option>\n      ..... snipped .....\n    <option value=\"10\">October</option>\n    <option value=\"11\">November</option>\n    <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"Date_Day\">\n    <option value=\"1\">01</option>\n    <option value=\"2\">02</option>\n    <option value=\"3\">03</option>\n      ..... snipped .....\n    <option value=\"11\">11</option>\n    <option value=\"12\">12</option>\n    <option value=\"13\" selected=\"selected\">13</option>\n    <option value=\"14\">14</option>\n    <option value=\"15\">15</option>\n      ..... snipped .....\n    <option value=\"29\">29</option>\n    <option value=\"30\">30</option>\n    <option value=\"31\">31</option>\n</select>\n<select name=\"Date_Year\">\n    <option value=\"2006\" selected=\"selected\">2006</option>\n</select>\n
    {* start and end year can be relative to current year *}\n{html_select_date prefix='StartDate' time=$time start_year='-5'\n       end_year='+1' display_days=false}\n

    With 2000 as the current year the output:

    <select name=\"StartDateMonth\">\n    <option value=\"1\">January</option>\n    <option value=\"2\">February</option>\n    .... snipped ....\n    <option value=\"11\">November</option>\n    <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"StartDateYear\">\n    <option value=\"1995\">1995</option>\n    .... snipped ....\n    <option value=\"1999\">1999</option>\n    <option value=\"2000\" selected=\"selected\">2000</option>\n    <option value=\"2001\">2001</option>\n</select>\n

    See also {html_select_time}, date_format, $smarty.now and the date tips page.

    "},{"location":"designers/language-custom-functions/language-function-html-select-time/","title":"{html_select_time}","text":"

    {html_select_time} is a custom function that creates time dropdowns for you. It can display any or all of: hour, minute, second and meridian.

    The time attribute can have different formats. It can be a unique timestamp, a string of the format YYYYMMDDHHMMSS or a string that is parseable by PHP's strtotime().

    "},{"location":"designers/language-custom-functions/language-function-html-select-time/#attributes","title":"Attributes","text":"Attribute Name Default Description prefix Time_ What to prefix the var name with time current timestamp What date/time to pre-select. Accepts timestamp, DateTime, mysql timestamp or any string parsable by strtotime(). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. display_hours TRUE Whether or not to display hours display_minutes TRUE Whether or not to display minutes display_seconds TRUE Whether or not to display seconds display_meridian TRUE Whether or not to display meridian (am/pm) use_24_hours TRUE Whether or not to use 24 hour clock minute_interval 1 Number interval in minute dropdown second_interval 1 Number interval in second dropdown hour_format \\%02d What format the hour label should be in (sprintf) hour_value_format \\%20d What format the hour value should be in (sprintf) minute_format \\%02d What format the minute label should be in (sprintf) minute_value_format \\%20d What format the minute value should be in (sprintf) second_format \\%02d What format the second label should be in (sprintf) second_value_format \\%20d What format the second value should be in (sprintf) field_array n/a Outputs values to array of this name all_extra null Adds extra attributes to select/input tags if given hour_extra null Adds extra attributes to select/input tags if given minute_extra null Adds extra attributes to select/input tags if given second_extra null Adds extra attributes to select/input tags if given meridian_extra null Adds extra attributes to select/input tags if given field_separator \\n String printed between different fields option_separator \\n String printed between different options of a field all_id null Adds id-attribute to all select/input tags if given hour_id null Adds id-attribute to select/input tags if given minute_id null Adds id-attribute to select/input tags if given second_id null Adds id-attribute to select/input tags if given meridian_id null Adds id-attribute to select/input tags if given all_empty null If supplied then the first element of any select-box has this value as it's label and \"\" as it's value. This is useful to make the select-boxes read \"Please select\" for example. hour_empty null If supplied then the first element of the hour's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an hour\" for example. minute_empty null If supplied then the first element of the minute's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an minute\" for example. second_empty null If supplied then the first element of the second's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an second\" for example. meridian_empty null If supplied then the first element of the meridian's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an meridian\" for example."},{"location":"designers/language-custom-functions/language-function-html-select-time/#examples","title":"Examples","text":"
    {html_select_time use_24_hours=true}\n

    At 9:20 and 23 seconds in the morning the template above would output:

    <select name=\"Time_Hour\">\n    <option value=\"00\">00</option>\n    <option value=\"01\">01</option>\n    ... snipped ....\n    <option value=\"08\">08</option>\n    <option value=\"09\" selected>09</option>\n    <option value=\"10\">10</option>\n    ... snipped ....\n    <option value=\"22\">22</option>\n    <option value=\"23\">23</option>\n</select>\n<select name=\"Time_Minute\">\n    <option value=\"00\">00</option>\n    <option value=\"01\">01</option>\n    ... snipped ....\n    <option value=\"19\">19</option>\n    <option value=\"20\" selected>20</option>\n    <option value=\"21\">21</option>\n    ... snipped ....\n    <option value=\"58\">58</option>\n    <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Second\">\n    <option value=\"00\">00</option>\n    <option value=\"01\">01</option>\n    ... snipped ....\n    <option value=\"22\">22</option>\n    <option value=\"23\" selected>23</option>\n    <option value=\"24\">24</option>\n    ... snipped ....\n    <option value=\"58\">58</option>\n    <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Meridian\">\n    <option value=\"am\" selected>AM</option>\n    <option value=\"pm\">PM</option>\n</select>\n

    See also $smarty.now, {html_select_date} and the date tips page.

    "},{"location":"designers/language-custom-functions/language-function-html-table/","title":"{html_table}","text":"

    {html_table} is a custom function that dumps an array of data into an HTML <table>.

    "},{"location":"designers/language-custom-functions/language-function-html-table/#attributes","title":"Attributes","text":"Attribute Name Required Description loop Yes Array of data to loop through cols No Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array. rows No Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements. inner No Direction of consecutive elements in the loop-array to be rendered. cols means elements are displayed col-by-col. rows means elements are displayed row-by-row. caption No Text to be used for the <caption> element of the table table_attr No Attributes for <table> tag (defaults to 'border=\"1\"') th_attr No Attributes for <th> tag (arrays are cycled) tr_attr No attributes for <tr> tag (arrays are cycled) td_attr No Attributes for <td> tag (arrays are cycled) trailpad No Value to pad the trailing cells on last row with (if any) (defaults to '\u00a0') hdir No Direction of each row to be rendered. possible values: right (left-to-right), and left (right-to-left) (defaults to 'right') vdir No Direction of each column to be rendered. possible values: down (top-to-bottom), up (bottom-to-top) (defaults to 'down') "},{"location":"designers/language-custom-functions/language-function-html-table/#examples","title":"Examples","text":"
    <?php\n$smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) );\n$smarty->assign( 'tr', array('bgcolor=\"#eeeeee\"','bgcolor=\"#dddddd\"') );\n$smarty->display('index.tpl');\n

    The variables assigned from php could be displayed as these three examples demonstrate. Each example shows the template followed by output.

    ** Example 1 ** 

    {html_table loop=$data}\n
    <table border=\"1\">\n    <tbody>\n        <tr><td>1</td><td>2</td><td>3</td></tr>\n        <tr><td>4</td><td>5</td><td>6</td></tr>\n        <tr><td>7</td><td>8</td><td>9</td></tr>\n    </tbody>\n</table>\n

    ** Example 2 ** 

    {html_table loop=$data cols=4 table_attr='border=\"0\"'}\n
    <table border=\"0\">\n    <tbody>\n        <tr><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n        <tr><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n        <tr><td>9</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n    </tbody>\n</table>\n

    ** Example 3 ** 

    {html_table loop=$data cols=\"first,second,third,fourth\" tr_attr=$tr}\n
    <table border=\"1\">\n    <thead>\n        <tr>\n        <th>first</th><th>second</th><th>third</th><th>fourth</th>\n        </tr>\n    </thead>\n    <tbody>\n        <tr bgcolor=\"#eeeeee\"><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n        <tr bgcolor=\"#dddddd\"><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n        <tr bgcolor=\"#eeeeee\"><td>9</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr>\n    </tbody>\n</table>\n

    "},{"location":"designers/language-custom-functions/language-function-mailto/","title":"{mailto}","text":"

    {mailto} automates the creation of a mailto: anchor links and optionally encodes them. Encoding emails makes it more difficult for web spiders to lift email addresses off of a site.

    "},{"location":"designers/language-custom-functions/language-function-mailto/#attributes","title":"Attributes","text":"Attribute Name Required Description address Yes The e-mail address text No The text to display, default is the e-mail address encode No How to encode the e-mail. Can be one of none, hex, javascript or javascript_charcode. cc No Email addresses to carbon copy, separate entries by a comma. bcc No Email addresses to blind carbon copy, separate entries by a comma subject No Email subject newsgroups No Newsgroups to post to, separate entries by a comma. followupto No Addresses to follow up to, separate entries by a comma. extra No Any extra information you want passed to the link, such as style sheet classes

    Note

    Javascript is probably the most thorough form of encoding, although you can use hex encoding too.

    "},{"location":"designers/language-custom-functions/language-function-mailto/#examples","title":"Examples","text":"
    {mailto address=\"me@example.com\"}\n<a href=\"mailto:me@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" text=\"send me some mail\"}\n<a href=\"mailto:me@example.com\" >send me some mail</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript\"}\n<script type=\"text/javascript\" language=\"javascript\">\n   eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))\n</script>\n\n{mailto address=\"me@example.com\" encode=\"hex\"}\n<a href=\"mailto:%6d%65.. snipped..3%6f%6d\">&#x6d;&..snipped...#x6f;&#x6d;</a>\n\n{mailto address=\"me@example.com\" subject=\"Hello to you!\"}\n<a href=\"mailto:me@example.com?subject=Hello%20to%20you%21\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" cc=\"you@example.com,they@example.com\"}\n<a href=\"mailto:me@example.com?cc=you@example.com,they@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" extra='class=\"email\"'}\n<a href=\"mailto:me@example.com\" class=\"email\">me@example.com</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript_charcode\"}\n<script type=\"text/javascript\" language=\"javascript\">\n    {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}\n</script>\n

    See also escape, {textformat} and obfuscating email addresses.

    "},{"location":"designers/language-custom-functions/language-function-math/","title":"{math}","text":"

    {math} allows the template designer to do math equations in the template.

    "},{"location":"designers/language-custom-functions/language-function-math/#attributes","title":"Attributes","text":"Attribute Name Required Description equation Yes The equation to execute format No The format of the result (sprintf) var Yes Equation variable value assign No Template variable the output will be assigned to [var ...] Yes Equation variable value

    Note

    {math} is an expensive function in performance due to its use of the php eval() function. Doing the math in PHP is much more efficient, so whenever possible do the math calculations in the script and assign() the results to the template. Definitely avoid repetitive {math} function calls, eg within {section} loops.

    "},{"location":"designers/language-custom-functions/language-function-math/#examples","title":"Examples","text":"

    Example 1 

    {* $height=4, $width=5 *}\n\n{math equation=\"x + y\" x=$height y=$width}\n

    The above example will output:

    9\n

    Example 2

    {* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *}\n\n{math equation=\"height * width / division\"\n    height=$row_height\n    width=$row_width\n    division=#col_div#}\n

    The above example will output:

    100\n

    Example 3

    {* you can use parenthesis *}\n\n{math equation=\"(( x + y ) / z )\" x=2 y=10 z=2}\n

    The above example will output:

    6\n

    Example 4

    {* you can supply a format parameter in sprintf format *}\n\n{math equation=\"x + y\" x=4.4444 y=5.0000 format=\"%.2f\"}\n

    The above example will output: 

    9.44\n

    "},{"location":"designers/language-custom-functions/language-function-textformat/","title":"{textformat}","text":"

    {textformat} is a block function used to format text. It basically cleans up spaces and special characters, and formats paragraphs by wrapping at a boundary and indenting lines.

    You can set the parameters explicitly, or use a preset style. Currently, \"email\" is the only available style.

    "},{"location":"designers/language-custom-functions/language-function-textformat/#attributes","title":"Attributes","text":"Attribute Name Default Description style n/a Preset style indent 0 The number of chars to indent every line indent_first 0 The number of chars to indent the first line indent_char (single space) The character (or string of chars) to indent with wrap 80 How many characters to wrap each line to wrap_char \\n The character (or string of chars) to break each line with wrap_cut FALSE If TRUE, wrap will break the line at the exact character instead of at a word boundary assign n/a The template variable the output will be assigned to"},{"location":"designers/language-custom-functions/language-function-textformat/#examples","title":"Examples","text":"
    {textformat wrap=40}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

    This is foo. This is foo. This is foo.\nThis is foo. This is foo. This is foo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo\nfoo. bar foo bar foo foo. bar foo bar\nfoo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo.\n
    {textformat wrap=40 indent=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

        This is foo. This is foo. This is\n    foo. This is foo. This is foo. This\n    is foo.\n\n    This is bar.\n\n    bar foo bar foo foo. bar foo bar foo\n    foo. bar foo bar foo foo. bar foo\n    bar foo foo. bar foo bar foo foo.\n    bar foo bar foo foo. bar foo bar\n    foo foo.\n
    {textformat wrap=40 indent=4 indent_first=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

       This is foo. This is foo. This\n   is foo. This is foo. This is foo.\n   This is foo.\n\n   This is bar.\n\n   bar foo bar foo foo. bar foo bar\n   foo foo. bar foo bar foo foo. bar\n   foo bar foo foo. bar foo bar foo\n   foo. bar foo bar foo foo. bar foo\n   bar foo foo.\n
    {textformat style=\"email\"}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\nbar foo bar foo     foo.\n\n{/textformat}\n

    The above example will output:

    This is foo. This is foo. This is foo. This is foo. This is foo. This is\nfoo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo\nfoo.\n

    See also {strip} and wordwrap.

    "},{"location":"designers/language-modifiers/","title":"Variable Modifiers","text":"

    Variable modifiers can be applied to variables, custom functions or strings. To apply a modifier, specify the value followed by a | (pipe) and the modifier name. A modifier may accept additional parameters that affect its behavior. These parameters follow the modifier name and are separated by a : (colon). Also, all php-functions can be used as modifiers implicitly (more below) and modifiers can be combined.

    "},{"location":"designers/language-modifiers/#examples","title":"Examples","text":"
    {* apply modifier to a variable *}\n{$title|upper}\n\n{* modifier with parameters *}\n{$title|truncate:40:\"...\"}\n\n{* apply modifier to a function parameter *}\n{html_table loop=$myvar|upper}\n\n{* with parameters *}\n{html_table loop=$myvar|truncate:40:\"...\"}\n\n{* apply modifier to literal string *}\n{\"foobar\"|upper}\n\n{* using date_format to format the current date *}\n{$smarty.now|date_format:\"%Y/%m/%d\"}\n\n{* apply modifier to a custom function *}\n{mailto|upper address=\"smarty@example.com\"}\n\n{* using  php's str_repeat *}\n{\"=\"|str_repeat:80}\n\n{* php's count *}\n{$myArray|@count}\n\n{* this will uppercase and truncate the whole array *}\n<select name=\"name_id\">\n{html_options output=$my_array|upper|truncate:20}\n</select>\n

    See also registerPlugin(), combining modifiers. and extending smarty with plugins

    "},{"location":"designers/language-modifiers/language-modifier-capitalize/","title":"capitalize","text":"

    This is used to capitalize the first letter of all words in a variable. This is similar to the PHP ucwords() function.

    "},{"location":"designers/language-modifiers/language-modifier-capitalize/#basic-usage","title":"Basic usage","text":"
    {$myVar|capitalize}\n
    "},{"location":"designers/language-modifiers/language-modifier-capitalize/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 boolean No This determines whether or not words with digits will be uppercased 2 boolean No This determines whether or not Capital letters within words should be lowercased, e.g. \"aAa\" to \"Aaa\""},{"location":"designers/language-modifiers/language-modifier-capitalize/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'next x-men film, x3, delayed.');\n

    Where the template is:

        {$articleTitle}\n    {$articleTitle|capitalize}\n    {$articleTitle|capitalize:true}\n

    Will output:

        next x-men film, x3, delayed.\n    Next X-Men Film, x3, Delayed.\n    Next X-Men Film, X3, Delayed.\n

    See also lower and upper

    "},{"location":"designers/language-modifiers/language-modifier-cat/","title":"cat","text":"

    This value is concatenated to the given variable.

    "},{"location":"designers/language-modifiers/language-modifier-cat/#basic-usage","title":"Basic usage","text":"
    {$myVar|cat:' units'}\n
    "},{"location":"designers/language-modifiers/language-modifier-cat/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 string No This value to concatenate to the given variable."},{"location":"designers/language-modifiers/language-modifier-cat/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', \"Psychics predict world didn't end\");\n

    Where template is:

        {$articleTitle|cat:' yesterday.'}\n

    Will output:

        Psychics predict world didn't end yesterday.\n
    "},{"location":"designers/language-modifiers/language-modifier-count-characters/","title":"count_characters","text":"

    This is used to count the number of characters in a variable.

    "},{"location":"designers/language-modifiers/language-modifier-count-characters/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_characters}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-characters/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 boolean No This determines whether to include whitespace characters in the count."},{"location":"designers/language-modifiers/language-modifier-count-characters/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.');\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_characters}\n    {$articleTitle|count_characters:true}\n

    Will output:

        Cold Wave Linked to Temperatures.\n    29\n    33\n

    See also count_words, count_sentences and count_paragraphs.

    "},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/","title":"count_paragraphs","text":"

    This is used to count the number of paragraphs in a variable.

    "},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_paragraphs}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle',\n                     \"War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\\n\\n\n                     Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\"\n                    );\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_paragraphs}\n

    Will output:

        War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\n    Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\n    2\n

    See also count_characters, count_sentences and count_words.

    "},{"location":"designers/language-modifiers/language-modifier-count-sentences/","title":"count_sentences","text":"

    This is used to count the number of sentences in a variable. A sentence being delimited by a dot, question- or exclamation-mark (.?!).

    "},{"location":"designers/language-modifiers/language-modifier-count-sentences/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_sentences}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-sentences/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle',\n                     'Two Soviet Ships Collide - One Dies.\n                     Enraged Cow Injures Farmer with Axe.'\n                     );\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_sentences}\n

    Will output:

        Two Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe.\n    2\n

    See also count_characters, count_paragraphs and count_words.

    "},{"location":"designers/language-modifiers/language-modifier-count-words/","title":"count_words","text":"

    This is used to count the number of words in a variable.

    "},{"location":"designers/language-modifiers/language-modifier-count-words/#basic-usage","title":"Basic usage","text":"
    {$myVar|count_words}\n
    "},{"location":"designers/language-modifiers/language-modifier-count-words/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n

    Where template is:

        {$articleTitle}\n    {$articleTitle|count_words}\n

    This will output:

        Dealers Will Hear Car Talk at Noon.\n    7\n

    See also count_characters, count_paragraphs and count_sentences.

    "},{"location":"designers/language-modifiers/language-modifier-date-format/","title":"date_format","text":"

    This formats a date and time into the given strftime() format. Dates can be passed to Smarty as unix timestamps, DateTime objects, mysql timestamps or any string made up of month day year, parsable by php\\'s strtotime(). Designers can then use date_format to have complete control of the formatting of the date. If the date passed to date_format is empty and a second parameter is passed, that will be used as the date to format.

    "},{"location":"designers/language-modifiers/language-modifier-date-format/#basic-usage","title":"Basic usage","text":"
    {$myVar|date_format:\"%Y-%m-%d\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-date-format/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 string No %b %e, %Y This is the format for the outputted date. 2 string No n/a This is the default date if the input is empty.

    Note

    Since Smarty-2.6.10 numeric values passed to date_format are always (except for mysql timestamps, see below) interpreted as a unix timestamp.

    Before Smarty-2.6.10 numeric strings that where also parsable by strtotime() in php (like YYYYMMDD) where sometimes (depending on the underlying implementation of strtotime()) interpreted as date strings and NOT as timestamps.

    The only exception are mysql timestamps: They are also numeric only and 14 characters long (YYYYMMDDHHMMSS), mysql timestamps have precedence over unix timestamps.

    Note

    date_format is essentially a wrapper to PHP's strftime() function. You may have more or less conversion specifiers available depending on your system's strftime() function where PHP was compiled. Check your system\\'s manpage for a full list of valid specifiers. However, a few of the specifiers are emulated on Windows. These are: %D, %e, %h, %l, %n, %r, %R, %t, %T.

    "},{"location":"designers/language-modifiers/language-modifier-date-format/#examples","title":"Examples","text":"
    <?php\n\n$config['date'] = '%I:%M %p';\n$config['time'] = '%H:%M:%S';\n$smarty->assign('config', $config);\n$smarty->assign('yesterday', strtotime('-1 day'));\n

    This template uses $smarty.now to get the current time:

    {$smarty.now|date_format}\n{$smarty.now|date_format:\"%D\"}\n{$smarty.now|date_format:$config.date}\n{$yesterday|date_format}\n{$yesterday|date_format:\"%A, %B %e, %Y\"}\n{$yesterday|date_format:$config.time}\n

    This above will output:

    Jan 1, 2022\n01/01/22\n02:33 pm\nDec 31, 2021\nMonday, December 1, 2021\n14:33:00\n
    "},{"location":"designers/language-modifiers/language-modifier-date-format/#conversion-specifiers","title":"Conversion specifiers","text":"

    date_format conversion specifiers:

    See also $smarty.now, strftime(), {html_select_date} and the date tips page.

    "},{"location":"designers/language-modifiers/language-modifier-default/","title":"default","text":"

    This is used to set a default value for a variable. If the variable is unset or an empty string, the given default value is printed instead. Default takes the one argument.

    "},{"location":"designers/language-modifiers/language-modifier-default/#basic-usage","title":"Basic usage","text":"
    {$myVar|default:\"(none)\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-default/#parameters","title":"Parameters","text":"Parameter Type Required Default Description 1 string No empty This is the default value to output if the variable is empty."},{"location":"designers/language-modifiers/language-modifier-default/#examples","title":"Examples","text":"
    <?php\n\n    $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n    $smarty->assign('email', '');\n

    Where template is:

    {$articleTitle|default:'no title'}\n{$myTitle|default:'no title'}\n{$email|default:'No email address available'}\n

    Will output:

    Dealers Will Hear Car Talk at Noon.\nno title\nNo email address available\n

    See also the default variable handling and the blank variable handling pages.

    "},{"location":"designers/language-modifiers/language-modifier-escape/","title":"escape","text":"

    escape is used to encode or escape a variable to html, url, single quotes, hex, hexentity, javascript and mail. By default its html.

    "},{"location":"designers/language-modifiers/language-modifier-escape/#basic-usage","title":"Basic usage","text":"
    {$myVar|escape}\n
    "},{"location":"designers/language-modifiers/language-modifier-escape/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No html, htmlall, url, urlpathinfo, quotes, hex, hexentity, javascript, mail html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to htmlentities() et. al. 3 boolean No FALSE TRUE Double encode entities from & to &amp; (applies to html and htmlall only)"},{"location":"designers/language-modifiers/language-modifier-escape/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"'Stiff Opposition Expected to Casketless Funeral Plan'\"\n                );\n$smarty->assign('EmailAddress','smarty@example.com');\n

    These are example escape template lines followed by the output

    {$articleTitle}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape}\n&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;\n\n{$articleTitle|escape:'html'}    {* escapes  & \" ' < > *}\n&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;\n\n{$articleTitle|escape:'htmlall'} {* escapes ALL html entities *}\n&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;\n\n<a href=\"?title={$articleTitle|escape:'url'}\">click here</a>\n<a\nhref=\"?title=%27Stiff%20Opposition%20Expected%20to%20Casketless%20Funeral%20Plan%27\">click here</a>\n\n{$articleTitle|escape:'quotes'}\n\\'Stiff Opposition Expected to Casketless Funeral Plan\\'\n\n<a href=\"mailto:{$EmailAddress|escape:\"hex\"}\">{$EmailAddress|escape:\"hexentity\"}</a>\n{$EmailAddress|escape:'mail'}    {* this converts to email to text *}\n<a href=\"mailto:%62%6f%..snip..%65%74\">&#x62;&#x6f;&#x62..snip..&#x65;&#x74;</a>\n\n{'mail@example.com'|escape:'mail'}\nsmarty [AT] example [DOT] com\n\n{* the \"rewind\" parameter registers the current location *}\n<a href=\"$my_path?page=foo&rewind={$my_uri|escape:url}\">click here</a>\n

    This snippet is useful for emails, but see also {mailto}

    {* email address mangled *}\n<a href=\"mailto:{$EmailAddress|escape:'hex'}\">{$EmailAddress|escape:'mail'}</a>\n

    See also escaping smarty parsing, {mailto} and the obfuscating email addresses page.

    "},{"location":"designers/language-modifiers/language-modifier-from-charset/","title":"from_charset","text":"

    from_charset is used to transcode a string from a given charset to the internal charset. This is the exact opposite of the to_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-from-charset/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be decoded from

    Note

    Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.

    See also Charset Encoding, to_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-indent/","title":"indent","text":"

    This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to indent with. For example: use \"\\t\" for a tab.

    "},{"location":"designers/language-modifiers/language-modifier-indent/#basic-usage","title":"Basic usage","text":"
    {$myVar|indent:4}\n
    "},{"location":"designers/language-modifiers/language-modifier-indent/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 integer No 4 This determines how many characters to indent to. 2 string No (one space) This is the character used to indent with."},{"location":"designers/language-modifiers/language-modifier-indent/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                'NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.'\n                );\n

    Where template is:

    {$articleTitle}\n\n{$articleTitle|indent}\n\n{$articleTitle|indent:10}\n\n{$articleTitle|indent:1:\"\\t\"}\n

    Will output:

    NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.\n\n    NJ judge to rule on nude beach.\n    Sun or rain expected today, dark tonight.\n    Statistics show that teen pregnancy drops off significantly after 25.\n\n          NJ judge to rule on nude beach.\n          Sun or rain expected today, dark tonight.\n          Statistics show that teen pregnancy drops off significantly after 25.\n\n        NJ judge to rule on nude beach.\n        Sun or rain expected today, dark tonight.\n        Statistics show that teen pregnancy drops off significantly after 25.\n

    See also strip, wordwrap and spacify.

    "},{"location":"designers/language-modifiers/language-modifier-lower/","title":"lower","text":"

    This is used to lowercase a variable. This is equivalent to the PHP strtolower() function.

    "},{"location":"designers/language-modifiers/language-modifier-lower/#basic-usage","title":"Basic usage","text":"
    {$myVar|lower}\n
    "},{"location":"designers/language-modifiers/language-modifier-lower/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');\n

    Where template is:

    {$articleTitle}\n{$articleTitle|lower}\n

    This will output:

    Two Convicts Evade Noose, Jury Hung.\ntwo convicts evade noose, jury hung.\n

    See also upper and capitalize.

    "},{"location":"designers/language-modifiers/language-modifier-nl2br/","title":"nl2br","text":"

    All \"\\n\" line breaks will be converted to html <br /> tags in the given variable. This is equivalent to the PHP\\'s nl2br() function.

    "},{"location":"designers/language-modifiers/language-modifier-nl2br/#basic-usage","title":"Basic usage","text":"
    {$myVar|nl2br}\n
    "},{"location":"designers/language-modifiers/language-modifier-nl2br/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Sun or rain expected\\ntoday, dark tonight\"\n                );\n

    Where the template is:

    {$articleTitle|nl2br}\n

    Will output:

    Sun or rain expected<br />today, dark tonight\n

    See also word_wrap, count_paragraphs and count_sentences.

    "},{"location":"designers/language-modifiers/language-modifier-regex-replace/","title":"regex_replace","text":"

    A regular expression search and replace on a variable. Use the preg_replace() syntax from the PHP manual.

    "},{"location":"designers/language-modifiers/language-modifier-regex-replace/#basic-usage","title":"Basic usage","text":"
    {$myVar|regex_replace:\"/foo/\":\"bar\"}\n

    Note

    Although Smarty supplies this regex convenience modifier, it is usually better to apply regular expressions in PHP, either via custom functions or modifiers. Regular expressions are considered application code and are not part of presentation logic.

    "},{"location":"designers/language-modifiers/language-modifier-regex-replace/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is the regular expression to be replaced. 2 string Yes This is the string of text to replace with."},{"location":"designers/language-modifiers/language-modifier-regex-replace/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', \"Infertility unlikely to\\nbe passed on, experts say.\");\n

    Where template is:

    {* replace each carriage return, tab and new line with a space *}\n\n{$articleTitle}\n{$articleTitle|regex_replace:\"/[\\r\\t\\n]/\":\" \"}\n

    Will output:

    Infertility unlikely to\nbe passed on, experts say.\nInfertility unlikely to be passed on, experts say.\n

    See also replace and escape.

    "},{"location":"designers/language-modifiers/language-modifier-replace/","title":"replace","text":"

    A simple search and replace on a variable. This is equivalent to the PHP's str_replace() function.

    "},{"location":"designers/language-modifiers/language-modifier-replace/#basic-usage","title":"Basic usage","text":"
    {$myVar|replace:\"foo\":\"bar\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-replace/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is the string of text to be replaced. 2 string Yes This is the string of text to replace with."},{"location":"designers/language-modifiers/language-modifier-replace/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', \"Child's Stool Great for Use in Garden.\");\n

    Where template is:

    {$articleTitle}\n{$articleTitle|replace:'Garden':'Vineyard'}\n{$articleTitle|replace:' ':'   '}\n

    Will output:

    Child's Stool Great for Use in Garden.\nChild's Stool Great for Use in Vineyard.\nChild's   Stool   Great   for   Use   in   Garden.\n

    See also regex_replace and escape.

    "},{"location":"designers/language-modifiers/language-modifier-spacify/","title":"spacify","text":"

    spacify is a way to insert a space between every character of a variable. You can optionally pass a different character or string to insert.

    "},{"location":"designers/language-modifiers/language-modifier-spacify/#basic-usage","title":"Basic usage","text":"
    {$myVar|spacify}\n
    "},{"location":"designers/language-modifiers/language-modifier-spacify/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 string No one space This what gets inserted between each character of the variable."},{"location":"designers/language-modifiers/language-modifier-spacify/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.');\n

    Where template is:

    {$articleTitle}\n{$articleTitle|spacify}\n{$articleTitle|spacify:\"^^\"}\n

    Will output:

    Something Went Wrong in Jet Crash, Experts Say.\nS o m e t h i n g   W .... snip ....  s h ,   E x p e r t s   S a y .\nS^^o^^m^^e^^t^^h^^i^^n^^g^^ .... snip .... ^^e^^r^^t^^s^^ ^^S^^a^^y^^.\n

    See also wordwrap and nl2br.

    "},{"location":"designers/language-modifiers/language-modifier-string-format/","title":"string_format","text":"

    This is a way to format strings, such as decimal numbers and such. Use the syntax for sprintf() for the formatting.

    "},{"location":"designers/language-modifiers/language-modifier-string-format/#basic-usage","title":"Basic usage","text":"
    {$myVar|string_format:\"%d\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-string-format/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is what format to use. (sprintf)"},{"location":"designers/language-modifiers/language-modifier-string-format/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('number', 23.5787446);\n

    Where template is:

    {$number}\n{$number|string_format:\"%.2f\"}\n{$number|string_format:\"%d\"}\n

    Will output:

    23.5787446\n23.58\n23\n

    See also date_format.

    "},{"location":"designers/language-modifiers/language-modifier-strip-tags/","title":"strip_tags","text":"

    This strips out HTML markup tags, basically anything between < and >.

    "},{"location":"designers/language-modifiers/language-modifier-strip-tags/#basic-usage","title":"Basic usage","text":"
    {$myVar|strip_tags}\n
    "},{"location":"designers/language-modifiers/language-modifier-strip-tags/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 bool No TRUE This determines whether the tags are replaced by ' ' or ''"},{"location":"designers/language-modifiers/language-modifier-strip-tags/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Blind Woman Gets <font face=\\\"helvetica\\\">New\nKidney</font> from Dad she Hasn't Seen in <b>years</b>.\"\n               );\n

    Where template is:

    {$articleTitle}\n{$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *}\n{$articleTitle|strip_tags:false}\n

    Will output:

    Blind Woman Gets <font face=\"helvetica\">New Kidney</font> from Dad she Hasn't Seen in <b>years</b>.\nBlind Woman Gets  New Kidney  from Dad she Hasn't Seen in  years .\nBlind Woman Gets New Kidney from Dad she Hasn't Seen in years.\n

    See also replace and regex_replace.

    "},{"location":"designers/language-modifiers/language-modifier-strip/","title":"strip","text":"

    This replaces all spaces, newlines and tabs with a single space, or with the supplied string.

    "},{"location":"designers/language-modifiers/language-modifier-strip/#basic-usage","title":"Basic usage","text":"
    {$myVar|strip}\n

    Note

    If you want to strip blocks of template text, use the built-in {strip} function.

    "},{"location":"designers/language-modifiers/language-modifier-strip/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('articleTitle', \"Grandmother of\\neight makes\\t    hole in one.\");\n$smarty->display('index.tpl');\n

    Where template is:

    {$articleTitle}\n{$articleTitle|strip}\n{$articleTitle|strip:'&nbsp;'}\n

    Will output:

    Grandmother of\neight makes        hole in one.\nGrandmother of eight makes hole in one.\nGrandmother&nbsp;of&nbsp;eight&nbsp;makes&nbsp;hole&nbsp;in&nbsp;one.\n

    See also {strip} and truncate.

    "},{"location":"designers/language-modifiers/language-modifier-to-charset/","title":"to_charset","text":"

    to_charset is used to transcode a string from the internal charset to a given charset. This is the exact opposite of the from_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-to-charset/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be encoded to

    Note

    Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.

    See also Charset Encoding, from_charset modifier.

    "},{"location":"designers/language-modifiers/language-modifier-truncate/","title":"truncate","text":"

    This truncates a variable to a character length, the default is 80. As an optional second parameter, you can specify a string of text to display at the end if the variable was truncated. The characters in the string are included with the original truncation length. By default, truncate will attempt to cut off at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter of TRUE.

    "},{"location":"designers/language-modifiers/language-modifier-truncate/#basic-usage","title":"Basic usage","text":"
    {$myVar|truncate:40:\"...\"}\n
    "},{"location":"designers/language-modifiers/language-modifier-truncate/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 integer No 80 This determines how many characters to truncate to. 2 string No ... This is a text string that replaces the truncated text. Its length is included in the truncation length setting. 3 boolean No FALSE This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE. 4 boolean No FALSE This determines whether the truncation happens at the end of the string with FALSE, or in the middle of the string with TRUE. Note that if this setting is TRUE, then word boundaries are ignored."},{"location":"designers/language-modifiers/language-modifier-truncate/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');\n

    where template is:

    {$articleTitle}\n{$articleTitle|truncate}\n{$articleTitle|truncate:30}\n{$articleTitle|truncate:30:\"\"}\n{$articleTitle|truncate:30:\"---\"}\n{$articleTitle|truncate:30:\"\":true}\n{$articleTitle|truncate:30:\"...\":true}\n{$articleTitle|truncate:30:'..':true:true}\n

    This will output:

    Two Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after...\nTwo Sisters Reunite after\nTwo Sisters Reunite after---\nTwo Sisters Reunite after Eigh\nTwo Sisters Reunite after E...\nTwo Sisters Re..ckout Counter.\n
    "},{"location":"designers/language-modifiers/language-modifier-unescape/","title":"unescape","text":"

    unescape is used to decode entity, html and htmlall. It counters the effects of the escape modifier for the given types.

    "},{"location":"designers/language-modifiers/language-modifier-unescape/#basic-usage","title":"Basic usage","text":"
    {$myVar|unescape}\n
    "},{"location":"designers/language-modifiers/language-modifier-unescape/#parameters","title":"Parameters","text":"Parameter Position Type Required Possible Values Default Description 1 string No html, htmlall, entity, html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to html_entity_decode() or htmlspecialchars_decode() or mb_convert_encoding() et. al."},{"location":"designers/language-modifiers/language-modifier-unescape/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Germans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro\"\n                );\n

    These are example unescape template lines followed by the output

    {$articleTitle}\nGermans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro\n\n{$articleTitle|unescape:\"html\"}\nGermans use \"&Uuml;mlauts\" and pay in &euro;uro\n\n{$articleTitle|unescape:\"htmlall\"}\nGermans use \"\u00dcmlauts\" and pay in \u20acuro\n

    See also escaping smarty parsing, escape modifier.

    "},{"location":"designers/language-modifiers/language-modifier-upper/","title":"upper","text":"

    This is used to uppercase a variable. This is equivalent to the PHP strtoupper() function.

    "},{"location":"designers/language-modifiers/language-modifier-upper/#basic-usage","title":"Basic usage","text":"
    {$myVar|upper}\n
    "},{"location":"designers/language-modifiers/language-modifier-upper/#examples","title":"Examples","text":"
    <?php\n$smarty->assign('articleTitle', \"If Strike isn't Settled Quickly it may Last a While.\");\n

    Where template is:

    {$articleTitle}\n{$articleTitle|upper}\n

    Will output:

    If Strike isn't Settled Quickly it may Last a While.\nIF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE.\n

    See also lower and capitalize.

    "},{"location":"designers/language-modifiers/language-modifier-wordwrap/","title":"wordwrap","text":"

    Wraps a string to a column width, the default is 80. As an optional second parameter, you can specify a string of text to wrap the text to the next line, the default is a carriage return \"\\n\". By default, wordwrap will attempt to wrap at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter as TRUE. This is equivalent to the PHP wordwrap() function.

    "},{"location":"designers/language-modifiers/language-modifier-wordwrap/#basic-usage","title":"Basic usage","text":"
    {$myVar|wordwrap:30}\n
    "},{"location":"designers/language-modifiers/language-modifier-wordwrap/#parameters","title":"Parameters","text":"Parameter Position Type Required Default Description 1 integer No 80 This determines how many columns to wrap to. 2 string No \\n This is the string used to wrap words with. 3 boolean No FALSE This determines whether to wrap at a word boundary (FALSE), or at the exact character (TRUE)."},{"location":"designers/language-modifiers/language-modifier-wordwrap/#examples","title":"Examples","text":"
    <?php\n\n$smarty->assign('articleTitle',\n                \"Blind woman gets new kidney from dad she hasn't seen in years.\"\n               );\n

    Where template is

    {$articleTitle}\n\n{$articleTitle|wordwrap:30}\n\n{$articleTitle|wordwrap:20}\n\n{$articleTitle|wordwrap:30:\"<br />\\n\"}\n\n{$articleTitle|wordwrap:26:\"\\n\":true}\n

    Will output:

    Blind woman gets new kidney from dad she hasn't seen in years.\n\nBlind woman gets new kidney\nfrom dad she hasn't seen in\nyears.\n\nBlind woman gets new\nkidney from dad she\nhasn't seen in\nyears.\n\nBlind woman gets new kidney<br />\nfrom dad she hasn't seen in<br />\nyears.\n\nBlind woman gets new kidn\ney from dad she hasn't se\nen in years.\n

    See also nl2br and {textformat}.

    "},{"location":"designers/language-variables/","title":"Variables","text":"

    Smarty has several 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, attributes and modifiers, inside conditional expressions, etc. To print a variable, simply enclose it in the delimiters so that it is the only thing contained between them.

    {$Name}\n\n{$product.part_no} <b>{$product.description}</b>\n\n{$Contacts[row].Phone}\n\n<body bgcolor=\"{#bgcolor#}\">\n
    "},{"location":"designers/language-variables/#scopes","title":"Scopes","text":"

    You can assign variables to specific variable scopes.

    Note

    An easy way to examine assigned Smarty variables is with the debugging console.

    "},{"location":"designers/language-variables/language-assigned-variables/","title":"Variables assigned from PHP","text":"

    Variables assigned from PHP are referenced by preceding them with a dollar ($) sign.

    "},{"location":"designers/language-variables/language-assigned-variables/#examples","title":"Examples","text":"
    <?php\n\n$smarty = new Smarty();\n\n$smarty->assign('firstname', 'Doug');\n$smarty->assign('lastname', 'Evans');\n$smarty->assign('meetingPlace', 'New York');\n\n$smarty->display('index.tpl');\n

    index.tpl source:

    Hello {$firstname} {$lastname}, glad to see you can make it.\n<br />\n{* this will not work as $variables are case sensitive *}\nThis weeks meeting is in {$meetingplace}.\n{* this will work *}\nThis weeks meeting is in {$meetingPlace}.\n

    This above would output:

    Hello Doug Evans, glad to see you can make it.\n<br />\nThis weeks meeting is in .\nThis weeks meeting is in New York.\n
    "},{"location":"designers/language-variables/language-assigned-variables/#associative-arrays","title":"Associative arrays","text":"

    You can also reference associative array variables by specifying the key after a dot \".\" symbol.

    <?php\n$smarty->assign('Contacts',\n    array('fax' => '555-222-9876',\n          'email' => 'zaphod@slartibartfast.example.com',\n          'phone' => array('home' => '555-444-3333',\n                           'cell' => '555-111-1234')\n                           )\n         );\n$smarty->display('index.tpl');\n

    index.tpl source:

    {$Contacts.fax}<br />\n{$Contacts.email}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts.phone.home}<br />\n{$Contacts.phone.cell}<br />\n

    this will output:

    555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n
    "},{"location":"designers/language-variables/language-assigned-variables/#array-indexes","title":"Array indexes","text":"

    You can reference arrays by their index, much like native PHP syntax.

    <?php\n$smarty->assign('Contacts', array(\n                           '555-222-9876',\n                           'zaphod@slartibartfast.example.com',\n                            array('555-444-3333',\n                                  '555-111-1234')\n                            ));\n$smarty->display('index.tpl');\n

    index.tpl source:

    {$Contacts[0]}<br />\n{$Contacts[1]}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts[2][0]}<br />\n{$Contacts[2][1]}<br />\n

    This will output:

    555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n
    "},{"location":"designers/language-variables/language-assigned-variables/#objects","title":"Objects","text":"

    Properties of objects assigned from PHP can be referenced by specifying the property name after the -> symbol.

    name:  {$person->name}<br />\nemail: {$person->email}<br />\n

    this will output:

    name:  Zaphod Beeblebrox<br />\nemail: zaphod@slartibartfast.example.com<br />\n
    "},{"location":"designers/language-variables/language-config-variables/","title":"Variables loaded from config files","text":"

    Variables that are loaded from the config files are referenced by enclosing them within #hash_marks#, or with the smarty variable $smarty.config. The later syntax is useful for embedding into quoted attribute values, or accessing variable values such as $smarty.config.$foo.

    "},{"location":"designers/language-variables/language-config-variables/#examples","title":"Examples","text":"

    Example config file - foo.conf: 

    pageTitle = \"This is mine\"\nbodyBgColor = '#eeeeee'\ntableBorderSize = 3\ntableBgColor = \"#bbbbbb\"\nrowBgColor = \"#cccccc\"\n

    A template demonstrating the #hash# method:

    {config_load file='foo.conf'}\n<html>\n    <title>{#pageTitle#}</title>\n    <body bgcolor=\"{#bodyBgColor#}\">\n        <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n            <tr bgcolor=\"{#rowBgColor#}\">\n                <td>First</td>\n                <td>Last</td>\n                <td>Address</td>\n            </tr>\n        </table>\n    </body>\n</html>\n

    A template demonstrating the $smarty.config method:

    {config_load file='foo.conf'}\n<html>\n<title>{$smarty.config.pageTitle}</title>\n    <body bgcolor=\"{$smarty.config.bodyBgColor}\">\n        <table border=\"{$smarty.config.tableBorderSize}\" bgcolor=\"{$smarty.config.tableBgColor}\">\n            <tr bgcolor=\"{$smarty.config.rowBgColor}\">\n                <td>First</td>\n                <td>Last</td>\n                <td>Address</td>\n            </tr>\n        </table>\n    </body>\n</html>\n

    Both examples would output:

    <html>\n    <title>This is mine</title>\n    <body bgcolor=\"#eeeeee\">\n        <table border=\"3\" bgcolor=\"#bbbbbb\">\n            <tr bgcolor=\"#cccccc\">\n                <td>First</td>\n                <td>Last</td>\n                <td>Address</td>\n            </tr>\n        </table>\n    </body>\n</html>\n

    Config file variables cannot be used until after they are loaded in from a config file. This procedure is explained later in this document under {config_load}.

    See also variables and $smarty reserved variables.

    "},{"location":"designers/language-variables/language-variable-scopes/","title":"Variable scopes","text":"

    You have the choice to assign variables to the scope of the main Smarty object, data objects created with createData(), and template objects created with createTemplate(). These objects can be chained. A template sees all the variables of its own object and all variables assigned to the objects in its chain of parent objects.

    By default, templates which are rendered by $smarty->display(...) or $smarty->fetch(...) calls are automatically linked to the Smarty object variable scope.

    By assigning variables to individual data or template objects you have full control which variables can be seen by a template.

    <?php\n// assign variable to Smarty object scope\n$smarty->assign('foo','smarty');\n\n// assign variables to data object scope\n$data = $smarty->createData();\n$data->assign('foo','data');\n$data->assign('bar','bar-data');\n\n// assign variables to other data object scope\n$data2 = $smarty->createData($data);\n$data2->assign('bar','bar-data2');\n\n// assign variable to template object scope\n$tpl = $smarty->createTemplate('index.tpl');\n$tpl->assign('bar','bar-template');\n\n// assign variable to template object scope with link to Smarty object\n$tpl2 = $smarty->createTemplate('index.tpl',$smarty);\n$tpl2->assign('bar','bar-template2');\n\n// This display() does see $foo='smarty' from the $smarty object\n$smarty->display('index.tpl');\n\n// This display() does see $foo='data' and $bar='bar-data' from the data object $data\n$smarty->display('index.tpl',$data);\n\n// This display() does see $foo='data' from the data object $data \n// and $bar='bar-data2' from the data object $data2\n$smarty->display('index.tpl',$data2);\n\n// This display() does see $bar='bar-template' from the template object $tpl\n$tpl->display();  // or $smarty->display($tpl);\n\n// This display() does see $bar='bar-template2' from the template object $tpl2\n// and $foo='smarty' form the Smarty object $foo\n$tpl2->display();  // or $smarty->display($tpl2);\n

    See also assign(), createData() and createTemplate().

    "},{"location":"designers/language-variables/language-variables-smarty/","title":"{$smarty} reserved variable","text":"

    The PHP reserved {$smarty} variable can be used to access several environment and request variables. The full list of them follows.

    "},{"location":"designers/language-variables/language-variables-smarty/#request-variables","title":"Request variables","text":"

    The request variables such as $_GET, $_POST, $_COOKIE, $_SERVER, $_ENV and $_SESSION can be accessed as demonstrated in the examples below:

    {* display value of page from URL ($_GET) http://www.example.com/index.php?page=foo *}\n{$smarty.get.page}\n\n{* display the variable \"page\" from a form ($_POST['page']) *}\n{$smarty.post.page}\n\n{* display the value of the cookie \"username\" ($_COOKIE['username']) *}\n{$smarty.cookies.username}\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\n{* display the system environment variable \"PATH\" *}\n{$smarty.env.PATH}\n\n{* display the php session variable \"id\" ($_SESSION['id']) *}\n{$smarty.session.id}\n\n{* display the variable \"username\" from merged get/post/cookies/server/env *}\n{$smarty.request.username}\n

    Note

    For historical reasons {$SCRIPT_NAME} is shorthand for {$smarty.server.SCRIPT_NAME}.

    <a href=\"{$SCRIPT_NAME}?page=smarty\">click me</a>\n<a href=\"{$smarty.server.SCRIPT_NAME}?page=smarty\">click me</a>\n

    Note

    Although Smarty provides direct access to PHP super globals for convenience, it should be used with caution. Directly accessing super globals mixes underlying application code structure with templates. A good practice is to assign specific needed values to template vars.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartynow","title":"{$smarty.now}","text":"

    The current timestamp can be accessed with {$smarty.now}. The value reflects the number of seconds passed since the so-called Epoch on January 1, 1970, and can be passed directly to the date_format modifier for display. Note that time() is called on each invocation; eg a script that takes three seconds to execute with a call to $smarty.now at start and end will show the three-second difference.

    {* use the date_format modifier to show current date and time *}\n{$smarty.now|date_format:'%Y-%m-%d %H:%M:%S'}\n
    "},{"location":"designers/language-variables/language-variables-smarty/#smartyconst","title":"{$smarty.const}","text":"

    You can access PHP constant values directly. See also smarty constants.

    <?php\n// the constant defined in php\ndefine('MY_CONST_VAL','CHERRIES');\n

    Output the constant in a template with

    {$smarty.const.MY_CONST_VAL}\n

    Note

    Although Smarty provides direct access to PHP constants for convenience, it is typically avoided as this is mixing underlying application code structure into the templates. A good practice is to assign specific needed values to template vars.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartycapture","title":"{$smarty.capture}","text":"

    Template output captured via the built-in {capture}..{/capture} function can be accessed using the {$smarty.capture} variable. See the {capture} page for more information.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyconfig","title":"{$smarty.config}","text":"

    {$smarty.config} variable can be used to refer to loaded config variables. {$smarty.config.foo} is a synonym for {#foo#}. See the {config_load} page for more info.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartysection","title":"{$smarty.section}","text":"

    The {$smarty.section} variables can be used to refer to {section} loop properties. These have some very useful values such as .first, .index, etc.

    Note

    The {$smarty.foreach} variable is no longer used with the new {foreach} syntax, but is still supported with Smarty 2.x style foreach syntax.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartytemplate","title":"{$smarty.template}","text":"

    Returns the name of the current template being processed (without the directory).

    "},{"location":"designers/language-variables/language-variables-smarty/#smartytemplate_object","title":"{$smarty.template_object}","text":"

    Returns the template object of the current template being processed.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartycurrent_dir","title":"{$smarty.current_dir}","text":"

    Returns the name of the directory for the current template being processed if it is loaded from the filesystem (the default).

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyversion","title":"{$smarty.version}","text":"

    Returns the version of Smarty the template was compiled with.

    <div id=\"footer\">Powered by Smarty {$smarty.version}</div>\n
    "},{"location":"designers/language-variables/language-variables-smarty/#smartyblockchild","title":"{$smarty.block.child}","text":"

    Returns block text from child template. See Template inheritance.

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyblockparent","title":"{$smarty.block.parent}","text":"

    Returns block text from parent template. See Template inheritance

    "},{"location":"designers/language-variables/language-variables-smarty/#smartyldelim-smartyrdelim","title":"{$smarty.ldelim}, {$smarty.rdelim}","text":"

    These variables are used for printing the left-delimiter and right-delimiter value literally, the same as {ldelim},{rdelim}.

    See also assigned variables and config variables

    "},{"location":"programmers/advanced-features/","title":"Advanced Features {#advanced.features}","text":""},{"location":"programmers/advanced-features/#table-of-contents","title":"Table of contents","text":""},{"location":"programmers/api-functions/","title":"Smarty Class Methods {#api.functions}","text":""},{"location":"programmers/api-functions/#table-of-contents","title":"Table of contents","text":"

    Note

    See Changing settings by template section for how to use the functions for individual templates.

    "},{"location":"programmers/api-variables/","title":"Smarty Class Variables {#api.variables}","text":"

    These are all of the available Smarty class variables. You can access them directly, or use the corresponding setter/getter methods.

    Note

    All class variables have magic setter/getter methods available. setter/getter methods are camelCaseFormat, unlike the variable itself. So for example, you can set and get the \\$smarty->template_dir variable with \\$smarty->setTemplateDir(\\$dir) and \\$dir = \\$smarty->getTemplateDir() respectively.

    Note

    See Changing settings by template section for how to change Smarty class variables for individual templates.

    "},{"location":"programmers/caching/","title":"Caching","text":"

    Caching is used to speed up a call to display() or fetch() by saving its output to a file. If a cached version of the call is available, that is displayed instead of regenerating the output. Caching can speed things up tremendously, especially templates with longer computation times. Since the output of display() or fetch() is cached, one cache file could conceivably be made up of several template files, config files, etc.

    Since templates are dynamic, it is important to be careful what you are caching and for how long. For instance, if you are displaying the front page of your website that does not change its content very often, it might work well to cache this page for an hour or more. On the other hand, if you are displaying a page with a timetable containing new information by the minute, it would not make sense to cache this page.

    "},{"location":"programmers/caching/#table-of-contents","title":"Table of contents","text":""},{"location":"programmers/charset/","title":"Charset Encoding {#charset}","text":""},{"location":"programmers/charset/#charset-encoding-charsetencoding","title":"Charset Encoding {#charset.encoding}","text":"

    There are a variety of encodings for textual data, ISO-8859-1 (Latin1) and UTF-8 being the most popular. Unless you change Smarty::$_CHARSET, Smarty recognizes UTF-8 as the internal charset if Multibyte String is available, ISO-8859-1 if not.

    Note

    ISO-8859-1 has been PHP\\'s default internal charset since the beginning. Unicode has been evolving since 1991. Since then it has become the one charset to conquer them all, as it is capable of encoding most of the known characters even across different character systems (latin, cyrillic, japanese, ...). UTF-8 is unicode\\'s most used encoding, as it allows referencing the thousands of character with the smallest size overhead possible.

    Since unicode and UTF-8 are very wide spread nowadays, their use is strongly encouraged.

    Note

    Smarty\\'s internals and core plugins are truly UTF-8 compatible since Smarty 3.1. To achieve unicode compatibility, the Multibyte String PECL is required. Unless your PHP environment offers this package, Smarty will not be able to offer full-scale UTF-8 compatibility.

    // use japanese character encoding\nif (function_exists('mb_internal_charset')) {\n  mb_internal_charset('EUC-JP');\n}\n\nrequire_once 'libs/Smarty.class.php';\nSmarty::$_CHARSET = 'EUC-JP';\n$smarty = new Smarty();\n
    "},{"location":"programmers/plugins/","title":"Extending Smarty With Plugins {#plugins}","text":""},{"location":"programmers/plugins/#table-of-contents","title":"Table of contents","text":"

    Version 2.0 introduced the plugin architecture that is used for almost all the customizable functionality of Smarty. This includes:

    With the exception of resources, backwards compatibility with the old way of registering handler functions via register_* API is preserved. If you did not use the API but instead modified the class variables $custom_funcs, $custom_mods, and other ones directly, then you will need to adjust your scripts to either use the API or convert your custom functionality into plugins.

    "},{"location":"programmers/resources/","title":"Resources","text":"

    The templates may come from a variety of sources. When you display() or fetch() a template, or when you include a template from within another template, you supply a resource type, followed by the appropriate path and template name. If a resource is not explicitly given, the value of $default_resource_type (default: \\\"file\\\") is assumed.

    "},{"location":"programmers/resources/#table-of-contents","title":"Table of contents","text":""},{"location":"programmers/smarty-constants/","title":"Constants {#smarty.constants}","text":""},{"location":"programmers/smarty-constants/#smarty_dir-constantsmartydir","title":"SMARTY_DIR {#constant.smarty.dir}","text":"

    This is the full system path to the location of the Smarty class files. If this is not defined in your script, then Smarty will attempt to determine the appropriate value automatically. If defined, the path must end with a trailing slash/.

    <?php\n// set path to Smarty directory *nix style\ndefine('SMARTY_DIR', '/usr/local/lib/php/Smarty-v.e.r/libs/');\n\n// path to Smarty windows style\ndefine('SMARTY_DIR', 'c:/webroot/libs/Smarty-v.e.r/libs/');\n\n// include the smarty class, note 'S' is upper case\nrequire_once(SMARTY_DIR . 'Smarty.class.php');\n?>\n

    See also $smarty.const.

    "},{"location":"programmers/advanced-features/advanced-features-objects/","title":"Objects {#advanced.features.objects}","text":"

    Smarty allows access to PHP objects through the templates.

    Note

    When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.

    There are two ways to access them.

    The first method has a much nicer template syntax. It is also more secure, as a registered object can be restricted to certain methods or properties. However, a registered object cannot be looped over or assigned in arrays of objects, etc. The method you choose will be determined by your needs, but use the first method whenever possible to keep template syntax to a minimum.

    If security is enabled, no private methods or functions can be accessed (beginning with \\'_\\'). If a method and property of the same name exist, the method will be used.

    You can restrict the methods and properties that can be accessed by listing them in an array as the third registration parameter.

    By default, parameters passed to objects through the templates are passed the same way custom functions get them. An associative array is passed as the first parameter, and the smarty object as the second. If you want the parameters passed one at a time for each argument like traditional object parameter passing, set the fourth registration parameter to FALSE.

    The optional fifth parameter has only effect with format being TRUE and contains a list of methods that should be treated as blocks. That means these methods have a closing tag in the template ({foobar->meth2}...{/foobar->meth2}) and the parameters to the methods have the same synopsis as the parameters for block-function-plugins: They get the four parameters $params, $content, $smarty and &$repeat and they also behave like block-function-plugins.

    <?php\n// the object\n\nclass My_Object {\n    function meth1($params, $smarty_obj) {\n        return 'this is my meth1';\n    }\n}\n\n$myobj = new My_Object;\n\n// registering the object (will be by reference)\n$smarty->registerObject('foobar',$myobj);\n\n// if we want to restrict access to certain methods or properties, list them\n$smarty->registerObject('foobar',$myobj,array('meth1','meth2','prop1'));\n\n// if you want to use the traditional object parameter format, pass a boolean of false\n$smarty->registerObject('foobar',$myobj,null,false);\n\n// We can also assign objects. assign_by_ref when possible.\n$smarty->assign_by_ref('myobj', $myobj);\n\n$smarty->display('index.tpl');\n?>\n

    And here\\'s how to access your objects in index.tpl:

    {* access our registered object *}\n{foobar->meth1 p1='foo' p2=$bar}\n\n{* you can also assign the output *}\n{foobar->meth1 p1='foo' p2=$bar assign='output'}\nthe output was {$output}\n\n{* access our assigned object *}\n{$myobj->meth1('foo',$bar)}\n

    See also registerObject() and assign().

    "},{"location":"programmers/advanced-features/advanced-features-outputfilters/","title":"Output Filters {#advanced.features.outputfilters}","text":"

    When the template is invoked via display() or fetch(), its output can be sent through one or more output filters. This differs from postfilters because postfilters operate on compiled templates before they are saved to the disk, whereas output filters operate on the template output when it is executed.

    Output filters can be either registered or loaded from the plugins directory by using the loadFilter() method or by setting the $autoload_filters variable. Smarty will pass the template output as the first argument, and expect the function to return the result of the processing.

    <?php\n// put this in your application\nfunction protect_email($tpl_output, Smarty_Internal_Template $template)\n{\n    $tpl_output =\n       preg_replace('!(\\S+)@([a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',\n                    '$1%40$2', $tpl_output);\n    return $tpl_output;\n}\n\n// register the outputfilter\n$smarty->registerFilter(\"output\",\"protect_email\");\n$smarty->display(\"index.tpl');\n\n// now any occurrence of an email address in the template output will have\n// a simple protection against spambots\n?>\n

    See also registerFilter(), loadFilter(), $autoload_filters, postfilters and $plugins_dir.

    "},{"location":"programmers/advanced-features/advanced-features-postfilters/","title":"Postfilters {#advanced.features.postfilters}","text":"

    Template postfilters are PHP functions that your templates are ran through after they are compiled. Postfilters can be either registered or loaded from the plugins directory by using the loadFilter() function or by setting the $autoload_filters variable. Smarty will pass the compiled template code as the first argument, and expect the function to return the result of the processing.

    <?php\n// put this in your application\nfunction add_header_comment($tpl_source, Smarty_Internal_Template $template)\n{\n    return \"<?php echo \\\"<!-- Created by Smarty! -->\\n\\\"; ?>\\n\".$tpl_source;\n}\n\n// register the postfilter\n$smarty->registerFilter('post','add_header_comment');\n$smarty->display('index.tpl');\n?>\n

    The postfilter above will make the compiled Smarty template index.tpl look like:

    <!-- Created by Smarty! -->\n{* rest of template content... *}\n

    See also registerFilter(), prefilters, outputfilters, and loadFilter().

    "},{"location":"programmers/advanced-features/advanced-features-prefilters/","title":"Prefilters {#advanced.features.prefilters}","text":"

    Template prefilters are PHP functions that your templates are ran through before they are compiled. This is good for preprocessing your templates to remove unwanted comments, keeping an eye on what people are putting in their templates, etc.

    Prefilters can be either registered or loaded from the plugins directory by using loadFilter() function or by setting the $autoload_filters variable.

    Smarty will pass the template source code as the first argument, and expect the function to return the resulting template source code.

    This will remove all the html comments in the template source.

    <?php\n// put this in your application\nfunction remove_dw_comments($tpl_source, Smarty_Internal_Template $template)\n{\n    return preg_replace(\"/<!--#.*-->/U\",'',$tpl_source);\n}\n\n// register the prefilter\n$smarty->registerFilter('pre','remove_dw_comments');\n$smarty->display('index.tpl');\n?>\n

    See also registerFilter(), postfilters and loadFilter().

    "},{"location":"programmers/advanced-features/advanced-features-security/","title":"Security {#advanced.features.security}","text":"

    Security is good for situations when you have untrusted parties editing the templates e.g. via ftp, and you want to reduce the risk of system security compromises through the template language.

    The settings of the security policy are defined by properties of an instance of the Smarty_Security class. These are the possible settings:

    If security is enabled, no private methods, functions or properties of static classes or assigned objects can be accessed (beginning with \\'_\\') by the template.

    To customize the security policy settings you can extend the Smarty_Security class or create an instance of it.

    <?php\nrequire 'Smarty.class.php';\n\nclass My_Security_Policy extends Smarty_Security {\n  // disable all PHP functions\n  public $php_functions = null;\n  // allow everthing as modifier\n  public $php_modifiers = array();\n}\n$smarty = new Smarty();\n// enable security\n$smarty->enableSecurity('My_Security_Policy');\n?>\n\n\n<?php\nrequire 'Smarty.class.php';\n$smarty = new Smarty();\n$my_security_policy = new Smarty_Security($smarty);\n// disable all PHP functions\n$my_security_policy->php_functions = null;\n// allow everthing as modifier\n$my_security_policy->php_modifiers = array();\n// enable security\n$smarty->enableSecurity($my_security_policy);\n?>\n\n\n<?php\nrequire 'Smarty.class.php';\n$smarty = new Smarty();\n// enable default security\n$smarty->enableSecurity();\n?>\n

    Note

    Most security policy settings are only checked when the template gets compiled. For that reason you should delete all cached and compiled template files when you change your security settings.

    "},{"location":"programmers/advanced-features/advanced-features-static-classes/","title":"Static Classes {#advanced.features.static.classes}","text":"

    You can directly access static classes. The syntax is the same as in PHP.

    Note

    Direct access to PHP classes is not recommended. This ties the underlying application code structure directly to the presentation, and also complicates template syntax. It is recommended to register plugins which insulate templates from PHP classes/objects. Use at your own discretion. See the Best Practices section of the Smarty website.

    {assign var=foo value=myclass::BAR}  <--- class constant BAR\n\n{assign var=foo value=myclass::method()}  <--- method result\n\n{assign var=foo value=myclass::method1()->method2}  <--- method chaining\n\n{assign var=foo value=myclass::$bar}  <--- property bar of class myclass\n\n{assign var=foo value=$bar::method}  <--- using Smarty variable bar as class name\n
    "},{"location":"programmers/advanced-features/advanced-features-streams/","title":"Streams {#advanced.features.streams}","text":"

    You can also use streams to call variables. {\\$foo:bar} will use the foo://bar stream to get the template variable.

    Using a PHP stream for a template variable resource from within a template.

    {$foo:bar}\n

    See also Template Resources

    "},{"location":"programmers/advanced-features/advanced-features-template-inheritance/","title":"Template Inheritance {#advanced.features.template.inheritance}","text":"

    Inheritance brings the concept of Object Oriented Programming to templates, allowing you to define one (or more) base templates that can be extended by child templates. Extending means that the child template can override all or some of the parent named block areas.

    Note

    When $compile_check is enabled, all files in the inheritance tree are checked for modifications upon each invocation. You may want to disable $compile_check on production servers for this reason.

    Note

    If you have a subtemplate which is included with {include} and it contains {block} areas it works only if the {include} itself is called from within a surrounding {block}. In the final parent template you may need a dummy {block} for it.

    layout.tpl (parent)

    <html>\n<head>\n  <title>{block name=title}Default Page Title{/block}</title>\n  {block name=head}{/block}\n</head>\n<body>\n{block name=body}{/block}\n</body>\n</html>\n

    myproject.tpl (child)

    {extends file='layout.tpl'}\n{block name=head}\n  <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n  <script src=\"/js/mypage.js\"></script>\n{/block}\n

    mypage.tpl (grandchild)

    {extends file='myproject.tpl'}\n{block name=title}My Page Title{/block}\n{block name=head}\n  <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n  <script src=\"/js/mypage.js\"></script>\n{/block}\n{block name=body}My HTML Page Body goes here{/block}\n

    To render the above use

     $smarty->display('mypage.tpl');\n

    The resulting output is

    <html>\n<head>\n  <title>My Page Title</title>\n  <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n  <script src=\"/js/mypage.js\"></script>\n</head>\n<body>\nMy HTML Page Body goes here\n</body>\n</html>\n

    Instead of using {extends} tags in the template files you can define the inheritance tree in your PHP script by using the extends: resource type.

    The code below will return same result as the example above.

    <?php\n$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); \n?>\n

    See also {block}, {extends} and extends: resource

    "},{"location":"programmers/advanced-features/advanced-features-template-settings/","title":"Changing settings by template {#advanced.features.template.settings}","text":"

    Normally you configure the Smarty settings by modifying the Smarty class variables. Furthermore you can register plugins, filters etc. with Smarty functions. Modifications done to the Smarty object will be global for all templates.

    However the Smarty class variables and functions can be accessed or called by individual template objects. Modification done to a template object will apply only for that template and its included subtemplates.

    <?php\n$tpl = $smarty->createTemplate('index.tpl);\n$tpl->cache_lifetime = 600;\n//or\n$tpl->setCacheLifetime(600);\n$smarty->display($tpl);\n?>\n\n\n\n\n<?php\n$tpl = $smarty->createTemplate('index.tpl);\n$tpl->registerPlugin('modifier','mymodifier');\n$smarty->display($tpl);\n?>\n
    "},{"location":"programmers/api-functions/api-add-config-dir/","title":"Api add config dir","text":"

    addConfigDir()

    add a directory to the list of directories where config files are stored

    "},{"location":"programmers/api-functions/api-add-config-dir/#description","title":"Description","text":"

    Smarty

    addConfigDir

    string|array

    config_dir

    string

    key

    <?php\n\n// add directory where config files are stored\n$smarty->addConfigDir('./config_1');\n\n// add directory where config files are stored and specify array-key\n$smarty->addConfigDir('./config_1', 'one');\n\n// add multiple directories where config files are stored and specify array-keys\n$smarty->addTemplateDir(array(\n    'two' => './config_2',\n    'three' => './config_3',\n));\n\n// view the template dir chain\nvar_dump($smarty->getConfigDir());\n\n// chaining of method calls\n$smarty->setConfigDir('./config')\n       ->addConfigDir('./config_1', 'one')\n       ->addConfigDir('./config_2', 'two');\n\n?>\n

    See also getConfigDir(), setConfigDir() and $config_dir.

    "},{"location":"programmers/api-functions/api-add-plugins-dir/","title":"Api add plugins dir","text":"

    addPluginsDir()

    add a directory to the list of directories where plugins are stored

    "},{"location":"programmers/api-functions/api-add-plugins-dir/#description","title":"Description","text":"

    Smarty

    addPluginsDir

    string|array

    plugins_dir

    <?php\n\n// add directory where plugins are stored\n$smarty->addPluginsDir('./plugins_1');\n\n// add multiple directories where plugins are stored\n$smarty->setPluginsDir(array(\n    './plugins_2',\n    './plugins_3',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setPluginsDir('./plugins')\n       ->addPluginsDir('./plugins_1')\n       ->addPluginsDir('./plugins_2');\n\n?>\n

    See also getPluginsDir(), setPluginsDir() and $plugins_dir.

    "},{"location":"programmers/api-functions/api-add-template-dir/","title":"Api add template dir","text":"

    addTemplateDir()

    add a directory to the list of directories where templates are stored

    "},{"location":"programmers/api-functions/api-add-template-dir/#description","title":"Description","text":"

    Smarty

    addTemplateDir

    string|array

    template_dir

    string

    key

    <?php\n\n// add directory where templates are stored\n$smarty->addTemplateDir('./templates_1');\n\n// add directory where templates are stored and specify array-key\n$smarty->addTemplateDir('./templates_1', 'one');\n\n// add multiple directories where templates are stored and specify array-keys\n$smarty->addTemplateDir(array(\n    'two' => './templates_2',\n    'three' => './templates_3',\n));\n\n// view the template dir chain\nvar_dump($smarty->getTemplateDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->addTemplateDir('./templates_1', 'one')\n       ->addTemplateDir('./templates_2', 'two');\n\n?>\n

    See also getTemplateDir(), setTemplateDir() and $template_dir.

    "},{"location":"programmers/api-functions/api-append-by-ref/","title":"Api append by ref","text":"

    appendByRef()

    append values by reference

    "},{"location":"programmers/api-functions/api-append-by-ref/#description","title":"Description","text":"

    void

    appendByRef

    string

    varname

    mixed

    var

    bool

    merge

    This is used to append() values to the templates by reference.

    Note

    With the introduction of PHP5, appendByRef() is not necessary for most intents and purposes. appendByRef() is useful if you want a PHP array index value to be affected by its reassignment from a template. Assigned object properties behave this way by default.

    NOTE.PARAMETER.MERGE

    <?php\n// appending name/value pairs\n$smarty->appendByRef('Name', $myname);\n$smarty->appendByRef('Address', $address);\n?>\n

    See also append(), assign() and getTemplateVars().

    "},{"location":"programmers/api-functions/api-append/","title":"Api append","text":"

    append()

    append an element to an assigned array

    "},{"location":"programmers/api-functions/api-append/#description","title":"Description","text":"

    void

    append

    mixed

    var

    void

    append

    string

    varname

    mixed

    var

    bool

    merge

    If you append to a string value, it is converted to an array value and then appended to. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs. If you pass the optional third parameter of TRUE, the value will be merged with the current array instead of appended.

    NOTE.PARAMETER.MERGE

    <?php\n// This is effectively the same as assign()\n$smarty->append('foo', 'Fred');\n// After this line, foo will now be seen as an array in the template\n$smarty->append('foo', 'Albert');\n\n$array = array(1 => 'one', 2 => 'two');\n$smarty->append('X', $array);\n$array2 = array(3 => 'three', 4 => 'four');\n// The following line will add a second element to the X array\n$smarty->append('X', $array2);\n\n// passing an associative array\n$smarty->append(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n?>\n

    See also appendByRef(), assign() and getTemplateVars()

    "},{"location":"programmers/api-functions/api-assign-by-ref/","title":"Api assign by ref","text":"

    assignByRef()

    assign values by reference

    "},{"location":"programmers/api-functions/api-assign-by-ref/#description","title":"Description","text":"

    void

    assignByRef

    string

    varname

    mixed

    var

    This is used to assign() values to the templates by reference.

    Note

    With the introduction of PHP5, assignByRef() is not necessary for most intents and purposes. assignByRef() is useful if you want a PHP array index value to be affected by its reassignment from a template. Assigned object properties behave this way by default.

    <?php\n// passing name/value pairs\n$smarty->assignByRef('Name', $myname);\n$smarty->assignByRef('Address', $address);\n?>\n

    See also assign(), clearAllAssign(), append(), {assign} and getTemplateVars().

    "},{"location":"programmers/api-functions/api-assign/","title":"Api assign","text":"

    assign()

    assign variables/objects to the templates

    "},{"location":"programmers/api-functions/api-assign/#description","title":"Description","text":"

    void

    assign

    mixed

    var

    void

    assign

    string

    varname

    mixed

    var

    bool

    nocache

    You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs.

    If you pass the optional third nocache parameter of TRUE, the variable is assigned as nocache variable. See Cacheability of Variables for details.

    Note

    When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.

    <?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// passing an associative array\n$smarty->assign(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n\n// passing an array\n$myArray = array('no' => 10, 'label' => 'Peanuts');\n$smarty->assign('foo',$myArray);\n\n// passing a row from a database (eg adodb)\n$sql = 'select id, name, email from contacts where contact ='.$id;\n$smarty->assign('contact', $db->getRow($sql));\n?>\n

    These are accessed in the template with

    {* note the vars are case sensitive like php *}\n{$Name}\n{$Address}\n{$city}\n{$state}\n\n{$foo.no}, {$foo.label}\n{$contact.id}, {$contact.name},{$contact.email}\n

    To access more complex array assignments see {foreach} and {section}

    See also assignByRef(), getTemplateVars(), clearAssign(), append() and {assign}

    "},{"location":"programmers/api-functions/api-clear-all-assign/","title":"Api clear all assign","text":"

    clearAllAssign()

    clears the values of all assigned variables

    "},{"location":"programmers/api-functions/api-clear-all-assign/#description","title":"Description","text":"

    void

    clearAllAssign

    <?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// will output above\nprint_r( $smarty->getTemplateVars() );\n\n// clear all assigned variables\n$smarty->clearAllAssign();\n\n// will output nothing\nprint_r( $smarty->getTemplateVars() );\n\n?>\n

    See also clearAssign(), clearConfig(), getTemplateVars(), assign() and append()

    "},{"location":"programmers/api-functions/api-clear-all-cache/","title":"Api clear all cache","text":"

    clearAllCache()

    clears the entire template cache

    "},{"location":"programmers/api-functions/api-clear-all-cache/#description","title":"Description","text":"

    void

    clearAllCache

    int

    expire_time

    As an optional parameter, you can supply a minimum age in seconds the cache files must be before they will get cleared.

    Note

    Since Smarty version 3.1.14 it is possible to delete cache files by their individual expiration time at creation by passing constant SMARTY::CLEAR_EXPIRED as expire_time parameter.

    <?php\n// clear the entire cache\n$smarty->clearAllCache();\n\n// clears all files over one hour old\n$smarty->clearAllCache(3600);\n?>\n

    See also clearCache(), isCached() and the caching page.

    "},{"location":"programmers/api-functions/api-clear-assign/","title":"Api clear assign","text":"

    clearAssign()

    clears the value of an assigned variable

    "},{"location":"programmers/api-functions/api-clear-assign/#description","title":"Description","text":"

    void

    clearAssign

    mixed

    var

    This can be a single value, or an array of values.

    <?php\n// clear a single variable\n$smarty->clearAssign('Name');\n\n// clears multiple variables\n$smarty->clearAssign(array('Name', 'Address', 'Zip'));\n?>\n

    See also clearAllAssign(), clearConfig(), getTemplateVars(), assign() and append()

    "},{"location":"programmers/api-functions/api-clear-cache/","title":"Api clear cache","text":"

    clearCache()

    clears the cache for a specific template

    "},{"location":"programmers/api-functions/api-clear-cache/#description","title":"Description","text":"

    void

    clearCache

    string

    template

    string

    cache_id

    string

    compile_id

    int

    expire_time

    <?php\n// clear the cache for a template\n$smarty->clearCache('index.tpl');\n\n// clear the cache for a particular cache id in an multiple-cache template\n$smarty->clearCache('index.tpl', 'MY_CACHE_ID');\n?>\n

    See also clearAllCache() and caching section.

    "},{"location":"programmers/api-functions/api-clear-compiled-tpl/","title":"Api clear compiled tpl","text":"

    clearCompiledTemplate()

    clears the compiled version of the specified template resource

    "},{"location":"programmers/api-functions/api-clear-compiled-tpl/#description","title":"Description","text":"

    void

    clearCompiledTemplate

    string

    tpl_file

    string

    compile_id

    int

    exp_time

    This clears the compiled version of the specified template resource, or all compiled template files if one is not specified. If you pass a $compile_id only the compiled template for this specific $compile_id is cleared. If you pass an exp_time, then only compiled templates older than exp_time seconds are cleared, by default all compiled templates are cleared regardless of their age. This function is for advanced use only, not normally needed.

    <?php\n// clear a specific template resource\n$smarty->clearCompiledTemplate('index.tpl');\n\n// clear entire compile directory\n$smarty->clearCompiledTemplate();\n?>\n

    See also clearCache().

    "},{"location":"programmers/api-functions/api-clear-config/","title":"Api clear config","text":"

    clearConfig()

    clears assigned config variables

    "},{"location":"programmers/api-functions/api-clear-config/#description","title":"Description","text":"

    void

    clearConfig

    string

    var

    This clears all assigned config variables. If a variable name is supplied, only that variable is cleared.

    <?php\n// clear all assigned config variables.\n$smarty->clearConfig();\n\n// clear one variable\n$smarty->clearConfig('foobar');\n?>\n

    See also getConfigVars(), config variables, config files, {config_load}, configLoad() and clearAssign().

    "},{"location":"programmers/api-functions/api-compile-all-config/","title":"Api compile all config","text":"

    compileAllConfig()

    compiles all known config files

    "},{"location":"programmers/api-functions/api-compile-all-config/#description","title":"Description","text":"

    string

    compileAllConfig

    string

    extension

    boolean

    force

    integer

    timelimit

    integer

    maxerror

    This function compiles config files found in the $config_dir folder. It uses the following parameters:

    Note

    This function may not create desired results in all configurations. Use is on own risk.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// force compilation of all config files\n$smarty->compileAllConfig('.config',true);\n\n?>\n
    "},{"location":"programmers/api-functions/api-compile-all-templates/","title":"Api compile all templates","text":"

    compileAllTemplates()

    compiles all known templates

    "},{"location":"programmers/api-functions/api-compile-all-templates/#description","title":"Description","text":"

    string

    compileAllTemplates

    string

    extension

    boolean

    force

    integer

    timelimit

    integer

    maxerror

    This function compiles template files found in the $template_dir folder. It uses the following parameters:

    Note

    This function may not create desired results in all configurations. Use is on own risk.

    Note

    If any template requires registered plugins, filters or objects you must register all of them before running this function.

    Note

    If you are using template inheritance this function will create compiled files of parent templates which will never be used.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// force compilation of all template files\n$smarty->compileAllTemplates('.tpl',true);\n\n?>\n
    "},{"location":"programmers/api-functions/api-config-load/","title":"Api config load","text":"

    configLoad()

    loads config file data and assigns it to the template

    "},{"location":"programmers/api-functions/api-config-load/#description","title":"Description","text":"

    void

    configLoad

    string

    file

    string

    section

    This loads config file data and assigns it to the template. This works identically to the template {config_load} function.

    Note

    As of Smarty 2.4.0, assigned template variables are kept across invocations of fetch() and display(). Config vars loaded from configLoad() are always global in scope. Config files are also compiled for faster execution, and respect the $force_compile and $compile_check settings.

    <?php\n// load config variables and assign them\n$smarty->configLoad('my.conf');\n\n// load a section\n$smarty->configLoad('my.conf', 'foobar');\n?>\n

    See also {config_load}, getConfigVars(), clearConfig(), and config variables

    "},{"location":"programmers/api-functions/api-create-data/","title":"Api create data","text":"

    createData()

    creates a data object

    "},{"location":"programmers/api-functions/api-create-data/#description","title":"Description","text":"

    string

    createData

    object

    parent

    string

    createData

    This creates a data object which will hold assigned variables. It uses the following parameters:

    Data objects are used to create scopes for assigned variables. They can be used to control which variables are seen by which templates.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// create data object with its private variable scope\n$data = $smarty->createData();\n\n// assign variable to data scope\n$data->assign('foo','bar');\n\n// create template object which will use variables from data object\n$tpl = $smarty->createTemplate('index.tpl',$data);\n\n// display the template\n$tpl->display();\n?>\n

    See also display(), and createTemplate(),

    "},{"location":"programmers/api-functions/api-create-template/","title":"Api create template","text":"

    createTemplate()

    returns a template object

    "},{"location":"programmers/api-functions/api-create-template/#description","title":"Description","text":"

    Smarty_Internal_Template

    createTemplate

    string

    template

    object

    parent

    Smarty_Internal_Template

    createTemplate

    string

    template

    array

    data

    Smarty_Internal_Template

    createTemplate

    string

    template

    string

    cache_id

    string

    compile_id

    object

    parent

    Smarty_Internal_Template

    createTemplate

    string

    template

    string

    cache_id

    string

    compile_id

    array

    data

    This creates a template object which later can be rendered by the display or fetch method. It uses the following parameters:

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// create template object with its private variable scope\n$tpl = $smarty->createTemplate('index.tpl');\n\n// assign variable to template scope\n$tpl->assign('foo','bar');\n\n// display the template\n$tpl->display();\n?>\n

    See also display(), and templateExists().

    "},{"location":"programmers/api-functions/api-disable-security/","title":"Api disable security","text":"

    disableSecurity()

    disables template security

    "},{"location":"programmers/api-functions/api-disable-security/#description","title":"Description","text":"

    string

    disableSecurity

    This disables security checking on templates.

    See also enableSecurity(), and Security.

    "},{"location":"programmers/api-functions/api-display/","title":"Api display","text":"

    display()

    displays the template

    "},{"location":"programmers/api-functions/api-display/#description","title":"Description","text":"

    void

    display

    string

    template

    string

    cache_id

    string

    compile_id

    This displays the contents of a template. To return the contents of a template into a variable, use fetch(). Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache_id, see the caching section for more information.

    PARAMETER.COMPILEID

    <?php\ninclude(SMARTY_DIR.'Smarty.class.php');\n$smarty = new Smarty();\n$smarty->setCaching(true);\n\n// only do db calls if cache doesn't exist\nif(!$smarty->isCached('index.tpl')) {\n\n  // dummy up some data\n  $address = '245 N 50th';\n  $db_data = array(\n               'City' => 'Lincoln',\n               'State' => 'Nebraska',\n               'Zip' => '68502'\n             );\n\n  $smarty->assign('Name', 'Fred');\n  $smarty->assign('Address', $address);\n  $smarty->assign('data', $db_data);\n\n}\n\n// display the output\n$smarty->display('index.tpl');\n?>\n

    Use the syntax for template resources to display files outside of the $template_dir directory.

    <?php\n// absolute filepath\n$smarty->display('/usr/local/include/templates/header.tpl');\n\n// absolute filepath (same thing)\n$smarty->display('file:/usr/local/include/templates/header.tpl');\n\n// windows absolute filepath (MUST use \"file:\" prefix)\n$smarty->display('file:C:/www/pub/templates/header.tpl');\n\n// include from template resource named \"db\"\n$smarty->display('db:header.tpl');\n?>\n

    See also fetch() and templateExists().

    "},{"location":"programmers/api-functions/api-enable-security/","title":"Api enable security","text":"

    enableSecurity()

    enables template security

    "},{"location":"programmers/api-functions/api-enable-security/#description","title":"Description","text":"

    string

    enableSecurity

    string

    securityclass

    string

    enableSecurity

    object

    securityobject

    string

    enableSecurity

    This enables security checking on templates. It uses the following parameters:

    For the details how to setup a security policy see the Security section.

    See also disableSecurity(), and Security.

    "},{"location":"programmers/api-functions/api-fetch/","title":"Api fetch","text":"

    fetch()

    returns the template output

    "},{"location":"programmers/api-functions/api-fetch/#description","title":"Description","text":"

    string

    fetch

    string

    template

    string

    cache_id

    string

    compile_id

    This returns the template output instead of displaying it. Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache id, see the caching section for more information.

    PARAMETER.COMPILEID

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(true);\n\n// set a separate cache_id for each unique URL\n$cache_id = md5($_SERVER['REQUEST_URI']);\n\n// capture the output\n$output = $smarty->fetch('index.tpl', $cache_id);\n\n// do something with $output here\necho $output;\n?>\n

    The email_body.tpl template

    Dear {$contact_info.name},\n\nWelcome and thank you for signing up as a member of our user group.\n\nClick on the link below to login with your user name\nof '{$contact_info.username}' so you can post in our forums.\n\n{$login_url}\n\nList master\n\n{textformat wrap=40}\nThis is some long-winded disclaimer text that would automatically get wrapped\nat 40 characters. This helps make the text easier to read in mail programs that\ndo not wrap sentences for you.\n{/textformat}\n

    The php script using the PHP mail() function

    <?php\n\n// get $contact_info from db or other resource here\n\n$smarty->assign('contact_info',$contact_info);\n$smarty->assign('login_url',\"http://{$_SERVER['SERVER_NAME']}/login\");\n\nmail($contact_info['email'], 'Thank You', $smarty->fetch('email_body.tpl'));\n\n?>\n

    See also {fetch} display(), {eval}, and templateExists().

    "},{"location":"programmers/api-functions/api-get-cache-dir/","title":"Api get cache dir","text":"

    getCacheDir()

    return the directory where the rendered template\\'s output is stored

    "},{"location":"programmers/api-functions/api-get-cache-dir/#description","title":"Description","text":"

    string

    getCacheDir

    <?php\n\n// get directory where compiled templates are stored\n$cacheDir = $smarty->getCacheDir();\n\n?>\n

    See also setCacheDir() and $cache_dir.

    "},{"location":"programmers/api-functions/api-get-compile-dir/","title":"Api get compile dir","text":"

    getCompileDir()

    returns the directory where compiled templates are stored

    "},{"location":"programmers/api-functions/api-get-compile-dir/#description","title":"Description","text":"

    string

    getCompileDir

    <?php\n\n// get directory where compiled templates are stored\n$compileDir = $smarty->getCompileDir();\n\n?>\n

    See also setCompileDir() and $compile_dir.

    "},{"location":"programmers/api-functions/api-get-config-dir/","title":"Api get config dir","text":"

    getConfigDir()

    return the directory where config files are stored

    "},{"location":"programmers/api-functions/api-get-config-dir/#description","title":"Description","text":"

    string|array

    getConfigDir

    string

    key

    <?php\n\n// set some config directories\n$smarty->setConfigDir(array(\n    'one' => './config',\n    'two' => './config_2',\n    'three' => './config_3',\n));\n\n// get all directories where config files are stored\n$config_dir = $smarty->getConfigDir();\nvar_dump($config_dir); // array\n\n// get directory identified by key\n$config_dir = $smarty->getConfigDir('one');\nvar_dump($config_dir); // string\n\n?>\n

    See also setConfigDir(), addConfigDir() and $config_dir.

    "},{"location":"programmers/api-functions/api-get-config-vars/","title":"Api get config vars","text":"

    getConfigVars()

    returns the given loaded config variable value

    "},{"location":"programmers/api-functions/api-get-config-vars/#description","title":"Description","text":"

    array

    getConfigVars

    string

    varname

    If no parameter is given, an array of all loaded config variables is returned.

    <?php\n\n// get loaded config template var #foo#\n$myVar = $smarty->getConfigVars('foo');\n\n// get all loaded config template vars\n$all_config_vars = $smarty->getConfigVars();\n\n// take a look at them\nprint_r($all_config_vars);\n?>\n

    See also clearConfig(), {config_load}, configLoad() and getTemplateVars().

    "},{"location":"programmers/api-functions/api-get-plugins-dir/","title":"Api get plugins dir","text":"

    getPluginsDir()

    return the directory where plugins are stored

    "},{"location":"programmers/api-functions/api-get-plugins-dir/#description","title":"Description","text":"

    array

    getPluginsDir

    <?php\n\n// set some plugins directories\n$smarty->setPluginsDir(array(\n    './plugins',\n    './plugins_2',\n));\n\n// get all directories where plugins are stored\n$config_dir = $smarty->getPluginsDir();\nvar_dump($config_dir); // array\n\n?>\n

    See also setPluginsDir(), addPluginsDir() and $plugins_dir.

    "},{"location":"programmers/api-functions/api-get-registered-object/","title":"Api get registered object","text":"

    getRegisteredObject()

    returns a reference to a registered object

    "},{"location":"programmers/api-functions/api-get-registered-object/#description","title":"Description","text":"

    array

    getRegisteredObject

    string

    object_name

    This is useful from within a custom function when you need direct access to a registered object. See the objects page for more info.

    <?php\nfunction smarty_block_foo($params, $smarty)\n{\n  if (isset($params['object'])) {\n    // get reference to registered object\n    $obj_ref = $smarty->getRegisteredObject($params['object']);\n    // use $obj_ref is now a reference to the object\n  }\n}\n?>\n

    See also registerObject(), unregisterObject() and objects page

    "},{"location":"programmers/api-functions/api-get-tags/","title":"Api get tags","text":"

    getTags()

    return tags used by template

    "},{"location":"programmers/api-functions/api-get-tags/#description","title":"Description","text":"

    string

    getTags

    object

    template

    This function returns an array of tagname/attribute pairs for all tags used by the template. It uses the following parameters:

    Note

    This function is experimental.

    <?php\ninclude('Smarty.class.php');\n$smarty = new Smarty;\n\n// create template object\n$tpl = $smarty->createTemplate('index.tpl');\n\n// get tags\n$tags = $smarty->getTags($tpl);\n\nprint_r($tags);\n\n?>\n
    "},{"location":"programmers/api-functions/api-get-template-dir/","title":"Api get template dir","text":"

    getTemplateDir()

    return the directory where templates are stored

    "},{"location":"programmers/api-functions/api-get-template-dir/#description","title":"Description","text":"

    string|array

    getTemplateDir

    string

    key

    <?php\n\n// set some template directories\n$smarty->setTemplateDir(array(\n    'one' => './templates',\n    'two' => './templates_2',\n    'three' => './templates_3',\n));\n\n// get all directories where templates are stored\n$template_dir = $smarty->getTemplateDir();\nvar_dump($template_dir); // array\n\n// get directory identified by key\n$template_dir = $smarty->getTemplateDir('one');\nvar_dump($template_dir); // string\n\n?>\n

    See also setTemplateDir(), addTemplateDir() and $template_dir.

    "},{"location":"programmers/api-functions/api-get-template-vars/","title":"Api get template vars","text":"

    getTemplateVars()

    returns assigned variable value(s)

    "},{"location":"programmers/api-functions/api-get-template-vars/#description","title":"Description","text":"

    array

    getTemplateVars

    string

    varname

    If no parameter is given, an array of all assigned variables are returned.

    <?php\n// get assigned template var 'foo'\n$myVar = $smarty->getTemplateVars('foo');\n\n// get all assigned template vars\n$all_tpl_vars = $smarty->getTemplateVars();\n\n// take a look at them\nprint_r($all_tpl_vars);\n?>\n

    See also assign(), {assign}, append(), clearAssign(), clearAllAssign() and getConfigVars()

    "},{"location":"programmers/api-functions/api-is-cached/","title":"Api is cached","text":"

    isCached()

    returns true if there is a valid cache for this template

    "},{"location":"programmers/api-functions/api-is-cached/#description","title":"Description","text":"

    bool

    isCached

    string

    template

    string

    cache_id

    string

    compile_id

    Note

    If isCached() returns TRUE it actually loads the cached output and stores it internally. Any subsequent call to display() or fetch() will return this internally stored output and does not try to reload the cache file. This prevents a race condition that may occur when a second process clears the cache between the calls to isCached() and to display() in the example above. This also means calls to clearCache() and other changes of the cache-settings may have no effect after isCached() returned TRUE.

    <?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl')) {\n// do database calls, assign vars here\n}\n\n$smarty->display('index.tpl');\n?>\n\n\n\n\n<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl', 'FrontPage')) {\n  // do database calls, assign vars here\n}\n\n$smarty->display('index.tpl', 'FrontPage');\n?>\n

    See also clearCache(), clearAllCache(), and caching section.

    "},{"location":"programmers/api-functions/api-load-filter/","title":"Api load filter","text":"

    loadFilter()

    load a filter plugin

    "},{"location":"programmers/api-functions/api-load-filter/#description","title":"Description","text":"

    void

    loadFilter

    string

    type

    string

    name

    The first argument specifies the type of the filter to load and can be one of the following: pre, post or output. The second argument specifies the name of the filter plugin.

    <?php\n\n// load prefilter named 'trim'\n$smarty->loadFilter('pre', 'trim');\n\n// load another prefilter named 'datefooter'\n$smarty->loadFilter('pre', 'datefooter');\n\n// load output filter named 'compress'\n$smarty->loadFilter('output', 'compress');\n\n?>\n

    See also registerFilter(), $autoload_filters and advanced features.

    "},{"location":"programmers/api-functions/api-mute-expected-errors/","title":"Api mute expected errors","text":"

    mutes expected warnings and notices deliberately generated by Smarty

    "},{"location":"programmers/api-functions/api-mute-expected-errors/#description","title":"Description","text":"

    string

    muteExpectedErrors

    muteExpectedErrors() registers a custom error handler using set_error_handler(). The error handler merely inspects $errno and $errfile to determine if the given error was produced deliberately and must be ignored, or should be passed on to the next error handler.

    Smarty::unmuteExpectedErrors() removes the current error handler. Please note, that if you\\'ve registered any custom error handlers after the muteExpectedErrors() call, the unmute will not remove Smarty\\'s muting error handler, but the one registered last.

    "},{"location":"programmers/api-functions/api-register-cacheresource/","title":"Api register cacheresource","text":"

    registerCacheResource()

    dynamically register CacheResources

    "},{"location":"programmers/api-functions/api-register-cacheresource/#description","title":"Description","text":"

    void

    registerCacheResource

    string

    name

    Smarty_CacheResource

    resource_handler

    Use this to dynamically register a CacheResource plugin with Smarty. Pass in the name of the CacheResource and the object extending Smarty_CacheResource. See Custom Cache Implementation for more information on how to create custom CacheResources.

    Note

    In Smarty2 this used to be a callback function called $cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.

    <?php\n$smarty->registerCacheResource('mysql', new Smarty_CacheResource_Mysql());\n?>\n

    See also unregisterCacheResource() and the Custom CacheResource Implementation section.

    "},{"location":"programmers/api-functions/api-register-class/","title":"Api register class","text":"

    registerClass()

    register a class for use in the templates

    "},{"location":"programmers/api-functions/api-register-class/#description","title":"Description","text":"

    void

    registerClass

    string

    class_name

    string

    class_impl

    Smarty allows you to access static classes from templates as long as the Security Policy does not tell it otherwise. If security is enabled, classes registered with registerClass() are accessible to templates.

    <?php\n\nclass Bar {\n  $property = \"hello world\";\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"Bar\");\n\n\n\n\n{* Smarty will access this class as long as it's not prohibited by security *}\n{Bar::$property}\n{* Foo translates to the real class Bar *}\n{Foo::$property}\n\n\n\n\n<?php\nnamespace my\\php\\application {\n  class Bar {\n    $property = \"hello world\";\n  }\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"\\my\\php\\application\\Bar\");\n\n\n\n\n{* Foo translates to the real class \\my\\php\\application\\Bar *}\n{Foo::$property}\n

    See also registerObject(), and Security.

    "},{"location":"programmers/api-functions/api-register-default-plugin-handler/","title":"Api register default plugin handler","text":"

    registerDefaultPluginHandler()

    register a function which gets called on undefined tags

    "},{"location":"programmers/api-functions/api-register-default-plugin-handler/#description","title":"Description","text":"

    void

    registerDefaultPluginHandler

    mixed

    callback

    Register a default plugin handler which gets called if the compiler can not find a definition for a tag otherwise. It uses the following parameters:

    If during compilation Smarty encounters tag which is not defined internal, registered or located in the plugins folder it tries to resolve it by calling the registered default plugin handler. The handler may be called several times for same undefined tag looping over valid plugin types.

    <?php\n\n$smarty = new Smarty();\n$smarty->registerDefaultPluginHandler('my_plugin_handler');\n\n/**\n * Default Plugin Handler\n *\n * called when Smarty encounters an undefined tag during compilation\n * \n * @param string                     $name      name of the undefined tag\n * @param string                     $type     tag type (e.g. Smarty::PLUGIN_FUNCTION, Smarty::PLUGIN_BLOCK, \n                                               Smarty::PLUGIN_COMPILER, Smarty::PLUGIN_MODIFIER, Smarty::PLUGIN_MODIFIERCOMPILER)\n * @param Smarty_Internal_Template   $template     template object\n * @param string                     &$callback    returned function name \n * @param string                     &$script      optional returned script filepath if function is external\n * @param bool                       &$cacheable    true by default, set to false if plugin is not cachable (Smarty >= 3.1.8)\n * @return bool                      true if successfull\n */\nfunction my_plugin_handler ($name, $type, $template, &$callback, &$script, &$cacheable)\n{\n    switch ($type) {\n        case Smarty::PLUGIN_FUNCTION:\n            switch ($name) {\n                case 'scriptfunction':\n                    $script = './scripts/script_function_tag.php';\n                    $callback = 'default_script_function_tag';\n                    return true;\n                case 'localfunction':\n                    $callback = 'default_local_function_tag';\n                    return true;\n                default:\n                return false;\n            }\n        case Smarty::PLUGIN_COMPILER:\n            switch ($name) {\n                case 'scriptcompilerfunction':\n                    $script = './scripts/script_compiler_function_tag.php';\n                    $callback = 'default_script_compiler_function_tag';\n                    return true;\n                default:\n                return false;\n            }\n        case Smarty::PLUGIN_BLOCK:\n            switch ($name) {\n                case 'scriptblock':\n                    $script = './scripts/script_block_tag.php';\n                    $callback = 'default_script_block_tag';\n                    return true;\n                default:\n                return false;\n            }\n        default:\n        return false;\n    }\n }\n\n?>\n

    Note

    The return callback must be static; a function name or an array of class and method name.

    Dynamic callbacks like objects methods are not supported.

    "},{"location":"programmers/api-functions/api-register-filter/","title":"Api register filter","text":"

    registerFilter()

    dynamically register filters

    "},{"location":"programmers/api-functions/api-register-filter/#description","title":"Description","text":"

    void

    registerFilter

    string

    type

    mixed

    callback

    Use this to dynamically register filters to operate on a templates. It uses the following parameters:

    NOTE.PARAMETER.FUNCTION

    A prefilter runs through the template source before it gets compiled. See template prefilters for more information on how to setup a prefiltering function.

    A postfilter runs through the template code after it was compiled to PHP. See template postfilters for more information on how to setup a postfiltering function.

    A outputfilter operates on a template\\'s output before it is displayed. See template output filters for more information on how to set up an output filter function.

    See also unregisterFilter(), loadFilter(), $autoload_filters, template pre filters template post filters template output filters section.

    "},{"location":"programmers/api-functions/api-register-object/","title":"Api register object","text":"

    registerObject()

    register an object for use in the templates

    "},{"location":"programmers/api-functions/api-register-object/#description","title":"Description","text":"

    void

    registerObject

    string

    object_name

    object

    object

    array

    allowed_methods_properties

    boolean

    format

    array

    block_methods

    Note

    When you register/assign objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.

    See the objects section for more information.

    See also getRegisteredObject(), and unregisterObject().

    "},{"location":"programmers/api-functions/api-register-plugin/","title":"Api register plugin","text":"

    registerPlugin()

    dynamically register plugins

    "},{"location":"programmers/api-functions/api-register-plugin/#description","title":"Description","text":"

    void

    registerPlugin

    string

    type

    string

    name

    mixed

    callback

    bool

    cacheable

    mixed

    cache_attrs

    This method registers functions or methods defined in your script as plugin. It uses the following parameters:

    <?php\n$smarty->registerPlugin(\"function\",\"date_now\", \"print_current_date\");\n\nfunction print_current_date($params, $smarty)\n{\n  if(empty($params[\"format\"])) {\n    $format = \"%b %e, %Y\";\n  } else {\n    $format = $params[\"format\"];\n  }\n  return strftime($format,time());\n}\n?>\n

    And in the template

    {date_now}\n\n{* or to format differently *}\n{date_now format=\"%Y/%m/%d\"}\n\n\n<?php\n// function declaration\nfunction do_translation ($params, $content, $smarty, &$repeat, $template)\n{\n  if (isset($content)) {\n    $lang = $params[\"lang\"];\n    // do some translation with $content\n    return $translation;\n  }\n}\n\n// register with smarty\n$smarty->registerPlugin(\"block\",\"translate\", \"do_translation\");\n?>\n

    Where the template is:

    {translate lang=\"br\"}Hello, world!{/translate}\n\n\n\n\n<?php\n\n// let's map PHP's stripslashes function to a Smarty modifier.\n$smarty->registerPlugin(\"modifier\",\"ss\", \"stripslashes\");\n\n?>\n

    In the template, use ss to strip slashes.

    <?php\n{$var|ss}\n?>\n

    See also unregisterPlugin(), plugin functions, plugin block functions, plugin compiler functions, and the creating plugin modifiers section.

    "},{"location":"programmers/api-functions/api-register-resource/","title":"Api register resource","text":"

    registerResource()

    dynamically register resources

    "},{"location":"programmers/api-functions/api-register-resource/#description","title":"Description","text":"

    void

    registerResource

    string

    name

    Smarty_resource

    resource_handler

    Use this to dynamically register a Resource plugin with Smarty. Pass in the name of the Resource and the object extending Smarty_Resource. See template resources for more information on how to setup a function for fetching templates.

    Note

    A resource name must be at least two characters in length. One character resource names will be ignored and used as part of the file path, such as $smarty->display('c:/path/to/index.tpl');

    Note

    Prior to Smarty 3.1 registerResource() accepted an array of callback functions. While this is still possible for backward compatibility reasons, it is strongly discouraged as callback functions have been deprecated as of Smarty 3.1.

    <?php\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n?>\n

    See also unregisterResource() and the template resources section.

    "},{"location":"programmers/api-functions/api-set-cache-dir/","title":"Api set cache dir","text":"

    setCacheDir()

    set the directory where the rendered template\\'s output is stored

    "},{"location":"programmers/api-functions/api-set-cache-dir/#description","title":"Description","text":"

    Smarty

    setCacheDir

    string

    cache_dir

    <?php\n\n// set directory where rendered template's output is stored\n$smarty->setCacheDir('./cache');\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getCacheDir() and $cache_dir.

    "},{"location":"programmers/api-functions/api-set-compile-dir/","title":"Api set compile dir","text":"

    setCompileDir()

    set the directory where compiled templates are stored

    "},{"location":"programmers/api-functions/api-set-compile-dir/#description","title":"Description","text":"

    Smarty

    setCompileDir

    string

    compile_dir

    <?php\n\n// set directory where compiled templates are stored\n$smarty->setCompileDir('./templates_c');\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getCompileDir() and $compile_dir.

    "},{"location":"programmers/api-functions/api-set-config-dir/","title":"Api set config dir","text":"

    setConfigDir()

    set the directories where config files are stored

    "},{"location":"programmers/api-functions/api-set-config-dir/#description","title":"Description","text":"

    Smarty

    setConfigDir

    string|array

    config_dir

    <?php\n\n// set a single directory where the config files are stored\n$smarty->setConfigDir('./config');\n\n// view the config dir chain\nvar_dump($smarty->getConfigDir());\n\n// set multiple director\u00edes where config files are stored\n$smarty->setConfigDir(array(\n    'one' => './config',\n    'two' => './config_2',\n    'three' => './config_3',\n));\n\n// view the config dir chain\nvar_dump($smarty->getConfigDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setConfigDir('./config')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getConfigDir(), addConfigDir() and $config_dir.

    "},{"location":"programmers/api-functions/api-set-plugins-dir/","title":"Api set plugins dir","text":"

    setPluginsDir()

    set the directories where plugins are stored

    "},{"location":"programmers/api-functions/api-set-plugins-dir/#description","title":"Description","text":"

    Smarty

    setPluginsDir

    string|array

    plugins_dir

    <?php\n\n// set a single directory where the plugins are stored\n$smarty->setPluginsDir('./plugins');\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// set multiple director\u00edes where plugins are stored\n$smarty->setPluginsDir(array(\n    './plugins',\n    './plugins_2',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setPluginsDir('./plugins')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getPluginsDir(), addPluginsDir() and $plugins_dir.

    "},{"location":"programmers/api-functions/api-set-template-dir/","title":"Api set template dir","text":"

    setTemplateDir()

    set the directories where templates are stored

    "},{"location":"programmers/api-functions/api-set-template-dir/#description","title":"Description","text":"

    Smarty

    setTemplateDir

    string|array

    template_dir

    <?php\n\n// set a single directory where the templates are stored\n$smarty->setTemplateDir('./cache');\n\n// view the template dir chain\nvar_dump($smarty->getTemplateDir());\n\n// set multiple director\u00edes where templates are stored\n$smarty->setTemplateDir(array(\n    'one' => './templates',\n    'two' => './templates_2',\n    'three' => './templates_3',\n));\n\n// view the template dir chain\nvar_dump($smarty->getTemplateDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n       ->setCompileDir('./templates_c')\n       ->setCacheDir('./cache');\n\n?>\n

    See also getTemplateDir(), addTemplateDir() and $template_dir.

    "},{"location":"programmers/api-functions/api-template-exists/","title":"Api template exists","text":"

    templateExists()

    checks whether the specified template exists

    "},{"location":"programmers/api-functions/api-template-exists/#description","title":"Description","text":"

    bool

    templateExists

    string

    template

    It can accept either a path to the template on the filesystem or a resource string specifying the template.

    This example uses $_GET['page'] to {include} a content template. If the template does not exist then an error page is displayed instead. First the page_container.tpl

    <html>\n<head><title>{$title}</title></head>\n<body>\n{include file='page_top.tpl'}\n\n{* include middle content page *}\n{include file=$content_template}\n\n{include file='page_footer.tpl'}\n</body>\n

    And the php script

    <?php\n\n// set the filename eg index.inc.tpl\n$mid_template = $_GET['page'].'.inc.tpl';\n\nif( !$smarty->templateExists($mid_template) ){\n    $mid_template = 'page_not_found.tpl';\n}\n$smarty->assign('content_template', $mid_template);\n\n$smarty->display('page_container.tpl');\n\n?>\n

    See also display(), fetch(), {include} and {insert}

    "},{"location":"programmers/api-functions/api-test-install/","title":"Api test install","text":"

    testInstall()

    checks Smarty installation

    "},{"location":"programmers/api-functions/api-test-install/#description","title":"Description","text":"

    void

    testInstall

    This function verifies that all required working folders of the Smarty installation can be accessed. It does output a corresponding protocol.

    <?php\nrequire_once('Smarty.class.php');\n$smarty  = new Smarty();\n$smarty->testInstall();\n?>\n
    "},{"location":"programmers/api-functions/api-unregister-cacheresource/","title":"Api unregister cacheresource","text":"

    unregisterCacheResource()

    dynamically unregister a CacheResource plugin

    "},{"location":"programmers/api-functions/api-unregister-cacheresource/#description","title":"Description","text":"

    void

    unregisterCacheResource

    string

    name

    Pass in the name of the CacheResource.

    <?php\n\n$smarty->unregisterCacheResource('mysql');\n\n?>\n

    See also registerCacheResource() and the Custom CacheResource Implementation section.

    "},{"location":"programmers/api-functions/api-unregister-filter/","title":"Api unregister filter","text":"

    unregisterFilter()

    dynamically unregister a filter

    "},{"location":"programmers/api-functions/api-unregister-filter/#description","title":"Description","text":"

    void

    unregisterFilter

    string

    type

    string|array

    callback

    Use this to dynamically unregister filters. It uses the following parameters:

    See also registerFilter().

    "},{"location":"programmers/api-functions/api-unregister-object/","title":"Api unregister object","text":"

    unregisterObject()

    dynamically unregister an object

    "},{"location":"programmers/api-functions/api-unregister-object/#description","title":"Description","text":"

    void

    unregisterObject

    string

    object_name

    See also registerObject() and objects section

    "},{"location":"programmers/api-functions/api-unregister-plugin/","title":"Api unregister plugin","text":"

    unregisterPlugin

    dynamically unregister plugins

    "},{"location":"programmers/api-functions/api-unregister-plugin/#description","title":"Description","text":"

    void

    unregisterPlugin

    string

    type

    string

    name

    This method unregisters plugins which previously have been registered by registerPlugin(), It uses the following parameters:

    <?php\n\n// we don't want template designers to have access to function plugin \"date_now\" \n$smarty->unregisterPlugin(\"function\",\"date_now\");\n\n?>\n

    See also registerPlugin().

    "},{"location":"programmers/api-functions/api-unregister-resource/","title":"Api unregister resource","text":"

    unregisterResource()

    dynamically unregister a resource plugin

    "},{"location":"programmers/api-functions/api-unregister-resource/#description","title":"Description","text":"

    void

    unregisterResource

    string

    name

    Pass in the name of the resource.

    <?php\n\n$smarty->unregisterResource('db');\n\n?>\n

    See also registerResource() and template resources

    "},{"location":"programmers/api-variables/variable-allow-php-templates/","title":"\\$allow_php_templates {#variable.allow.php.templates}","text":"

    By default the PHP template file resource is disabled. Setting $allow_php_templates to TRUE will enable PHP template files.

    ::: {.informalexample}

    <?php\n$smarty->allow_php_templates = true;\n?>\n

    :::

    Note

    The PHP template file resource is an undocumented deprecated feature.

    "},{"location":"programmers/api-variables/variable-auto-literal/","title":"\\$auto_literal {#variable.auto.literal}","text":"

    The Smarty delimiter tags { and } will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting auto_literal to false.

    ::: {.informalexample}

    <?php\n$smarty->auto_literal = false;\n?>\n

    :::

    See also Escaping Smarty parsing,

    "},{"location":"programmers/api-variables/variable-autoload-filters/","title":"\\$autoload_filters {#variable.autoload.filters}","text":"

    If there are some filters that you wish to load on every template invocation, you can specify them using this variable and Smarty will automatically load them for you. The variable is an associative array where keys are filter types and values are arrays of the filter names. For example:

    ::: {.informalexample}

    <?php\n$smarty->autoload_filters = array('pre' => array('trim', 'stamp'),\n                                  'output' => array('convert'));\n?>\n

    :::

    See also registerFilter() and loadFilter()

    "},{"location":"programmers/api-variables/variable-cache-dir/","title":"\\$cache_dir {#variable.cache.dir}","text":"

    This is the name of the directory where template caches are stored. By default this is ./cache, meaning that Smarty will look for the cache/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.

    You can also use your own custom cache implementation to control cache files, which will ignore this setting. See also $use_sub_dirs.

    Note

    This setting must be either a relative or absolute path. include_path is not used for writing files.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    As of Smarty 3.1 the attribute \\$cache_dir is no longer accessible directly. Use getCacheDir() and setCacheDir() instead.

    See also getCacheDir(), setCacheDir(), $caching, $use_sub_dirs, $cache_lifetime, $cache_modified_check and the caching section.

    "},{"location":"programmers/api-variables/variable-cache-id/","title":"\\$cache_id {#variable.cache.id}","text":"

    Persistent cache_id identifier. As an alternative to passing the same $cache_id to each and every function call, you can set this $cache_id and it will be used implicitly thereafter.

    With a $cache_id you can have multiple cache files for a single call to display() or fetch() depending for example from different content of the same template. See the caching section for more information.

    "},{"location":"programmers/api-variables/variable-cache-lifetime/","title":"\\$cache_lifetime {#variable.cache.lifetime}","text":"

    This is the length of time in seconds that a template cache is valid. Once this time has expired, the cache will be regenerated.

    If $force_compile is enabled, the cache files will be regenerated every time, effectively disabling caching. You can clear all the cache files with the clear_all_cache() function, or individual cache files (or groups) with the clear_cache() function.

    "},{"location":"programmers/api-variables/variable-cache-locking/","title":"\\$cache_locking {#variable.cache.locking}","text":"

    Cache locking avoids concurrent cache generation. This means resource intensive pages can be generated only once, even if they\\'ve been requested multiple times in the same moment.

    Cache locking is disabled by default. To enable it set $cache_locking to TRUE.

    See also $locking_timeout

    "},{"location":"programmers/api-variables/variable-cache-modified-check/","title":"\\$cache_modified_check {#variable.cache.modified.check}","text":"

    If set to TRUE, Smarty will respect the If-Modified-Since header sent from the client. If the cached file timestamp has not changed since the last visit, then a '304: Not Modified' header will be sent instead of the content. This works only on cached content without {insert} tags.

    See also $caching, $cache_lifetime, and the caching section.

    "},{"location":"programmers/api-variables/variable-caching-type/","title":"\\$caching_type {#variable.caching.type}","text":"

    This property specifies the name of the caching handler to use. It defaults to file, enabling the internal filesystem based cache handler.

    See Custom Cache Implementation for pointers on setting up your own cache handler.

    "},{"location":"programmers/api-variables/variable-caching/","title":"\\$caching {#variable.caching}","text":"

    This tells Smarty whether or not to cache the output of the templates to the $cache_dir. By default this is set to the constant Smarty::CACHING_OFF. If your templates consistently generate the same content, it is advisable to turn on $caching, as this may result in significant performance gains.

    You can also have multiple caches for the same template.

    See also $cache_dir, $cache_lifetime, $cache_modified_check, is_cached() and the caching section.

    "},{"location":"programmers/api-variables/variable-compile-check/","title":"\\$compile_check {#variable.compile.check}","text":"

    Upon each invocation of the PHP application, Smarty tests to see if the current template has changed (different timestamp) since the last time it was compiled. If it has changed, it recompiles that template. If the template has yet not been compiled at all, it will compile regardless of this setting. By default this variable is set to TRUE.

    Once an application is put into production (ie the templates won\\'t be changing), the compile check step is no longer needed. Be sure to set $compile_check to FALSE for maximum performance. Note that if you change this to FALSE and a template file is changed, you will *not* see the change since the template will not get recompiled.

    Note that up to Smarty 4.x, Smarty will check for the existence of the source template even if $compile_check is disabled.

    If $caching is enabled and $compile_check is enabled, then the cache files will get regenerated if an involved template file or config file was updated.

    As of Smarty 3.1 $compile_check can be set to the value Smarty::COMPILECHECK_CACHEMISS. This enables Smarty to revalidate the compiled template, once a cache file is regenerated. So if there was a cached template, but it\\'s expired, Smarty will run a single compile_check before regenerating the cache.

    See $force_compile and clearCompiledTemplate().

    "},{"location":"programmers/api-variables/variable-compile-dir/","title":"\\$compile_dir {#variable.compile.dir}","text":"

    This is the name of the directory where compiled templates are located. By default this is ./templates_c, meaning that Smarty will look for the templates_c/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.

    Note

    This setting must be either a relative or absolute path. include_path is not used for writing files.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    As of Smarty 3.1 the attribute \\$compile_dir is no longer accessible directly. Use getCompileDir() and setCompileDir() instead.

    See also getCompileDir(), setCompileDir(), $compile_id and $use_sub_dirs.

    "},{"location":"programmers/api-variables/variable-compile-id/","title":"\\$compile_id {#variable.compile.id}","text":"

    Persistent compile identifier. As an alternative to passing the same $compile_id to each and every function call, you can set this $compile_id and it will be used implicitly thereafter.

    If you use the same template with different pre- and/or post-filters you must use a unique $compile_id to keep the compiled template files separated.

    For example a prefilter that localizes your templates (that is: translates language dependent parts) at compile time, then you could use the current language as $compile_id and you will get a set of compiled templates for each language you use.

    <?php\n$smarty->compile_id = 'en';\n?>\n

    Another application would be to use the same compile directory across multiple domains / multiple virtual hosts.

    <?php\n\n$smarty->compile_id = $_SERVER['SERVER_NAME'];\n$smarty->compile_dir = '/path/to/shared_compile_dir';\n\n?>\n

    Note

    In Smarty 3 a $compile_id is no longer required to keep templates with same name in different $template_dir folders separated. The $template_dir file path is encoded in the file name of compiled and cached template files.

    "},{"location":"programmers/api-variables/variable-compile-locking/","title":"\\$compile_locking {#variable.compile.locking}","text":"

    Compile locking avoids concurrent compilation of the same template.

    Compile locking is enabled by default. To disable it set $compile_locking to FALSE.

    "},{"location":"programmers/api-variables/variable-compiler-class/","title":"\\$compiler_class {#variable.compiler.class}","text":"

    Specifies the name of the compiler class that Smarty will use to compile the templates. The default is \\'Smarty_Compiler\\'. For advanced users only.

    "},{"location":"programmers/api-variables/variable-config-booleanize/","title":"\\$config_booleanize {#variable.config.booleanize}","text":"

    If set to TRUE, config files values of on/true/yes and off/false/no get converted to boolean values automatically. This way you can use the values in the template like so: {if #foobar#}...{/if}. If foobar was on, true or yes, the {if} statement will execute. Defaults to TRUE.

    "},{"location":"programmers/api-variables/variable-config-dir/","title":"\\$config_dir {#variable.config.dir}","text":"

    This is the directory used to store config files used in the templates. Default is ./configs, meaning that Smarty will look for the configs/ directory in the same directory as the executing php script.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    As of Smarty 3.1 the attribute \\$config_dir is no longer accessible directly. Use getConfigDir(), setConfigDir() and addConfigDir() instead.

    See also getConfigDir(), setConfigDir() and addConfigDir().

    "},{"location":"programmers/api-variables/variable-config-overwrite/","title":"\\$config_overwrite {#variable.config.overwrite}","text":"

    If set to TRUE, the default then variables read in from config files will overwrite each other. Otherwise, the variables will be pushed onto an array. This is helpful if you want to store arrays of data in config files, just list each element multiple times.

    This examples uses {cycle} to output a table with alternating red/green/blue row colors with $config_overwrite = FALSE.

    The config file.

    # row colors\nrowColors = #FF0000\nrowColors = #00FF00\nrowColors = #0000FF\n

    The template with a {section} loop.

    <table>\n  {section name=r loop=$rows}\n  <tr bgcolor=\"{cycle values=#rowColors#}\">\n    <td> ....etc.... </td>\n  </tr>\n  {/section}\n</table>\n

    See also {config_load}, getConfigVars(), clearConfig(), configLoad() and the config files section.

    "},{"location":"programmers/api-variables/variable-config-read-hidden/","title":"\\$config_read_hidden {#variable.config.read.hidden}","text":"

    If set to TRUE, hidden sections ie section names beginning with a period(.) in config files can be read from templates. Typically you would leave this FALSE, that way you can store sensitive data in the config files such as database parameters and not worry about the template loading them. FALSE by default.

    "},{"location":"programmers/api-variables/variable-debug-template/","title":"\\$debug_tpl {#variable.debug_template}","text":"

    This is the name of the template file used for the debugging console. By default, it is named debug.tpl and is located in the SMARTY_DIR.

    See also $debugging and the debugging console section.

    "},{"location":"programmers/api-variables/variable-debugging-ctrl/","title":"\\$debugging_ctrl {#variable.debugging.ctrl}","text":"

    This allows alternate ways to enable debugging. NONE means no alternate methods are allowed. URL means when the keyword SMARTY_DEBUG is found in the QUERY_STRING, debugging is enabled for that invocation of the script. If $debugging is TRUE, this value is ignored.

    <?php\n// shows debug console only on localhost ie\n// http://localhost/script.php?foo=bar&SMARTY_DEBUG\n$smarty->debugging = false; // the default\n$smarty->debugging_ctrl = ($_SERVER['SERVER_NAME'] == 'localhost') ? 'URL' : 'NONE';\n?>\n

    See also debugging console section, $debugging and $smarty_debug_id.

    "},{"location":"programmers/api-variables/variable-debugging/","title":"\\$debugging {#variable.debugging}","text":"

    This enables the debugging console. The console is a javascript popup window that informs you of the included templates, variables assigned from php and config file variables for the current script. It does not show variables assigned within a template with the {assign} function.

    The console can also be enabled from the url with $debugging_ctrl.

    See also {debug}, $debug_tpl, and $debugging_ctrl.

    "},{"location":"programmers/api-variables/variable-default-config-handler-func/","title":"\\$default_config_handler_func {#variable.default.config.handler.func}","text":"

    This function is called when a config file cannot be obtained from its resource.

    Note

    The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a SmartyException is thrown.

    <?php\n\n$smarty = new Smarty();\n$smarty->default_config_handler_func = 'my_default_config_handler_func';\n\n/**\n * Default Config Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string   $type     resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string   $name     resource name (e.g. \"foo/bar.tpl\")\n * @param string  &$content  config's content\n * @param integer &$modified config's modification time\n * @param Smarty   $smarty   Smarty instance\n * @return string|boolean   path to file or boolean true if $content and $modified \n *                          have been filled, boolean false if no default config \n *                          could be loaded\n */\nfunction my_default_config_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n    if (false) {\n        // return corrected filepath\n        return \"/tmp/some/foobar.tpl\";\n    } elseif (false) {\n        // return a config directly\n        $content = 'someVar = \"the config source\"';\n        $modified = time();\n        return true;\n    } else {\n        // tell smarty that we failed\n        return false;\n    }\n}\n\n?>\n
    "},{"location":"programmers/api-variables/variable-default-config-type/","title":"\\$default_config_type {#variable.default.config.type}","text":"

    This tells smarty what resource type to use for config files. The default value is file, meaning that $smarty->configLoad('test.conf') and $smarty->configLoad('file:test.conf') are identical in meaning. See the resource chapter for more details.

    "},{"location":"programmers/api-variables/variable-default-modifiers/","title":"\\$default_modifiers {#variable.default.modifiers}","text":"

    This is an array of modifiers to implicitly apply to every variable in a template. For example, to HTML-escape every variable by default, use array('escape:\"htmlall\"'). To make a variable exempt from default modifiers, add the \\'nofilter\\' attribute to the output tag such as {$var nofilter}.

    "},{"location":"programmers/api-variables/variable-default-resource-type/","title":"\\$default_resource_type {#variable.default.resource.type}","text":"

    This tells smarty what resource type to use implicitly. The default value is file, meaning that $smarty->display('index.tpl') and $smarty->display('file:index.tpl') are identical in meaning. See the resource chapter for more details.

    "},{"location":"programmers/api-variables/variable-default-template-handler-func/","title":"\\$default_template_handler_func {#variable.default.template.handler.func}","text":"

    This function is called when a template cannot be obtained from its resource.

    Note

    The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a SmartyException is thrown.

    <?php\n\n$smarty = new Smarty();\n$smarty->default_template_handler_func = 'my_default_template_handler_func';\n\n/**\n * Default Template Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string   $type     resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string   $name     resource name (e.g. \"foo/bar.tpl\")\n * @param string  &$content  template's content\n * @param integer &$modified template's modification time\n * @param Smarty   $smarty   Smarty instance\n * @return string|boolean   path to file or boolean true if $content and $modified \n *                          have been filled, boolean false if no default template \n *                          could be loaded\n */\nfunction my_default_template_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n    if (false) {\n        // return corrected filepath\n        return \"/tmp/some/foobar.tpl\";\n    } elseif (false) {\n        // return a template directly\n        $content = \"the template source\";\n        $modified = time();\n        return true;\n    } else {\n        // tell smarty that we failed\n        return false;\n    }\n}\n\n?>\n
    "},{"location":"programmers/api-variables/variable-direct-access-security/","title":"\\$direct_access_security {#variable.direct.access.security}","text":"

    Direct access security inhibits direct browser access to compiled or cached template files.

    Direct access security is enabled by default. To disable it set $direct_access_security to FALSE.

    Note

    This is a compile time option. If you change the setting you must make sure that the templates get recompiled.

    "},{"location":"programmers/api-variables/variable-error-reporting/","title":"\\$error_reporting {#variable.error.reporting}","text":"

    When this value is set to a non-null-value it\\'s value is used as php\\'s error_reporting level inside of display() and fetch().

    Smarty 3.1.2 introduced the muteExpectedErrors() function. Calling Smarty::muteExpectedErrors(); after setting up custom error handling will ensure that warnings and notices (deliberately) produced by Smarty will not be passed to other custom error handlers. If your error logs are filling up with warnings regarding filemtime() or unlink() calls, please enable Smarty\\'s error muting.

    See also debugging and troubleshooting.

    "},{"location":"programmers/api-variables/variable-escape-html/","title":"\\$escape_html {#variable.escape.html}","text":"

    Setting $escape_html to TRUE will escape all template variable output by wrapping it in htmlspecialchars({$output}, ENT_QUOTES, $char_set);, which is the same as {$variable|escape:\"html\"}.

    Template designers can choose to selectively disable this feature by adding the nofilter flag: {$variable nofilter}.

    Modifiers and Filters are run in the following order: modifier, default_modifier, \\$escape_html, registered variable filters, autoloaded variable filters, template instance\\'s variable filters. Everything except the individual modifier can be disabled with the nofilter flag.

    Note

    This is a compile time option. If you change the setting you must make sure that the templates get recompiled.

    "},{"location":"programmers/api-variables/variable-force-cache/","title":"\\$force_cache {#variable.force.cache}","text":"

    This forces Smarty to (re)cache templates on every invocation. It does not override the $caching level, but merely pretends the template has never been cached before.

    "},{"location":"programmers/api-variables/variable-force-compile/","title":"\\$force_compile {#variable.force.compile}","text":"

    This forces Smarty to (re)compile templates on every invocation. This setting overrides $compile_check. By default this is FALSE. This is handy for development and debugging. It should never be used in a production environment. If $caching is enabled, the cache file(s) will be regenerated every time.

    "},{"location":"programmers/api-variables/variable-left-delimiter/","title":"\\$left_delimiter {#variable.left.delimiter}","text":"

    This is the left delimiter used by the template language. Default is {.

    See also $right_delimiter and escaping smarty parsing .

    "},{"location":"programmers/api-variables/variable-locking-timeout/","title":"\\$locking_timeout {#variable.locking.timeout}","text":"

    This is maximum time in seconds a cache lock is valid to avoid dead locks. The default value is 10 seconds.

    See also $cache_locking

    "},{"location":"programmers/api-variables/variable-merge-compiled-includes/","title":"\\$merge_compiled_includes {#variable.merge.compiled.includes}","text":"

    By setting $merge_compiled_includes to TRUE Smarty will merge the compiled template code of subtemplates into the compiled code of the main template. This increases rendering speed of templates using a many different sub-templates.

    Individual sub-templates can be merged by setting the inline option flag within the {include} tag. $merge_compiled_includes does not have to be enabled for the inline merge.

    ::: {.informalexample}

    <?php\n$smarty->merge_compiled_includes = true;\n?>\n

    :::

    Note

    This is a compile time option. If you change the setting you must make sure that the templates get recompiled.

    See also {include} tag

    "},{"location":"programmers/api-variables/variable-plugins-dir/","title":"\\$plugins_dir {#variable.plugins.dir}","text":"

    This is the directory or directories where Smarty will look for the plugins that it needs. Default is plugins/ under the SMARTY_DIR. If you supply a relative path, Smarty will first look under the SMARTY_DIR, then relative to the current working directory, then relative to the PHP include_path. If $plugins_dir is an array of directories, Smarty will search for your plugin in each plugin directory in the order they are given.

    Note

    For best performance, do not setup your $plugins_dir to have to use the PHP include path. Use an absolute pathname, or a path relative to SMARTY_DIR or the current working directory.

    Note

    As of Smarty 3.1 the attribute \\$plugins_dir is no longer accessible directly. Use getPluginsDir(), setPluginsDir() and addPluginsDir() instead.

    See also getPluginsDir(), setPluginsDir() and addPluginsDir().

    "},{"location":"programmers/api-variables/variable-right-delimiter/","title":"\\$right_delimiter {#variable.right.delimiter}","text":"

    This is the right delimiter used by the template language. Default is }.

    See also $left_delimiter and escaping smarty parsing.

    "},{"location":"programmers/api-variables/variable-smarty-debug-id/","title":"\\$smarty_debug_id {#variable.smarty.debug.id}","text":"

    The value of $smarty_debug_id defines the URL keyword to enable debugging at browser level. The default value is SMARTY_DEBUG.

    See also debugging console section, $debugging and $debugging_ctrl.

    "},{"location":"programmers/api-variables/variable-template-dir/","title":"\\$template_dir {#variable.template.dir}","text":"

    This is the name of the default template directory. If you do not supply a resource type when including files, they will be found here. By default this is ./templates, meaning that Smarty will look for the templates/ directory in the same directory as the executing php script. \\$template_dir can also be an array of directory paths: Smarty will traverse the directories and stop on the first matching template found.

    Note

    It is not recommended to put this directory under the web server document root.

    Note

    If the directories known to $template_dir are relative to directories known to the include_path you need to activate the $use_include_path option.

    Note

    As of Smarty 3.1 the attribute \\$template_dir is no longer accessible directly. Use getTemplateDir(), setTemplateDir() and addTemplateDir() instead.

    See also Template Resources, $use_include_path, getTemplateDir(), setTemplateDir() and addTemplateDir().

    "},{"location":"programmers/api-variables/variable-trusted-dir/","title":"\\$trusted_dir {#variable.trusted.dir}","text":"

    $trusted_dir is only for use when security is enabled. This is an array of all directories that are considered trusted. Trusted directories are where you keep php scripts that are executed directly from the templates with {insert}.

    "},{"location":"programmers/api-variables/variable-use-include-path/","title":"\\$use_include_path {#variable.use.include.path}","text":"

    This tells smarty to respect the include_path within the File Template Resource handler and the plugin loader to resolve the directories known to $template_dir. The flag also makes the plugin loader check the include_path for $plugins_dir.

    Note

    You should not design your applications to rely on the include_path, as this may - depending on your implementation - slow down your system (and Smarty) considerably.

    If use_include_path is enabled, file discovery for $template_dir and $plugins_dir work as follows.

    This means that whenever a directory/file relative to the current working directory is encountered, it is preferred over anything potentially accessible through the include_path.

    Note

    Smarty does not filter elements of the include_path. That means a \\\".:\\\" within your include path will trigger the current working directory lookup twice.

    See also Template Resources and $template_dir

    "},{"location":"programmers/api-variables/variable-use-sub-dirs/","title":"\\$use_sub_dirs {#variable.use.sub.dirs}","text":"

    Smarty will create subdirectories under the compiled templates and cache directories if $use_sub_dirs is set to TRUE, default is FALSE. In an environment where there are potentially tens of thousands of files created, this may help the filesystem speed. On the other hand, some environments do not allow PHP processes to create directories, so this must be disabled which is the default.

    Sub directories are more efficient, so use them if you can. Theoretically you get much better performance on a filesystem with 10 directories each having 100 files, than with 1 directory having 1000 files. This was certainly the case with Solaris 7 (UFS)... with newer filesystems such as ext3 and especially reiserfs, the difference is almost nothing.

    Note

    See also $compile_id, $cache_dir, and $compile_dir.

    "},{"location":"programmers/caching/caching-cacheable/","title":"Controlling Cacheability of Output {#caching.cacheable}","text":"

    If caching is enabled normally the whole final output of the page gets cached. However Smarty3 offers several options how to exclude sections of your output from caching.

    Note

    Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache.

    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-template-section-cacheabilitysections","title":"Cacheability of Template Section {#cacheability.sections}","text":"

    A larger section of your template can easily excluded from caching by using the {nocache} and {/nocache} tags.

    Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n

    The above code will output the current date on a cached page.

    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-tags-cacheabilitytags","title":"Cacheability of Tags {#cacheability.tags}","text":"

    Caching for an individual tag can be disabled by adding the \\\"nocache\\\" option flag to the tag.

    Today's date is\n{$smarty.now|date_format nocache}\n
    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-variables-cacheabilityvariables","title":"Cacheability of Variables {#cacheability.variables}","text":"

    You can assign() variables as not cachable. Any tag which uses such variable will be automatically executed in nocache mode.

    Note

    If a tag is executed in nocache mode you must make sure that all other variables used by that tag are also assigned from PHP when the page is loaded from the cache.

    Note

    The nocache status of an assigned variable will effect the compiled template code. If you change the status you must manually delete existing compiled and cached template files to force a recompile.

    // assign $foo as nocahe variable\n$smarty->assign('foo',time(),true);\n\n\nDynamic time value is {$foo}\n
    "},{"location":"programmers/caching/caching-cacheable/#cacheability-of-plugins-cacheabilityplugins","title":"Cacheability of Plugins {#cacheability.plugins}","text":"

    The cacheability of plugins can be declared when registering them. The third parameter to registerPlugin() is called $cacheable and defaults to TRUE.

    When registering a plugin with $cacheable=false the plugin is called everytime the page is displayed, even if the page comes from the cache. The plugin function behaves a little like an {insert} function.

    Note

    The $cacheable status will effect the compiled template code. If you change the status you must manually delete existing compiled and cached template files to force a recompile.

    In contrast to {insert} the attributes to the plugins are not cached by default. They can be declared to be cached with the fourth parameter $cache_attrs. $cache_attrs is an array of attribute-names that should be cached, so the plugin-function get value as it was the time the page was written to cache everytime it is fetched from the cache.

    <?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nfunction remaining_seconds($params, $smarty) {\n    $remain = $params['endtime'] - time();\n    if($remain >= 0){\n        return $remain . ' second(s)';\n    }else{\n        return 'done';\n    }\n}\n\n$smarty->registerPlugin('function','remaining', 'remaining_seconds', false, array('endtime'));\n\nif (!$smarty->isCached('index.tpl')) {\n    // fetch $obj from db and assign...\n    $smarty->assignByRef('obj', $obj);\n}\n\n$smarty->display('index.tpl');\n?>\n

    where index.tpl is:

    Time Remaining: {remaining endtime=$obj->endtime}\n

    The number of seconds till the endtime of $obj is reached changes on each display of the page, even if the page is cached. Since the endtime attribute is cached the object only has to be pulled from the database when page is written to the cache but not on subsequent requests of the page.

    index.php:\n\n<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nfunction smarty_block_dynamic($param, $content, $smarty) {\n    return $content;\n}\n$smarty->registerPlugin('block','dynamic', 'smarty_block_dynamic', false);\n\n$smarty->display('index.tpl');\n?>\n

    where index.tpl is:

    Page created: {'0'|date_format:'%D %H:%M:%S'}\n\n{dynamic}\n\nNow is: {'0'|date_format:'%D %H:%M:%S'}\n\n... do other stuff ...\n\n{/dynamic}\n

    When reloading the page you will notice that both dates differ. One is \"dynamic\" one is \"static\". You can do everything between {dynamic}...{/dynamic} and be sure it will not be cached like the rest of the page.

    Note

    The above example shall just demonstrate how a dynamic block plugins works. See Cacheability of Template Section on how to disable caching of a template section by the built-in {nocache} and {/nocache} tags.

    "},{"location":"programmers/caching/caching-custom/","title":"Custom Cache Implementation {#caching.custom}","text":"

    As an alternative to using the default file-based caching mechanism, you can specify a custom cache implementation that will be used to read, write and clear cached files.

    Note

    In Smarty2 this used to be a callback function called $cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.

    With a custom cache implementation you\\'re likely trying to achieve at least one of the following goals: replace the slow filesystem by a faster storage engine, centralize the cache to be accessible to multiple servers.

    Smarty allows CacheResource implementations to use one of the APIs Smarty_CacheResource_Custom or Smarty_CacheResource_KeyValueStore. Smarty_CacheResource_Custom is a simple API directing all read, write, clear calls to your implementation. This API allows you to store wherever and however you deem fit. The Smarty_CacheResource_KeyValueStore API allows you to turn any \\\"dumb\\\" KeyValue-Store (like APC, Memcache, ...) into a full-featured CacheResource implementation. That is, everything around deep cache-groups like \\\"a|b|c\\\" is being handled for you in way that allows clearing the cache-group \\\"a\\\" and all nested groups are cleared as well - even though KeyValue-Stores don\\'t allow this kind of hierarchy by nature.

    Custom CacheResources may be put in a file cacheresource.foobarxyz.php within your $plugins_dir, or registered on runtime with registerCacheResource(). In either case you need to set $caching_type to invoke your custom CacheResource implementation.

    <?php\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->caching_type = 'mysql';\n\n/**\n * MySQL CacheResource\n *\n * CacheResource Implementation based on the Custom API to use\n * MySQL as the storage resource for Smarty's output caching.\n *\n * Table definition:\n * <pre>CREATE TABLE IF NOT EXISTS `output_cache` (\n *   `id` CHAR(40) NOT NULL COMMENT 'sha1 hash',\n *   `name` VARCHAR(250) NOT NULL,\n *   `cache_id` VARCHAR(250) NULL DEFAULT NULL,\n *   `compile_id` VARCHAR(250) NULL DEFAULT NULL,\n *   `modified` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,\n *   `content` LONGTEXT NOT NULL,\n *   PRIMARY KEY (`id`),\n *   INDEX(`name`),\n *   INDEX(`cache_id`),\n *   INDEX(`compile_id`),\n *   INDEX(`modified`)\n * ) ENGINE = InnoDB;</pre>\n *\n * @package CacheResource-examples\n * @author Rodney Rehm\n */\nclass Smarty_CacheResource_Mysql extends Smarty_CacheResource_Custom {\n    // PDO instance\n    protected $db;\n    protected $fetch;\n    protected $fetchTimestamp;\n    protected $save;\n\n    public function __construct() {\n        try {\n            $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n        } catch (PDOException $e) {\n            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n        }\n        $this->fetch = $this->db->prepare('SELECT modified, content FROM output_cache WHERE id = :id');\n        $this->fetchTimestamp = $this->db->prepare('SELECT modified FROM output_cache WHERE id = :id');\n        $this->save = $this->db->prepare('REPLACE INTO output_cache (id, name, cache_id, compile_id, content)\n            VALUES  (:id, :name, :cache_id, :compile_id, :content)');\n    }\n\n    /**\n     * fetch cached content and its modification time from data source\n     *\n     * @param string $id unique cache content identifier\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @param string $content cached content\n     * @param integer $mtime cache modification timestamp (epoch)\n     * @return void\n     */\n    protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime)\n    {\n        $this->fetch->execute(array('id' => $id));\n        $row = $this->fetch->fetch();\n        $this->fetch->closeCursor();        \n        if ($row) {\n            $content = $row['content'];\n            $mtime = strtotime($row['modified']);\n        } else {\n            $content = null;\n            $mtime = null;\n        }\n    }\n\n    /**\n     * Fetch cached content's modification timestamp from data source\n     *\n     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the complete cached content.\n     * @param string $id unique cache content identifier\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @return integer|boolean timestamp (epoch) the template was modified, or false if not found\n     */\n    protected function fetchTimestamp($id, $name, $cache_id, $compile_id)\n    {\n        $this->fetchTimestamp->execute(array('id' => $id));\n        $mtime = strtotime($this->fetchTimestamp->fetchColumn());\n        $this->fetchTimestamp->closeCursor();\n        return $mtime;\n    }\n\n    /**\n     * Save content to cache\n     *\n     * @param string $id unique cache content identifier\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @param integer|null $exp_time seconds till expiration time in seconds or null\n     * @param string $content content to cache\n     * @return boolean success\n     */\n    protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content)\n    {\n        $this->save->execute(array(\n            'id' => $id,\n            'name' => $name,\n            'cache_id' => $cache_id,\n            'compile_id' => $compile_id,\n            'content' => $content,\n        ));\n        return !!$this->save->rowCount();\n    }\n\n    /**\n     * Delete content from cache\n     *\n     * @param string $name template name\n     * @param string $cache_id cache id\n     * @param string $compile_id compile id\n     * @param integer|null $exp_time seconds till expiration or null\n     * @return integer number of deleted caches\n     */\n    protected function delete($name, $cache_id, $compile_id, $exp_time)\n    {\n        // delete the whole cache\n        if ($name === null && $cache_id === null && $compile_id === null && $exp_time === null) {\n            // returning the number of deleted caches would require a second query to count them\n            $query = $this->db->query('TRUNCATE TABLE output_cache');\n            return -1;\n        }\n        // build the filter\n        $where = array();\n        // equal test name\n        if ($name !== null) {\n            $where[] = 'name = ' . $this->db->quote($name);\n        }\n        // equal test compile_id\n        if ($compile_id !== null) {\n            $where[] = 'compile_id = ' . $this->db->quote($compile_id);\n        }\n        // range test expiration time\n        if ($exp_time !== null) {\n            $where[] = 'modified < DATE_SUB(NOW(), INTERVAL ' . intval($exp_time) . ' SECOND)';\n        }\n        // equal test cache_id and match sub-groups\n        if ($cache_id !== null) {\n            $where[] = '(cache_id = '. $this->db->quote($cache_id)\n                . ' OR cache_id LIKE '. $this->db->quote($cache_id .'|%') .')';\n        }\n        // run delete query\n        $query = $this->db->query('DELETE FROM output_cache WHERE ' . join(' AND ', $where));\n        return $query->rowCount();\n    }\n}\n\n\n\n\n<?php\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->caching_type = 'memcache';\n\n/**\n * Memcache CacheResource\n *\n * CacheResource Implementation based on the KeyValueStore API to use\n * memcache as the storage resource for Smarty's output caching.\n *\n * Note that memcache has a limitation of 256 characters per cache-key.\n * To avoid complications all cache-keys are translated to a sha1 hash.\n *\n * @package CacheResource-examples\n * @author Rodney Rehm\n */\nclass Smarty_CacheResource_Memcache extends Smarty_CacheResource_KeyValueStore {\n    /**\n     * memcache instance\n     * @var Memcache\n     */\n    protected $memcache = null;\n\n    public function __construct()\n    {\n        $this->memcache = new Memcache();\n        $this->memcache->addServer( '127.0.0.1', 11211 );\n    }\n\n    /**\n     * Read values for a set of keys from cache\n     *\n     * @param array $keys list of keys to fetch\n     * @return array list of values with the given keys used as indexes\n     * @return boolean true on success, false on failure\n     */\n    protected function read(array $keys)\n    {\n        $_keys = $lookup = array();\n        foreach ($keys as $k) {\n            $_k = sha1($k);\n            $_keys[] = $_k;\n            $lookup[$_k] = $k;\n        }\n        $_res = array();\n        $res = $this->memcache->get($_keys);\n        foreach ($res as $k => $v) {\n            $_res[$lookup[$k]] = $v;\n        }\n        return $_res;\n    }\n\n    /**\n     * Save values for a set of keys to cache\n     *\n     * @param array $keys list of values to save\n     * @param int $expire expiration time\n     * @return boolean true on success, false on failure\n     */\n    protected function write(array $keys, $expire=null)\n    {\n        foreach ($keys as $k => $v) {\n            $k = sha1($k);\n            $this->memcache->set($k, $v, 0, $expire);\n        }\n        return true;\n    }\n\n    /**\n     * Remove values from cache\n     *\n     * @param array $keys list of keys to delete\n     * @return boolean true on success, false on failure\n     */\n    protected function delete(array $keys)\n    {\n        foreach ($keys as $k) {\n            $k = sha1($k);\n            $this->memcache->delete($k);\n        }\n        return true;\n    }\n\n    /**\n     * Remove *all* values from cache\n     *\n     * @return boolean true on success, false on failure\n     */\n    protected function purge()\n    {\n        return $this->memcache->flush();\n    }\n}\n
    "},{"location":"programmers/caching/caching-groups/","title":"Cache Groups {#caching.groups}","text":"

    You can do more elaborate grouping by setting up $cache_id groups. This is accomplished by separating each sub-group with a vertical bar | in the $cache_id value. You can have as many sub-groups as you like.

    Cache grouping should not be confused with your template directory hierarchy, the cache grouping has no knowledge of how your templates are structured. So for example, if you have a template structure like themes/blue/index.tpl and you want to be able to clear all the cache files for the \"blue\" theme, you will need to create a cache group structure that mimics your template file structure, such as display('themes/blue/index.tpl','themes|blue'), then clear them with clearCache(null,'themes|blue').

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with 'sports|basketball' as the first two cache_id groups\n$smarty->clearCache(null,'sports|basketball');\n\n// clear all caches with \"sports\" as the first cache_id group. This would\n// include \"sports|basketball\", or \"sports|(anything)|(anything)|(anything)|...\"\n$smarty->clearCache(null,'sports');\n\n// clear the foo.tpl cache file with \"sports|basketball\" as the cache_id\n$smarty->clearCache('foo.tpl','sports|basketball');\n\n\n$smarty->display('index.tpl','sports|basketball');\n?>\n
    "},{"location":"programmers/caching/caching-multiple-caches/","title":"Multiple Caches Per Page {#caching.multiple.caches}","text":"

    You can have multiple cache files for a single call to display() or fetch(). Let\\'s say that a call to display('index.tpl') may have several different output contents depending on some condition, and you want separate caches for each one. You can do this by passing a $cache_id as the second parameter to the function call.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = $_GET['article_id'];\n\n$smarty->display('index.tpl', $my_cache_id);\n?>\n

    Above, we are passing the variable $my_cache_id to display() as the $cache_id. For each unique value of $my_cache_id, a separate cache will be generated for index.tpl. In this example, article_id was passed in the URL and is used as the $cache_id.

    Note

    Be very cautious when passing values from a client (web browser) into Smarty or any PHP application. Although the above example of using the article_id from the URL looks handy, it could have bad consequences. The $cache_id is used to create a directory on the file system, so if the user decided to pass an extremely large value for article_id, or write a script that sends random article_id\\'s at a rapid pace, this could possibly cause problems at the server level. Be sure to sanitize any data passed in before using it. In this instance, maybe you know the article_id has a length of ten characters and is made up of alpha-numerics only, and must be a valid article_id in the database. Check for this!

    Be sure to pass the same $cache_id as the second parameter to isCached() and clearCache().

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = $_GET['article_id'];\n\nif(!$smarty->isCached('index.tpl',$my_cache_id)) {\n    // No cache available, do variable assignments here.\n    $contents = get_database_contents();\n    $smarty->assign($contents);\n}\n\n$smarty->display('index.tpl',$my_cache_id);\n?>\n

    You can clear all caches for a particular $cache_id by passing NULL as the first parameter to clearCache().

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with \"sports\" as the $cache_id\n$smarty->clearCache(null,'sports');\n\n$smarty->display('index.tpl','sports');\n?>\n

    In this manner, you can \"group\" your caches together by giving them the same $cache_id.

    "},{"location":"programmers/caching/caching-setting-up/","title":"Setting Up Caching {#caching.setting.up}","text":"

    The first thing to do is enable caching by setting $caching to one of Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n// uses the value of $smarty->cacheLifetime() to determine\n// the number of seconds a cache is good for\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$smarty->display('index.tpl');\n?>\n

    With caching enabled, the function call to display('index.tpl') will render the template as usual, but also saves a copy of its output to a file (a cached copy) in the $cache_dir. On the next call to display('index.tpl'), the cached copy will be used instead of rendering the template again.

    Note

    The files in the $cache_dir are named similar to the template name. Although they end in the .php extension, they are not intended to be directly executable. Do not edit these files!

    Each cached page has a limited lifetime determined by $cache_lifetime. The default value is 3600 seconds, or one hour. After that time expires, the cache is regenerated. It is possible to give individual caches their own expiration time by setting $caching to Smarty::CACHING_LIFETIME_SAVED. See $cache_lifetime for more details.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n// retain current cache lifetime for each specific display call\n$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// set the cache_lifetime for index.tpl to 5 minutes\n$smarty->setCacheLifetime(300);\n$smarty->display('index.tpl');\n\n// set the cache_lifetime for home.tpl to 1 hour\n$smarty->setCacheLifetime(3600);\n$smarty->display('home.tpl');\n\n// NOTE: the following $cache_lifetime setting will not work when $caching\n// is set to Smarty::CACHING_LIFETIME_SAVED.\n// The cache lifetime for home.tpl has already been set\n// to 1 hour, and will no longer respect the value of $cache_lifetime.\n// The home.tpl cache will still expire after 1 hour.\n$smarty->setCacheLifetime(30); // 30 seconds\n$smarty->display('home.tpl');\n?>\n

    If $compile_check is enabled (default), every template file and config file that is involved with the cache file is checked for modification. If any of the files have been modified since the cache was generated, the cache is immediately regenerated. This is a computational overhead, so for optimum performance set $compile_check to FALSE.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n$smarty->setCompileCheck(false);\n\n$smarty->display('index.tpl');\n?>\n

    If $force_compile is enabled, the cache files will always be regenerated. This effectively disables caching, however this also seriously degrades performance. $force_compile is meant to be used for debugging purposes. The appropriate way to disable caching is to set $caching to Smarty::CACHING_OFF.

    The isCached() function can be used to test if a template has a valid cache or not. If you have a cached template that requires something like a database fetch, you can use this to skip that process.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl')) {\n    // No cache available, do variable assignments here.\n    $contents = get_database_contents();\n    $smarty->assign($contents);\n}\n\n$smarty->display('index.tpl');\n?>\n

    You can keep parts of a page dynamic (disable caching) with the {nocache}{/nocache} block function, the {insert} function, or by using the nocache parameter for most template functions.

    Let\\'s say the whole page can be cached except for a banner that is displayed down the side of the page. By using the {insert} function for the banner, you can keep this element dynamic within the cached content. See the documentation on {insert} for more details and examples.

    You can clear all the cache files with the clearAllCache() function, or individual cache files and groups with the clearCache() function.

    <?php\nrequire('Smarty.class.php');\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear only cache for index.tpl\n$smarty->clearCache('index.tpl');\n\n// clear out all cache files\n$smarty->clearAllCache();\n\n$smarty->display('index.tpl');\n?>\n
    "},{"location":"programmers/plugins/plugins-block-functions/","title":"Block Functions {#plugins.block.functions}","text":"

    void

    smarty_block_

    name

    array

    \\$params

    mixed

    \\$content

    object

    \\$template

    boolean

    &\\$repeat

    Block functions are functions of the form: {func} .. {/func}. In other words, they enclose a template block and operate on the contents of this block. Block functions take precedence over custom functions of the same name, that is, you cannot have both custom function {func} and block function {func}..{/func}.

    If you have nested block functions, it\\'s possible to find out what the parent block function is by accessing $smarty->_tag_stack variable. Just do a var_dump() on it and the structure should be apparent.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     block.translate.php\n * Type:     block\n * Name:     translate\n * Purpose:  translate a block of text\n * -------------------------------------------------------------\n */\nfunction smarty_block_translate($params, $content, Smarty_Internal_Template $template, &$repeat)\n{\n    // only output on the closing tag\n    if(!$repeat){\n        if (isset($content)) {\n            $lang = $params['lang'];\n            // do some intelligent translation thing here with $content\n            return $translation;\n        }\n    }\n}\n?>\n

    See also: registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-compiler-functions/","title":"Compiler Functions {#plugins.compiler.functions}","text":"

    Compiler functions are called only during compilation of the template. They are useful for injecting PHP code or time-sensitive static content into the template. If there is both a compiler function and a custom function registered under the same name, the compiler function has precedence.

    mixed

    smarty_compiler_

    name

    array

    \\$params

    object

    \\$smarty

    The compiler function is passed two parameters: the params array which contains precompiled strings for the attribute values and the Smarty object. It\\'s supposed to return the code to be injected into the compiled template including the surrounding PHP tags.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     compiler.tplheader.php\n * Type:     compiler\n * Name:     tplheader\n * Purpose:  Output header containing the source file name and\n *           the time it was compiled.\n * -------------------------------------------------------------\n */\nfunction smarty_compiler_tplheader($params, Smarty $smarty)\n{\n    return \"<?php\\necho '\" . $smarty->_current_file . \" compiled at \" . date('Y-m-d H:M'). \"';\\n?>\";\n}\n?>\n

    This function can be called from the template as:

    {* this function gets executed at compile time only *}\n{tplheader}\n

    The resulting PHP code in the compiled template would be something like this:

    <?php\necho 'index.tpl compiled at 2002-02-20 20:02';\n?>\n

    See also registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-functions/","title":"Template Functions {#plugins.functions}","text":"

    void

    smarty_function_

    name

    array

    \\$params

    object

    \\$template

    All attributes passed to template functions from the template are contained in the $params as an associative array.

    The output (return value) of the function will be substituted in place of the function tag in the template, eg the {fetch} function. Alternatively, the function can simply perform some other task without any output, eg the {assign} function.

    If the function needs to assign some variables to the template or use some other Smarty-provided functionality, it can use the supplied $template object to do so eg $template->foo().

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     function.eightball.php\n * Type:     function\n * Name:     eightball\n * Purpose:  outputs a random magic answer\n * -------------------------------------------------------------\n */\nfunction smarty_function_eightball($params, Smarty_Internal_Template $template)\n{\n    $answers = array('Yes',\n                     'No',\n                     'No way',\n                     'Outlook not so good',\n                     'Ask again soon',\n                     'Maybe in your reality');\n\n    $result = array_rand($answers);\n    return $answers[$result];\n}\n?>\n

    which can be used in the template as:

    Question: Will we ever have time travel?\nAnswer: {eightball}.\n\n\n\n<?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     function.assign.php\n * Type:     function\n * Name:     assign\n * Purpose:  assign a value to a template variable\n * -------------------------------------------------------------\n */\nfunction smarty_function_assign($params, Smarty_Internal_Template $template)\n{\n    if (empty($params['var'])) {\n        trigger_error(\"assign: missing 'var' parameter\");\n        return;\n    }\n\n    if (!in_array('value', array_keys($params))) {\n        trigger_error(\"assign: missing 'value' parameter\");\n        return;\n    }\n\n    $template->assign($params['var'], $params['value']);\n\n}\n?>\n

    See also: registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-howto/","title":"How Plugins Work {#plugins.howto}","text":"

    Plugins are always loaded on demand. Only the specific modifiers, functions, resources, etc invoked in the templates scripts will be loaded. Moreover, each plugin is loaded only once, even if you have several different instances of Smarty running within the same request.

    Pre/postfilters and output filters are a bit of a special case. Since they are not mentioned in the templates, they must be registered or loaded explicitly via API functions before the template is processed. The order in which multiple filters of the same type are executed depends on the order in which they are registered or loaded.

    The plugins directory can be a string containing a path or an array containing multiple paths. To install a plugin, simply place it in one of the directories and Smarty will use it automatically.

    "},{"location":"programmers/plugins/plugins-inserts/","title":"Inserts {#plugins.inserts}","text":"

    Insert plugins are used to implement functions that are invoked by {insert} tags in the template.

    string

    smarty_insert_

    name

    array

    \\$params

    object

    \\$template

    The first parameter to the function is an associative array of attributes passed to the insert.

    The insert function is supposed to return the result which will be substituted in place of the {insert} tag in the template.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     insert.time.php\n * Type:     time\n * Name:     time\n * Purpose:  Inserts current date/time according to format\n * -------------------------------------------------------------\n */\nfunction smarty_insert_time($params, Smarty_Internal_Template $template)\n{\n    if (empty($params['format'])) {\n        trigger_error(\"insert time: missing 'format' parameter\");\n        return;\n    }\n    return strftime($params['format']);\n}\n?>\n
    "},{"location":"programmers/plugins/plugins-modifiers/","title":"Modifiers {#plugins.modifiers}","text":"

    Modifiers are little functions that are applied to a variable in the template before it is displayed or used in some other context. Modifiers can be chained together.

    mixed

    smarty_modifier_

    name

    mixed

    \\$value

    [mixed

    \\$param1

    , ...]

    The first parameter to the modifier plugin is the value on which the modifier is to operate. The rest of the parameters are optional, depending on what kind of operation is to be performed.

    The modifier has to return the result of its processing.

    This plugin basically aliases one of the built-in PHP functions. It does not have any additional parameters.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     modifier.capitalize.php\n * Type:     modifier\n * Name:     capitalize\n * Purpose:  capitalize words in the string\n * -------------------------------------------------------------\n */\nfunction smarty_modifier_capitalize($string)\n{\n    return ucwords($string);\n}\n?>\n\n\n<?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     modifier.truncate.php\n * Type:     modifier\n * Name:     truncate\n * Purpose:  Truncate a string to a certain length if necessary,\n *           optionally splitting in the middle of a word, and\n *           appending the $etc string.\n * -------------------------------------------------------------\n */\nfunction smarty_modifier_truncate($string, $length = 80, $etc = '...',\n                                  $break_words = false)\n{\n    if ($length == 0)\n        return '';\n\n    if (strlen($string) > $length) {\n        $length -= strlen($etc);\n        $fragment = substr($string, 0, $length+1);\n        if ($break_words)\n            $fragment = substr($fragment, 0, -1);\n        else\n            $fragment = preg_replace('/\\s+(\\S+)?$/', '', $fragment);\n        return $fragment.$etc;\n    } else\n        return $string;\n}\n?>\n

    See also registerPlugin(), unregisterPlugin().

    "},{"location":"programmers/plugins/plugins-naming-conventions/","title":"Naming Conventions {#plugins.naming.conventions}","text":"

    Plugin files and functions must follow a very specific naming convention in order to be located by Smarty.

    plugin files must be named as follows:

    type.name.php

    plugin functions inside the PHP files must be named as follows:

    smarty_type_name

    Smarty will output appropriate error messages if the plugin file it needs is not found, or if the file or the plugin function are named improperly.

    "},{"location":"programmers/plugins/plugins-outputfilters/","title":"Output Filters {#plugins.outputfilters}","text":"

    Output filter plugins operate on a template\\'s output, after the template is loaded and executed, but before the output is displayed.

    string

    smarty_outputfilter_

    name

    string

    \\$template_output

    object

    \\$template

    The first parameter to the output filter function is the template output that needs to be processed, and the second parameter is the instance of Smarty invoking the plugin. The plugin is supposed to do the processing and return the results.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     outputfilter.protect_email.php\n * Type:     outputfilter\n * Name:     protect_email\n * Purpose:  Converts @ sign in email addresses to %40 as\n *           a simple protection against spambots\n * -------------------------------------------------------------\n */\n function smarty_outputfilter_protect_email($output, Smarty_Internal_Template $template)\n {\n     return preg_replace('!(\\S+)@([a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',\n                         '$1%40$2', $output);\n }\n?>\n

    See also registerFilter(), unregisterFilter().

    "},{"location":"programmers/plugins/plugins-prefilters-postfilters/","title":"Prefilters/Postfilters {#plugins.prefilters.postfilters}","text":"

    Prefilter and postfilter plugins are very similar in concept; where they differ is in the execution -- more precisely the time of their execution.

    string

    smarty_prefilter_

    name

    string

    \\$source

    object

    \\$template

    Prefilters are used to process the source of the template immediately before compilation. The first parameter to the prefilter function is the template source, possibly modified by some other prefilters. The plugin is supposed to return the modified source. Note that this source is not saved anywhere, it is only used for compilation.

    string

    smarty_postfilter_

    name

    string

    \\$compiled

    object

    \\$template

    Postfilters are used to process the compiled output of the template (the PHP code) immediately after the compilation is done but before the compiled template is saved to the filesystem. The first parameter to the postfilter function is the compiled template code, possibly modified by other postfilters. The plugin is supposed to return the modified version of this code.

    <?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     prefilter.pre01.php\n * Type:     prefilter\n * Name:     pre01\n * Purpose:  Convert html tags to be lowercase.\n * -------------------------------------------------------------\n */\n function smarty_prefilter_pre01($source, Smarty_Internal_Template $template)\n {\n     return preg_replace('!<(\\w+)[^>]+>!e', 'strtolower(\"$1\")', $source);\n }\n?>\n\n\n\n\n<?php\n/*\n * Smarty plugin\n * -------------------------------------------------------------\n * File:     postfilter.post01.php\n * Type:     postfilter\n * Name:     post01\n * Purpose:  Output code that lists all current template vars.\n * -------------------------------------------------------------\n */\n function smarty_postfilter_post01($compiled, Smarty_Internal_Template $template)\n {\n     $compiled = \"<pre>\\n<?php print_r(\\$template->getTemplateVars()); ?>\\n</pre>\" . $compiled;\n     return $compiled;\n }\n?>\n

    See also registerFilter() and unregisterFilter().

    "},{"location":"programmers/plugins/plugins-resources/","title":"Resources {#plugins.resources}","text":"

    Resource plugins are meant as a generic way of providing template sources or PHP script components to Smarty. Some examples of resources: databases, LDAP, shared memory, sockets, and so on.

    Custom Resources may be put in a file resource.foobarxyz.php within your $plugins_dir, or registered on runtime with registerResource(). In either case you will be able to access that resource by prepending its name to the template you\\'re addressing: foobarxyz:yourtemplate.tpl.

    If a Resource\\'s templates should not be run through the Smarty compiler, the Custom Resource may extend Smarty_Resource_Uncompiled. The Resource Handler must then implement the function renderUncompiled(Smarty_Internal_Template $_template). $_template is a reference to the current template and contains all assigned variables which the implementor can access via $_template->smarty->getTemplateVars(). These Resources simply echo their rendered content to the output stream. The rendered output will be output-cached if the Smarty instance was configured accordingly. See libs/sysplugins/smarty_internal_resource_php.php for an example.

    If the Resource\\'s compiled templates should not be cached on disk, the Custom Resource may extend Smarty_Resource_Recompiled. These Resources are compiled every time they are accessed. This may be an expensive overhead. See libs/sysplugins/smarty_internal_resource_eval.php for an example.

    <?php\n\n/**\n * MySQL Resource\n *\n * Resource Implementation based on the Custom API to use\n * MySQL as the storage resource for Smarty's templates and configs.\n *\n * Table definition:\n * <pre>CREATE TABLE IF NOT EXISTS `templates` (\n *   `name` varchar(100) NOT NULL,\n *   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\n *   `source` text,\n *   PRIMARY KEY (`name`)\n * ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>\n *\n * Demo data:\n * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', \"2010-12-25 22:00:00\", '{$x=\"hello world\"}{$x}');</pre>\n *\n * @package Resource-examples\n * @author Rodney Rehm\n */\nclass Smarty_Resource_Mysql extends Smarty_Resource_Custom {\n    // PDO instance\n    protected $db;\n    // prepared fetch() statement\n    protected $fetch;\n    // prepared fetchTimestamp() statement\n    protected $mtime;\n\n    public function __construct() {\n        try {\n            $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n        } catch (PDOException $e) {\n            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n        }\n        $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');\n        $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');\n    }\n\n    /**\n     * Fetch a template and its modification time from database\n     *\n     * @param string $name template name\n     * @param string $source template source\n     * @param integer $mtime template modification timestamp (epoch)\n     * @return void\n     */\n    protected function fetch($name, &$source, &$mtime)\n    {\n        $this->fetch->execute(array('name' => $name));\n        $row = $this->fetch->fetch();\n        $this->fetch->closeCursor();\n        if ($row) {\n            $source = $row['source'];\n            $mtime = strtotime($row['modified']);\n        } else {\n            $source = null;\n            $mtime = null;\n        }\n    }\n\n    /**\n     * Fetch a template's modification time from database\n     *\n     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the comple template source.\n     * @param string $name template name\n     * @return integer timestamp (epoch) the template was modified\n     */\n    protected function fetchTimestamp($name) {\n        $this->mtime->execute(array('name' => $name));\n        $mtime = $this->mtime->fetchColumn();\n        $this->mtime->closeCursor();\n        return strtotime($mtime);\n    }\n}\n\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n\n// using resource from php script\n$smarty->display(\"mysql:index.tpl\");\n?>\n

    And from within Smarty template:

    {include file='mysql:extras/navigation.tpl'}\n

    See also registerResource(), unregisterResource().

    "},{"location":"programmers/plugins/plugins-writing/","title":"Writing Plugins {#plugins.writing}","text":"

    Plugins can be either loaded by Smarty automatically from the filesystem or they can be registered at runtime via one of the register_* API functions. They can also be unregistered by using unregister_* API functions.

    For the plugins that are registered at runtime, the name of the plugin function(s) does not have to follow the naming convention.

    If a plugin depends on some functionality provided by another plugin (as is the case with some plugins bundled with Smarty), then the proper way to load the needed plugin is this:

    <?php\nfunction smarty_function_yourPlugin(array $params, Smarty_Internal_Template $template)\n{\n  // load plugin depended upon\n  $template->smarty->loadPlugin('smarty_shared_make_timestamp');\n  // plugin code\n}\n?>\n

    As a general rule, the currently evaluated template\\'s Smarty_Internal_Template object is always passed to the plugins as the last parameter with two exceptions:

    "},{"location":"programmers/resources/resources-custom/","title":"Custom Template Resources {#resources.custom}","text":"

    You can retrieve templates using whatever possible source you can access with PHP: databases, sockets, files, etc. You do this by writing resource plugin functions and registering them with Smarty.

    See resource plugins section for more information on the functions you are supposed to provide.

    Note

    Note that you cannot override the built-in file: resource, but you can provide a resource that fetches templates from the file system in some other way by registering under another resource name.

    <?php\n\n/**\n* MySQL Resource\n*\n* Resource Implementation based on the Custom API to use\n* MySQL as the storage resource for Smarty's templates and configs.\n*\n* Table definition:\n* <pre>CREATE TABLE IF NOT EXISTS `templates` (\n*   `name` varchar(100) NOT NULL,\n*   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\n*   `source` text,\n*   PRIMARY KEY (`name`)\n* ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>\n*\n* Demo data:\n* <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', \"2010-12-25 22:00:00\", '{$x=\"hello world\"}{$x}');</pre>\n*\n* @package Resource-examples\n* @author Rodney Rehm\n*/\nclass Smarty_Resource_Mysql extends Smarty_Resource_Custom {\n // PDO instance\n protected $db;\n // prepared fetch() statement\n protected $fetch;\n // prepared fetchTimestamp() statement\n protected $mtime;\n\n public function __construct() {\n     try {\n         $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n     } catch (PDOException $e) {\n         throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n     }\n     $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');\n     $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');\n }\n\n /**\n  * Fetch a template and its modification time from database\n  *\n  * @param string $name template name\n  * @param string $source template source\n  * @param integer $mtime template modification timestamp (epoch)\n  * @return void\n  */\n protected function fetch($name, &$source, &$mtime)\n {\n     $this->fetch->execute(array('name' => $name));\n     $row = $this->fetch->fetch();\n     $this->fetch->closeCursor();\n     if ($row) {\n         $source = $row['source'];\n         $mtime = strtotime($row['modified']);\n     } else {\n         $source = null;\n         $mtime = null;\n     }\n }\n\n /**\n  * Fetch a template's modification time from database\n  *\n  * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the comple template source.\n  * @param string $name template name\n  * @return integer timestamp (epoch) the template was modified\n  */\n protected function fetchTimestamp($name) {\n     $this->mtime->execute(array('name' => $name));\n     $mtime = $this->mtime->fetchColumn();\n     $this->mtime->closeCursor();\n     return strtotime($mtime);\n }\n}\n\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n\n// using resource from php script\n$smarty->display(\"mysql:index.tpl\");\n?>\n

    And from within Smarty template:

    {include file='mysql:extras/navigation.tpl'}\n
    "},{"location":"programmers/resources/resources-extends/","title":"Extends Template Resources {#resources.extends}","text":"

    The extends: resource is used to define child/parent relationships for template inheritance from the PHP script. For details see section of Template Inheritance.

    As of Smarty 3.1 the extends: resource may use any available template resource, including string: and eval:. When templates from strings are used, make sure they are properly (url or base64) encoded. Is an eval: resource found within an inheritance chain, its \\\"don\\'t save a compile file\\\" property is superseded by the extends: resource. The templates within an inheritance chain are not compiled separately, though. Only a single compiled template will be generated.

    Note

    Use this when inheritance is required programmatically. When inheriting within PHP, it is not obvious from the child template what inheritance took place. If you have a choice, it is normally more flexible and intuitive to handle inheritance chains from within the templates.

    <?php\n$smarty->display('extends:parent.tpl|child.tpl|grandchild.tpl');\n\n// inheritance from multiple template sources\n$smarty->display('extends:db:parent.tpl|file:child.tpl|grandchild.tpl|eval:{block name=\"fooBazVar_\"}hello world{/block}'); \n?>\n

    See also Template Inheritance {block} and {extends}.

    "},{"location":"programmers/resources/resources-file/","title":"File Template Resources {#resources.file}","text":"

    Smarty ships with a built-in template resource for the filesystem. The file: is the default resource. The resource key file: must only be specified, if the $default_resource_type has been changed.

    If the file resource cannot find the requested template, the $default_template_handler_func is invoked.

    Note

    As of Smarty 3.1 the file resource no longer walks through the include_path unless $use_include_path is activated

    "},{"location":"programmers/resources/resources-file/#templates-from-template_dir-templatesfromtemplatedir","title":"Templates from \\$template_dir {#templates.from.template.dir}","text":"

    The file resource pulls templates source files from the directories specified in $template_dir. The list of directories is traversed in the order they appear in the array. The first template found is the one to process.

    <?php\n$smarty->display('index.tpl');\n$smarty->display('file:index.tpl'); // same as above\n?>\n

    From within a Smarty template

    {include file='index.tpl'}\n{include file='file:index.tpl'} {* same as above *}\n
    "},{"location":"programmers/resources/resources-file/#templates-from-a-specific-template_dir-templatesfromspecifiedtemplatedir","title":"Templates from a specific \\$template_dir {#templates.from.specified.template.dir}","text":"

    Smarty 3.1 introduced the bracket-syntax for specifying an element from $template_dir. This allows websites employing multiple sets of templates better control over which template to access.

    The bracket-syntax can be used from anywhere you can specify the file: resource type.

    <?php\n\n// setup template directories\n$smarty->setTemplateDir(array(\n    './templates',            // element: 0, index: 0\n    './templates_2',          // element: 1, index: 1\n    '10' => 'templates_10',   // element: 2, index: '10'\n    'foo' => 'templates_foo', // element: 3, index: 'foo'\n));\n\n/*\n  assume the template structure\n  ./templates/foo.tpl\n  ./templates_2/foo.tpl\n  ./templates_2/bar.tpl\n  ./templates_10/foo.tpl\n  ./templates_10/bar.tpl\n  ./templates_foo/foo.tpl\n*/\n\n// regular access\n$smarty->display('file:foo.tpl'); \n// will load ./templates/foo.tpl\n\n// using numeric index\n$smarty->display('file:[1]foo.tpl'); \n// will load ./templates_2/foo.tpl\n\n// using numeric string index\n$smarty->display('file:[10]foo.tpl'); \n// will load ./templates_10/foo.tpl\n\n// using string index\n$smarty->display('file:[foo]foo.tpl'); \n// will load ./templates_foo/foo.tpl\n\n// using \"unknown\" numeric index (using element number)\n$smarty->display('file:[2]foo.tpl'); \n// will load ./templates_10/foo.tpl\n\n?>\n

    From within a Smarty template

    {include file=\"file:foo.tpl\"}\n{* will load ./templates/foo.tpl *}\n\n{include file=\"file:[1]foo.tpl\"}\n{* will load ./templates_2/foo.tpl *}\n\n{include file=\"file:[foo]foo.tpl\"}\n{* will load ./templates_foo/foo.tpl *}\n
    "},{"location":"programmers/resources/resources-file/#templates-from-any-directory-templatesfromanydir","title":"Templates from any directory {#templates.from.any.dir}","text":"

    Templates outside of the $template_dir require the file: template resource type, followed by the absolute path to the template (with leading slash.)

    Note

    With Security enabled, access to templates outside of the $template_dir is not allowed unless you list those directories in $secure_dir.

    <?php\n$smarty->display('file:/export/templates/index.tpl');\n$smarty->display('file:/path/to/my/templates/menu.tpl');\n?>\n

    And from within a Smarty template:

    {include file='file:/usr/local/share/templates/navigation.tpl'}\n
    "},{"location":"programmers/resources/resources-file/#windows-filepaths-templateswindowsfilepath","title":"Windows Filepaths {#templates.windows.filepath}","text":"

    If you are using a Windows machine, filepaths usually include a drive letter (C:) at the beginning of the pathname. Be sure to use file: in the path to avoid namespace conflicts and get the desired results.

    <?php\n$smarty->display('file:C:/export/templates/index.tpl');\n$smarty->display('file:F:/path/to/my/templates/menu.tpl');\n?>\n

    And from within Smarty template:

    {include file='file:D:/usr/local/share/templates/navigation.tpl'}\n
    "},{"location":"programmers/resources/resources-streams/","title":"Stream Template Resources {#resources.streams}","text":"

    Streams allow you to use PHP streams as a template resource. The syntax is much the same a traditional template resource names.

    Smarty will first look for a registered template resource. If nothing is found, it will check if a PHP stream is available. If a stream is available, Smarty will use it to fetch the template.

    Note

    You can further define allowed streams with security enabled.

    Using a PHP stream for a template resource from the display() function.

     $smarty->display('foo:bar.tpl');\n

    Using a PHP stream for a template resource from within a template.

     {include file=\"foo:bar.tpl\"}\n
    "},{"location":"programmers/resources/resources-string/","title":"String Template Resources {#resources.string}","text":"

    Smarty can render templates from a string by using the string: or eval: resource.

    Note

    With a string: resource type, each unique string generates a compiled file. Smarty cannot detect a string that has changed, and therefore will generate a new compiled file for each unique string. It is important to choose the correct resource so that you do not fill your disk space with wasted compiled strings.

    <?php\n$smarty->assign('foo','value');\n$template_string = 'display {$foo} here';\n$smarty->display('string:'.$template_string); // compiles for later reuse\n$smarty->display('eval:'.$template_string); // compiles every time\n?>\n

    From within a Smarty template

    {include file=\"string:$template_string\"} {* compiles for later reuse *}\n{include file=\"eval:$template_string\"} {* compiles every time *}\n

    Both string: and eval: resources may be encoded with urlencode() or base64_encode(). This is not necessary for the usual use of string: and eval:, but is required when using either of them in conjunction with Extends Template Resource

     <?php\n $smarty->assign('foo','value');\n $template_string_urlencode = urlencode('display {$foo} here');\n $template_string_base64 = base64_encode('display {$foo} here');\n $smarty->display('eval:urlencode:'.$template_string_urlencode); // will decode string using urldecode()\n $smarty->display('eval:base64:'.$template_string_base64); // will decode string using base64_decode()\n ?>\n

    From within a Smarty template

     {include file=\"string:urlencode:$template_string_urlencode\"} {* will decode string using urldecode() *}\n {include file=\"eval:base64:$template_string_base64\"} {* will decode string using base64_decode() *}\n
    "},{"location":"programmers/resources/template-resources/","title":"Resources {#resasdources}","text":"

    The templates may come from a variety of sources. When you display() or fetch() a template, or when you include a template from within another template, you supply a resource type, followed by the appropriate path and template name. If a resource is not explicitly given, the value of $default_resource_type is assumed.

    "},{"location":"programmers/resources/template-resources/#templates-from-other-sources-templatesfromelsewhere","title":"Templates from other sources {#templates.from.elsewhere}","text":"

    You can retrieve templates using whatever possible source you can access with PHP: databases, sockets, files, etc. You do this by writing resource plugin functions and registering them with Smarty.

    See resource plugins section for more information on the functions you are supposed to provide.

    Note

    Note that you cannot override the built-in file: resource, but you can provide a resource that fetches templates from the file system in some other way by registering under another resource name.

    <?php\n\n/**\n * MySQL Resource\n *\n * Resource Implementation based on the Custom API to use\n * MySQL as the storage resource for Smarty's templates and configs.\n *\n * Table definition:\n * <pre>CREATE TABLE IF NOT EXISTS `templates` (\n *   `name` varchar(100) NOT NULL,\n *   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,\n *   `source` text,\n *   PRIMARY KEY (`name`)\n * ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>\n *\n * Demo data:\n * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', \"2010-12-25 22:00:00\", '{$x=\"hello world\"}{$x}');</pre>\n *\n * @package Resource-examples\n * @author Rodney Rehm\n */\nclass Smarty_Resource_Mysql extends Smarty_Resource_Custom {\n    // PDO instance\n    protected $db;\n    // prepared fetch() statement\n    protected $fetch;\n    // prepared fetchTimestamp() statement\n    protected $mtime;\n\n    public function __construct() {\n        try {\n            $this->db = new PDO(\"mysql:dbname=test;host=127.0.0.1\", \"smarty\", \"smarty\");\n        } catch (PDOException $e) {\n            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());\n        }\n        $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');\n        $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');\n    }\n\n    /**\n     * Fetch a template and its modification time from database\n     *\n     * @param string $name template name\n     * @param string $source template source\n     * @param integer $mtime template modification timestamp (epoch)\n     * @return void\n     */\n    protected function fetch($name, &$source, &$mtime)\n    {\n        $this->fetch->execute(array('name' => $name));\n        $row = $this->fetch->fetch();\n        $this->fetch->closeCursor();\n        if ($row) {\n            $source = $row['source'];\n            $mtime = strtotime($row['modified']);\n        } else {\n            $source = null;\n            $mtime = null;\n        }\n    }\n\n    /**\n     * Fetch a template's modification time from database\n     *\n     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than loading the comple template source.\n     * @param string $name template name\n     * @return integer timestamp (epoch) the template was modified\n     */\n    protected function fetchTimestamp($name) {\n        $this->mtime->execute(array('name' => $name));\n        $mtime = $this->mtime->fetchColumn();\n        $this->mtime->closeCursor();\n        return strtotime($mtime);\n    }\n}\n\n\nrequire_once 'libs/Smarty.class.php';\n$smarty = new Smarty();\n$smarty->registerResource('mysql', new Smarty_Resource_Mysql());\n\n// using resource from php script\n$smarty->display(\"mysql:index.tpl\");\n?>\n

    And from within Smarty template:

    {include file='mysql:extras/navigation.tpl'}\n
    "},{"location":"programmers/resources/template-resources/#default-template-handler-function-defaulttemplatehandlerfunction","title":"Default template handler function {#default.template.handler.function}","text":"

    You can specify a function that is used to retrieve template contents in the event the template cannot be retrieved from its resource. One use of this is to create templates that do not exist on-the-fly.

    See also Streams

    "}]} \ No newline at end of file diff --git a/4.x/sitemap.xml.gz b/4.x/sitemap.xml.gz index 670bc97d..23c81b9b 100644 Binary files a/4.x/sitemap.xml.gz and b/4.x/sitemap.xml.gz differ diff --git a/4.x/upgrading/index.html b/4.x/upgrading/index.html new file mode 100644 index 00000000..6fd614a3 --- /dev/null +++ b/4.x/upgrading/index.html @@ -0,0 +1,2829 @@ + + + + + + + + + + + + + + + + + + + + + + + Upgrading from an older version - Smarty Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + + + + + + +
    + +
    + + + + +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Upgrading from an older version

    +

    Upgrading from v3 to v4

    +

    Smarty 4 is mostly identical to Smarty 3. Most notably, it adds support for PHP8 and drops support for PHP7.0 and below. +Additionally, some deprecated features that have long been discouraged have been dropped from the language.

    +

    Muting PHP8 warnings

    +

    If you simultaneously upgrade Smarty to v4 van PHP to v8, you may notice your error logs filling up with warnings about undefined or null template vars +due to a change in how PHP handles these. This may be helpful to spot errors, but if you find this annoying, you can use +$smarty->muteUndefinedOrNullWarnings() to make Smarty convert these warnings into notices.

    +

    ASP tags

    +

    You can no longer user ASP-style tags like <% %> and <%= %> in your templates. +Replace them with {...} tags.

    +

    SmartyBC

    +

    Check your codebase for SmartyBC. +We have dropped deprecated API calls that where only accessible through the SmartyBC class.

    +

    No more embedded PHP

    +

    We have completely dropped support for {php} and {include_php} tags and embedded PHP in templates. +Check your templates for this, and rewrite any embedded PHP blocks, by moving logic to your PHP files or by +creating a plugin function.

    +

    Other changes

    +

    Search your code for the following changes:

    +
      +
    • SMARTY_RESOURCE_CHAR_SET and SMARTY_RESOURCE_DATE_FORMAT constants have been removed
      • +
    • Smarty::muteExpectedErrors and Smarty::unmuteExpectedErrors API methods have been removed
      • +
    • Smarty::getVariable method has been removed. Use Smarty::getTemplateVars instead.
      • +
    • Smarty::registerResource no longer accepts an array of callback functions
      • +
    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file