@@ -3870,7 +3870,7 @@ variable modifier.Note
"Undefined variable" errors will show an E_NOTICE if not disabled in -PHP\'s
error_reporting()level or +PHP\'serror_reporting()level or Smarty\'s$error_reportingproperty and a variable had not been assigned to Smarty.
As a rule of thumb, always pass dates to Smarty as
-timestamps. This allows template designers to
+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.
$errno as it should. If, for
whatever reason, this is the desired behaviour of your custom error
handler, please call
diff --git a/4.3/designers/language-basic-syntax/language-syntax-quotes/index.html b/4.3/designers/language-basic-syntax/language-syntax-quotes/index.html
index 80eb3a8d..0706a898 100644
--- a/4.3/designers/language-basic-syntax/language-syntax-quotes/index.html
+++ b/4.3/designers/language-basic-syntax/language-syntax-quotes/index.html
@@ -3799,7 +3799,7 @@
Smarty will recognize assigned variables embedded in \"double quotes\" so long as the variable name contains only numbers, letters - and under_scores. See naming + and under_scores. See naming for more detail.
Template variables start with the \$dollar sign. They can contain -numbers, letters and underscores, much like a PHP +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.
diff --git a/4.3/designers/language-builtin-functions/language-function-if/index.html b/4.3/designers/language-builtin-functions/language-function-if/index.html index a54fae45..3cc6ffba 100644 --- a/4.3/designers/language-builtin-functions/language-function-if/index.html +++ b/4.3/designers/language-builtin-functions/language-function-if/index.html @@ -3795,7 +3795,7 @@{if} statements in Smarty have much the same flexibility as PHP
-if statements, with a few added features for the
+if statements, with a few added features for the
template engine. Every {if} must be paired with a matching {/if}.
{else} and {elseif} are also permitted. All PHP conditionals and
functions are recognized, such as ||, or, &&, and,
diff --git a/4.3/designers/language-builtin-functions/language-function-section/index.html b/4.3/designers/language-builtin-functions/language-function-section/index.html
index 77fe4017..23abc19b 100644
--- a/4.3/designers/language-builtin-functions/language-function-section/index.html
+++ b/4.3/designers/language-builtin-functions/language-function-section/index.html
@@ -4000,7 +4000,7 @@ arrays, use the {foreach}
The name of the {section} can be anything you like, made up of
- letters, numbers and underscores, like PHP
+ letters, numbers and underscores, like PHP
variables.
The The The above arrays would be output with the following template (note the
-use of the php The +, -, /, *, abs, ceil, cos, exp, floor, log, log10, max, min, pi,
pow, rand, round, sin, sqrt, srans and tan are all valid operators.
Check the PHP documentation for further information on these
- math functions. If you supply the Note This is used to capitalize the first letter of all words in a variable.
-This is similar to the PHP Parameter Position Type Required Default Description This formats a date and time into the given
- Note See also Parameter Position Type Required Possible Values Default Description Note This is used to lowercase a variable. This is equivalent to the PHP
- All A regular expression search and replace on a variable. Use the
- Note A simple search and replace on a variable. This is equivalent to the
-PHP\'s Parameter Position Type Required Default Description This is a way to format strings, such as decimal numbers and such. Use
-the syntax for Parameter Position Type Required Default Description Note Parameter Position Type Required Possible Values Default Description This is used to uppercase a variable. This is equivalent to the PHP
- Parameter Position Type Required Default Description The PHP reserved The request variables such as
+ The request variables such as
The current timestamp can be accessed
+ The current timestamp can be accessed
with Smarty allows access to PHP objects through
+ Smarty allows access to PHP objects through
the templates. Note The php script using the PHP The php script using the PHP string muteExpectedErrors muteExpectedErrors() registers a custom error handler using
-set_error_handler(). The error
+set_error_handler(). The error
handler merely inspects When this value is set to a non-null-value it\'s value is used as php\'s
- Smarty 3.1.2 introduced the
Note If the directories known to Note This tells smarty to respect the
-include_path within
+include_path within
the Test if requested file is in Test if requested file is in Test if requested file is in If you have nested block functions, it\'s possible to find out what the
parent block function is by accessing 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
+ 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. And Note As of Smarty 3.1 the file resource no longer walks through the
-include_path unless
+include_path unless
Both 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: When this template is rendered, with the value \"Hello world\" for the variable $title, 640 for $width, and 480 for $height, the result is: 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 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. 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. 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. 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. 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. 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. 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. 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: 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. 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. 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? 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. 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: Smarty can be run with PHP 7.1 to PHP 8.2. Smarty versions 3.1.11 or later can be installed with Composer. To get the latest stable version of Smarty use: Now that the library files are in place, it's time to setup the Smarty directories for your application. Smarty requires four directories which are by default named The defaults can be changed as follows: 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 You can verify if your system has the correct access rights for these directories with Now, let's create the Note Now lets edit our php file. We'll create an instance of Smarty, Note In our example, we are setting absolute paths to all of the Smarty directories. If Now, run your PHP file. You should see \\\"Hello Ned, welcome to Smarty!\\\" You have completed the basic setup for Smarty! ============== This is a continuation of the basic installation, please read that first! A slightly more flexible way to setup 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. Now, we can use 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. The article Then the template designer edits the templates and uses a combination of HTML tags and template tags to format the presentation of these variables with elements such as tables, div\\'s, background colors, font sizes, style sheets, svg etc. One day the programmer needs to change the way the article content is retrieved, ie a change in application logic. This change does not affect the template designer, the content will still arrive in the template exactly the same. Likewise, if the template designer wants to completely redesign the templates, this would require no change to the application logic. Therefore, the programmer can make changes to the application logic without the need to restructure templates, and the template designer can make changes to templates without breaking application logic. 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 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. Two major benefits: SYNTAX: Templates typically consist of semantic markup such as HTML. PHP syntax works well for application code, but quickly degenerates when mixed with HTML. Smarty\\'s simple {tag} syntax is designed specifically to express presentation. Smarty focuses your templates on presentation and less on \\\"code\\\". This lends to quicker template deployment and easier maintenance. Smarty syntax requires no working knowledge of PHP, and is intuitive for programmers and non-programmers alike. INSULATION: When PHP is mixed with templates, there are no restrictions on what type of logic can be injected into a template. Smarty insulates the templates from PHP, creating a controlled separation of presentation from business logic. Smarty also has security features that can further enforce restrictions on templates. 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. There may be times when you want to print a default value for an empty variable instead of printing nothing, such as printing Note \"Undefined variable\" errors will show an E_NOTICE if not disabled in PHP\\'s See also If a variable is used frequently throughout your templates, applying the See also When the majority of your templates use the same headers and footers, it is common to split those out into their own templates and As a rule of thumb, always pass dates to Smarty as timestamps. This allows template designers to use the This will output: This will output: Dates can be compared in the template by timestamps with: When using See also 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, You can do this by writing a custom plugin for fetching the content and assigning it to a template variable. See also: 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 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 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: 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. 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 The A See also debugging. 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 Set To see the available variables for a particular template, see the Note The debugging console does not work when you use the Note The load times of each template and config file are in seconds, or fractions thereof. See also troubleshooting. 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. 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 The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing Config files are loaded into templates with the built-in template function You can hide variables or entire sections by prepending the variable name or section name with a period(.) eg 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 See also A simple Smarty template could look like this: All Smarty template tags are enclosed within delimiters. By default these are For the examples in this manual, we will assume that you are using the default delimiters. In Smarty, all content outside of delimiters is displayed as static content, or unchanged. When Smarty encounters template tags, it attempts to interpret them, and displays the appropriate output in their place. The basis components of the Smarty syntax are: - Comments - Variables - Functions - Attributes - Quotes - Math - Escaping 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 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 where template is: The above example will output: Smarty comes with several custom plugin functions that you can use in the templates. Variable modifiers can be applied to variables, custom functions or strings. To apply a modifier, specify the value followed by a Modifiers can be applied to any type of variables, including arrays and objects. Note The default behavior was changed with Smarty 3. In Smarty 2.x, you had to use an \\\" If you want a modifier to apply to each individual item of an array, you will either need to loop the array in the template, or provide for this functionality inside your modifier function. Note Second, in Smarty 2.x, modifiers were applied to the result of math expressions like Modifiers are autoloaded from the All php-functions can be used as modifiers implicitly, as demonstrated in the example above. However, using php-functions as modifiers has two little pitfalls: First - sometimes the order of the function-parameters is not the desirable one. Formatting Secondly - if security is enabled, all php-functions that are to be used as modifiers have to be declared trusted in the See also Smarty has several different types of variables. The type of the variable depends on what symbol it is prefixed or enclosed within. Variables in Smarty can be either displayed directly or used as arguments for functions, 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. Note An easy way to examine assigned Smarty variables is with the debugging console. 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 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 Note Changing delimiters affects ALL template syntax and escapement. Be sure to clear out cache and compiled files if you decide to change them. Where the template is: Math can be applied directly to variable values. 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. 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 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. Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so: ::: {.informalexample} ::: Smarty comments are NOT displayed in the final output of the template, unlike 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: Both built-in functions and custom functions have the same syntax within templates. Built-in functions are the inner workings of Smarty, such as Custom functions are additional functions implemented via plugins. They can be modified to your liking, or you can create new ones. See also Smarty will recognize assigned variables embedded in \\\"double quotes\\\" so long as the variable name contains only numbers, letters and under_scores. See naming for more detail. With any other characters, for example a period(.) or In addition Smarty3 does allow embedded Smarty tags in double quoted strings. This is useful if you want to include variables with modifiers, plugin or PHP function results. 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 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 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 See also Note Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion. Attributes: Attribute Name Type Required Default Description Option Flags: nocache Assigns the variable with the \\'nocache\\' attribute The above example will output: See also Note Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion. Note See also the Attributes: Attribute Name Type Required Default Description Option Flags: nocache Assigns the variable with the \\'nocache\\' attribute The above example will output: The above example will output: Variables assigned in the included template will be seen in the including template. The template above includes the example You can assign a variable to root of the current root tree. The variable is seen by all templates using the same root tree. A global variable is seen by all templates. To access The template variables are only available after/during template execution as in the following script. The following functions can also optionally assign template variables. See also The Optionally Attributes: Attribute Name Type Required Default Description Option Flags (in child templates only): append The parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like See also Template Inheritance, Note Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The The Values for variables can be passed to the template function as attributes. Attributes: Attribute Name Type Required Default Description Option Flags: nocache Call the template function in nocache mode Will generate the following output See also The captured content can be used in the template from the variable Attributes: Attribute Name Type Required Default Description Option Flags: nocache Disables caching of this captured block Note Be careful when capturing This example demonstrates the capture function. This example also demonstrates how multiple calls of capture can be used to create an array with captured content. The above example will output: See also Attributes: Attribute Name Type Required Default Description The and the template Config Files may also contain sections. You can load variables from within a section with the added attribute Note Config file sections and the built-in template function called See See also the config files page, config variables page, If caching is enabled and a page is loaded from cache In order to see also the variables which have been locally assigned within the template it does make sense to place the See also the debugging console page. The If a child template extends a parent template with the Use the syntax for template resources to extend files outside of the Note When extending a variable parent like Attributes: Attribute Name Type Required Default Description See also Template Inheritance and The Attributes: Attribute Name Shorthand Type Required Default Description Option Flags: nocache Disables caching of the The above example will output: The above example will output: The above example will output: See also Note This foreach syntax does not accept any named attributes. This syntax is new to Smarty 3, however the Smarty 2.x syntax The Instead of specifying the Note The Note Although you can retrieve the array key with the syntax Option Flags: nocache Disables caching of the Template to output The above example will output: Template to output The above example will output: Assign an array to Smarty, the key contains the key for each looped value. The template to output Either of the above examples will output: A database (PDO) example of looping over search results. This example is looping over a PHP iterator instead of an array(). The above is assuming the results contain the columns named 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. The \\\"is div by\\\" operator can be used to detect a specific iteration. Here we bold-face the name every 4th iteration. 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. This will output something similar to this: The show See also Note Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The The Default values for variables can be passed to the template function as attributes. Like in PHP function declarations you can only use scalar values as default. The default values can be overwritten when the template function is being called. You can use all variables from the calling template inside the template function. Changes to variables or new created variables inside the template function have local scope and are not visible inside the calling template after the template function is executed. Attributes: Attribute Name Type Required Default Description 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 Will generate the following output See also If securty is enabled, only PHP functions from 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. 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 The Setting the optional Variables can be passed to included templates as attributes. Any variables explicitly passed to an included template are only available within the scope of the included file. Attribute variables override current template variables, in the case when they are named the same. You can use all variables from the including template inside the included template. But changes to variables or new created variables inside the included template have local scope and are not visible inside the including template after the Use the syntax for template resources to Attributes: Attribute Name Type Required Default Description cache_lifetime integer No n/a Enable caching of this subtemplate with an individual cache lifetime compile_id string/integer No n/a Compile this subtemplate with an individual compile_id cache_id string/integer No n/a Enable caching of this subtemplate with an individual cache_id scope string No n/a Define the scope of all in the subtemplate assigned variables: \\'parent\\',\\'root\\' or \\'global\\' [var ...] [var type] No n/a variable to pass local to template Option Flags: 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 The template above includes the example Variables assigned in the included template will be seen in the including template. The template above includes the example The included template will not be cached. In this example included template will be cached with an individual cache lifetime of 500 seconds. In this example included template will be cached independent of the global caching setting. This example assigns the contents of This example includes another template relative to the directory of the current template. See also Note Note As of Smarty 3.1 the Attribute Name Type Required Default Description 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. In this example, we are using the name \"getBanner\" and passing the parameters #banner_location_id# and #site_id#. Smarty will look for a function named insert_getBanner() in your PHP application, passing the values of #banner_location_id# and #site_id# as the first argument in an associative array. All {insert} function names in your application must be prepended with \\\"insert_\\\" to remedy possible function name-space conflicts. Your insert_getBanner() function should do something with the passed values and return the results. These results are then displayed in the template in place of the {insert} tag. In this example, Smarty would call this function: insert_getBanner(array(\\\"lid\\\" => \\\"12345\\\",\\\"sid\\\" => \\\"67890\\\")); and display the returned results in place of the {insert} tag. If you supply the Note Assigning the output to a template variable isn\\'t too useful with caching enabled. If you supply the The path can be either absolute, or relative to The Smarty object is passed as the second argument. This way you can reference and modify information in the Smarty object from within the 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, See also The above example will output: Another example with some Javascript will output See also Note See also Note Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache. The above code will output the current date on a cached page. See also the caching section. A Note The Note {section} loops cannot loop over associative arrays, they must be numerically indexed, and sequential (0,1,2,...). For associative arrays, use the Attribute Name Type Required Default Description Option Flags: nocache Disables caching of the Required attributes are The {section}\\'s can be nested, and the nested The When printing a variable within a A The template that outputs the array The above example will output: The above example will output: The This is an example of printing an associative array of data with a The template to output The above example will output: This example assumes that The The above example will output: {section}\\'s can be nested as deep as you like. With nested {section}\\'s, you can access complex data structures, such as multi-dimensional arrays. This is an example In this template, \\$contact_type[customer] is an array of contact types for the current customer. The above example will output: Results of a database search (eg ADODB or PEAR) are assigned to Smarty The template to output the database result in a HTML table Note If the Note The above example will output: Template to output the above array in a table The above example will output a table containing the following: Note This is not affected by the Template to output every other element of the The above example will output: Another example that uses the An that uses the Note The \\\"is div by\\\" syntax is a simpler alternative to the PHP mod operator syntax. The mod operator is allowed: Note You can also use \\\"is odd by\\\" to reverse the alternating. This example loops the The above example will output: Boolean The above example will output: See also The SYNTAX: {setfilter filter1|filter2|filter3....}...{/setfilter} The filter can be: A variable filter plugin specified by it\\'s name. A modifier specified by it\\'s name and optional additional parameter. 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 Note The setting of template instance filters does not effect the output of included subtemplates. This is a short-hand version of the {assign} function. You can assign values directly to the template, or assign values to array elements too. Note Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion. The following attributes can be added to the tag: Attributes: Attribute Name Shorthand Type Required Default Description Option Flags: nocache Assigns the variable with the \\'nocache\\' attribute The above example will output: Variables assigned in the included template will be seen in the including template. The template above includes the example See also 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 Note The above example will output: 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 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. 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 The above example will count down the value of \\$foo until 1 is reached. See also If you supply the Attribute Name Type Required Default Description this will output: Attribute Name Type Required Default Description You can You can force the current value not to print with the The If you supply the The above template would output: Attribute Name Type Required Default Description See also the debugging console page. If you supply the Attribute Name Type Required Default Description Note Evaluated variables are treated the same as templates. They follow the same escapement and security features just as if they were templates. Evaluated variables are compiled on every invocation, the compiled versions are not saved! However if you have caching enabled, the output will be cached with the rest of the template. If the content to evaluate doesn\\'t change often, or is used repeatedly, consider using The contents of the config file, Where the template is: The above template will output: This outputs the server name (in uppercase) and IP. The assigned variable Where the template is: If the file name begins with Note This will not support http redirects, be sure to include a trailing slash on your web page fetches where necessary. If the file name begins with For local files, either a full system file path must be given, or a path relative to the executed php script. Note If security is enabled and you are fetching a file from the local file system, If the Attribute Name Type Required Default Description See also Attribute Name Type Required Default Description Required attributes are All output is XHTML compliant. All parameters that are not in the list above are printed as name/value-pairs inside each of the created \\<input>-tags. where template is or where PHP code is: and the template is both examples will output: The results of the database queries above would be output with. See also Attribute Name Type Required Default Description All parameters that are not in the list above are printed as name/value-pairs inside the created Note Example output of the above template would be: Attribute Name Type Required Default Description Required attributes are If the optional If a given value is an array, it will treat it as an html All parameters that are not in the list above are printed as name/value-pairs inside the All output is XHTML compliant. The following template will generate a drop-down list. Note the presence of the Output of the above example would be: The above arrays would be output with the following template (note the use of the php The above example would output: Where a template could be as follows. Note the use of the The script above and the following template would output: See also Attribute Name Type Required Default Description Required attributes are All output is XHTML compliant. All parameters that are not in the list above are output as name/value-pairs inside each of the created Where template is: Where template is: Both examples will output: The variable assigned from the database above would be output with the template: See also month_value_format string No \\%m strftime() format of the month values, default is %m for month numbers. all_empty string No null If supplied then the first element of any select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-boxes read \"Please select\" for example. year_empty string No null If supplied then the first element of the year\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select a year\" for example. Note that you can use values like \"-MM-DD\" as time-attribute to indicate an unselected year. month_empty string No null If supplied then the first element of the month\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. . Note that you can use values like \"YYYY--DD\" as time-attribute to indicate an unselected month. day_empty string No null If supplied then the first element of the day\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. Note that you can use values like \"YYYY-MM-\" as time-attribute to indicate an unselected day. Note There is an useful php function on the date tips page for converting Template code This will output: With 2000 as the current year the output: See also The minute_value_format string No \\%20d What format the minute value should be in (sprintf) second_format string No \\%02d What format the second label should be in (sprintf) second_value_format string No \\%20d What format the second value should be in (sprintf) field_array string No n/a Outputs values to array of this name all_extra string No null Adds extra attributes to select/input tags if given hour_extra string No null Adds extra attributes to select/input tags if given minute_extra string No null Adds extra attributes to select/input tags if given second_extra string No null Adds extra attributes to select/input tags if given meridian_extra string No null Adds extra attributes to select/input tags if given field_separator string No \\n String printed between different fields option_separator string No \\n String printed between different options of a field all_id string No null Adds id-attribute to all select/input tags if given hour_id string No null Adds id-attribute to select/input tags if given minute_id string No null Adds id-attribute to select/input tags if given second_id string No null Adds id-attribute to select/input tags if given meridian_id string No null Adds id-attribute to select/input tags if given all_empty string No null If supplied then the first element of any select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-boxes read \"Please select\" for example. hour_empty string No null If supplied then the first element of the hour\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an hour\" for example. minute_empty string No null If supplied then the first element of the minute\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an minute\" for example. second_empty string No null If supplied then the first element of the second\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an second\" for example. meridian_empty string No null If supplied then the first element of the meridian\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an meridian\" for example. At 9:20 and 23 seconds in the morning the template above would output: See also Attribute Name Type Required Default Description The The If The variables assigned from php could be displayed as these three examples demonstrate. Each example shows the template followed by output. Note Javascript is probably the most thorough form of encoding, although you can use hex encoding too. Attribute Name Type Required Default Description See also Any numeric template variables may be used in the equations, and the result is printed in place of the tag. The variables used in the equation are passed as parameters, which can be template variables or static values. +, -, /, *, abs, ceil, cos, exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, srans and tan are all valid operators. Check the PHP documentation for further information on these math functions. If you supply the Note Attribute Name Type Required Default Description Example a: The above example will output: Example b: The above example will output: Example c: The above example will output: Example d: The above example will output: You can set the parameters explicitly, or use a preset style. Currently \"email\" is the only available style. Attribute Name Type Required Default Description indent_first number No 0 The number of chars to indent the first line indent_char string No (single space) The character (or string of chars) to indent with wrap number No 80 How many characters to wrap each line to wrap_char string No \\n The character (or string of chars) to break each line with wrap_cut boolean No FALSE If TRUE, wrap will break the line at the exact character instead of at a word boundary assign string No n/a The template variable the output will be assigned to The above example will output: The above example will output: The above example will output: The above example will output: See also This is used to capitalize the first letter of all words in a variable. This is similar to the PHP Parameter Position Type Required Default Description Where the template is: Will output: See also This value is concatenated to the given variable. Parameter Position Type Required Default Description Where template is: Will output: This is used to count the number of characters in a variable. Parameter Position Type Required Default Description Where template is: Will output: See also This is used to count the number of paragraphs in a variable. Where template is: Will output: See also This is used to count the number of sentences in a variable. A sentence being delimited by a dot, question- or exclamation-mark (.?!). Where template is: Will output: See also This is used to count the number of words in a variable. Where template is: This will output: See also This formats a date and time into the given Parameter Position Type Required Default Description Note Since Smarty-2.6.10 numeric values passed to Before Smarty-2.6.10 numeric strings that where also parsable by The only exception are mysql timestamps: They are also numeric only and 14 characters long ( Note This template uses This above will output: \\%a - abbreviated weekday name according to the current locale \\%A - full weekday name according to the current locale \\%b - abbreviated month name according to the current locale \\%B - full month name according to the current locale \\%c - preferred date and time representation for the current locale \\%C - century number (the year divided by 100 and truncated to an integer, range 00 to 99) \\%d - day of the month as a decimal number (range 01 to 31) \\%D - same as %m/%d/%y \\%e - day of the month as a decimal number, a single digit is preceded by a space (range 1 to 31) \\%g - Week-based year within century [00,99] \\%G - Week-based year, including the century [0000,9999] \\%h - same as %b \\%H - hour as a decimal number using a 24-hour clock (range 00 to 23) \\%I - hour as a decimal number using a 12-hour clock (range 01 to 12) \\%j - day of the year as a decimal number (range 001 to 366) \\%k - Hour (24-hour clock) single digits are preceded by a blank. (range 0 to 23) \\%l - hour as a decimal number using a 12-hour clock, single digits preceded by a space (range 1 to 12) \\%m - month as a decimal number (range 01 to 12) \\%M - minute as a decimal number \\%n - newline character \\%p - either `am\\' or `pm\\' according to the given time value, or the corresponding strings for the current locale \\%r - time in a.m. and p.m. notation \\%R - time in 24 hour notation \\%S - second as a decimal number \\%t - tab character \\%T - current time, equal to %H:%M:%S \\%u - weekday as a decimal number [1,7], with 1 representing Monday \\%U - week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week \\%V - The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week. \\%w - day of the week as a decimal, Sunday being 0 \\%W - week number of the current year as a decimal number, starting with the first Monday as the first day of the first week \\%x - preferred date representation for the current locale without the time \\%X - preferred time representation for the current locale without the date \\%y - year as a decimal number without a century (range 00 to 99) \\%Y - year as a decimal number including the century \\%Z - time zone or name or abbreviation \\%% - a literal `%\\' character See also This is used to set a default value for a variable. If the variable is unset or an empty string, the given default value is printed instead. Default takes the one argument. Parameter Position Type Required Default Description Where template is: Will output: See also the default variable handling and the blank variable handling pages. Parameter Position Type Required Possible Values Default Description These are example This snippet is useful for emails, but see also See also escaping smarty parsing, Parameter Position Type Required Possible Values Default Description 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. This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to indent with eg use Parameter Position Type Required Default Description Where template is: Will output: See also This is used to lowercase a variable. This is equivalent to the PHP Where template is: This will output: See also All Where the template is: Will output: See also A regular expression search and replace on a variable. Use the Note Although Smarty supplies this regex convenience modifier, it is usually better to apply regular expressions in PHP, either via custom functions or modifiers. Regular expressions are considered application code and are not part of presentation logic. Parameters Parameter Position Type Required Default Description Where template is: Will output: See also A simple search and replace on a variable. This is equivalent to the PHP\\'s Parameter Position Type Required Default Description Where template is: Will output: See also Parameter Position Type Required Default Description Where template is: Will output: See also This is a way to format strings, such as decimal numbers and such. Use the syntax for Parameter Position Type Required Default Description Where template is: Will output: See also This strips out markup tags, basically anything between Parameter Position Type Required Default Description Where template is: Will output: See also This replaces all spaces, newlines and tabs with a single space, or with the supplied string. Note If you want to strip blocks of template text, use the built-in Where template is: Will output: See also Parameter Position Type Required Possible Values Default Description 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. 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, Parameter Position Type Required Default Description where template is: This will output: Parameter Position Type Required Possible Values Default Description These are example See also escaping smarty parsing, escape modifier. This is used to uppercase a variable. This is equivalent to the PHP Where template is: Will output: See also 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 Parameter Position Type Required Default Description Where template is Will output: See also Assigned variables that are referenced by preceding them with a dollar ( PHP code This above would output: You can also reference associative array variables by specifying the key after a dot \\\".\\\" symbol. this will output: You can reference arrays by their index, much like native PHP syntax. This will output: Properties of objects assigned from PHP can be referenced by specifying the property name after the this will output: Variables that are loaded from the config files are referenced by enclosing them within Example config file - A template demonstrating the A template demonstrating the Both examples would output: 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 See also variables and \\$smarty reserved variables You have the choice to assign variables to the scope of the main Smarty object, data objects created with By default templates which are rendered by By assigning variables to individual data or template objects you have full control which variables can be seen by a template. See also The PHP reserved The request variables such as Note For historical reasons 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. The current timestamp can be accessed with ::: {.informalexample} ::: You can access PHP constant values directly. See also smarty constants. ::: {.informalexample} ::: Output the constant in a template with ::: {.informalexample} ::: 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. Template output captured via the built-in The Note The Returns the name of the current template being processed (without the directory). Returns the template object of the current template being processed. Returns the name of the directory for the current template being processed. Returns the version of Smarty the template was compiled with. Returns block text from child template. See Template inheritance. Returns block text from parent template. See Template inheritance These variables are used for printing the left-delimiter and right-delimiter value literally, the same as See also assigned variables and config variables Note See 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 Caching is used to speed up a call to 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. There are a variety of encodings for textual data, ISO-8859-1 (Latin1) and UTF-8 being the most popular. Unless you change Note 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. Version 2.0 introduced the plugin architecture that is used for almost all the customizable functionality of Smarty. This includes: functions modifiers block functions compiler functions prefilters postfilters outputfilters resources inserts 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 The templates may come from a variety of sources. When you 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/. See also 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. One way is to register objects to the template, then use access them via syntax similar to custom functions. The other way is to 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 And here\\'s how to access your objects in See also When the template is invoked via Output filters can be either registered or loaded from the plugins directory by using the See also 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 The postfilter above will make the compiled Smarty template See also 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 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. See also 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: The expression but deny access to these URIs: 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. 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. 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. 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. See also 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. The inheritance tree can be as deep as you want, meaning you can extend a file that extends another one that extends another one and so on. The child templates can not define any content besides what\\'s inside The content of Template inheritance is a compile time process which creates a single compiled template file. Compared to corresponding solutions based on subtemplates included with the The child template extends its parent defined with the Note When Note If you have a subtemplate which is included with layout.tpl (parent) myproject.tpl (child) mypage.tpl (grandchild) To render the above use The resulting output is Instead of using The code below will return same result as the example above. See also Normally you configure the Smarty settings by modifying the 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. addConfigDir() add a directory to the list of directories where config files are stored Smarty addConfigDir string|array config_dir string key See also addPluginsDir() add a directory to the list of directories where plugins are stored Smarty addPluginsDir string|array plugins_dir See also addTemplateDir() add a directory to the list of directories where templates are stored Smarty addTemplateDir string|array template_dir string key See also appendByRef() append values by reference void appendByRef string varname mixed var bool merge This is used to Note With the introduction of PHP5, NOTE.PARAMETER.MERGE See also append() append an element to an assigned array 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 See also assignByRef() assign values by reference void assignByRef string varname mixed var This is used to Note With the introduction of PHP5, See also assign() assign variables/objects to the templates 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 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. These are accessed in the template with To access more complex array assignments see See also clearAllAssign() clears the values of all assigned variables void clearAllAssign See also clearAllCache() clears the entire template cache 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 See also clearAssign() clears the value of an assigned variable void clearAssign mixed var This can be a single value, or an array of values. See also clearCache() clears the cache for a specific template void clearCache string template string cache_id string compile_id int expire_time If you have multiple caches for a template, you can clear a specific cache by supplying the You can also pass a As an optional fourth parameter, you can supply a minimum age in seconds the cache file must be before it 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 fourth parameter. See also clearCompiledTemplate() clears the compiled version of the specified template resource 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 See also clearConfig() clears assigned config variables void clearConfig string var This clears all assigned config variables. If a variable name is supplied, only that variable is cleared. See also compileAllConfig() compiles all known config files string compileAllConfig string extension boolean force integer timelimit integer maxerror This function compiles config files found in the Note This function may not create desired results in all configurations. Use is on own risk. compileAllTemplates() compiles all known templates string compileAllTemplates string extension boolean force integer timelimit integer maxerror This function compiles template files found in the 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. configLoad() loads config file data and assigns it to the template void configLoad string file string section This loads config file data and assigns it to the template. This works identically to the template Note As of Smarty 2.4.0, assigned template variables are kept across invocations of See also createData() creates a data object 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. See also createTemplate() returns a template object 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: See also disableSecurity() disables template security string disableSecurity This disables security checking on templates. See also display() displays the template 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 PARAMETER.COMPILEID Use the syntax for template resources to display files outside of the See also enableSecurity() enables template security 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 fetch() returns the template output 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 PARAMETER.COMPILEID The The php script using the PHP See also getCacheDir() return the directory where the rendered template\\'s output is stored string getCacheDir See also getCompileDir() returns the directory where compiled templates are stored string getCompileDir See also getConfigDir() return the directory where config files are stored string|array getConfigDir string key See also getConfigVars() returns the given loaded config variable value array getConfigVars string varname If no parameter is given, an array of all loaded config variables is returned. See also getPluginsDir() return the directory where plugins are stored array getPluginsDir See also getRegisteredObject() returns a reference to a registered object 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. See also getTags() return tags used by template 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. getTemplateDir() return the directory where templates are stored string|array getTemplateDir string key See also getTemplateVars() returns assigned variable value(s) array getTemplateVars string varname If no parameter is given, an array of all assigned variables are returned. See also isCached() returns true if there is a valid cache for this template bool isCached string template string cache_id string compile_id This only works if You can also pass a You can supply a If you do not want to pass a Note If See also loadFilter() load a filter plugin void loadFilter string type string name The first argument specifies the type of the filter to load and can be one of the following: See also mutes expected warnings and notices deliberately generated by Smarty string muteExpectedErrors muteExpectedErrors() registers a custom error handler using set_error_handler(). The error handler merely inspects registerCacheResource() dynamically register CacheResources void registerCacheResource string name Smarty_CacheResource resource_handler Use this to dynamically register a CacheResource plugin with Smarty. Pass in the Note In Smarty2 this used to be a callback function called See also registerClass() register a class for use in the templates 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 See also registerDefaultPluginHandler() register a function which gets called on undefined tags 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. 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. registerFilter() dynamically register filters 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 registerObject() register an object for use in the templates 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 registerPlugin() dynamically register plugins 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: And in the template Where the template is: In the template, use See also registerResource() dynamically register resources void registerResource string name Smarty_resource resource_handler Use this to dynamically register a Resource plugin with Smarty. Pass in the 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 Note Prior to Smarty 3.1 See also setCacheDir() set the directory where the rendered template\\'s output is stored Smarty setCacheDir string cache_dir See also setCompileDir() set the directory where compiled templates are stored Smarty setCompileDir string compile_dir See also setConfigDir() set the directories where config files are stored Smarty setConfigDir string|array config_dir See also setPluginsDir() set the directories where plugins are stored Smarty setPluginsDir string|array plugins_dir See also setTemplateDir() set the directories where templates are stored Smarty setTemplateDir string|array template_dir See also templateExists() checks whether the specified template exists 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 And the php script See also testInstall() checks Smarty installation void testInstall This function verifies that all required working folders of the Smarty installation can be accessed. It does output a corresponding protocol. unregisterCacheResource() dynamically unregister a CacheResource plugin void unregisterCacheResource string name Pass in the See also unregisterFilter() dynamically unregister a filter void unregisterFilter string type string|array callback Use this to dynamically unregister filters. It uses the following parameters: See also unregisterObject() dynamically unregister an object void unregisterObject string object_name See also unregisterPlugin dynamically unregister plugins void unregisterPlugin string type string name This method unregisters plugins which previously have been registered by registerPlugin(), It uses the following parameters: See also unregisterResource() dynamically unregister a resource plugin void unregisterResource string name Pass in the See also By default the PHP template file resource is disabled. Setting ::: {.informalexample} ::: Note The PHP template file resource is an undocumented deprecated feature. 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} ::: See also Escaping Smarty Parsing, 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} ::: See also This is the name of the directory where template caches are stored. By default this is You can also use your own custom cache implementation to control cache files, which will ignore this setting. See also 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 See also Persistent cache_id identifier. As an alternative to passing the same With a This is the length of time in seconds that a template cache is valid. Once this time has expired, the cache will be regenerated. A A value of 0 will cause the cache to always regenerate (good for testing only, to disable caching a more efficient method is to set If you want to give certain templates their own cache lifetime, you could do this by setting If 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 See also 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 See also This property specifies the name of the caching handler to use. It defaults to See Custom Cache Implementation for pointers on setting up your own cache handler. This tells Smarty whether or not to cache the output of the templates to the You can also have multiple caches for the same template. A constant value of Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED enables caching. A value of Smarty::CACHING_LIFETIME_CURRENT tells Smarty to use the current A value of Smarty::CACHING_LIFETIME_SAVED tells Smarty to use the If If See also 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 If As of Smarty 3.1 See This is the name of the directory where compiled templates are located. By default this is 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 See also Persistent compile identifier. As an alternative to passing the same If you use the same template with different pre- and/or post-filters you must use a unique 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 Another application would be to use the same compile directory across multiple domains / multiple virtual hosts. Note In Smarty 3 a Compile locking avoids concurrent compilation of the same template. Compile locking is enabled by default. To disable it set Specifies the name of the compiler class that Smarty will use to compile the templates. The default is \\'Smarty_Compiler\\'. For advanced users only. If set to TRUE, config files values of This is the directory used to store config files used in the templates. Default is 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 See also 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 The config file. The template with a See also 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. This is the name of the template file used for the debugging console. By default, it is named See also This allows alternate ways to enable debugging. See also debugging console section, 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 The console can also be enabled from the url with See also 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. This tells smarty what resource type to use for config files. The default value is 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 This tells smarty what resource type to use implicitly. The default value is 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. Direct access security inhibits direct browser access to compiled or cached template files. Direct access security is enabled by default. To disable it set Note This is a compile time option. If you change the setting you must make sure that the templates get recompiled. When this value is set to a non-null-value it\\'s value is used as php\\'s Smarty 3.1.2 introduced the See also debugging and troubleshooting. Setting Template designers can choose to selectively disable this feature by adding the 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 Note This is a compile time option. If you change the setting you must make sure that the templates get recompiled. This forces Smarty to (re)cache templates on every invocation. It does not override the This forces Smarty to (re)compile templates on every invocation. This setting overrides This is the left delimiter used by the template language. Default is See also This is maximum time in seconds a cache lock is valid to avoid dead locks. The default value is 10 seconds. See also By setting Individual sub-templates can be merged by setting the ::: {.informalexample} ::: Note This is a compile time option. If you change the setting you must make sure that the templates get recompiled. See also This is the directory or directories where Smarty will look for the plugins that it needs. Default is Note For best performance, do not setup your Note As of Smarty 3.1 the attribute \\$plugins_dir is no longer accessible directly. Use See also This is the right delimiter used by the template language. Default is See also The value of See also debugging console section, 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 Note It is not recommended to put this directory under the web server document root. Note If the directories known to Note As of Smarty 3.1 the attribute \\$template_dir is no longer accessible directly. Use See also This tells smarty to respect the include_path within the 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 For each element Test if requested file is in For each Test if requested file is in Try default_handler or fail. 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 Smarty will create subdirectories under the compiled templates and cache directories if 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 Safe_mode is being deprecated in PHP6. See also 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. A larger section of your template can easily excluded from caching by using the The above code will output the current date on a cached page. Caching for an individual tag can be disabled by adding the \\\"nocache\\\" option flag to the tag. You can 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. The cacheability of plugins can be declared when registering them. The third parameter to When registering a plugin with Note The In contrast to where The number of seconds till the endtime of where When reloading the page you will notice that both dates differ. One is \"dynamic\" one is \"static\". You can do everything between Note The above example shall just demonstrate how a dynamic block plugins works. See 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 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 Custom CacheResources may be put in a file You can do more elaborate grouping by setting up You can think of cache groups like a directory hierarchy. For instance, a cache group of If you specify a If you specify a template name such as You CANNOT remove a specified template name under multiple cache groups such as 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 You can have multiple cache files for a single call to Above, we are passing the variable 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 Be sure to pass the same You can clear all caches for a particular In this manner, you can \"group\" your caches together by giving them the same The first thing to do is enable caching by setting With caching enabled, the function call to Note The files in the Each cached page has a limited lifetime determined by If If The You can keep parts of a page dynamic (disable caching) with the 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 You can clear all the cache files with the void smarty_block_ name array \\$params mixed \\$content object \\$template boolean &\\$repeat Block functions are functions of the form: By default your function implementation is called twice by Smarty: once for the opening tag, and once for the closing tag. (See Starting with Smarty 3.1 the returned value of the opening tag call is displayed as well. Only the opening tag of the block function may have attributes. All attributes passed to template functions from the template are contained in the The value of the The parameter If you have nested block functions, it\\'s possible to find out what the parent block function is by accessing See also: 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. This function can be called from the template as: The resulting PHP code in the compiled template would be something like this: See also void smarty_function_ name array \\$params object \\$template All attributes passed to template functions from the template are contained in the The output (return value) of the function will be substituted in place of the function tag in the template, eg the If the function needs to assign some variables to the template or use some other Smarty-provided functionality, it can use the supplied which can be used in the template as: See also: 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. Insert plugins are used to implement functions that are invoked by 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 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. See also 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: Where function modifier block compiler prefilter postfilter outputfilter resource insert And Some examples: plugin functions inside the PHP files must be named as follows: The meanings of An example modifier 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. 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. See also 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. See also 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 If a Resource\\'s templates should not be run through the Smarty compiler, the Custom Resource may extend If the Resource\\'s compiled templates should not be cached on disk, the Custom Resource may extend And from within Smarty template: See also 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: 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: modifiers do not get passed the Smarty_Internal_Template object at all blocks get passed 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 And from within Smarty template: The As of Smarty 3.1 the 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. See also Template Inheritance Smarty ships with a built-in template resource for the filesystem. The If the file resource cannot find the requested template, the Note As of Smarty 3.1 the file resource no longer walks through the include_path unless The file resource pulls templates source files from the directories specified in From within a Smarty template Smarty 3.1 introduced the bracket-syntax for specifying an element from The bracket-syntax can be used from anywhere you can specify the From within a Smarty template Templates outside of the Note With And from within a Smarty template: If you are using a Windows machine, filepaths usually include a drive letter (C:) at the beginning of the pathname. Be sure to use And from within Smarty template: 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. Using a PHP stream for a template resource from within a template. Smarty can render templates from a string by using the The The Note With a From within a Smarty template Both From within a Smarty template The templates may come from a variety of sources. When you 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 And from within Smarty template: 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 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: When this template is rendered, with the value \"Hello world\" for the variable $title, 640 for $width, and 480 for $height, the result is: 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 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. 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. 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. 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. 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. 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. 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. 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: 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. 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. 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? 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. 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: Smarty can be run with PHP 7.1 to PHP 8.2. Smarty versions 3.1.11 or later can be installed with Composer. To get the latest stable version of Smarty use: Now that the library files are in place, it's time to setup the Smarty directories for your application. Smarty requires four directories which are by default named The defaults can be changed as follows: 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 You can verify if your system has the correct access rights for these directories with Now, let's create the Note Now lets edit our php file. We'll create an instance of Smarty, Note In our example, we are setting absolute paths to all of the Smarty directories. If Now, run your PHP file. You should see \\\"Hello Ned, welcome to Smarty!\\\" You have completed the basic setup for Smarty! ============== This is a continuation of the basic installation, please read that first! A slightly more flexible way to setup 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. Now, we can use 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. The article Then the template designer edits the templates and uses a combination of HTML tags and template tags to format the presentation of these variables with elements such as tables, div\\'s, background colors, font sizes, style sheets, svg etc. One day the programmer needs to change the way the article content is retrieved, ie a change in application logic. This change does not affect the template designer, the content will still arrive in the template exactly the same. Likewise, if the template designer wants to completely redesign the templates, this would require no change to the application logic. Therefore, the programmer can make changes to the application logic without the need to restructure templates, and the template designer can make changes to templates without breaking application logic. 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 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. Two major benefits: SYNTAX: Templates typically consist of semantic markup such as HTML. PHP syntax works well for application code, but quickly degenerates when mixed with HTML. Smarty\\'s simple {tag} syntax is designed specifically to express presentation. Smarty focuses your templates on presentation and less on \\\"code\\\". This lends to quicker template deployment and easier maintenance. Smarty syntax requires no working knowledge of PHP, and is intuitive for programmers and non-programmers alike. INSULATION: When PHP is mixed with templates, there are no restrictions on what type of logic can be injected into a template. Smarty insulates the templates from PHP, creating a controlled separation of presentation from business logic. Smarty also has security features that can further enforce restrictions on templates. 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. There may be times when you want to print a default value for an empty variable instead of printing nothing, such as printing Note \"Undefined variable\" errors will show an E_NOTICE if not disabled in PHP\\'s See also If a variable is used frequently throughout your templates, applying the See also When the majority of your templates use the same headers and footers, it is common to split those out into their own templates and As a rule of thumb, always pass dates to Smarty as timestamps. This allows template designers to use the This will output: This will output: Dates can be compared in the template by timestamps with: When using See also 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, You can do this by writing a custom plugin for fetching the content and assigning it to a template variable. See also: 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 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 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: 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. 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 The A See also debugging. 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 Set To see the available variables for a particular template, see the Note The debugging console does not work when you use the Note The load times of each template and config file are in seconds, or fractions thereof. See also troubleshooting. 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. 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 The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing Config files are loaded into templates with the built-in template function You can hide variables or entire sections by prepending the variable name or section name with a period(.) eg 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 See also A simple Smarty template could look like this: All Smarty template tags are enclosed within delimiters. By default these are For the examples in this manual, we will assume that you are using the default delimiters. In Smarty, all content outside of delimiters is displayed as static content, or unchanged. When Smarty encounters template tags, it attempts to interpret them, and displays the appropriate output in their place. The basis components of the Smarty syntax are: - Comments - Variables - Functions - Attributes - Quotes - Math - Escaping 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 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 where template is: The above example will output: Smarty comes with several custom plugin functions that you can use in the templates. Variable modifiers can be applied to variables, custom functions or strings. To apply a modifier, specify the value followed by a Modifiers can be applied to any type of variables, including arrays and objects. Note The default behavior was changed with Smarty 3. In Smarty 2.x, you had to use an \\\" If you want a modifier to apply to each individual item of an array, you will either need to loop the array in the template, or provide for this functionality inside your modifier function. Note Second, in Smarty 2.x, modifiers were applied to the result of math expressions like Modifiers are autoloaded from the All php-functions can be used as modifiers implicitly, as demonstrated in the example above. However, using php-functions as modifiers has two little pitfalls: First - sometimes the order of the function-parameters is not the desirable one. Formatting Secondly - if security is enabled, all php-functions that are to be used as modifiers have to be declared trusted in the See also Smarty has several different types of variables. The type of the variable depends on what symbol it is prefixed or enclosed within. Variables in Smarty can be either displayed directly or used as arguments for functions, 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. Note An easy way to examine assigned Smarty variables is with the debugging console. 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 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 Note Changing delimiters affects ALL template syntax and escapement. Be sure to clear out cache and compiled files if you decide to change them. Where the template is: Math can be applied directly to variable values. 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. 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 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. Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so: ::: {.informalexample} ::: Smarty comments are NOT displayed in the final output of the template, unlike 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: Both built-in functions and custom functions have the same syntax within templates. Built-in functions are the inner workings of Smarty, such as Custom functions are additional functions implemented via plugins. They can be modified to your liking, or you can create new ones. See also Smarty will recognize assigned variables embedded in \\\"double quotes\\\" so long as the variable name contains only numbers, letters and under_scores. See naming for more detail. With any other characters, for example a period(.) or In addition Smarty3 does allow embedded Smarty tags in double quoted strings. This is useful if you want to include variables with modifiers, plugin or PHP function results. 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 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 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 See also Note Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion. Attributes: Attribute Name Type Required Default Description Option Flags: nocache Assigns the variable with the \\'nocache\\' attribute The above example will output: See also Note Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion. Note See also the Attributes: Attribute Name Type Required Default Description Option Flags: nocache Assigns the variable with the \\'nocache\\' attribute The above example will output: The above example will output: Variables assigned in the included template will be seen in the including template. The template above includes the example You can assign a variable to root of the current root tree. The variable is seen by all templates using the same root tree. A global variable is seen by all templates. To access The template variables are only available after/during template execution as in the following script. The following functions can also optionally assign template variables. See also The Optionally Attributes: Attribute Name Type Required Default Description Option Flags (in child templates only): append The parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like parent.tpl child.tpl The result would look like See also Template Inheritance, Note Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The The Values for variables can be passed to the template function as attributes. Attributes: Attribute Name Type Required Default Description Option Flags: nocache Call the template function in nocache mode Will generate the following output See also The captured content can be used in the template from the variable Attributes: Attribute Name Type Required Default Description Option Flags: nocache Disables caching of this captured block Note Be careful when capturing This example demonstrates the capture function. This example also demonstrates how multiple calls of capture can be used to create an array with captured content. The above example will output: See also Attributes: Attribute Name Type Required Default Description The and the template Config Files may also contain sections. You can load variables from within a section with the added attribute Note Config file sections and the built-in template function called See See also the config files page, config variables page, If caching is enabled and a page is loaded from cache In order to see also the variables which have been locally assigned within the template it does make sense to place the See also the debugging console page. The If a child template extends a parent template with the Use the syntax for template resources to extend files outside of the Note When extending a variable parent like Attributes: Attribute Name Type Required Default Description See also Template Inheritance and The Attributes: Attribute Name Shorthand Type Required Default Description Option Flags: nocache Disables caching of the The above example will output: The above example will output: The above example will output: See also Note This foreach syntax does not accept any named attributes. This syntax is new to Smarty 3, however the Smarty 2.x syntax The Instead of specifying the Note The Note Although you can retrieve the array key with the syntax Option Flags: nocache Disables caching of the Template to output The above example will output: Template to output The above example will output: Assign an array to Smarty, the key contains the key for each looped value. The template to output Either of the above examples will output: A database (PDO) example of looping over search results. This example is looping over a PHP iterator instead of an array(). The above is assuming the results contain the columns named 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. The \\\"is div by\\\" operator can be used to detect a specific iteration. Here we bold-face the name every 4th iteration. 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. This will output something similar to this: The show See also Note Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The The Default values for variables can be passed to the template function as attributes. Like in PHP function declarations you can only use scalar values as default. The default values can be overwritten when the template function is being called. You can use all variables from the calling template inside the template function. Changes to variables or new created variables inside the template function have local scope and are not visible inside the calling template after the template function is executed. Attributes: Attribute Name Type Required Default Description 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 Will generate the following output See also If securty is enabled, only PHP functions from 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. 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 The Setting the optional Variables can be passed to included templates as attributes. Any variables explicitly passed to an included template are only available within the scope of the included file. Attribute variables override current template variables, in the case when they are named the same. You can use all variables from the including template inside the included template. But changes to variables or new created variables inside the included template have local scope and are not visible inside the including template after the Use the syntax for template resources to Attributes: Attribute Name Type Required Default Description cache_lifetime integer No n/a Enable caching of this subtemplate with an individual cache lifetime compile_id string/integer No n/a Compile this subtemplate with an individual compile_id cache_id string/integer No n/a Enable caching of this subtemplate with an individual cache_id scope string No n/a Define the scope of all in the subtemplate assigned variables: \\'parent\\',\\'root\\' or \\'global\\' [var ...] [var type] No n/a variable to pass local to template Option Flags: 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 The template above includes the example Variables assigned in the included template will be seen in the including template. The template above includes the example The included template will not be cached. In this example included template will be cached with an individual cache lifetime of 500 seconds. In this example included template will be cached independent of the global caching setting. This example assigns the contents of This example includes another template relative to the directory of the current template. See also Note Note As of Smarty 3.1 the Attribute Name Type Required Default Description 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. In this example, we are using the name \"getBanner\" and passing the parameters #banner_location_id# and #site_id#. Smarty will look for a function named insert_getBanner() in your PHP application, passing the values of #banner_location_id# and #site_id# as the first argument in an associative array. All {insert} function names in your application must be prepended with \\\"insert_\\\" to remedy possible function name-space conflicts. Your insert_getBanner() function should do something with the passed values and return the results. These results are then displayed in the template in place of the {insert} tag. In this example, Smarty would call this function: insert_getBanner(array(\\\"lid\\\" => \\\"12345\\\",\\\"sid\\\" => \\\"67890\\\")); and display the returned results in place of the {insert} tag. If you supply the Note Assigning the output to a template variable isn\\'t too useful with caching enabled. If you supply the The path can be either absolute, or relative to The Smarty object is passed as the second argument. This way you can reference and modify information in the Smarty object from within the 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, See also The above example will output: Another example with some Javascript will output See also Note See also Note Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache. The above code will output the current date on a cached page. See also the caching section. A Note The Note {section} loops cannot loop over associative arrays, they must be numerically indexed, and sequential (0,1,2,...). For associative arrays, use the Attribute Name Type Required Default Description Option Flags: nocache Disables caching of the Required attributes are The {section}\\'s can be nested, and the nested The When printing a variable within a A The template that outputs the array The above example will output: The above example will output: The This is an example of printing an associative array of data with a The template to output The above example will output: This example assumes that The The above example will output: {section}\\'s can be nested as deep as you like. With nested {section}\\'s, you can access complex data structures, such as multi-dimensional arrays. This is an example In this template, \\$contact_type[customer] is an array of contact types for the current customer. The above example will output: Results of a database search (eg ADODB or PEAR) are assigned to Smarty The template to output the database result in a HTML table Note If the Note The above example will output: Template to output the above array in a table The above example will output a table containing the following: Note This is not affected by the Template to output every other element of the The above example will output: Another example that uses the An that uses the Note The \\\"is div by\\\" syntax is a simpler alternative to the PHP mod operator syntax. The mod operator is allowed: Note You can also use \\\"is odd by\\\" to reverse the alternating. This example loops the The above example will output: Boolean The above example will output: See also The SYNTAX: {setfilter filter1|filter2|filter3....}...{/setfilter} The filter can be: A variable filter plugin specified by it\\'s name. A modifier specified by it\\'s name and optional additional parameter. 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 Note The setting of template instance filters does not effect the output of included subtemplates. This is a short-hand version of the {assign} function. You can assign values directly to the template, or assign values to array elements too. Note Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion. The following attributes can be added to the tag: Attributes: Attribute Name Shorthand Type Required Default Description Option Flags: nocache Assigns the variable with the \\'nocache\\' attribute The above example will output: Variables assigned in the included template will be seen in the including template. The template above includes the example See also 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 Note The above example will output: 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 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. 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 The above example will count down the value of \\$foo until 1 is reached. See also If you supply the Attribute Name Type Required Default Description this will output: Attribute Name Type Required Default Description You can You can force the current value not to print with the The If you supply the The above template would output: Attribute Name Type Required Default Description See also the debugging console page. If you supply the Attribute Name Type Required Default Description Note Evaluated variables are treated the same as templates. They follow the same escapement and security features just as if they were templates. Evaluated variables are compiled on every invocation, the compiled versions are not saved! However if you have caching enabled, the output will be cached with the rest of the template. If the content to evaluate doesn\\'t change often, or is used repeatedly, consider using The contents of the config file, Where the template is: The above template will output: This outputs the server name (in uppercase) and IP. The assigned variable Where the template is: If the file name begins with Note This will not support http redirects, be sure to include a trailing slash on your web page fetches where necessary. If the file name begins with For local files, either a full system file path must be given, or a path relative to the executed php script. Note If security is enabled and you are fetching a file from the local file system, If the Attribute Name Type Required Default Description See also Attribute Name Type Required Default Description Required attributes are All output is XHTML compliant. All parameters that are not in the list above are printed as name/value-pairs inside each of the created \\<input>-tags. where template is or where PHP code is: and the template is both examples will output: The results of the database queries above would be output with. See also Attribute Name Type Required Default Description All parameters that are not in the list above are printed as name/value-pairs inside the created Note Example output of the above template would be: Attribute Name Type Required Default Description Required attributes are If the optional If a given value is an array, it will treat it as an html All parameters that are not in the list above are printed as name/value-pairs inside the All output is XHTML compliant. The following template will generate a drop-down list. Note the presence of the Output of the above example would be: The above arrays would be output with the following template (note the use of the php The above example would output: Where a template could be as follows. Note the use of the The script above and the following template would output: See also Attribute Name Type Required Default Description Required attributes are All output is XHTML compliant. All parameters that are not in the list above are output as name/value-pairs inside each of the created Where template is: Where template is: Both examples will output: The variable assigned from the database above would be output with the template: See also month_value_format string No \\%m strftime() format of the month values, default is %m for month numbers. all_empty string No null If supplied then the first element of any select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-boxes read \"Please select\" for example. year_empty string No null If supplied then the first element of the year\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select a year\" for example. Note that you can use values like \"-MM-DD\" as time-attribute to indicate an unselected year. month_empty string No null If supplied then the first element of the month\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. . Note that you can use values like \"YYYY--DD\" as time-attribute to indicate an unselected month. day_empty string No null If supplied then the first element of the day\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. Note that you can use values like \"YYYY-MM-\" as time-attribute to indicate an unselected day. Note There is an useful php function on the date tips page for converting Template code This will output: With 2000 as the current year the output: See also The minute_value_format string No \\%20d What format the minute value should be in (sprintf) second_format string No \\%02d What format the second label should be in (sprintf) second_value_format string No \\%20d What format the second value should be in (sprintf) field_array string No n/a Outputs values to array of this name all_extra string No null Adds extra attributes to select/input tags if given hour_extra string No null Adds extra attributes to select/input tags if given minute_extra string No null Adds extra attributes to select/input tags if given second_extra string No null Adds extra attributes to select/input tags if given meridian_extra string No null Adds extra attributes to select/input tags if given field_separator string No \\n String printed between different fields option_separator string No \\n String printed between different options of a field all_id string No null Adds id-attribute to all select/input tags if given hour_id string No null Adds id-attribute to select/input tags if given minute_id string No null Adds id-attribute to select/input tags if given second_id string No null Adds id-attribute to select/input tags if given meridian_id string No null Adds id-attribute to select/input tags if given all_empty string No null If supplied then the first element of any select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-boxes read \"Please select\" for example. hour_empty string No null If supplied then the first element of the hour\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an hour\" for example. minute_empty string No null If supplied then the first element of the minute\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an minute\" for example. second_empty string No null If supplied then the first element of the second\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an second\" for example. meridian_empty string No null If supplied then the first element of the meridian\\'s select-box has this value as it\\'s label and \"\" as it\\'s value. This is useful to make the select-box read \"Please select an meridian\" for example. At 9:20 and 23 seconds in the morning the template above would output: See also Attribute Name Type Required Default Description The The If The variables assigned from php could be displayed as these three examples demonstrate. Each example shows the template followed by output. Note Javascript is probably the most thorough form of encoding, although you can use hex encoding too. Attribute Name Type Required Default Description See also Any numeric template variables may be used in the equations, and the result is printed in place of the tag. The variables used in the equation are passed as parameters, which can be template variables or static values. +, -, /, *, abs, ceil, cos, exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, srans and tan are all valid operators. Check the PHP documentation for further information on these math functions. If you supply the Note Attribute Name Type Required Default Description Example a: The above example will output: Example b: The above example will output: Example c: The above example will output: Example d: The above example will output: You can set the parameters explicitly, or use a preset style. Currently \"email\" is the only available style. Attribute Name Type Required Default Description indent_first number No 0 The number of chars to indent the first line indent_char string No (single space) The character (or string of chars) to indent with wrap number No 80 How many characters to wrap each line to wrap_char string No \\n The character (or string of chars) to break each line with wrap_cut boolean No FALSE If TRUE, wrap will break the line at the exact character instead of at a word boundary assign string No n/a The template variable the output will be assigned to The above example will output: The above example will output: The above example will output: The above example will output: See also This is used to capitalize the first letter of all words in a variable. This is similar to the PHP Parameter Position Type Required Default Description Where the template is: Will output: See also This value is concatenated to the given variable. Parameter Position Type Required Default Description Where template is: Will output: This is used to count the number of characters in a variable. Parameter Position Type Required Default Description Where template is: Will output: See also This is used to count the number of paragraphs in a variable. Where template is: Will output: See also This is used to count the number of sentences in a variable. A sentence being delimited by a dot, question- or exclamation-mark (.?!). Where template is: Will output: See also This is used to count the number of words in a variable. Where template is: This will output: See also This formats a date and time into the given Parameter Position Type Required Default Description Note Since Smarty-2.6.10 numeric values passed to Before Smarty-2.6.10 numeric strings that where also parsable by The only exception are mysql timestamps: They are also numeric only and 14 characters long ( Note This template uses This above will output: \\%a - abbreviated weekday name according to the current locale \\%A - full weekday name according to the current locale \\%b - abbreviated month name according to the current locale \\%B - full month name according to the current locale \\%c - preferred date and time representation for the current locale \\%C - century number (the year divided by 100 and truncated to an integer, range 00 to 99) \\%d - day of the month as a decimal number (range 01 to 31) \\%D - same as %m/%d/%y \\%e - day of the month as a decimal number, a single digit is preceded by a space (range 1 to 31) \\%g - Week-based year within century [00,99] \\%G - Week-based year, including the century [0000,9999] \\%h - same as %b \\%H - hour as a decimal number using a 24-hour clock (range 00 to 23) \\%I - hour as a decimal number using a 12-hour clock (range 01 to 12) \\%j - day of the year as a decimal number (range 001 to 366) \\%k - Hour (24-hour clock) single digits are preceded by a blank. (range 0 to 23) \\%l - hour as a decimal number using a 12-hour clock, single digits preceded by a space (range 1 to 12) \\%m - month as a decimal number (range 01 to 12) \\%M - minute as a decimal number \\%n - newline character \\%p - either `am\\' or `pm\\' according to the given time value, or the corresponding strings for the current locale \\%r - time in a.m. and p.m. notation \\%R - time in 24 hour notation \\%S - second as a decimal number \\%t - tab character \\%T - current time, equal to %H:%M:%S \\%u - weekday as a decimal number [1,7], with 1 representing Monday \\%U - week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week \\%V - The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week. \\%w - day of the week as a decimal, Sunday being 0 \\%W - week number of the current year as a decimal number, starting with the first Monday as the first day of the first week \\%x - preferred date representation for the current locale without the time \\%X - preferred time representation for the current locale without the date \\%y - year as a decimal number without a century (range 00 to 99) \\%Y - year as a decimal number including the century \\%Z - time zone or name or abbreviation \\%% - a literal `%\\' character See also This is used to set a default value for a variable. If the variable is unset or an empty string, the given default value is printed instead. Default takes the one argument. Parameter Position Type Required Default Description Where template is: Will output: See also the default variable handling and the blank variable handling pages. Parameter Position Type Required Possible Values Default Description These are example This snippet is useful for emails, but see also See also escaping smarty parsing, Parameter Position Type Required Possible Values Default Description 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. This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to indent with eg use Parameter Position Type Required Default Description Where template is: Will output: See also This is used to lowercase a variable. This is equivalent to the PHP Where template is: This will output: See also All Where the template is: Will output: See also A regular expression search and replace on a variable. Use the Note Although Smarty supplies this regex convenience modifier, it is usually better to apply regular expressions in PHP, either via custom functions or modifiers. Regular expressions are considered application code and are not part of presentation logic. Parameters Parameter Position Type Required Default Description Where template is: Will output: See also A simple search and replace on a variable. This is equivalent to the PHP\\'s Parameter Position Type Required Default Description Where template is: Will output: See also Parameter Position Type Required Default Description Where template is: Will output: See also This is a way to format strings, such as decimal numbers and such. Use the syntax for Parameter Position Type Required Default Description Where template is: Will output: See also This strips out markup tags, basically anything between Parameter Position Type Required Default Description Where template is: Will output: See also This replaces all spaces, newlines and tabs with a single space, or with the supplied string. Note If you want to strip blocks of template text, use the built-in Where template is: Will output: See also Parameter Position Type Required Possible Values Default Description 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. 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, Parameter Position Type Required Default Description where template is: This will output: Parameter Position Type Required Possible Values Default Description These are example See also escaping smarty parsing, escape modifier. This is used to uppercase a variable. This is equivalent to the PHP Where template is: Will output: See also 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 Parameter Position Type Required Default Description Where template is Will output: See also Assigned variables that are referenced by preceding them with a dollar ( PHP code This above would output: You can also reference associative array variables by specifying the key after a dot \\\".\\\" symbol. this will output: You can reference arrays by their index, much like native PHP syntax. This will output: Properties of objects assigned from PHP can be referenced by specifying the property name after the this will output: Variables that are loaded from the config files are referenced by enclosing them within Example config file - A template demonstrating the A template demonstrating the Both examples would output: 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 See also variables and \\$smarty reserved variables You have the choice to assign variables to the scope of the main Smarty object, data objects created with By default templates which are rendered by By assigning variables to individual data or template objects you have full control which variables can be seen by a template. See also The PHP reserved The request variables such as Note For historical reasons 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. The current timestamp can be accessed with ::: {.informalexample} ::: You can access PHP constant values directly. See also smarty constants. ::: {.informalexample} ::: Output the constant in a template with ::: {.informalexample} ::: 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. Template output captured via the built-in The Note The Returns the name of the current template being processed (without the directory). Returns the template object of the current template being processed. Returns the name of the directory for the current template being processed. Returns the version of Smarty the template was compiled with. Returns block text from child template. See Template inheritance. Returns block text from parent template. See Template inheritance These variables are used for printing the left-delimiter and right-delimiter value literally, the same as See also assigned variables and config variables Note See 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 Caching is used to speed up a call to 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. There are a variety of encodings for textual data, ISO-8859-1 (Latin1) and UTF-8 being the most popular. Unless you change Note 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. Version 2.0 introduced the plugin architecture that is used for almost all the customizable functionality of Smarty. This includes: functions modifiers block functions compiler functions prefilters postfilters outputfilters resources inserts 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 The templates may come from a variety of sources. When you 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/. See also 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. One way is to register objects to the template, then use access them via syntax similar to custom functions. The other way is to 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 And here\\'s how to access your objects in See also When the template is invoked via Output filters can be either registered or loaded from the plugins directory by using the See also 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 The postfilter above will make the compiled Smarty template See also 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 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. See also 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: The expression but deny access to these URIs: 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. 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. 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. 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. See also 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. The inheritance tree can be as deep as you want, meaning you can extend a file that extends another one that extends another one and so on. The child templates can not define any content besides what\\'s inside The content of Template inheritance is a compile time process which creates a single compiled template file. Compared to corresponding solutions based on subtemplates included with the The child template extends its parent defined with the Note When Note If you have a subtemplate which is included with layout.tpl (parent) myproject.tpl (child) mypage.tpl (grandchild) To render the above use The resulting output is Instead of using The code below will return same result as the example above. See also Normally you configure the Smarty settings by modifying the 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. addConfigDir() add a directory to the list of directories where config files are stored Smarty addConfigDir string|array config_dir string key See also addPluginsDir() add a directory to the list of directories where plugins are stored Smarty addPluginsDir string|array plugins_dir See also addTemplateDir() add a directory to the list of directories where templates are stored Smarty addTemplateDir string|array template_dir string key See also appendByRef() append values by reference void appendByRef string varname mixed var bool merge This is used to Note With the introduction of PHP5, NOTE.PARAMETER.MERGE See also append() append an element to an assigned array 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 See also assignByRef() assign values by reference void assignByRef string varname mixed var This is used to Note With the introduction of PHP5, See also assign() assign variables/objects to the templates 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 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. These are accessed in the template with To access more complex array assignments see See also clearAllAssign() clears the values of all assigned variables void clearAllAssign See also clearAllCache() clears the entire template cache 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 See also clearAssign() clears the value of an assigned variable void clearAssign mixed var This can be a single value, or an array of values. See also clearCache() clears the cache for a specific template void clearCache string template string cache_id string compile_id int expire_time If you have multiple caches for a template, you can clear a specific cache by supplying the You can also pass a As an optional fourth parameter, you can supply a minimum age in seconds the cache file must be before it 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 fourth parameter. See also clearCompiledTemplate() clears the compiled version of the specified template resource 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 See also clearConfig() clears assigned config variables void clearConfig string var This clears all assigned config variables. If a variable name is supplied, only that variable is cleared. See also compileAllConfig() compiles all known config files string compileAllConfig string extension boolean force integer timelimit integer maxerror This function compiles config files found in the Note This function may not create desired results in all configurations. Use is on own risk. compileAllTemplates() compiles all known templates string compileAllTemplates string extension boolean force integer timelimit integer maxerror This function compiles template files found in the 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. configLoad() loads config file data and assigns it to the template void configLoad string file string section This loads config file data and assigns it to the template. This works identically to the template Note As of Smarty 2.4.0, assigned template variables are kept across invocations of See also createData() creates a data object 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. See also createTemplate() returns a template object 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: See also disableSecurity() disables template security string disableSecurity This disables security checking on templates. See also display() displays the template 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 PARAMETER.COMPILEID Use the syntax for template resources to display files outside of the See also enableSecurity() enables template security 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 fetch() returns the template output 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 PARAMETER.COMPILEID The The php script using the PHP See also getCacheDir() return the directory where the rendered template\\'s output is stored string getCacheDir See also getCompileDir() returns the directory where compiled templates are stored string getCompileDir See also getConfigDir() return the directory where config files are stored string|array getConfigDir string key See also getConfigVars() returns the given loaded config variable value array getConfigVars string varname If no parameter is given, an array of all loaded config variables is returned. See also getPluginsDir() return the directory where plugins are stored array getPluginsDir See also getRegisteredObject() returns a reference to a registered object 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. See also getTags() return tags used by template 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. getTemplateDir() return the directory where templates are stored string|array getTemplateDir string key See also getTemplateVars() returns assigned variable value(s) array getTemplateVars string varname If no parameter is given, an array of all assigned variables are returned. See also isCached() returns true if there is a valid cache for this template bool isCached string template string cache_id string compile_id This only works if You can also pass a You can supply a If you do not want to pass a Note If See also loadFilter() load a filter plugin void loadFilter string type string name The first argument specifies the type of the filter to load and can be one of the following: See also mutes expected warnings and notices deliberately generated by Smarty string muteExpectedErrors muteExpectedErrors() registers a custom error handler using set_error_handler(). The error handler merely inspects registerCacheResource() dynamically register CacheResources void registerCacheResource string name Smarty_CacheResource resource_handler Use this to dynamically register a CacheResource plugin with Smarty. Pass in the Note In Smarty2 this used to be a callback function called See also registerClass() register a class for use in the templates 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 See also registerDefaultPluginHandler() register a function which gets called on undefined tags 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. 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. registerFilter() dynamically register filters 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 registerObject() register an object for use in the templates 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 registerPlugin() dynamically register plugins 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: And in the template Where the template is: In the template, use See also registerResource() dynamically register resources void registerResource string name Smarty_resource resource_handler Use this to dynamically register a Resource plugin with Smarty. Pass in the 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 Note Prior to Smarty 3.1 See also setCacheDir() set the directory where the rendered template\\'s output is stored Smarty setCacheDir string cache_dir See also setCompileDir() set the directory where compiled templates are stored Smarty setCompileDir string compile_dir See also setConfigDir() set the directories where config files are stored Smarty setConfigDir string|array config_dir See also setPluginsDir() set the directories where plugins are stored Smarty setPluginsDir string|array plugins_dir See also setTemplateDir() set the directories where templates are stored Smarty setTemplateDir string|array template_dir See also templateExists() checks whether the specified template exists 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 And the php script See also testInstall() checks Smarty installation void testInstall This function verifies that all required working folders of the Smarty installation can be accessed. It does output a corresponding protocol. unregisterCacheResource() dynamically unregister a CacheResource plugin void unregisterCacheResource string name Pass in the See also unregisterFilter() dynamically unregister a filter void unregisterFilter string type string|array callback Use this to dynamically unregister filters. It uses the following parameters: See also unregisterObject() dynamically unregister an object void unregisterObject string object_name See also unregisterPlugin dynamically unregister plugins void unregisterPlugin string type string name This method unregisters plugins which previously have been registered by registerPlugin(), It uses the following parameters: See also unregisterResource() dynamically unregister a resource plugin void unregisterResource string name Pass in the See also By default the PHP template file resource is disabled. Setting ::: {.informalexample} ::: Note The PHP template file resource is an undocumented deprecated feature. 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} ::: See also Escaping Smarty Parsing, 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} ::: See also This is the name of the directory where template caches are stored. By default this is You can also use your own custom cache implementation to control cache files, which will ignore this setting. See also 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 See also Persistent cache_id identifier. As an alternative to passing the same With a This is the length of time in seconds that a template cache is valid. Once this time has expired, the cache will be regenerated. A A value of 0 will cause the cache to always regenerate (good for testing only, to disable caching a more efficient method is to set If you want to give certain templates their own cache lifetime, you could do this by setting If 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 See also 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 See also This property specifies the name of the caching handler to use. It defaults to See Custom Cache Implementation for pointers on setting up your own cache handler. This tells Smarty whether or not to cache the output of the templates to the You can also have multiple caches for the same template. A constant value of Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED enables caching. A value of Smarty::CACHING_LIFETIME_CURRENT tells Smarty to use the current A value of Smarty::CACHING_LIFETIME_SAVED tells Smarty to use the If If See also 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 If As of Smarty 3.1 See This is the name of the directory where compiled templates are located. By default this is 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 See also Persistent compile identifier. As an alternative to passing the same If you use the same template with different pre- and/or post-filters you must use a unique 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 Another application would be to use the same compile directory across multiple domains / multiple virtual hosts. Note In Smarty 3 a Compile locking avoids concurrent compilation of the same template. Compile locking is enabled by default. To disable it set Specifies the name of the compiler class that Smarty will use to compile the templates. The default is \\'Smarty_Compiler\\'. For advanced users only. If set to TRUE, config files values of This is the directory used to store config files used in the templates. Default is 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 See also 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 The config file. The template with a See also 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. This is the name of the template file used for the debugging console. By default, it is named See also This allows alternate ways to enable debugging. See also debugging console section, 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 The console can also be enabled from the url with See also 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. This tells smarty what resource type to use for config files. The default value is 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 This tells smarty what resource type to use implicitly. The default value is 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. Direct access security inhibits direct browser access to compiled or cached template files. Direct access security is enabled by default. To disable it set Note This is a compile time option. If you change the setting you must make sure that the templates get recompiled. When this value is set to a non-null-value it\\'s value is used as php\\'s Smarty 3.1.2 introduced the See also debugging and troubleshooting. Setting Template designers can choose to selectively disable this feature by adding the 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 Note This is a compile time option. If you change the setting you must make sure that the templates get recompiled. This forces Smarty to (re)cache templates on every invocation. It does not override the This forces Smarty to (re)compile templates on every invocation. This setting overrides This is the left delimiter used by the template language. Default is See also This is maximum time in seconds a cache lock is valid to avoid dead locks. The default value is 10 seconds. See also By setting Individual sub-templates can be merged by setting the ::: {.informalexample} ::: Note This is a compile time option. If you change the setting you must make sure that the templates get recompiled. See also This is the directory or directories where Smarty will look for the plugins that it needs. Default is Note For best performance, do not setup your Note As of Smarty 3.1 the attribute \\$plugins_dir is no longer accessible directly. Use See also This is the right delimiter used by the template language. Default is See also The value of See also debugging console section, 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 Note It is not recommended to put this directory under the web server document root. Note If the directories known to Note As of Smarty 3.1 the attribute \\$template_dir is no longer accessible directly. Use See also This tells smarty to respect the include_path within the 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 For each element Test if requested file is in For each Test if requested file is in Try default_handler or fail. 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 Smarty will create subdirectories under the compiled templates and cache directories if 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 Safe_mode is being deprecated in PHP6. See also 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. A larger section of your template can easily excluded from caching by using the The above code will output the current date on a cached page. Caching for an individual tag can be disabled by adding the \\\"nocache\\\" option flag to the tag. You can 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. The cacheability of plugins can be declared when registering them. The third parameter to When registering a plugin with Note The In contrast to where The number of seconds till the endtime of where When reloading the page you will notice that both dates differ. One is \"dynamic\" one is \"static\". You can do everything between Note The above example shall just demonstrate how a dynamic block plugins works. See 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 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 Custom CacheResources may be put in a file You can do more elaborate grouping by setting up You can think of cache groups like a directory hierarchy. For instance, a cache group of If you specify a If you specify a template name such as You CANNOT remove a specified template name under multiple cache groups such as 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 You can have multiple cache files for a single call to Above, we are passing the variable 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 Be sure to pass the same You can clear all caches for a particular In this manner, you can \"group\" your caches together by giving them the same The first thing to do is enable caching by setting With caching enabled, the function call to Note The files in the Each cached page has a limited lifetime determined by If If The You can keep parts of a page dynamic (disable caching) with the 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 You can clear all the cache files with the void smarty_block_ name array \\$params mixed \\$content object \\$template boolean &\\$repeat Block functions are functions of the form: By default your function implementation is called twice by Smarty: once for the opening tag, and once for the closing tag. (See Starting with Smarty 3.1 the returned value of the opening tag call is displayed as well. Only the opening tag of the block function may have attributes. All attributes passed to template functions from the template are contained in the The value of the The parameter If you have nested block functions, it\\'s possible to find out what the parent block function is by accessing See also: 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. This function can be called from the template as: The resulting PHP code in the compiled template would be something like this: See also void smarty_function_ name array \\$params object \\$template All attributes passed to template functions from the template are contained in the The output (return value) of the function will be substituted in place of the function tag in the template, eg the If the function needs to assign some variables to the template or use some other Smarty-provided functionality, it can use the supplied which can be used in the template as: See also: 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. Insert plugins are used to implement functions that are invoked by 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 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. See also 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: Where function modifier block compiler prefilter postfilter outputfilter resource insert And Some examples: plugin functions inside the PHP files must be named as follows: The meanings of An example modifier 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. 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. See also 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. See also 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 If a Resource\\'s templates should not be run through the Smarty compiler, the Custom Resource may extend If the Resource\\'s compiled templates should not be cached on disk, the Custom Resource may extend And from within Smarty template: See also 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: 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: modifiers do not get passed the Smarty_Internal_Template object at all blocks get passed 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 And from within Smarty template: The As of Smarty 3.1 the 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. See also Template Inheritance Smarty ships with a built-in template resource for the filesystem. The If the file resource cannot find the requested template, the Note As of Smarty 3.1 the file resource no longer walks through the include_path unless The file resource pulls templates source files from the directories specified in From within a Smarty template Smarty 3.1 introduced the bracket-syntax for specifying an element from The bracket-syntax can be used from anywhere you can specify the From within a Smarty template Templates outside of the Note With And from within a Smarty template: If you are using a Windows machine, filepaths usually include a drive letter (C:) at the beginning of the pathname. Be sure to use And from within Smarty template: 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. Using a PHP stream for a template resource from within a template. Smarty can render templates from a string by using the The The Note With a From within a Smarty template Both From within a Smarty template The templates may come from a variety of sources. When you 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 And from within Smarty template: 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 name of the {section} can be anything you like, see PHP
+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}
diff --git a/4.3/designers/language-builtin-functions/language-function-while/index.html b/4.3/designers/language-builtin-functions/language-function-while/index.html
index 86b0e873..8a3b2b1f 100644
--- a/4.3/designers/language-builtin-functions/language-function-while/index.html
+++ b/4.3/designers/language-builtin-functions/language-function-while/index.html
@@ -3795,7 +3795,7 @@
{while} {#language.function.while}
{while} loops in Smarty have much the same flexibility as PHP
-while statements, with a few added features for
+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.count() function as a
+use of the php count() function as a
modifier to set the select size).<select name="customer_id" size="{$cust_names|@count}">
{html_options values=$cust_ids output=$cust_names selected=$customer_id}
diff --git a/4.3/designers/language-custom-functions/language-function-html-select-date/index.html b/4.3/designers/language-custom-functions/language-function-html-select-date/index.html
index 8e9299b3..6351250f 100644
--- a/4.3/designers/language-custom-functions/language-function-html-select-date/index.html
+++ b/4.3/designers/language-custom-functions/language-function-html-select-date/index.html
@@ -3802,7 +3802,7 @@ name/value-pairs inside the <select> tags of day, month and y
prefix string No Date\_ What to prefix the var name with
- time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL
+ time [timestamp](https://www.php.net/function.time), [DateTime](https://www.php.net/class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](https://www.php.net/strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](https://www.php.net/function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL
start\_year string No current year The first year in the dropdown, either year number, or relative to current year (+/- N)
end\_year string No same as start\_year The last year in the dropdown, either year number, or relative to current year (+/- N)
display\_days boolean No TRUE Whether to display days or not
diff --git a/4.3/designers/language-custom-functions/language-function-html-select-time/index.html b/4.3/designers/language-custom-functions/language-function-html-select-time/index.html
index 7df5df98..f45a9643 100644
--- a/4.3/designers/language-custom-functions/language-function-html-select-time/index.html
+++ b/4.3/designers/language-custom-functions/language-function-html-select-time/index.html
@@ -3799,12 +3799,12 @@ that creates time dropdowns for you. It can display any or all of hour,
minute, second and meridian.
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().strtotime().
Attribute Name Type Required Default Description
prefix string No Time\_ What to prefix the var name with
- time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from.
+ time [timestamp](https://www.php.net/function.time), [DateTime](https://www.php.net/class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](https://www.php.net/strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](https://www.php.net/function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from.
display\_hours boolean No TRUE Whether or not to display hours
display\_minutes boolean No TRUE Whether or not to display minutes
display\_seconds boolean No TRUE Whether or not to display seconds
diff --git a/4.3/designers/language-custom-functions/language-function-math/index.html b/4.3/designers/language-custom-functions/language-function-math/index.html
index 0e8becce..5f7abc84 100644
--- a/4.3/designers/language-custom-functions/language-function-math/index.html
+++ b/4.3/designers/language-custom-functions/language-function-math/index.html
@@ -3809,7 +3809,7 @@ template.
assign attribute, the output of the {math}
@@ -3820,7 +3820,7 @@ template.
{math} is an expensive function in performance due to its use of the
-php eval() function. Doing the math in PHP
+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
diff --git a/4.3/designers/language-modifiers/language-modifier-capitalize/index.html b/4.3/designers/language-modifiers/language-modifier-capitalize/index.html
index 64a8dd80..49c24a0b 100644
--- a/4.3/designers/language-modifiers/language-modifier-capitalize/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-capitalize/index.html
@@ -3795,7 +3795,7 @@
capitalize {#language.modifier.capitalize}
ucwords()
+This is similar to the PHP ucwords()
function.
diff --git a/4.3/designers/language-modifiers/language-modifier-date-format/index.html b/4.3/designers/language-modifiers/language-modifier-date-format/index.html
index fa04540e..52242773 100644
--- a/4.3/designers/language-modifiers/language-modifier-date-format/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-date-format/index.html
@@ -3795,11 +3795,11 @@
date_format {#language.modifier.date.format}
strftime() format. Dates can be passed to
-Smarty as unix timestamps, DateTime
+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
+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.YYYYMMDDHHMMSS), mysql timestamps have
precedence over unix timestamps.
date_format is essentially a wrapper to PHP\'s
-strftime() function. You may have more
+strftime() function. You may have more
or less conversion specifiers available depending on your system\'s
-strftime() function where PHP was
+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.$smarty.now,
-strftime(),
+strftime(),
{html_select_date} and the
date tips page.html.
1 string No `html`, `htmlall`, `url`, `urlpathinfo`, `quotes`, `hex`, `hexentity`, `javascript`, `mail` `html` This is the escape format to use.
- 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to htmlentities() et. al.
+ 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](https://www.php.net/htmlentities) `UTF-8` The character set encoding passed to htmlentities() et. al.
3 boolean No FALSE TRUE Double encode entites from & to &amp; (applys to `html` and `htmlall` only)
diff --git a/4.3/designers/language-modifiers/language-modifier-from-charset/index.html b/4.3/designers/language-modifiers/language-modifier-from-charset/index.html
index 02136bc0..447be5a0 100644
--- a/4.3/designers/language-modifiers/language-modifier-from-charset/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-from-charset/index.html
@@ -3799,7 +3799,7 @@ internal charset. This is the exact opposite of the 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be decoded from
+ 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](https://www.php.net/mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be decoded from
lower {#language.modifier.lower}
strtolower() function.strtolower() function.
<?php
$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');
diff --git a/4.3/designers/language-modifiers/language-modifier-nl2br/index.html b/4.3/designers/language-modifiers/language-modifier-nl2br/index.html
index ca1b7b28..309c54fa 100644
--- a/4.3/designers/language-modifiers/language-modifier-nl2br/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-nl2br/index.html
@@ -3796,7 +3796,7 @@
nl2br {#language.modifier.nl2br}
"\n" line breaks will be converted to html <br /> tags in the
given variable. This is equivalent to the PHP\'s
-nl2br() function.nl2br() function.
<?php
$smarty->assign('articleTitle',
diff --git a/4.3/designers/language-modifiers/language-modifier-regex-replace/index.html b/4.3/designers/language-modifiers/language-modifier-regex-replace/index.html
index 19dca190..5c9d1cc9 100644
--- a/4.3/designers/language-modifiers/language-modifier-regex-replace/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-regex-replace/index.html
@@ -3795,7 +3795,7 @@
regex_replace {#language.modifier.regex.replace}
preg_replace() syntax from the PHP
+preg_replace() syntax from the PHP
manual.
replace {#language.modifier.replace}
str_replace() function.str_replace() function.
1 string Yes *n/a* This is the string of text to be replaced.
diff --git a/4.3/designers/language-modifiers/language-modifier-string-format/index.html b/4.3/designers/language-modifiers/language-modifier-string-format/index.html
index 6652f46e..24ce707d 100644
--- a/4.3/designers/language-modifiers/language-modifier-string-format/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-string-format/index.html
@@ -3795,7 +3795,7 @@
string_format {#language.modifier.string.format}
sprintf() for the
+the syntax for sprintf() for the
formatting.
diff --git a/4.3/designers/language-modifiers/language-modifier-to-charset/index.html b/4.3/designers/language-modifiers/language-modifier-to-charset/index.html
index a95a4bcb..9c95f3f3 100644
--- a/4.3/designers/language-modifiers/language-modifier-to-charset/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-to-charset/index.html
@@ -3799,7 +3799,7 @@ a given charset. This is the exact opposite of the 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be encoded to
+ 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](https://www.php.net/mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be encoded to
1 string No `html`, `htmlall`, `entity`, `html` This is the escape format to use.
- 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to html\_entity\_decode() or htmlspecialchars\_decode() or mb\_convert\_encoding() et. al.
+ 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](https://www.php.net/htmlentities) `UTF-8` The character set encoding passed to html\_entity\_decode() or htmlspecialchars\_decode() or mb\_convert\_encoding() et. al.
<?php
diff --git a/4.3/designers/language-modifiers/language-modifier-upper/index.html b/4.3/designers/language-modifiers/language-modifier-upper/index.html
index 1178b11a..ddb34a59 100644
--- a/4.3/designers/language-modifiers/language-modifier-upper/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-upper/index.html
@@ -3795,7 +3795,7 @@
upper {#language.modifier.upper}
strtoupper() function.strtoupper() function.
<?php
$smarty->assign('articleTitle', "If Strike isn't Settled Quickly it may Last a While.");
?>
diff --git a/4.3/designers/language-modifiers/language-modifier-wordwrap/index.html b/4.3/designers/language-modifiers/language-modifier-wordwrap/index.html
index 51f06fb9..e59f807c 100644
--- a/4.3/designers/language-modifiers/language-modifier-wordwrap/index.html
+++ b/4.3/designers/language-modifiers/language-modifier-wordwrap/index.html
@@ -3800,7 +3800,7 @@ 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.
+wordwrap() function.
1 integer No 80 This determines how many columns to wrap to.
diff --git a/4.3/designers/language-variables/language-variables-smarty/index.html b/4.3/designers/language-variables/language-variables-smarty/index.html
index 151dbb8d..f8102ca4 100644
--- a/4.3/designers/language-variables/language-variables-smarty/index.html
+++ b/4.3/designers/language-variables/language-variables-smarty/index.html
@@ -4011,7 +4011,7 @@
{$smarty} variable can be used to access several
environment and request variables. The full list of them follows.Request variables {#language.variables.smarty.request}
-$_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 *}
@@ -4049,11 +4049,11 @@ globals mixes underlying application code structure with templates. A
good practice is to assign specific needed values to template vars.
{\$smarty.now} {#language.variables.smarty.now}
-{$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
+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.Objects {#advanced.features.objects}
-
mail()
+mail()
function<?php
diff --git a/4.3/programmers/api-functions/api-mute-expected-errors/index.html b/4.3/programmers/api-functions/api-mute-expected-errors/index.html
index efa6a4ae..82092606 100644
--- a/4.3/programmers/api-functions/api-mute-expected-errors/index.html
+++ b/4.3/programmers/api-functions/api-mute-expected-errors/index.html
@@ -3798,7 +3798,7 @@
$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.\$error_reporting {#variable.error.reporting}
error_reporting level inside of
+error_reporting level inside of
display() and fetch().muteExpectedErrors() function. Calling
diff --git a/4.3/programmers/api-variables/variable-template-dir/index.html b/4.3/programmers/api-variables/variable-template-dir/index.html
index b45464f8..cc1620b5 100644
--- a/4.3/programmers/api-variables/variable-template-dir/index.html
+++ b/4.3/programmers/api-variables/variable-template-dir/index.html
@@ -3808,7 +3808,7 @@ document root.$template_dir are relative to
directories known to the
-include_path you
+include_path you
need to activate the $use_include_path
option.\$use_include_path {#variable.use.include.path}
File Template Resource handler and the plugin
loader to resolve the directories known to
$template_dir. The flag also makes the
@@ -3816,7 +3816,7 @@ as this may - depending on your implementation - slow down your system
\$plugins_dir) do$directory relative to the current
+$directory relative to the current
working directory. If file
found, return it.$directory relative to the $path
- (possibly relative to the current working
+ (possibly relative to the current working
directory). If file found,
return it.
$use_sub_dirs=true doesn\'t work with
- safe_mode=On, that\'s why
+ safe_mode=On, that\'s why
it\'s switchable and why it\'s off by default.{func} and block function
$smarty->_tag_stack variable.
-Just do a var_dump() on it and the
+Just do a var_dump() on it and the
structure should be apparent.<?php
/*
diff --git a/4.3/programmers/plugins/plugins-modifiers/index.html b/4.3/programmers/plugins/plugins-modifiers/index.html
index 0d29ad40..c48ea1fd 100644
--- a/4.3/programmers/plugins/plugins-modifiers/index.html
+++ b/4.3/programmers/plugins/plugins-modifiers/index.html
@@ -3808,7 +3808,7 @@ other context. Modifiers can be chained together.
name should be a valid identifier; letters, numbers, and
- underscores only, see php
+ underscores only, see php
variables.
$use_include_path is activatedTemplates from \$template_dir {#templates.from.template.dir}
diff --git a/4.3/programmers/resources/resources-string/index.html b/4.3/programmers/resources/resources-string/index.html
index 1ffef4eb..7401205d 100644
--- a/4.3/programmers/resources/resources-string/index.html
+++ b/4.3/programmers/resources/resources-string/index.html
@@ -3834,8 +3834,8 @@ $smarty->display('eval:'.$template_string); // compiles every time
{include file="eval:$template_string"} {* compiles every time *}
string: and eval: resources may be encoded with
-urlencode() or
-base64_encode(). This is not necessary
+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<h1>{$title|escape}</h1>\n<p>\n The number of pixels is: {math equation=\"x * y\" x=$height y=$width}.\n</p>\n
"},{"location":"#introduction","title":"Introduction","text":"<h1>Hello world</h1>\n<p>\n The number of pixels is: 307200.\n</p>\n
"},{"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":"{$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/#how-does-it-work","title":"How does it work?","text":"
"},{"location":"getting-started/","title":"What is Smarty?","text":""},{"location":"getting-started/#requirements","title":"Requirements","text":"composer require smarty/smarty\n````\nTo get the latest, unreleased version, use:\n```bash\ncomposer require smarty/smarty:dev-master\n````\nTo get the previous stable version of Smarty, Smarty 3, use:\n```bash\ncomposer require smarty/smarty:^3\n````\nHere's how you create an instance of Smarty in your PHP scripts:\n```php\n<?php\nrequire 'vendor/autoload.php';\n$smarty = new Smarty();\ntemplates, configs, templates_c and cache relative to the current working directory.$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');\nhttpd.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/\ntestInstall():$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();\nindex.tpl file that Smarty will display. This needs to be located in the $template_dir.{* Smarty *}\nHello {$name}, welcome to Smarty!\n{* 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.assign() a template variable and display() the index.tpl file.<?php\nrequire 'vendor/autoload.php';\n$smarty = new Smarty();\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$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\n/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.<?php\nclass Smarty_GuestBook extends Smarty {\npublic function __construct()\n{\nparent::__construct();\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$this->caching = Smarty::CACHING_LIFETIME_CURRENT;\n$this->assign('app_name', 'Guest Book');\n}\n}\nSmarty_GuestBook instead of Smarty in our scripts:
"},{"location":"philosophy/","title":"Philosophy","text":""},{"location":"philosophy/#what-is-smarty","title":"What is Smarty?","text":"$smarty = new Smarty_GuestBook();\n$smarty->assign('name','Ned');\n$smarty->display('index.tpl');\n
"},{"location":"philosophy/#goals","title":"Goals","text":"$headline, $tagline, $author and $body are content elements, they contain no information about how they will be presented. They are passed into Smarty by the application.
"},{"location":"philosophy/#web-designers-and-php","title":"Web designers and PHP","text":" 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.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 \n{else}\n {$title}\n{/if}\n\n{* the short way *}\n{$title|default:' '}\ndefault modifier and default variable handling.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}\ndefault modifier and blank variable handling.{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'}\narchives.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'}\nheader.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>\nfooter.tpl
"},{"location":"appendixes/tips/#dates-tipsdates","title":"Dates {#tips.dates}","text":"</body>\n</html>\ndate_format modifier for full control over date formatting, and also makes it easy to compare dates if necessary.{$startDate|date_format}\nJan 4, 2009\n\n\n\n\n{$startDate|date_format:\"%Y/%m/%d\"}\n2009/01/04\n{if $order_date < $invoice_date}\n ...do something..\n{/if}\n{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?>\n{html_select_date}, {html_select_time}, date_format and $smarty.now,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?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?>\nindex.tpl{load_ticker symbol='SMARTY' assign='ticker'}\n\nStock Name: {$ticker.name} Stock Price: {$ticker.price}\n{include}.{mailto} plugin.<div id=\"contact\">Send inquiries to\n{mailto address=$EmailAddress encode='javascript' subject='Hello'}\n</div>\nescape modifier and {mailto}.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\nParse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75\n{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...\nor\nWarning: Smarty error: unable to read resource: \"site.conf\" in...\n
$template_dir is incorrect, doesn\\'t exist or the file index.tpl is not in the templates/ directory{config_load} function is within a template (or configLoad() has been called) and either $config_dir is incorrect, does not exist or site.conf is not in the directory.Fatal error: Smarty error: the $compile_dir 'templates_c' does not exist,\nor is not a directory...\n
$compile_diris incorrectly set, the directory does not exist, or templates_c is a file and not a directory.Fatal error: Smarty error: unable to write to $compile_dir '....\n
$compile_dir is not writable by the web server. See the bottom of the installing smarty page for more about permissions.Fatal error: Smarty error: the $cache_dir 'cache' does not exist,\nor is not a directory. in /..\n
$caching is enabled and either; the $cache_dir is incorrectly set, the directory does not exist, or cache/ is a file and not a directory.Fatal error: Smarty error: unable to write to $cache_dir '/...\n
$caching is enabled and the $cache_dir is not writable by the web server. See the bottom of the installing smarty page for permissions.Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php \nin /path/to/smarty/libs/sysplugins/smarty_resource.php\n
$errno as it should. If, for whatever reason, this is the desired behaviour of your custom error handler, please call muteExpectedErrors() after you\\'ve registered your custom error handler.debug.tpl is included with the distribution of Smarty which controls the formatting of the console.$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.{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.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.# 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# (hash) at the beginning of the line.[ 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_load} or the API configLoad() function.[.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.$smarty->configLoad(\"db:my.conf\").{config_load}, $config_overwrite, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()<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{ and }, but they can be changed.
assign attribute which collects the result the function to a named template variable instead of being output; much like the {assign} function.| (pipe) character.<?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\n\n?>\n{$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\n
"},{"location":"designers/language-custom-functions/","title":"Custom Functions {#language.custom.functions}","text":"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-modifiers/","title":"Variable Modifiers {#language.modifiers}","text":""},{"location":"designers/language-modifiers/#table-of-contents","title":"Table of contents","text":"
| (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.{* 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
@\\\" symbol to apply a modifier to an array, such as {$articleTitle|@count}. With Smarty 3, the \\\"@\\\" is no longer necessary, and is ignored.{8+2}, meaning that {8+2|count_characters} would give 2, as 8+2=10 and 10 is two characters long. With Smarty 3, modifiers are applied to the variables or atomic expressions before executing the calculations, so since 2 is one character long, {8+2|count_characters} gives 9. To get the old result use parentheses like {(8+2)|count_characters}.$plugins_dir or can be registered explicitly with the registerPlugin() function. The later is useful for sharing a function between php scripts and smarty templates.
$foo with {\"%2.f\"|sprintf:$foo} actually works, but asks for the more intuitive, like {$foo|string_format:\"%2.f\"} that is provided by the Smarty distribution.$modifiers property of the security policy. See the Security section for details.registerPlugin(), combining modifiers. and extending smarty with plugins
{$Name}\n\n{$product.part_no} <b>{$product.description}</b>\n\n{$Contacts[row].Phone}\n\n<body bgcolor=\"{#bgcolor#}\">\n$auto_literal to false.<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.$left_delimiter and $right_delimiter values.<?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\n?>\n
"},{"location":"designers/language-basic-syntax/language-math/","title":"Math {#language.math}","text":"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{$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`\"}\ntrue and false. If an attribute has no value assigned it gets the default boolean value of true.{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{* this is a comment *}\n<!-- HTML comments -->. These are useful for making internal notes in the templates which no one will see ;-)
"},{"location":"designers/language-basic-syntax/language-syntax-functions/","title":"Functions {#language.syntax.functions}","text":"{* 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{*********************************************************\nMulti 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{funcname attr1=\"val1\" attr2=\"val2\"}.{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
{if}, {section} and {strip}. There should be no need to change or modify them.{html_options} is an example of a custom function.registerPlugin()
$object->reference, then the variable must be surrounded by `backticks`.{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\n\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\"}\nescape.$smarty.config variable.{$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$_GET, $_SESSION, etc are available via the reserved $smarty variable.$smarty, config variables {assign} and assign().{append} is used for creating or appending template variable arrays during the execution of a template. var string Yes *n/a* The name of the variable being assigned\n value string Yes *n/a* The value being assigned\n index string No *n/a* The index for the new array element. If not specified the value is append to the end of the array.\n scope string No *n/a* The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'\nName Description\n{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}.\nThe first name is Bob.\nThe last name is Meyer.\nappend() and getTemplateVars().{assign} is used for assigning template variables during the execution of a template.short-form method of assigning template vars. var string Yes *n/a* The name of the variable being assigned\n value string Yes *n/a* The value being assigned\n scope string No *n/a* The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'\nName Description\n{assign var=\"name\" value=\"Bob\"}\n{assign \"name\" \"Bob\"} {* short-hand *}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n\n\n\n\n{assign var=\"name\" value=\"Bob\" nocache}\n{assign \"name\" \"Bob\" nocache} {* short-hand *}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n\n\n\n\n{assign var=running_total value=$running_total+$some_array[$row].some_value}\n{include file=\"sub_template.tpl\"}\n...\n{* display variable assigned in sub_template *}\n{$foo}<br>\n...\nsub_template.tpl below...\n{* foo will be known also in the including template *}\n{assign var=\"foo\" value=\"something\" scope=parent}\n{* bar is assigned only local in the including template *}\n{assign var=\"bar\" value=\"value\"}\n...\n{assign var=foo value=\"bar\" scope=\"root\"}\n{assign var=foo value=\"bar\" scope=\"global\"}\n{assign \"foo\" \"bar\" scope=\"global\"} {* short-hand *}\n{assign} variables from a php script use getTemplateVars(). Here\\'s the template that creates the variable $foo.{assign var=\"foo\" value=\"Smarty\"}\n<?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\n?>\n{capture}, {include}, {insert}, {counter}, {cycle}, {eval}, {fetch}, {math}, {textformat}{$var=...}, assign() and getTemplateVars().{block} is used to define a named area of template source for template inheritance. For details see section of Template Inheritance.{block} template source area of a child template will replace the corresponding areas in the parent template(s).{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 the {\\$smarty.block.parent} the {block} content of the parent template can be inserted at any location of the child {block} content. {\\$smarty.block.child} inserts the {block} content of the child template at any location of the parent {block}.{blocks}'s can be nested. name string Yes *n/a* The name of the template source block\nName Description\n{block} content will be be appended to the content of the parent template {block} prepend The {block} content will be prepended to the content of the parent template {block} hide Ignore the block content if no child block of same name is existing. nocache Disables caching of the {block} content<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{extends file=\"parent.tpl\"} \n{block name=\"title\"}\nPage Title\n{/block}\n<html>\n <head>\n <title>Page Title</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"}Title - {/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\" append}\nPage Title\n{/block}\n<html>\n <head>\n <title>Title - Page Title</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"} is my title{/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\" prepend}\nPage Title\n{/block}\n<html>\n <head>\n <title>Page title is my titel</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"}The {$smarty.block.child} was inserted here{/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\"}\nChild Title\n{/block}\n<html>\n <head>\n <title>The Child Title was inserted here</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"}Parent Title{/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\"}\nYou will see now - {$smarty.block.parent} - here\n{/block}\n<html>\n <head>\n <title>You will see now - Parent Title - here</title>\n </head>\n</html>\n$smarty.block.parent, $smarty.block.child, and {extends}{call} is used to call a template function defined by the {function} tag just like a plugin function.{call} tag must be used to call a template function defined externally from the given template. Otherwise you can directly use the function as {funcname ...} in the template.
{call} tag must have the name attribute which contains the the name of the template function. name string Yes *n/a* The name of the template function\n assign string No *n/a* The name of the variable that the output of called template function will be assigned to\n\\[var \\...\\] \\[var type\\] No *n/a* variable to pass local to template function\nName Description\n{* 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* 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{function}{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.$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. name string Yes *n/a* The name of the captured block\n assign string No *n/a* The variable name where to assign the captured output to\n append string No *n/a* The name of an array variable where to append the captured output to\nName Description\n{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.{* 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{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{capture append=\"foo\"}hello{/capture}I say just {capture append=\"foo\"}world{/capture}\n{foreach $foo as $text}{$text} {/foreach}\nI say just hello world\n$smarty.capture, {eval}, {fetch}, fetch() and {assign}.{config_load} is used for loading config #variables# from a configuration file into the template. file string Yes *n/a* The name of the config file to include\n section string No *n/a* The name of the section to load\n scope string no *local* How the scope of the loaded variables are treated, which must be one of local, parent or global. local means variables are loaded into the local template context. parent means variables are loaded into both the local context and the parent template that called it. global means variables are available to all templates.\nexample.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{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>\nsection. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.{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$config_overwrite to create arrays of config file variables.$config_dir, getConfigVars() and configLoad().{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.{debug} does show only the variables which assigned for the cached page.{debug} tag at the end of the template.{extends} tags are used in child templates in template inheritance for extending parent templates. For details see section of Template Inheritance.
{extends} tag must be on the first line of the template.{extends} tag it may contain only {block} tags. Any other template content is ignored.$template_dir directory.{extends file=$parent_file}, make sure you include $parent_file in the $compile_id. Otherwise Smarty cannot distinguish between different $parent_files. file string Yes *n/a* The name of the template file which is extended\n\n\n{extends file='parent.tpl'}\n{extends 'parent.tpl'} {* short-hand *}\n{block}.{for}{forelse} tag is used to create simple loops. The following different formats are supported:
{for $var=$start to $end} simple loop with step size of 1.{for $var=$start to $end step $step} loop with individual step size.{forelse} is executed when the loop is not iterated. max n/a integer No *n/a* Limit the number of iterations\nName Description\n{for} loop<ul>\n{for $foo=1 to 3}\n <li>{$foo}</li>\n{/for}\n</ul>\n<ul>\n <li>1</li>\n <li>2</li>\n <li>3</li>\n</ul>\n\n\n\n\n$smarty->assign('to',10);\n\n\n\n\n<ul>\n{for $foo=3 to $to max=3}\n <li>{$foo}</li>\n{/for}\n</ul>\n<ul>\n <li>3</li>\n <li>4</li>\n <li>5</li>\n</ul>\n\n\n\n\n$smarty->assign('start',10);\n$smarty->assign('to',5);\n\n\n\n\n<ul>\n{for $foo=$start to $to}\n <li>{$foo}</li>\n{forelse}\n no iteration\n{/for}\n</ul>\n no iteration\n{foreach}, {section} and {while}{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.{foreach $arrayvar as $itemvar}{foreach $arrayvar as $keyvar=>$itemvar}{foreach from=$myarray key=\"mykey\" item=\"myitem\"} is still supported.
{foreach} loops can be nested.array variable, usually an array of values, determines the number of times {foreach} will loop. You can also pass an integer for arbitrary loops.{foreachelse} is executed when there are no values in the array variable.{foreach} properties are @index, @iteration, @first, @last, @show, @total.{foreach} constructs are {break}, {continue}.key variable you can access the current key of the loop item by {$item@key} (see examples below).$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.{foreach $myArray as $myKey => $myValue}, the key is always available as $myValue@key within the foreach loop.Name Description\n{foreach} loop<?php\n$arr = array('red', 'green', 'blue');\n$smarty->assign('myColors', $arr);\n?>\n$myColors in an un-ordered list<ul>\n{foreach $myColors as $color}\n <li>{$color}</li>\n{/foreach}\n</ul>\n<ul>\n <li>red</li>\n <li>green</li>\n <li>blue</li>\n</ul>\n\n\n\n\n<?php\n$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');\n$smarty->assign('myPeople', $people);\n?>\n$myArray as key/value pairs.<ul>\n{foreach $myPeople as $value}\n <li>{$value@key}: {$value}</li>\n{/foreach}\n</ul>\n<ul>\n <li>fname: John</li>\n <li>lname: Doe</li>\n <li>email: j.doe@example.com</li>\n</ul>\n<?php\n $smarty->assign('contacts', array(\n array('phone' => '555-555-1234',\n 'fax' => '555-555-5678',\n 'cell' => '555-555-0357'),\n array('phone' => '800-555-4444',\n 'fax' => '800-555-3333',\n 'cell' => '800-555-2222')\n ));\n?>\n$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 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<?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?>\n\n\n\n\n{foreach $res as $r} \n {$r.id} \n {$r.name}\n{foreachelse}\n .. no results .. \n{/foreach}\nid and name.index contains the current array index, starting with zero.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#iteration-foreachpropertyiteration","title":"\\@iteration {#foreach.property.iteration}","text":"{* 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>\niteration contains the current loop iteration and always starts at one, unlike index. It is incremented by one on each iteration.{foreach $myNames as $name}\n {if $name@iteration is div by 4}\n <b>{$name}</b>\n {/if}\n {$name}\n{/foreach}\n {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
"},{"location":"designers/language-builtin-functions/language-function-foreach/#first-foreachpropertyfirst","title":"\\@first {#foreach.property.first}","text":" <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 ...\nfirst is TRUE if the current {foreach} iteration is the initial one. Here we display a table header row on the first iteration.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#last-foreachpropertylast","title":"\\@last {#foreach.property.last}","text":"{* 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>\nlast is set to TRUE if the current {foreach} iteration is the final one. Here we display a horizontal rule on the last iteration.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#show-foreachpropertyshow","title":"\\@show {#foreach.property.show}","text":"{* 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}\nshow 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.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#total-foreachpropertytotal","title":"\\@total {#foreach.property.total}","text":"<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}\ntotal 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{section}, {for} and {while}{break} aborts the iteration of the array
"},{"location":"designers/language-builtin-functions/language-function-foreach/#continue-foreachconstructcontinue","title":"{continue} {#foreach.construct.continue}","text":" {$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{continue} leaves the current iteration and begins with the next iteration.
"},{"location":"designers/language-builtin-functions/language-function-function/","title":"{function} {#language.function.function}","text":" {$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{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.{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.
{function} tag must have the name attribute which contains the the name of the template function. A tag with this name can be used to call the template function. name string Yes *n/a* The name of the template function\n\\[var \\...\\] \\[var type\\] No *n/a* default variable value to pass local to the template function\n{funcname ...} tag unless you what to use default values. Default values must be scalar and can not be variable. Variables must be passed when the template is called.{* define the function *}\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* 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{call}{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.$php_functions property of the securty policy are allowed. See the Security section for details. Qualifier Alternates Syntax Example Meaning PHP Equivalent\n == eq \\$a eq \\$b equals ==\n != ne, neq \\$a neq \\$b not equals !=\n \\> gt \\$a gt \\$b greater than \\>\n \\< lt \\$a lt \\$b less than \\<\n \\>= gte, ge \\$a ge \\$b greater than or equal \\>=\n \\<= lte, le \\$a le \\$b less than or equal \\<=\n === \\$a === 0 check for identity ===\n ! not not \\$a negation (unary) !\n \\% mod \\$a mod \\$b modulous \\%\n
"},{"location":"designers/language-builtin-functions/language-function-include/","title":"{include} {#language.function.include}","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\n\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{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.
{include} tag must have the file attribute which contains the template resource path.assign attribute specifies the template variable that the output of {include} is assigned to, instead of being displayed. Similar to {assign}.{include} statement. This default behaviour can be changed for all variables assigned in the included template by using the scope attribute at the {include} statement or for individual variables by using the scope attribute at the {assign} statement. The later is useful to return values from the included template to the including template.{include} files outside of the $template_dir directory. file string Yes *n/a* The name of the template file to include\n assign string No *n/a* The name of the variable that the output of include will be assigned to\nName Description\n<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\n\n\n\n{include 'links.tpl' title='Newest links' links=$link_array}\n{* body of template goes here *}\n{include 'footer.tpl' foo='bar'}\nlinks.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{include 'sub_template.tpl' scope=parent}\n...\n{* display variables assigned in sub_template *}\n{$foo}<br>\n{$bar}<br>\n...\nsub_template.tpl below...\n{assign var=foo value='something'}\n{assign var=bar value='value'}\n...\n{include 'sub_template.tpl' nocache}\n...\n{include 'sub_template.tpl' cache_lifetime=500}\n...\n{include 'sub_template.tpl' caching}\n...\nnav.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 {include 'template-in-a-template_dir-directory.tpl'}\n {include './template-in-same-directory.tpl'}\n {include '../template-in-parent-directory.tpl'}\n\n\n\n\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{insert}, template resources and componentized templates.{insert} tags are deprecated from Smarty, and should not be used. Put your PHP logic in PHP scripts or plugin functions instead.{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. name string Yes *n/a* The name of the insert function (insert\\_`name`) or insert plugin\n assign string No *n/a* The name of the template variable the output will be assigned to\n script string No *n/a* The name of the php script that is included before the insert function is called\n\\[var \\...\\] \\[var type\\] No *n/a* variable to pass to insert function\n{* 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
assign attribute, the output of the {insert} tag will be assigned to this template variable instead of being output to the template.script attribute, this php script will be included (only once) before the {insert} function is executed. This is the case where the insert function may not exist yet, and a php script must be included first to make it work.$trusted_dir. If security is enabled, then the script must be located in the $trusted_dir path of the security policy. See the Security section for details.{insert} function.{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.{include}{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{funcname} is how functions look in Smarty!\n<script language=\"JavaScript\">\nfunction foo() {ldelim}\n ... code ...\n{rdelim}\n</script>\n<script language=\"JavaScript\">\nfunction foo() {\n .... code ...\n}\n</script>\n\n\n\n\n<script language=\"JavaScript\" type=\"text/javascript\">\n function myJsFunction(){ldelim}\n alert(\"The server name\\n{$smarty.server.SERVER_NAME}\\n{$smarty.server.SERVER_ADDR}\");\n {rdelim}\n</script>\n<a href=\"javascript:myJsFunction()\">Click here for Server Info</a>\n{literal} and escaping Smarty parsing.{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.{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{ldelim} {rdelim} and the escaping Smarty parsing page.{nocache} is used to disable caching of a template section. Every {nocache} must be paired with a matching {/nocache}.Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n{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.{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.{foreach} loop. name string Yes *n/a* The name of the section\n loop mixed Yes *n/a* Value to determine the number of loop iterations\n start integer No *0* The index position that the section will begin looping. If the value is negative, the start position is calculated from the end of the array. For example, if there are seven values in the loop array and start is -2, the start index is 5. Invalid values (values outside of the length of the loop array) are automatically truncated to the closest valid value.\n step integer No *1* The step value that will be used to traverse the loop array. For example, step=2 will loop on index 0,2,4, etc. If step is negative, it will step through the array backwards.\n max integer No *n/a* Sets the maximum number of times the section will loop.\n show boolean No *TRUE* Determines whether or not to show this section\nName Description\n{section} loop
name and loop.name of the {section} can be anything you like, made up of letters, numbers and underscores, like PHP variables.{section} names must be unique from each other.loop attribute, usually an array of values, determines the number of times the {section} will loop. You can also pass an integer as the loop value.{section}, the {section} name must be given next to variable name within [brackets].{sectionelse} is executed when there are no values in the loop variable.{section} also has its own variables that handle {section} properties. These properties are accessible as: {$smarty.section.name.property} where \"name\" is the attribute name.{section} properties are index, index_prev, index_next, iteration, first, last, rownum, loop, show, total.assign() an array to Smarty<?php\n$data = array(1000,1001,1002);\n$smarty->assign('custid',$data);\n?>\n{* 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}\nid: 1000<br />\nid: 1001<br />\nid: 1002<br />\n<hr />\nid: 1002<br />\nid: 1001<br />\nid: 1000<br />\n\n\n\n\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}\n10 12 14 16 18\n<hr />\n20 18 16 14 12 10\nname 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{section}. Following is the php script to assign the $contacts array to Smarty.<?php\n$data = array(\n array('name' => 'John Smith', 'home' => '555-555-5555',\n 'cell' => '666-555-5555', 'email' => 'john@myexample.com'),\n array('name' => 'Jack Jones', 'home' => '777-555-5555',\n 'cell' => '888-555-5555', 'email' => 'jack@myexample.com'),\n array('name' => 'Jane Munson', 'home' => '000-555-5555',\n 'cell' => '123456', 'email' => 'jane@myexample.com')\n );\n$smarty->assign('contacts',$data);\n?>\n$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<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$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 = array(1001,1002,1003);\n$smarty->assign('custid',$id);\n\n$fullnames = array('John Smith','Jack Jones','Jane Munson');\n$smarty->assign('name',$fullnames);\n\n$addr = array('253 Abbey road', '417 Mulberry ln', '5605 apple st');\n$smarty->assign('address',$addr);\n\n?>\nloop 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<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.php script that assigns the arrays.<?php\n\n$id = array(1001,1002,1003);\n$smarty->assign('custid',$id);\n\n$fullnames = array('John Smith','Jack Jones','Jane Munson');\n$smarty->assign('name',$fullnames);\n\n$addr = array('253 N 45th', '417 Mulberry ln', '5605 apple st');\n$smarty->assign('address',$addr);\n\n$types = array(\n array( 'home phone', 'cell phone', 'e-mail'),\n array( 'home phone', 'web'),\n array( 'cell phone')\n );\n$smarty->assign('contact_type', $types);\n\n$info = array(\n array('555-555-5555', '666-555-5555', 'john@myexample.com'),\n array( '123-456-4', 'www.example.com'),\n array( '0457878')\n );\n$smarty->assign('contact_info', $info);\n\n?>\n{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<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<?php\n$sql = 'select id, name, home, cell, email from contacts '\n .\"where name like '$foo%' \";\n$smarty->assign('contacts', $db->getAll($sql));\n?>\n
"},{"location":"designers/language-builtin-functions/language-function-section/#index-sectionpropertyindex","title":".index {#section.property.index}","text":"<table>\n<tr><th> </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>\nindex 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.step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.$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
"},{"location":"designers/language-builtin-functions/language-function-section/#index_prev-sectionpropertyindexprev","title":".index_prev {#section.property.index.prev}","text":"0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nindex_prev is the previous loop index. On the first loop, this is set to -1.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 = array(1001,1002,1003,1004,1005);\n$smarty->assign('rows',$data);\n?>\n{* $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
"},{"location":"designers/language-builtin-functions/language-function-section/#iteration-sectionpropertyiteration","title":".iteration {#section.property.iteration}","text":"index id index_prev prev_id index_next next_id\n0 1001 -1 1 1002\n1 1002 0 1001 2 1003\n2 1003 1 1002 3 1004\n3 1004 2 1003 4 1005\n4 1005 3 1004 5\niteration contains the current loop iteration and starts at one.{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?>\n$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}\niteration=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 />\niteration 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> </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>\niteration 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{if $smarty.section.co.iteration % 5 == 1} will work just the same.first is set to TRUE if the current {section} iteration is the initial one.last is set to TRUE if the current section iteration is the final one.$customers array, outputs a header block on the first iteration and on the last outputs the footer block. Also uses the total property.
"},{"location":"designers/language-builtin-functions/language-function-section/#rownum-sectionpropertyrownum","title":".rownum {#section.property.rownum}","text":"{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}\nrownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.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
"},{"location":"designers/language-builtin-functions/language-function-section/#show-sectionpropertyshow","title":".show {#section.property.show}","text":"0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nThere are 3 customers shown above.\nshow 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.$show_customer_info has been passed from the PHP application, to regulate whether or not this section shows.{section name=customer loop=$customers show=$show_customer_info}\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
"},{"location":"designers/language-builtin-functions/language-function-section/#total-sectionpropertytotal","title":".total {#section.property.total}","text":"1 id: 1000<br />\n2 id: 1001<br />\n3 id: 1002<br />\n\nthe section was shown.\ntotal 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{foreach}, {for}, {while} and $smarty.section.{setfilter}...{/setfilter} block tag allows the definition of template instance\\'s variable filters.
{setfilter}...{/setfilter} blocks can be nested. The filter definition of inner blocks does replace the definition of the outer block.nofilter flag.<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 scope n/a string No *n/a* The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'\nName Description\n{$name='Bob'}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n\n\n\n\n{$running_total=$running_total+$some_array[row].some_value}\n\n\n\n\n{$user.name=\"Bob\"}\n\n\n\n\n{$user.name.first=\"Bob\"}\n\n\n\n\n{$users[]=\"Bob\"}\n{include file=\"sub_template.tpl\"}\n...\n{* display variable assigned in sub_template *}\n{$foo}<br>\n...\nsub_template.tpl below...\n{* foo will be known also in the including template *}\n{$foo=\"something\" scope=parent}\n{* bar is assigned only local in the including template *}\n{$bar=\"value\"}\n...\n{assign} and {append}{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.{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 border='0'>\n <tr>\n <td>\n <a href=\"{$url}\">\n <font color=\"red\">This is a test</font>\n </a>\n </td>\n </tr>\n</table>\n{/strip}\n<table border='0'><tr><td><a href=\"http://. snipped...</a></td></tr></table>\nstrip modifier.{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. Qualifier Alternates Syntax Example Meaning PHP Equivalent\n == eq \\$a eq \\$b equals ==\n != ne, neq \\$a neq \\$b not equals !=\n \\> gt \\$a gt \\$b greater than \\>\n \\< lt \\$a lt \\$b less than \\<\n \\>= gte, ge \\$a ge \\$b greater than or equal \\>=\n \\<= lte, le \\$a le \\$b less than or equal \\<=\n === \\$a === 0 check for identity ===\n ! not not \\$a negation (unary) !\n \\% mod \\$a mod \\$b modulous \\%\n{while $foo > 0}\n {$foo--}\n{/while}\n{foreach}, {for} and {section}.{counter} is used to print out a count. {counter} will remember the count on each iteration. You can adjust the number, the interval and the direction of the count, as well as determine whether or not to print the value. You can run multiple counters concurrently by supplying a unique name for each one. If you do not supply a name, the name \"default\" will be used.assign attribute, the output of the {counter} function will be assigned to this template variable instead of being output to the template. name string No *default* The name of the counter\n start number No *1* The initial number to start counting from\n skip number No *1* The interval to count by\n direction string No *up* The direction to count (up/down)\n print boolean No *TRUE* Whether or not to print the value\n assign string No *n/a* the template variable the output will be assigned to\n\n\n{* initialize the count *}\n{counter start=0 skip=2}<br />\n{counter}<br />\n{counter}<br />\n{counter}<br />\n
"},{"location":"designers/language-custom-functions/language-function-cycle/","title":"{cycle} {#language.function.cycle}","text":"0<br />\n2<br />\n4<br />\n6<br />\n{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. name string No *default* The name of the cycle\n values mixed Yes *N/A* The values to cycle through, either a comma delimited list (see delimiter attribute), or an array of values\n print boolean No *TRUE* Whether to print the value or not\n advance boolean No *TRUE* Whether or not to advance to the next value\n delimiter string No *,* The delimiter to use in the values attribute\n assign string No *n/a* The template variable the output will be assigned to\n reset boolean No *FALSE* The cycle will be set to the first value and not advanced\n
{cycle} through more than one set of values in a template by supplying a name attribute. Give each {cycle} an unique name.print attribute set to FALSE. This would be useful for silently skipping a value.advance attribute is used to repeat a value. When set to FALSE, the next call to {cycle} will print the same value.assign attribute, the output of the {cycle} function will be assigned to a template variable instead of being output to the template.{section name=rows loop=$data}\n<tr class=\"{cycle values=\"odd,even\"}\">\n <td>{$data[rows]}</td>\n</tr>\n{/section}\n
"},{"location":"designers/language-custom-functions/language-function-debug/","title":"{debug} {#language.function.debug}","text":"<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{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. output string No *javascript* output type, html or javascript\n{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.assign attribute, the output of the {eval} function will be assigned to this template variable instead of being output to the template. var mixed Yes *n/a* Variable (or string) to evaluate\n assign string No *n/a* The template variable the output will be assigned to\n
{include file=\"string:{$template_code}\"} instead. This may cache the compiled state and thus doesn\\'t have to run the (comparably slow) compiler on every invocation.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{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}\nThis 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$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?>\n
"},{"location":"designers/language-custom-functions/language-function-fetch/","title":"{fetch} {#language.function.fetch}","text":" {eval var=$foo}\n{fetch} is used to retrieve files from the local file system, http, or ftp and display the contents.
http://, the web site page will be fetched and displayed.ftp://, the file will be downloaded from the ftp server and displayed.{fetch} will only allow files from within the $secure_dir path of the security policy. See the Security section for details.assign attribute is set, the output of the {fetch} function will be assigned to this template variable instead of being output to the template. file string Yes *n/a* The file, http or ftp site to fetch\n assign string No *n/a* The template variable the output will be assigned to\n\n\n{* 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{capture}, {eval}, {assign} and fetch().{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. name string No *checkbox* Name of checkbox list\n values array Yes, unless using options attribute *n/a* An array of values for checkbox buttons\n output array Yes, unless using options attribute *n/a* An array of output for checkbox buttons\n selected string/array No *empty* The selected checkbox element(s)\n options associative array Yes, unless using values and output *n/a* An associative array of values and output\n separator string No *empty* String of text to separate each checkbox item\n assign string No *empty* Assign checkbox tags to an array instead of output\n labels boolean No *TRUE* Add \\<label\\>-tags to the output\n label\\_ids boolean No *FALSE* Add id-attributes to \\<label\\> and \\<input\\> to the output\n escape boolean No *TRUE* Escape the output / content (values are always escaped)\n strict boolean No *FALSE* Will make the \\\"extra\\\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\\\"disabled\\\"* and *\\\"readonly\\\"* respectively\n
values and output, unless you use options instead.<?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\n?>\n{html_checkboxes name='id' values=$cust_ids output=$cust_names\n selected=$customer_id separator='<br />'}\n<?php\n\n$smarty->assign('cust_checkboxes', array(\n 1000 => 'Joe Schmoe',\n 1001 => 'Jack Smith',\n 1002 => 'Jane Johnson',\n 1003 => 'Charlie Brown')\n );\n$smarty->assign('customer_id', 1001);\n\n?>\n{html_checkboxes name='id' options=$cust_checkboxes\n selected=$customer_id separator='<br />'}\n<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\n\n\n\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\n?>\n{html_checkboxes name='contact_type_id' options=$contact_types\n selected=$contact.contact_type_id separator='<br />'}\n{html_radios} and {html_options}{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. file string Yes *n/a* name/path to image\n height string No *actual image height* Height to display image\n width string No *actual image width* Width to display image\n basedir string no *web server doc root* Directory to base relative paths from\n alt string no *\"\"* Alternative description of the image\n href string no *n/a* href value to link the image to\npath\\_prefix string no *n/a* Prefix for output path\n
basedir is the base directory that relative image paths are based from. If not given, the web server\\'s document root $_ENV['DOCUMENT_ROOT'] is used as the base. If security is enabled, then the image must be located in the $secure_dir path of the security policy. See the Security section for details.href is the href value to link the image to. If link is supplied, an <a href=\"LINKVALUE\"><a> tag is placed around the image tag.path_prefix is an optional prefix string you can give the output path. This is useful if you want to supply a different server name for the image.<img> tag.{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.{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
"},{"location":"designers/language-custom-functions/language-function-html-options/","title":"{html_options} {#language.function.html.options}","text":"<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{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. values array Yes, unless using options attribute *n/a* An array of values for dropdown\n output array Yes, unless using options attribute *n/a* An array of output for dropdown\n selected string/array No *empty* The selected option element(s)\n options associative array Yes, unless using values and output *n/a* An associative array of values and output\n name string No *empty* Name of select group\n strict boolean No *FALSE* Will make the \\\"extra\\\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\\\"disabled\\\"* and *\\\"readonly\\\"* respectively\n
values and output, unless you use the combined options instead.name attribute is given, the <select></select> tags are created, otherwise ONLY the <option> list is generated.<optgroup>, and display the groups. Recursion is supported with <optgroup>.<select> tag. They are ignored if the optional name is not given.<?php\n$smarty->assign('myOptions', array(\n 1800 => 'Joe Schmoe',\n 9904 => 'Jack Smith',\n 2003 => 'Charlie Brown')\n );\n$smarty->assign('mySelect', 9904);\n?>\nname attribute which creates the <select> tags.{html_options name=foo options=$myOptions selected=$mySelect}\n<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\n\n<?php\n$smarty->assign('cust_ids', array(56,92,13));\n$smarty->assign('cust_names', array(\n 'Joe Schmoe',\n 'Jane Johnson',\n 'Charlie Brown'));\n$smarty->assign('customer_id', 92);\n?>\ncount() 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<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\n\n\n\n\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\n?>\ntruncate 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\n\n\n\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?>\n{html_options name=foo options=$lookups selected=$fav}\n<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{html_checkboxes} and {html_radios}{html_radios} is a custom function that creates a HTML radio button group. It also takes care of which item is selected by default as well. name string No *radio* Name of radio list\n values array Yes, unless using options attribute *n/a* An array of values for radio buttons\n output array Yes, unless using options attribute *n/a* An array of output for radio buttons\n selected string No *empty* The selected radio element\n options associative array Yes, unless using values and output *n/a* An associative array of values and output\n separator string No *empty* String of text to separate each radio item\n assign string No *empty* Assign radio tags to an array instead of output\n labels boolean No *TRUE* Add \\<label\\>-tags to the output\n label\\_ids boolean No *FALSE* Add id-attributes to \\<label\\> and \\<input\\> to the output\n escape boolean No *TRUE* Escape the output / content (values are always escaped)\n strict boolean No *FALSE* Will make the \\\"extra\\\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\\\"disabled\\\"* and *\\\"readonly\\\"* respectively\n
values and output, unless you use options instead.<input>-tags.<?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\n?>\n{html_radios name='id' values=$cust_ids output=$cust_names\n selected=$customer_id separator='<br />'}\n\n\n\n\n<?php\n\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\n?>\n{html_radios name='id' options=$cust_radios\n selected=$customer_id separator='<br />'}\n<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\n\n\n\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\n?>\n{html_radios name='contact_type_id' options=$contact_types\n selected=$contact.contact_type_id separator='<br />'}\n{html_checkboxes} and {html_options}{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. Attribute Name Type Required Default Description\n prefix string No Date\\_ What to prefix the var name with\n time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\\_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL\n start\\_year string No current year The first year in the dropdown, either year number, or relative to current year (+/- N)\n end\\_year string No same as start\\_year The last year in the dropdown, either year number, or relative to current year (+/- N)\n display\\_days boolean No TRUE Whether to display days or not\n display\\_months boolean No TRUE Whether to display months or not\n display\\_years boolean No TRUE Whether to display years or not\n month\\_names array No null List of strings to display for months. array(1 =\\> \\'Jan\\', ..., 12 =\\> \\'Dec\\')\n month\\_format string No \\%B What format the month should be in (strftime)\n day\\_format string No \\%02d What format the day output should be in (sprintf)\nday\\_value\\_format string No \\%d What format the day value should be in (sprintf)\n year\\_as\\_text boolean No FALSE Whether or not to display the year as text\n reverse\\_years boolean No FALSE Display years in reverse order\n field\\_array string No null If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name\\[Day\\], name\\[Year\\], name\\[Month\\].\n day\\_size string No null Adds size attribute to select tag if given\n month\\_size string No null Adds size attribute to select tag if given\n year\\_size string No null Adds size attribute to select tag if given\n all\\_extra string No null Adds extra attributes to all select/input tags if given\n day\\_extra string No null Adds extra attributes to select/input tags if given\n month\\_extra string No null Adds extra attributes to select/input tags if given\n year\\_extra string No null Adds extra attributes to select/input tags if given\n all\\_id string No null Adds id-attribute to all select/input tags if given\n day\\_id string No null Adds id-attribute to select/input tags if given\n month\\_id string No null Adds id-attribute to select/input tags if given\n year\\_id string No null Adds id-attribute to select/input tags if given\n field\\_order string No MDY The order in which to display the fields\n field\\_separator string No \\\\n String printed between different fields\n{html_select_date} form values to a timestamp.{html_select_date}\n<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\n\n\n\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<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{html_select_time}, date_format, $smarty.now and the date tips page.{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.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(). Attribute Name Type Required Default Description\n prefix string No Time\\_ What to prefix the var name with\n time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from.\n display\\_hours boolean No TRUE Whether or not to display hours\n display\\_minutes boolean No TRUE Whether or not to display minutes\n display\\_seconds boolean No TRUE Whether or not to display seconds\n display\\_meridian boolean No TRUE Whether or not to display meridian (am/pm)\n use\\_24\\_hours boolean No TRUE Whether or not to use 24 hour clock\n minute\\_interval integer No 1 Number interval in minute dropdown\n second\\_interval integer No 1 Number interval in second dropdown\n hour\\_format string No \\%02d What format the hour label should be in (sprintf)\nhour\\_value\\_format string No \\%20d What format the hour value should be in (sprintf)\n minute\\_format string No \\%02d What format the minute label should be in (sprintf)\n{html_select_time use_24_hours=true}\n<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$smarty.now, {html_select_date} and the date tips page.{html_table} is a custom function that dumps an array of data into an HTML <table>. loop array Yes *n/a* Array of data to loop through\n cols mixed No *3* Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array.\n rows integer No *empty* Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements.\n inner string No *cols* Direction of consecutive elements in the loop-array to be rendered. *cols* means elements are displayed col-by-col. *rows* means elements are displayed row-by-row.\n caption string No *empty* Text to be used for the `<caption>` element of the table\ntable\\_attr string No *border=\\\"1\\\"* Attributes for `<table>` tag\n th\\_attr string No *empty* Attributes for `<th>` tag (arrays are cycled)\n tr\\_attr string No *empty* attributes for `<tr>` tag (arrays are cycled)\n td\\_attr string No *empty* Attributes for `<td>` tag (arrays are cycled)\n trailpad string No * * Value to pad the trailing cells on last row with (if any)\n hdir string No *right* Direction of each row to be rendered. possible values: *right* (left-to-right), and *left* (right-to-left)\n vdir string No *down* Direction of each column to be rendered. possible values: *down* (top-to-bottom), *up* (bottom-to-top)\n
cols attribute determines how many columns will be in the table.table_attr, tr_attr and td_attr values determine the attributes given to the <table>, <tr> and <td> tags.tr_attr or td_attr are arrays, they will be cycled through.trailpad is the value put into the trailing cells on the last table row if there are any present.<?php\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?>\n
"},{"location":"designers/language-custom-functions/language-function-mailto/","title":"{mailto} {#language.function.mailto}","text":"{**** Example One ****}\n{html_table loop=$data}\n\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\n\n{**** Example Two ****}\n{html_table loop=$data cols=4 table_attr='border=\"0\"'}\n\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> </td><td> </td><td> </td></tr>\n</tbody>\n</table>\n\n\n{**** Example Three ****}\n{html_table loop=$data cols=\"first,second,third,fourth\" tr_attr=$tr}\n\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> </td><td> </td><td> </td></tr>\n</tbody>\n</table>\n{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. address string Yes *n/a* The e-mail address\n text string No *n/a* The text to display, default is the e-mail address\n encode string No *none* How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`.\n cc string No *n/a* Email addresses to carbon copy, separate entries by a comma.\n bcc string No *n/a* Email addresses to blind carbon copy, separate entries by a comma\n subject string No *n/a* Email subject\n newsgroups string No *n/a* Newsgroups to post to, separate entries by a comma.\n followupto string No *n/a* Addresses to follow up to, separate entries by a comma.\n extra string No *n/a* Any extra information you want passed to the link, such as style sheet classes\n\n\n{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\">m&..snipped...#x6f;m</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>\nescape, {textformat} and obfuscating email addresses.{math} allows the template designer to do math equations in the template.
assign attribute, the output of the {math} function will be assigned to this template variable instead of being output to the template.{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. equation string Yes *n/a* The equation to execute\n format string No *n/a* The format of the result (sprintf)\n var numeric Yes *n/a* Equation variable value\n assign string No *n/a* Template variable the output will be assigned to\n\\[var \\...\\] numeric Yes *n/a* Equation variable value\n {* $height=4, $width=5 *}\n\n {math equation=\"x + y\" x=$height y=$width}\n 9\n {* $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 100\n {* you can use parenthesis *}\n\n {math equation=\"(( x + y ) / z )\" x=2 y=10 z=2}\n 6\n {* you can supply a format parameter in sprintf format *}\n\n {math equation=\"x + y\" x=4.4444 y=5.0000 format=\"%.2f\"}\n
"},{"location":"designers/language-custom-functions/language-function-textformat/","title":"{textformat} {#language.function.textformat}","text":" 9.44\n{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. style string No *n/a* Preset style\n indent number No *0* The number of chars to indent every line\n {textformat wrap=40}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n This is foo. This is foo. This is foo.\n This is foo. This is foo. This 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 bar\n foo foo. bar foo bar foo foo. bar foo\n bar foo foo. bar foo bar foo foo.\n\n\n\n\n {textformat wrap=40 indent=4}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n 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\n\n\n\n {textformat wrap=40 indent=4 indent_first=4}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n 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\n\n\n\n {textformat style=\"email\"}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n This is foo. This is foo. This is foo. This is foo. This is foo. This is\n foo.\n\n This is bar.\n\n bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo\n bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo\n foo.\n{strip} and wordwrap.ucwords() function. 1 boolean No FALSE This determines whether or not words with digits will be uppercased\n 2 boolean No FALSE This determines whether or not Capital letters within words should be lowercased, e.g. \\\"aAa\\\" to \\\"Aaa\\\"\n\n\n<?php\n\n$smarty->assign('articleTitle', 'next x-men film, x3, delayed.');\n\n?>\n{$articleTitle}\n{$articleTitle|capitalize}\n{$articleTitle|capitalize:true}\nnext x-men film, x3, delayed.\nNext X-Men Film, x3, Delayed.\nNext X-Men Film, X3, Delayed.\nlower and upper 1 string No *empty* This value to catenate to the given variable.\n\n\n<?php\n\n$smarty->assign('articleTitle', \"Psychics predict world didn't end\");\n\n?>\n{$articleTitle|cat:' yesterday.'}\n
"},{"location":"designers/language-modifiers/language-modifier-count-characters/","title":"count_characters {#language.modifier.count.characters}","text":"Psychics predict world didn't end yesterday.\n 1 boolean No FALSE This determines whether or not to include whitespace characters in the count.\n\n\n<?php\n\n$smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.');\n\n?>\n{$articleTitle}\n{$articleTitle|count_characters}\n{$articleTitle|count_characters:true}\nCold Wave Linked to Temperatures.\n29\n33\ncount_words, count_sentences and count_paragraphs.<?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\n?>\n{$articleTitle}\n{$articleTitle|count_paragraphs}\nWar Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\nMan is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\n2\ncount_characters, count_sentences and count_words.<?php\n\n$smarty->assign('articleTitle',\n 'Two Soviet Ships Collide - One Dies.\n Enraged Cow Injures Farmer with Axe.'\n );\n\n?>\n{$articleTitle}\n{$articleTitle|count_sentences}\nTwo Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe.\n2\ncount_characters, count_paragraphs and count_words.<?php\n\n$smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n\n?>\n{$articleTitle}\n{$articleTitle|count_words}\nDealers Will Hear Car Talk at Noon.\n7\ncount_characters, count_paragraphs and count_sentences.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. 1 string No \\%b %e, %Y This is the format for the outputted date.\n 2 string No n/a This is the default date if the input is empty.\ndate_format are always (except for mysql timestamps, see below) interpreted as a unix timestamp.strtotime() in php (like YYYYMMDD) where sometimes (depending on the underlying implementation of strtotime()) interpreted as date strings and NOT as timestamps.YYYYMMDDHHMMSS), mysql timestamps have precedence over unix timestamps.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.<?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\n?>\n$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}\nJan 1, 2022\n01/01/22\n02:33 pm\nDec 31, 2021\nMonday, December 1, 2021\n14:33:00\ndate_format conversion specifiers:
$smarty.now, strftime(), {html_select_date} and the date tips page. 1 string No *empty* This is the default value to output if the variable is empty.\n\n\n<?php\n\n$smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n$smarty->assign('email', '');\n\n?>\n{$articleTitle|default:'no title'}\n{$myTitle|default:'no title'}\n{$email|default:'No email address available'}\nDealers Will Hear Car Talk at Noon.\nno title\nNo email address available\nescape is used to encode or escape a variable to html, url, single quotes, hex, hexentity, javascript and mail. By default its html. 1 string No `html`, `htmlall`, `url`, `urlpathinfo`, `quotes`, `hex`, `hexentity`, `javascript`, `mail` `html` This is the escape format to use.\n 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to htmlentities() et. al.\n 3 boolean No FALSE TRUE Double encode entites from & to &amp; (applys to `html` and `htmlall` only)\n\n\n<?php\n\n$smarty->assign('articleTitle',\n \"'Stiff Opposition Expected to Casketless Funeral Plan'\"\n );\n$smarty->assign('EmailAddress','smarty@example.com');\n\n?>\nescape template lines followed by the output{$articleTitle}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'html'} {* escapes & \" ' < > *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'htmlall'} {* escapes ALL html entities *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\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\">bob..snip..et</a>\n\n{'mail@example.com'|escape:'mail'}\nsmarty [AT] example [DOT] com\n\n\n\n\n{* the \"rewind\" parameter registers the current location *}\n<a href=\"$my_path?page=foo&rewind=$my_uri|urlencode}\">click here</a>\n{mailto}{* email address mangled *}\n<a href=\"mailto:{$EmailAddress|escape:'hex'}\">{$EmailAddress|escape:'mail'}</a>\n{mailto} and the obfuscating email addresses page.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. 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be decoded from\n\"\\t\" for a tab. 1 integer No 4 This determines how many characters to indent to.\n 2 string No (one space) This is the character used to indent with.\n\n\n<?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?>\n{$articleTitle}\n\n{$articleTitle|indent}\n\n{$articleTitle|indent:10}\n\n{$articleTitle|indent:1:\"\\t\"}\nNJ 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.\nstrip, wordwrap and spacify.strtolower() function.<?php\n\n$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');\n\n?>\n{$articleTitle}\n{$articleTitle|lower}\nTwo Convicts Evade Noose, Jury Hung.\ntwo convicts evade noose, jury hung.\nupper and capitalize.\"\\n\" line breaks will be converted to html <br /> tags in the given variable. This is equivalent to the PHP\\'s nl2br() function.<?php\n\n$smarty->assign('articleTitle',\n \"Sun or rain expected\\ntoday, dark tonight\"\n );\n\n?>\n{$articleTitle|nl2br}\nSun or rain expected<br />today, dark tonight\nword_wrap, count_paragraphs and count_sentences.preg_replace() syntax from the PHP manual. 1 string Yes *n/a* This is the regular expression to be replaced.\n 2 string Yes *n/a* This is the string of text to replace with.\n\n\n<?php\n\n$smarty->assign('articleTitle', \"Infertility unlikely to\\nbe passed on, experts say.\");\n\n?>\n{* replace each carriage return, tab and new line with a space *}\n\n{$articleTitle}\n{$articleTitle|regex_replace:\"/[\\r\\t\\n]/\":\" \"}\nInfertility unlikely to\nbe passed on, experts say.\nInfertility unlikely to be passed on, experts say.\nreplace and escape.str_replace() function. 1 string Yes *n/a* This is the string of text to be replaced.\n 2 string Yes *n/a* This is the string of text to replace with.\n\n\n<?php\n\n$smarty->assign('articleTitle', \"Child's Stool Great for Use in Garden.\");\n\n?>\n{$articleTitle}\n{$articleTitle|replace:'Garden':'Vineyard'}\n{$articleTitle|replace:' ':' '}\nChild's Stool Great for Use in Garden.\nChild's Stool Great for Use in Vineyard.\nChild's Stool Great for Use in Garden.\nregex_replace and escape.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. 1 string No *one space* This what gets inserted between each character of the variable.\n\n\n<?php\n\n$smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.');\n\n?>\n{$articleTitle}\n{$articleTitle|spacify}\n{$articleTitle|spacify:\"^^\"}\nSomething 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^^.\nwordwrap and nl2br.sprintf() for the formatting. 1 string Yes *n/a* This is what format to use. (sprintf)\n\n\n<?php\n\n$smarty->assign('number', 23.5787446);\n\n?>\n{$number}\n{$number|string_format:\"%.2f\"}\n{$number|string_format:\"%d\"}\n23.5787446\n23.58\n23\ndate_format.< and >. 1 bool No TRUE This determines whether the tags are replaced by \\' \\' or \\'\\'\n\n\n<?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\n?>\n{$articleTitle}\n{$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *}\n{$articleTitle|strip_tags:false}\nBlind 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.\nreplace and regex_replace.{strip} function.<?php\n$smarty->assign('articleTitle', \"Grandmother of\\neight makes\\t hole in one.\");\n$smarty->display('index.tpl');\n?>\n{$articleTitle}\n{$articleTitle|strip}\n{$articleTitle|strip:' '}\nGrandmother of\neight makes hole in one.\nGrandmother of eight makes hole in one.\nGrandmother of eight makes hole in one.\n{strip} and truncate.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. 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be encoded to\ntruncate 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. 1 integer No 80 This determines how many characters to truncate to.\n 2 string No \\... This is a text string that replaces the truncated text. Its length is included in the truncation length setting.\n 3 boolean No FALSE This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE.\n 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.\n\n\n<?php\n$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');\n?>\n{$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
"},{"location":"designers/language-modifiers/language-modifier-unescape/","title":"unescape {#language.modifier.unescape}","text":"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.\nunescape is used to decode entity, html and htmlall. It counters the effects of the escape modifier for the given types. 1 string No `html`, `htmlall`, `entity`, `html` This is the escape format to use.\n 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to html\\_entity\\_decode() or htmlspecialchars\\_decode() or mb\\_convert\\_encoding() et. al.\n\n\n<?php\n\n$smarty->assign('articleTitle',\n \"Germans use "Ümlauts" and pay in €uro\"\n );\n\n?>\nunescape template lines followed by the output{$articleTitle}\nGermans use "Ümlauts" and pay in €uro\n\n{$articleTitle|unescape:\"html\"}\nGermans use \"Ümlauts\" and pay in €uro\n\n{$articleTitle|unescape:\"htmlall\"}\nGermans use \"\u00dcmlauts\" and pay in \u20acuro\nstrtoupper() function.<?php\n$smarty->assign('articleTitle', \"If Strike isn't Settled Quickly it may Last a While.\");\n?>\n{$articleTitle}\n{$articleTitle|upper}\nIf Strike isn't Settled Quickly it may Last a While.\nIF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE.\nlower and capitalize.\"\\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. 1 integer No 80 This determines how many columns to wrap to.\n 2 string No \\\\n This is the string used to wrap words with.\n 3 boolean No FALSE This determines whether or not to wrap at a word boundary (FALSE), or at the exact character (TRUE).\n\n\n<?php\n\n$smarty->assign('articleTitle',\n \"Blind woman gets new kidney from dad she hasn't seen in years.\"\n );\n\n?>\n{$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}\nBlind 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.\nnl2br and {textformat}.$) sign.<?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\n?>\nindex.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
"},{"location":"designers/language-variables/language-assigned-variables/#associative-arrays-languagevariablesassocarrays","title":"Associative arrays {#language.variables.assoc.arrays}","text":"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<?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?>\nindex.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
"},{"location":"designers/language-variables/language-assigned-variables/#array-indexes-languagevariablesarrayindexes","title":"Array indexes {#language.variables.array.indexes}","text":"555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n<?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?>\nindex.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
"},{"location":"designers/language-variables/language-assigned-variables/#objects-languagevariablesobjects","title":"Objects {#language.variables.objects}","text":"555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n-> symbol.name: {$person->name}<br />\nemail: {$person->email}<br />\n
"},{"location":"designers/language-variables/language-config-variables/","title":"Variables loaded from config files {#language.config.variables}","text":"name: Zaphod Beeblebrox<br />\nemail: zaphod@slartibartfast.example.com<br />\n#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.foo.conf:pageTitle = \"This is mine\"\nbodyBgColor = '#eeeeee'\ntableBorderSize = 3\ntableBgColor = \"#bbbbbb\"\nrowBgColor = \"#cccccc\"\n#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$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<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_load}.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.$smarty->display(...) or $smarty->fetch(...) calls are automatically linked to the Smarty object variable scope.// 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);\nassign(), createData() and createTemplate().{$smarty} variable can be used to access several environment and request variables. The full list of them follows.$_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{$SCRIPT_NAME} is short-hand 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{$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<?php\n// the constant defined in php\ndefine('MY_CONST_VAL','CHERRIES');\n?>\n{$smarty.const.MY_CONST_VAL}\n{capture}..{/capture} function can be accessed using the {$smarty.capture} variable. See the {capture} page for more information.{$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.{$smarty.section} variables can be used to refer to {section} loop properties. These have some very useful values such as .first, .index, etc.{$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/#smartyblockchild-languagevariablessmartyblockchild","title":"{\\$smarty.block.child} {#language.variables.smarty.block.child}","text":"<div id=\"footer\">Powered by Smarty {$smarty.version}</div>\n{ldelim},{rdelim}.
"},{"location":"programmers/api-functions/","title":"Smarty Class Methods {#api.functions}","text":""},{"location":"programmers/api-functions/#table-of-contents","title":"Table of contents","text":"
Changing settings by template section for how to use the functions for individual templates.
Changing settings by template section for how to change Smarty class variables for individual templates.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.
"},{"location":"programmers/charset/","title":"Charset Encoding {#charset}","text":""},{"location":"programmers/charset/#charset-encoding-charsetencoding","title":"Charset Encoding {#charset.encoding}","text":"Smarty::$_CHARSET, Smarty recognizes UTF-8 as the internal charset if Multibyte String is available, ISO-8859-1 if not.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.
"},{"location":"programmers/plugins/","title":"Extending Smarty With Plugins {#plugins}","text":""},{"location":"programmers/plugins/#table-of-contents","title":"Table of contents","text":"// 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
$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.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/smarty-constants/","title":"Constants {#smarty.constants}","text":""},{"location":"programmers/smarty-constants/#smarty_dir-constantsmartydir","title":"SMARTY_DIR {#constant.smarty.dir}","text":"<?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$smarty.const.
assign() objects to the templates and access them much like any other assigned variable.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?>\nindex.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)}\nregisterObject() and assign().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.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?>\nregisterFilter(), loadFilter(), $autoload_filters, postfilters and $plugins_dir.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?>\nindex.tpl look like:<!-- Created by Smarty! -->\n{* rest of template content... *}\nregisterFilter(), prefilters, outputfilters, and loadFilter().loadFilter() function or by setting the $autoload_filters variable.<?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?>\nregisterFilter(), postfilters and loadFilter().
$secure_dir is an array of template directories that are considered secure. $template_dir considered secure implicitly. The default is an empty array.$trusted_dir 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}. The default is an empty array.$trusted_uri is an array of regular expressions matching URIs that are considered trusted. This security directive used by {fetch} and {html_image}. URIs passed to these functions are reduced to {$PROTOCOL}://{$HOSTNAME} to allow simple regular expressions (without having to deal with edge cases like authentication-tokens).'#https?://.*smarty.net$#i' would allow accessing the following URIs:
http://smarty.net/foohttp://smarty.net/foohttp://www.smarty.net/foohttp://smarty.net/foohttps://foo.bar.www.smarty.net/foo/bla?blubb=1
http://smarty.com/foo (not matching top-level domain \\\"com\\\")ftp://www.smarty.net/foo (not matching protocol \\\"ftp\\\")http://www.smarty.net.otherdomain.com/foo (not matching end of domain \\\"smarty.net\\\")$static_classes is an array of classes that are considered trusted. The default is an empty array which allows access to all static classes. To disable access to all static classes set \\$static_classes = null.$php_functions is an array of PHP functions that are considered trusted and can be used from within template. To disable access to all PHP functions set \\$php_functions = null. An empty array ( \\$php_functions = array() ) will allow all PHP functions. The default is array(\\'isset\\', \\'empty\\', \\'count\\', \\'sizeof\\', \\'in_array\\', \\'is_array\\',\\'time\\',\\'nl2br\\').$php_modifiers is an array of PHP functions that are considered trusted and can be used from within template as modifier. To disable access to all PHP modifier set \\$php_modifier = null. An empty array ( \\$php_modifier = array() ) will allow all PHP functions. The default is array(\\'escape\\',\\'count\\').$streams is an array of streams that are considered trusted and can be used from within template. To disable access to all streams set \\$streams = null. An empty array ( \\$streams = array() ) will allow all streams. The default is array(\\'file\\').$allowed_modifiers is an array of (registered / autoloaded) modifiers that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.$disabled_modifiers is an array of (registered / autoloaded) modifiers that may not be accessible to the template.$allowed_tags is a boolean flag which controls if constants can function-, block and filter plugins that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.$disabled_tags is an array of (registered / autoloaded) function-, block and filter plugins that may not be accessible to the template.$allow_constants is a boolean flag which controls if constants can be accessed by the template. The default is \\\"true\\\".$allow_super_globals is a boolean flag which controls if the PHP super globals can be accessed by the template. The default is \\\"true\\\".<?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
"},{"location":"programmers/advanced-features/advanced-features-streams/","title":"Streams {#advanced.features.streams}","text":"{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{$foo:bar}\nTemplate Resources
{block} tags they override. Anything outside of {block} tags will be removed.{block} tags from child and parent templates can be merged by the append or prepend {block} tag option flags and {$smarty.block.parent} or {$smarty.block.child} placeholders.{include} tag it does have much better performance when rendering.{extends} tag, which must be the first line in the child template. Instead of using the {extends} tags in the template files you can define the whole template inheritance tree in the PHP script when you are calling fetch() or display() with the extends: template resource type. The later provides even more flexibility.$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.{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.<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{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{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 $smarty->display('mypage.tpl');\n<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{extends} tags in the template files you can define the inheritance tree in your PHP script by using the extends: resource type.<?php\n$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); \n?>\n{block}, {extends} and extends: resourceSmarty class variables. Furthermore you can register plugins, filters etc. with Smarty functions. Modifications done to the Smarty object will be global for all templates.
"},{"location":"programmers/api-functions/api-add-config-dir/","title":"Api add config dir","text":"<?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<?php\n\n// add directory where config files are stored\n$smarty->addConigDir('./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?>\ngetConfigDir(), setConfigDir() and $config_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?>\ngetPluginsDir(), setPluginsDir() and $plugins_dir.<?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?>\ngetTemplateDir(), setTemplateDir() and $template_dir.append() values to the templates by reference.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.<?php\n// appending name/value pairs\n$smarty->appendByRef('Name', $myname);\n$smarty->appendByRef('Address', $address);\n?>\nappend(), assign() and getTemplateVars().<?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?>\nappendByRef(), assign() and getTemplateVars()assign() values to the templates by reference.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?>\nassign(), clearAllAssign(), append(), {assign} and getTemplateVars().nocache parameter of TRUE, the variable is assigned as nocache variable. See Cacheability of Variables for details.<?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{* 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{foreach} and {section}assignByRef(), getTemplateVars(), clearAssign(), append() and {assign}<?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?>\nclearAssign(), clearConfig(), getTemplateVars(), assign() and append()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?>\nclearCache(), isCached() and the caching page.<?php\n// clear a single variable\n$smarty->clearAssign('Name');\n\n// clears multiple variables\n$smarty->clearAssign(array('Name', 'Address', 'Zip'));\n?>\nclearAllAssign(), clearConfig(), getTemplateVars(), assign() and append()
cache_id as the second parameter.$compile_id as a third parameter. You can group templates together so they can be removed as a group, see the caching section for more information.<?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?>\nclearAllCache() and caching section.$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?>\nclearCache().<?php\n// clear all assigned config variables.\n$smarty->clearConfig();\n\n// clear one variable\n$smarty->clearConfig('foobar');\n?>\ngetConfigVars(), config variables, config files, {config_load}, configLoad() and clearAssign().$config_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the config files. The default is \\\".conf\\\".force is an optional boolean which controls if only modified (false) or all (true) config files shall be compiled. The default is \\\"false\\\".timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.maxerror is an optional integer to set an error limit. If more config files failed to compile the function will be aborted. The default is no limit.
"},{"location":"programmers/api-functions/api-compile-all-templates/","title":"Api compile all templates","text":"<?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$template_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the template files. The default is \\\".tpl\\\".force is an optional boolean which controls if only modified (false) or all (true) templates shall be compiled. The default is \\\"false\\\".timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.maxerror is an optional integer to set an error limit. If more templates failed to compile the function will be aborted. The default is no limit.
"},{"location":"programmers/api-functions/api-config-load/","title":"Api config load","text":"<?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{config_load} function.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{config_load}, getConfigVars(), clearConfig(), and config variables
parent is an optional parameter. It is an uplink to the main Smarty object, a another user-created data object or to user-created template object. These objects can be chained. Templates can access variables assigned to any of the objects in it\\'s parent chain.<?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?>\ndisplay(), and createTemplate(),
template must be a valid template resource type and path.<?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?>\ndisplay(), and templateExists().enableSecurity(), and Security.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.<?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$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?>\nfetch() and templateExists().
securityclass is an optional parameter. It\\'s the name of the class with defines the security policy parameters.securityobject is an optional parameter. It\\'s the object with defines the security policy parameters.disableSecurity(), and Security.$cache id, see the caching section for more information.<?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?>\nemail_body.tpl templateDear {$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}\nmail() 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{fetch} display(), {eval}, and templateExists().<?php\n\n// get directory where compiled templates are stored\n$cacheDir = $smarty->getCacheDir();\n\n?>\nsetCacheDir() and $cache_dir.<?php\n\n// get directory where compiled templates are stored\n$compileDir = $smarty->getCompileDir();\n\n?>\nsetCompileDir() and $compile_dir.<?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?>\nsetConfigDir(), addConfigDir() and $config_dir.<?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?>\nclearConfig(), {config_load}, configLoad() and getTemplateVars().<?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?>\nsetPluginsDir(), addPluginsDir() and $plugins_dir.<?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?>\nregisterObject(), unregisterObject() and objects page
template is the template object.
"},{"location":"programmers/api-functions/api-get-template-dir/","title":"Api get template dir","text":"<?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<?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?>\nsetTemplateDir(), addTemplateDir() and $template_dir.<?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?>\nassign(), {assign}, append(), clearAssign(), clearAllAssign() and getConfigVars()
$caching is set to one of Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED to enable caching. See the caching section for more info.$cache_id as an optional second parameter in case you want multiple caches for the given template.$compile id as an optional third parameter. If you omit that parameter the persistent $compile_id is used if its set.$cache_id but want to pass a $compile_id you have to pass NULL as a $cache_id.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?>\nclearCache(), clearAllCache(), and caching section.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?>\nregisterFilter(), $autoload_filters and advanced features.$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.name of the CacheResource and the object extending Smarty_CacheResource. See Custom Cache Implementation for more information on how to create custom CacheResources.$cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.<?php\n$smarty->registerCacheResource('mysql', new Smarty_CacheResource_Mysql());\n?>\nunregisterCacheResource() and the Custom CacheResource Implementation section.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}\nregisterObject(), and Security.<?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?>\nunregisterFilter(), loadFilter(), $autoload_filters, template pre filters template post filters template output filters section.getRegisteredObject(), and unregisterObject().
cacheable and cache_attrs can be omitted in most cases. See controlling cacheability of plugins output on how to use them properly.<?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{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{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?>\nss to strip slashes.<?php\n{$var|ss}\n?>\nunregisterPlugin(), plugin functions, plugin block functions, plugin compiler functions, and the creating plugin modifiers section.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.$smarty->display('c:/path/to/index.tpl');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?>\nunregisterResource() and the template resources section.<?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?>\ngetCacheDir() and $cache_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?>\ngetCompileDir() and $compile_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?>\ngetConfigDir(), addConfigDir() and $config_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?>\ngetPluginsDir(), addPluginsDir() and $plugins_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?>\ngetTemplateDir(), addTemplateDir() and $template_dir.$_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<?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?>\ndisplay(), fetch(), {include} and {insert}
"},{"location":"programmers/api-functions/api-unregister-cacheresource/","title":"Api unregister cacheresource","text":"<?php\nrequire_once('Smarty.class.php');\n$smarty = new Smarty();\n$smarty->testInstall();\n?>\nname of the CacheResource.<?php\n\n$smarty->unregisterCacheResource('mysql');\n\n?>\nregisterCacheResource() and the Custom CacheResource Implementation section.registerFilter().registerObject() and objects section<?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?>\nregisterPlugin().name of the resource.<?php\n\n$smarty->unregisterResource('db');\n\n?>\nregisterResource() and template resources$allow_php_templates to TRUE will enable PHP template files.<?php\n$smarty->allow_php_templates = true;\n?>\n<?php\n$smarty->auto_literal = false;\n?>\n<?php\n$smarty->autoload_filters = array('pre' => array('trim', 'stamp'),\n 'output' => array('convert'));\n?>\nregisterFilter() and loadFilter()./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.$use_sub_dirs.getCacheDir() and setCacheDir() instead.getCacheDir(), setCacheDir(), $caching, $use_sub_dirs, $cache_lifetime, $cache_modified_check and the caching section.$cache_id to each and every function call, you can set this $cache_id and it will be used implicitly thereafter.$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.
$caching must be turned on (either Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED) for $cache_lifetime to have any purpose.$cache_lifetime value of -1 will force the cache to never expire.$caching = Smarty::CACHING_OFF).$caching = Smarty::CACHING_LIFETIME_SAVED, then set $cache_lifetime to a unique value just before calling display() or fetch().$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.$cache_locking to TRUE.$locking_timeout'304: Not Modified' header will be sent instead of the content. This works only on cached content without {insert} tags.$caching, $cache_lifetime, and the caching section.file, enabling the internal filesystem based cache handler.$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.
$cache_lifetime variable to determine if the cache has expired.$cache_lifetime value at the time the cache was generated. This way you can set the $cache_lifetime just before fetching the template to have granular control over when that particular cache expires. See also isCached().$compile_check is enabled, the cached content will be regenerated if any of the templates or config files that are part of this cache are changed.$force_compile is enabled, the cached content will always be regenerated.$cache_dir, $cache_lifetime, $cache_modified_check, is_cached() and the caching section.$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.$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.$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.$force_compile and clearCompiledTemplate()../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.getCompileDir() and setCompileDir() instead.getCompileDir(), setCompileDir(), $compile_id and $use_sub_dirs.$compile_id to each and every function call, you can set this $compile_id and it will be used implicitly thereafter.$compile_id to keep the compiled template files separated.$compile_id and you will get a set of compiled templates for each language you use.<?php\n$smarty->compile_id = 'en';\n?>\n<?php\n\n$smarty->compile_id = $_SERVER['SERVER_NAME'];\n$smarty->compile_dir = '/path/to/shared_compile_dir';\n\n?>\n$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.$compile_locking to FALSE.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../configs, meaning that Smarty will look for the configs/ directory in the same directory as the executing php script.getConfigDir(), setConfigDir() and addConfigDir() instead.getConfigDir(), setConfigDir() and addConfigDir().{cycle} to output a table with alternating red/green/blue row colors with $config_overwrite = FALSE.# row colors\nrowColors = #FF0000\nrowColors = #00FF00\nrowColors = #0000FF\n{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{config_load}, getConfigVars(), clearConfig(), configLoad() and the config files section.debug.tpl and is located in the SMARTY_DIR.$debugging and the debugging console section.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$debugging and $smarty_debug_id.{assign} function.$debugging_ctrl.{debug}, $debug_tpl, and $debugging_ctrl.
"},{"location":"programmers/api-variables/variable-default-config-type/","title":"\\$default_config_type {#variable.default.config.type}","text":"<?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?>\nfile, meaning that $smarty->configLoad('test.conf') and $smarty->configLoad('file:test.conf') are identical in meaning. See the resource chapter for more details.array('escape:\"htmlall\"'). To make a variable exempt from default modifiers, add the \\'nofilter\\' attribute to the output tag such as {$var nofilter}.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-direct-access-security/","title":"\\$direct_access_security {#variable.direct.access.security}","text":"<?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$direct_access_security to FALSE.error_reporting level inside of display() and fetch().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.$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\"}.nofilter flag: {$variable nofilter}.nofilter flag.$caching level, but merely pretends the template has never been cached before.$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.{.$right_delimiter and escaping smarty parsing .$cache_locking$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.inline option flag within the {include} tag. $merge_compiled_includes does not have to be enabled for the inline merge.<?php\n$smarty->merge_compiled_includes = true;\n?>\n{include} tagplugins/ 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.$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.getPluginsDir(), setPluginsDir() and addPluginsDir() instead.getPluginsDir(), setPluginsDir() and addPluginsDir().}.$left_delimiter and escaping smarty parsing.$smarty_debug_id defines the URL keyword to enable debugging at browser level. The default value is SMARTY_DEBUG.$debugging and $debugging_ctrl../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.$template_dir are relative to directories known to the include_path you need to activate the $use_include_path option.getTemplateDir(), setTemplateDir() and addTemplateDir() instead.Template Resources, $use_include_path, getTemplateDir(), setTemplateDir() and addTemplateDir().$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}.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.$template_dir and $plugins_dir work as follows.
$directory in array (\\$template_dir or \\$plugins_dir) do$directory relative to the current working directory. If file found, return it.$path in include_path do$directory relative to the $path (possibly relative to the current working directory). If file found, return it.Template Resources and $template_dir$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.
$use_sub_dirs=true doesn\\'t work with safe_mode=On, that\\'s why it\\'s switchable and why it\\'s off by default.$use_sub_dirs=true on Windows can cause problems.$compile_id, $cache_dir, and $compile_dir.{nocache} and {/nocache} tags.Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n
"},{"location":"programmers/caching/caching-cacheable/#cacheability-of-variables-cacheabilityvariables","title":"Cacheability of Variables {#cacheability.variables}","text":"Today's date is\n{$smarty.now|date_format nocache}\nassign() variables as not cachable. Any tag which uses such variable will be automatically executed in nocache mode.
"},{"location":"programmers/caching/caching-cacheable/#cacheability-of-plugins-cacheabilityplugins","title":"Cacheability of Plugins {#cacheability.plugins}","text":"// assign $foo as nocahe variable\n$smarty->assign('foo',time(),true);\n\n\nDynamic time value is {$foo}\nregisterPlugin() is called $cacheable and defaults to TRUE.$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.$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.{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?>\nindex.tpl is:Time Remaining: {remaining endtime=$obj->endtime}\n$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?>\nindex.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{dynamic}...{/dynamic} and be sure it will not be cached like the rest of the page.Cacheability of Template Section on how to disable caching of a template section by the built-in {nocache} and {/nocache} tags.$cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.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.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.
"},{"location":"programmers/caching/caching-groups/","title":"Cache Groups {#caching.groups}","text":"<?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$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.
'a|b|c' could be thought of as the directory structure '/a/b/c/'.clearCache(null,'a|b|c') would be like removing the files '/a/b/c/*'. clearCache(null,'a|b') would be like removing the files '/a/b/*'.$compile_id such as clearCache(null,'a|b','foo') it is treated as an appended cache group '/a/b/c/foo/'.clearCache('foo.tpl','a|b|c') then Smarty will attempt to remove '/a/b/c/foo.tpl'.'/a/b/*/foo.tpl', the cache grouping works left-to-right ONLY. You will need to group your templates under a single cache group hierarchy to be able to clear them as a group.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').
"},{"location":"programmers/caching/caching-multiple-caches/","title":"Multiple Caches Per Page {#caching.multiple.caches}","text":"<?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?>\ndisplay() 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$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.$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!$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$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$cache_id.$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?>\ndisplay('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.$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!$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$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$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.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{nocache}{/nocache} block function, the {insert} function, or by using the nocache parameter for most template functions.{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.clearAllCache() function, or individual cache files and groups with the clearCache() function.
"},{"location":"programmers/plugins/plugins-block-functions/","title":"Block Functions {#plugins.block.functions}","text":"<?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{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}.
$repeat below on how to change this.)$params variable as an associative array. The opening tag attributes are also accessible to your function when processing the closing tag.$content variable depends on whether your function is called for the opening or closing tag. In case of the opening tag, it will be NULL, and in case of the closing tag it will be the contents of the template block. Note that the template block will have already been processed by Smarty, so all you will receive is the template output, not the template source.$repeat is passed by reference to the function implementation and provides a possibility for it to control how many times the block is displayed. By default $repeat is TRUE at the first call of the block-function (the opening tag) and FALSE on all subsequent calls to the block function (the block\\'s closing tag). Each time the function implementation returns with $repeat being TRUE, the contents between {func}...{/func} are evaluated and the function implementation is called again with the new block contents in the parameter $content.$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?>\nregisterPlugin(), unregisterPlugin().<?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 gets executed at compile time only *}\n{tplheader}\n<?php\necho 'index.tpl compiled at 2002-02-20 20:02';\n?>\nregisterPlugin(), unregisterPlugin().$params as an associative array.{fetch} function. Alternatively, the function can simply perform some other task without any output, eg the {assign} function.$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?>\nQuestion: 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?>\nregisterPlugin(), unregisterPlugin().{insert} tags in the template.{insert} tag in the template.
"},{"location":"programmers/plugins/plugins-modifiers/","title":"Modifiers {#plugins.modifiers}","text":"<?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<?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?>\nregisterPlugin(), unregisterPlugin().type.name.php
type is one of these plugin types:
name should be a valid identifier; letters, numbers, and underscores only, see php variables.function.html_select_date.php, resource.db.php, modifier.spacify.php.smarty_type_name
type and name are the same as above.foo would be function smarty_modifier_foo().<?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?>\nregisterFilter(), unregisterFilter().<?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?>\nregisterFilter() and unregisterFilter().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.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.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{include file='mysql:extras/navigation.tpl'}\nregisterResource(), unregisterResource().<?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
"},{"location":"programmers/resources/resources-custom/","title":"Custom Template Resources {#resources.custom}","text":"$repeat after the Smarty_Internal_Template object to keep backwards compatibility to older versions of Smarty.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
"},{"location":"programmers/resources/resources-extends/","title":"Extends Template Resources {#resources.extends}","text":"{include file='mysql:extras/navigation.tpl'}\nextends: resource is used to define child/parent relationships for template inheritance from the PHP script. For details see section of Template Inheritance.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.<?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{block} and {extends}.file: is the default resource. The resource key file: must only be specified, if the $default_resource_type has been changed.$default_template_handler_func is invoked.$use_include_path is activated$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
"},{"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":"{include file='index.tpl'}\n{include file='file:index.tpl'} {* same as above *}\n$template_dir. This allows websites employing multiple sets of templates better control over which template to access.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
"},{"location":"programmers/resources/resources-file/#templates-from-any-directory-templatesfromanydir","title":"Templates from any directory {#templates.from.any.dir}","text":"{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$template_dir require the file: template resource type, followed by the absolute path to the template (with leading slash.)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
"},{"location":"programmers/resources/resources-file/#windows-filepaths-templateswindowsfilepath","title":"Windows Filepaths {#templates.windows.filepath}","text":"{include file='file:/usr/local/share/templates/navigation.tpl'}\nfile: 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
"},{"location":"programmers/resources/resources-streams/","title":"Stream Template Resources {#resources.streams}","text":"{include file='file:D:/usr/local/share/templates/navigation.tpl'}\n $smarty->display('foo:bar.tpl');\n
"},{"location":"programmers/resources/resources-string/","title":"String Template Resources {#resources.string}","text":" {include file=\"foo:bar.tpl\"}\nstring: or eval: resource.
string: resource behaves much the same as a template file. The template source is compiled from a string and stores the compiled template code for later reuse. Each unique template string will create a new compiled template file. If your template strings are accessed frequently, this is a good choice. If you have frequently changing template strings (or strings with low reuse value), the eval: resource may be a better choice, as it doesn\\'t save compiled templates to disk.eval: resource evaluates the template source every time a page is rendered. This is a good choice for strings with low reuse value. If the same string is accessed frequently, the string: resource may be a better choice.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{include file=\"string:$template_string\"} {* compiles for later reuse *}\n{include file=\"eval:$template_string\"} {* compiles every time *}\nstring: 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
"},{"location":"programmers/resources/template-resources/","title":"Resources {#resasdources}","text":" {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() *}\ndisplay() 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.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
"},{"location":"programmers/resources/template-resources/#default-template-handler-function-defaulttemplatehandlerfunction","title":"Default template handler function {#default.template.handler.function}","text":"{include file='mysql:extras/navigation.tpl'}\nStreams<h1>{$title|escape}</h1>\n<p>\n The number of pixels is: {math equation=\"x * y\" x=$height y=$width}.\n</p>\n
"},{"location":"#introduction","title":"Introduction","text":"<h1>Hello world</h1>\n<p>\n The number of pixels is: 307200.\n</p>\n
"},{"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":"{$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/#how-does-it-work","title":"How does it work?","text":"
"},{"location":"getting-started/","title":"What is Smarty?","text":""},{"location":"getting-started/#requirements","title":"Requirements","text":"composer require smarty/smarty\n````\nTo get the latest, unreleased version, use:\n```bash\ncomposer require smarty/smarty:dev-master\n````\nTo get the previous stable version of Smarty, Smarty 3, use:\n```bash\ncomposer require smarty/smarty:^3\n````\nHere's how you create an instance of Smarty in your PHP scripts:\n```php\n<?php\nrequire 'vendor/autoload.php';\n$smarty = new Smarty();\ntemplates, configs, templates_c and cache relative to the current working directory.$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');\nhttpd.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/\ntestInstall():$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();\nindex.tpl file that Smarty will display. This needs to be located in the $template_dir.{* Smarty *}\nHello {$name}, welcome to Smarty!\n{* 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.assign() a template variable and display() the index.tpl file.<?php\nrequire 'vendor/autoload.php';\n$smarty = new Smarty();\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$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\n/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.<?php\nclass Smarty_GuestBook extends Smarty {\npublic function __construct()\n{\nparent::__construct();\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$this->caching = Smarty::CACHING_LIFETIME_CURRENT;\n$this->assign('app_name', 'Guest Book');\n}\n}\nSmarty_GuestBook instead of Smarty in our scripts:
"},{"location":"philosophy/","title":"Philosophy","text":""},{"location":"philosophy/#what-is-smarty","title":"What is Smarty?","text":"$smarty = new Smarty_GuestBook();\n$smarty->assign('name','Ned');\n$smarty->display('index.tpl');\n
"},{"location":"philosophy/#goals","title":"Goals","text":"$headline, $tagline, $author and $body are content elements, they contain no information about how they will be presented. They are passed into Smarty by the application.
"},{"location":"philosophy/#web-designers-and-php","title":"Web designers and PHP","text":" 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.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 \n{else}\n {$title}\n{/if}\n\n{* the short way *}\n{$title|default:' '}\ndefault modifier and default variable handling.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}\ndefault modifier and blank variable handling.{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'}\narchives.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'}\nheader.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>\nfooter.tpl
"},{"location":"appendixes/tips/#dates-tipsdates","title":"Dates {#tips.dates}","text":"</body>\n</html>\ndate_format modifier for full control over date formatting, and also makes it easy to compare dates if necessary.{$startDate|date_format}\nJan 4, 2009\n\n\n\n\n{$startDate|date_format:\"%Y/%m/%d\"}\n2009/01/04\n{if $order_date < $invoice_date}\n ...do something..\n{/if}\n{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?>\n{html_select_date}, {html_select_time}, date_format and $smarty.now,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?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?>\nindex.tpl{load_ticker symbol='SMARTY' assign='ticker'}\n\nStock Name: {$ticker.name} Stock Price: {$ticker.price}\n{include}.{mailto} plugin.<div id=\"contact\">Send inquiries to\n{mailto address=$EmailAddress encode='javascript' subject='Hello'}\n</div>\nescape modifier and {mailto}.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\nParse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75\n{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...\nor\nWarning: Smarty error: unable to read resource: \"site.conf\" in...\n
$template_dir is incorrect, doesn\\'t exist or the file index.tpl is not in the templates/ directory{config_load} function is within a template (or configLoad() has been called) and either $config_dir is incorrect, does not exist or site.conf is not in the directory.Fatal error: Smarty error: the $compile_dir 'templates_c' does not exist,\nor is not a directory...\n
$compile_diris incorrectly set, the directory does not exist, or templates_c is a file and not a directory.Fatal error: Smarty error: unable to write to $compile_dir '....\n
$compile_dir is not writable by the web server. See the bottom of the installing smarty page for more about permissions.Fatal error: Smarty error: the $cache_dir 'cache' does not exist,\nor is not a directory. in /..\n
$caching is enabled and either; the $cache_dir is incorrectly set, the directory does not exist, or cache/ is a file and not a directory.Fatal error: Smarty error: unable to write to $cache_dir '/...\n
$caching is enabled and the $cache_dir is not writable by the web server. See the bottom of the installing smarty page for permissions.Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php \nin /path/to/smarty/libs/sysplugins/smarty_resource.php\n
$errno as it should. If, for whatever reason, this is the desired behaviour of your custom error handler, please call muteExpectedErrors() after you\\'ve registered your custom error handler.debug.tpl is included with the distribution of Smarty which controls the formatting of the console.$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.{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.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.# 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# (hash) at the beginning of the line.[ 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_load} or the API configLoad() function.[.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.$smarty->configLoad(\"db:my.conf\").{config_load}, $config_overwrite, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()<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{ and }, but they can be changed.
assign attribute which collects the result the function to a named template variable instead of being output; much like the {assign} function.| (pipe) character.<?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\n\n?>\n{$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\n
"},{"location":"designers/language-custom-functions/","title":"Custom Functions {#language.custom.functions}","text":"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-modifiers/","title":"Variable Modifiers {#language.modifiers}","text":""},{"location":"designers/language-modifiers/#table-of-contents","title":"Table of contents","text":"
| (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.{* 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
@\\\" symbol to apply a modifier to an array, such as {$articleTitle|@count}. With Smarty 3, the \\\"@\\\" is no longer necessary, and is ignored.{8+2}, meaning that {8+2|count_characters} would give 2, as 8+2=10 and 10 is two characters long. With Smarty 3, modifiers are applied to the variables or atomic expressions before executing the calculations, so since 2 is one character long, {8+2|count_characters} gives 9. To get the old result use parentheses like {(8+2)|count_characters}.$plugins_dir or can be registered explicitly with the registerPlugin() function. The later is useful for sharing a function between php scripts and smarty templates.
$foo with {\"%2.f\"|sprintf:$foo} actually works, but asks for the more intuitive, like {$foo|string_format:\"%2.f\"} that is provided by the Smarty distribution.$modifiers property of the security policy. See the Security section for details.registerPlugin(), combining modifiers. and extending smarty with plugins
{$Name}\n\n{$product.part_no} <b>{$product.description}</b>\n\n{$Contacts[row].Phone}\n\n<body bgcolor=\"{#bgcolor#}\">\n$auto_literal to false.<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.$left_delimiter and $right_delimiter values.<?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\n?>\n
"},{"location":"designers/language-basic-syntax/language-math/","title":"Math {#language.math}","text":"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{$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`\"}\ntrue and false. If an attribute has no value assigned it gets the default boolean value of true.{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{* this is a comment *}\n<!-- HTML comments -->. These are useful for making internal notes in the templates which no one will see ;-)
"},{"location":"designers/language-basic-syntax/language-syntax-functions/","title":"Functions {#language.syntax.functions}","text":"{* 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{*********************************************************\nMulti 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{funcname attr1=\"val1\" attr2=\"val2\"}.{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
{if}, {section} and {strip}. There should be no need to change or modify them.{html_options} is an example of a custom function.registerPlugin()
$object->reference, then the variable must be surrounded by `backticks`.{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\n\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\"}\nescape.$smarty.config variable.{$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$_GET, $_SESSION, etc are available via the reserved $smarty variable.$smarty, config variables {assign} and assign().{append} is used for creating or appending template variable arrays during the execution of a template. var string Yes *n/a* The name of the variable being assigned\n value string Yes *n/a* The value being assigned\n index string No *n/a* The index for the new array element. If not specified the value is append to the end of the array.\n scope string No *n/a* The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'\nName Description\n{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}.\nThe first name is Bob.\nThe last name is Meyer.\nappend() and getTemplateVars().{assign} is used for assigning template variables during the execution of a template.short-form method of assigning template vars. var string Yes *n/a* The name of the variable being assigned\n value string Yes *n/a* The value being assigned\n scope string No *n/a* The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'\nName Description\n{assign var=\"name\" value=\"Bob\"}\n{assign \"name\" \"Bob\"} {* short-hand *}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n\n\n\n\n{assign var=\"name\" value=\"Bob\" nocache}\n{assign \"name\" \"Bob\" nocache} {* short-hand *}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n\n\n\n\n{assign var=running_total value=$running_total+$some_array[$row].some_value}\n{include file=\"sub_template.tpl\"}\n...\n{* display variable assigned in sub_template *}\n{$foo}<br>\n...\nsub_template.tpl below...\n{* foo will be known also in the including template *}\n{assign var=\"foo\" value=\"something\" scope=parent}\n{* bar is assigned only local in the including template *}\n{assign var=\"bar\" value=\"value\"}\n...\n{assign var=foo value=\"bar\" scope=\"root\"}\n{assign var=foo value=\"bar\" scope=\"global\"}\n{assign \"foo\" \"bar\" scope=\"global\"} {* short-hand *}\n{assign} variables from a php script use getTemplateVars(). Here\\'s the template that creates the variable $foo.{assign var=\"foo\" value=\"Smarty\"}\n<?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\n?>\n{capture}, {include}, {insert}, {counter}, {cycle}, {eval}, {fetch}, {math}, {textformat}{$var=...}, assign() and getTemplateVars().{block} is used to define a named area of template source for template inheritance. For details see section of Template Inheritance.{block} template source area of a child template will replace the corresponding areas in the parent template(s).{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 the {\\$smarty.block.parent} the {block} content of the parent template can be inserted at any location of the child {block} content. {\\$smarty.block.child} inserts the {block} content of the child template at any location of the parent {block}.{blocks}'s can be nested. name string Yes *n/a* The name of the template source block\nName Description\n{block} content will be be appended to the content of the parent template {block} prepend The {block} content will be prepended to the content of the parent template {block} hide Ignore the block content if no child block of same name is existing. nocache Disables caching of the {block} content<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{extends file=\"parent.tpl\"} \n{block name=\"title\"}\nPage Title\n{/block}\n<html>\n <head>\n <title>Page Title</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"}Title - {/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\" append}\nPage Title\n{/block}\n<html>\n <head>\n <title>Title - Page Title</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"} is my title{/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\" prepend}\nPage Title\n{/block}\n<html>\n <head>\n <title>Page title is my titel</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"}The {$smarty.block.child} was inserted here{/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\"}\nChild Title\n{/block}\n<html>\n <head>\n <title>The Child Title was inserted here</title>\n </head>\n</html>\n<html>\n <head>\n <title>{block name=\"title\"}Parent Title{/block}</title>\n </head>\n</html>\n{extends file=\"parent.tpl\"} \n{block name=\"title\"}\nYou will see now - {$smarty.block.parent} - here\n{/block}\n<html>\n <head>\n <title>You will see now - Parent Title - here</title>\n </head>\n</html>\n$smarty.block.parent, $smarty.block.child, and {extends}{call} is used to call a template function defined by the {function} tag just like a plugin function.{call} tag must be used to call a template function defined externally from the given template. Otherwise you can directly use the function as {funcname ...} in the template.
{call} tag must have the name attribute which contains the the name of the template function. name string Yes *n/a* The name of the template function\n assign string No *n/a* The name of the variable that the output of called template function will be assigned to\n\\[var \\...\\] \\[var type\\] No *n/a* variable to pass local to template function\nName Description\n{* 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* 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{function}{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.$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. name string Yes *n/a* The name of the captured block\n assign string No *n/a* The variable name where to assign the captured output to\n append string No *n/a* The name of an array variable where to append the captured output to\nName Description\n{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.{* 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{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{capture append=\"foo\"}hello{/capture}I say just {capture append=\"foo\"}world{/capture}\n{foreach $foo as $text}{$text} {/foreach}\nI say just hello world\n$smarty.capture, {eval}, {fetch}, fetch() and {assign}.{config_load} is used for loading config #variables# from a configuration file into the template. file string Yes *n/a* The name of the config file to include\n section string No *n/a* The name of the section to load\n scope string no *local* How the scope of the loaded variables are treated, which must be one of local, parent or global. local means variables are loaded into the local template context. parent means variables are loaded into both the local context and the parent template that called it. global means variables are available to all templates.\nexample.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{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>\nsection. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.{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$config_overwrite to create arrays of config file variables.$config_dir, getConfigVars() and configLoad().{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.{debug} does show only the variables which assigned for the cached page.{debug} tag at the end of the template.{extends} tags are used in child templates in template inheritance for extending parent templates. For details see section of Template Inheritance.
{extends} tag must be on the first line of the template.{extends} tag it may contain only {block} tags. Any other template content is ignored.$template_dir directory.{extends file=$parent_file}, make sure you include $parent_file in the $compile_id. Otherwise Smarty cannot distinguish between different $parent_files. file string Yes *n/a* The name of the template file which is extended\n\n\n{extends file='parent.tpl'}\n{extends 'parent.tpl'} {* short-hand *}\n{block}.{for}{forelse} tag is used to create simple loops. The following different formats are supported:
{for $var=$start to $end} simple loop with step size of 1.{for $var=$start to $end step $step} loop with individual step size.{forelse} is executed when the loop is not iterated. max n/a integer No *n/a* Limit the number of iterations\nName Description\n{for} loop<ul>\n{for $foo=1 to 3}\n <li>{$foo}</li>\n{/for}\n</ul>\n<ul>\n <li>1</li>\n <li>2</li>\n <li>3</li>\n</ul>\n\n\n\n\n$smarty->assign('to',10);\n\n\n\n\n<ul>\n{for $foo=3 to $to max=3}\n <li>{$foo}</li>\n{/for}\n</ul>\n<ul>\n <li>3</li>\n <li>4</li>\n <li>5</li>\n</ul>\n\n\n\n\n$smarty->assign('start',10);\n$smarty->assign('to',5);\n\n\n\n\n<ul>\n{for $foo=$start to $to}\n <li>{$foo}</li>\n{forelse}\n no iteration\n{/for}\n</ul>\n no iteration\n{foreach}, {section} and {while}{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.{foreach $arrayvar as $itemvar}{foreach $arrayvar as $keyvar=>$itemvar}{foreach from=$myarray key=\"mykey\" item=\"myitem\"} is still supported.
{foreach} loops can be nested.array variable, usually an array of values, determines the number of times {foreach} will loop. You can also pass an integer for arbitrary loops.{foreachelse} is executed when there are no values in the array variable.{foreach} properties are @index, @iteration, @first, @last, @show, @total.{foreach} constructs are {break}, {continue}.key variable you can access the current key of the loop item by {$item@key} (see examples below).$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.{foreach $myArray as $myKey => $myValue}, the key is always available as $myValue@key within the foreach loop.Name Description\n{foreach} loop<?php\n$arr = array('red', 'green', 'blue');\n$smarty->assign('myColors', $arr);\n?>\n$myColors in an un-ordered list<ul>\n{foreach $myColors as $color}\n <li>{$color}</li>\n{/foreach}\n</ul>\n<ul>\n <li>red</li>\n <li>green</li>\n <li>blue</li>\n</ul>\n\n\n\n\n<?php\n$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');\n$smarty->assign('myPeople', $people);\n?>\n$myArray as key/value pairs.<ul>\n{foreach $myPeople as $value}\n <li>{$value@key}: {$value}</li>\n{/foreach}\n</ul>\n<ul>\n <li>fname: John</li>\n <li>lname: Doe</li>\n <li>email: j.doe@example.com</li>\n</ul>\n<?php\n $smarty->assign('contacts', array(\n array('phone' => '555-555-1234',\n 'fax' => '555-555-5678',\n 'cell' => '555-555-0357'),\n array('phone' => '800-555-4444',\n 'fax' => '800-555-3333',\n 'cell' => '800-555-2222')\n ));\n?>\n$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 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<?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?>\n\n\n\n\n{foreach $res as $r} \n {$r.id} \n {$r.name}\n{foreachelse}\n .. no results .. \n{/foreach}\nid and name.index contains the current array index, starting with zero.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#iteration-foreachpropertyiteration","title":"\\@iteration {#foreach.property.iteration}","text":"{* 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>\niteration contains the current loop iteration and always starts at one, unlike index. It is incremented by one on each iteration.{foreach $myNames as $name}\n {if $name@iteration is div by 4}\n <b>{$name}</b>\n {/if}\n {$name}\n{/foreach}\n {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
"},{"location":"designers/language-builtin-functions/language-function-foreach/#first-foreachpropertyfirst","title":"\\@first {#foreach.property.first}","text":" <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 ...\nfirst is TRUE if the current {foreach} iteration is the initial one. Here we display a table header row on the first iteration.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#last-foreachpropertylast","title":"\\@last {#foreach.property.last}","text":"{* 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>\nlast is set to TRUE if the current {foreach} iteration is the final one. Here we display a horizontal rule on the last iteration.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#show-foreachpropertyshow","title":"\\@show {#foreach.property.show}","text":"{* 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}\nshow 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.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#total-foreachpropertytotal","title":"\\@total {#foreach.property.total}","text":"<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}\ntotal 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{section}, {for} and {while}{break} aborts the iteration of the array
"},{"location":"designers/language-builtin-functions/language-function-foreach/#continue-foreachconstructcontinue","title":"{continue} {#foreach.construct.continue}","text":" {$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{continue} leaves the current iteration and begins with the next iteration.
"},{"location":"designers/language-builtin-functions/language-function-function/","title":"{function} {#language.function.function}","text":" {$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{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.{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.
{function} tag must have the name attribute which contains the the name of the template function. A tag with this name can be used to call the template function. name string Yes *n/a* The name of the template function\n\\[var \\...\\] \\[var type\\] No *n/a* default variable value to pass local to the template function\n{funcname ...} tag unless you what to use default values. Default values must be scalar and can not be variable. Variables must be passed when the template is called.{* define the function *}\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* 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{call}{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.$php_functions property of the securty policy are allowed. See the Security section for details. Qualifier Alternates Syntax Example Meaning PHP Equivalent\n == eq \\$a eq \\$b equals ==\n != ne, neq \\$a neq \\$b not equals !=\n \\> gt \\$a gt \\$b greater than \\>\n \\< lt \\$a lt \\$b less than \\<\n \\>= gte, ge \\$a ge \\$b greater than or equal \\>=\n \\<= lte, le \\$a le \\$b less than or equal \\<=\n === \\$a === 0 check for identity ===\n ! not not \\$a negation (unary) !\n \\% mod \\$a mod \\$b modulous \\%\n
"},{"location":"designers/language-builtin-functions/language-function-include/","title":"{include} {#language.function.include}","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\n\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{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.
{include} tag must have the file attribute which contains the template resource path.assign attribute specifies the template variable that the output of {include} is assigned to, instead of being displayed. Similar to {assign}.{include} statement. This default behaviour can be changed for all variables assigned in the included template by using the scope attribute at the {include} statement or for individual variables by using the scope attribute at the {assign} statement. The later is useful to return values from the included template to the including template.{include} files outside of the $template_dir directory. file string Yes *n/a* The name of the template file to include\n assign string No *n/a* The name of the variable that the output of include will be assigned to\nName Description\n<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\n\n\n\n{include 'links.tpl' title='Newest links' links=$link_array}\n{* body of template goes here *}\n{include 'footer.tpl' foo='bar'}\nlinks.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{include 'sub_template.tpl' scope=parent}\n...\n{* display variables assigned in sub_template *}\n{$foo}<br>\n{$bar}<br>\n...\nsub_template.tpl below...\n{assign var=foo value='something'}\n{assign var=bar value='value'}\n...\n{include 'sub_template.tpl' nocache}\n...\n{include 'sub_template.tpl' cache_lifetime=500}\n...\n{include 'sub_template.tpl' caching}\n...\nnav.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 {include 'template-in-a-template_dir-directory.tpl'}\n {include './template-in-same-directory.tpl'}\n {include '../template-in-parent-directory.tpl'}\n\n\n\n\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{insert}, template resources and componentized templates.{insert} tags are deprecated from Smarty, and should not be used. Put your PHP logic in PHP scripts or plugin functions instead.{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. name string Yes *n/a* The name of the insert function (insert\\_`name`) or insert plugin\n assign string No *n/a* The name of the template variable the output will be assigned to\n script string No *n/a* The name of the php script that is included before the insert function is called\n\\[var \\...\\] \\[var type\\] No *n/a* variable to pass to insert function\n{* 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
assign attribute, the output of the {insert} tag will be assigned to this template variable instead of being output to the template.script attribute, this php script will be included (only once) before the {insert} function is executed. This is the case where the insert function may not exist yet, and a php script must be included first to make it work.$trusted_dir. If security is enabled, then the script must be located in the $trusted_dir path of the security policy. See the Security section for details.{insert} function.{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.{include}{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{funcname} is how functions look in Smarty!\n<script language=\"JavaScript\">\nfunction foo() {ldelim}\n ... code ...\n{rdelim}\n</script>\n<script language=\"JavaScript\">\nfunction foo() {\n .... code ...\n}\n</script>\n\n\n\n\n<script language=\"JavaScript\" type=\"text/javascript\">\n function myJsFunction(){ldelim}\n alert(\"The server name\\n{$smarty.server.SERVER_NAME}\\n{$smarty.server.SERVER_ADDR}\");\n {rdelim}\n</script>\n<a href=\"javascript:myJsFunction()\">Click here for Server Info</a>\n{literal} and escaping Smarty parsing.{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.{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{ldelim} {rdelim} and the escaping Smarty parsing page.{nocache} is used to disable caching of a template section. Every {nocache} must be paired with a matching {/nocache}.Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n{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.{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.{foreach} loop. name string Yes *n/a* The name of the section\n loop mixed Yes *n/a* Value to determine the number of loop iterations\n start integer No *0* The index position that the section will begin looping. If the value is negative, the start position is calculated from the end of the array. For example, if there are seven values in the loop array and start is -2, the start index is 5. Invalid values (values outside of the length of the loop array) are automatically truncated to the closest valid value.\n step integer No *1* The step value that will be used to traverse the loop array. For example, step=2 will loop on index 0,2,4, etc. If step is negative, it will step through the array backwards.\n max integer No *n/a* Sets the maximum number of times the section will loop.\n show boolean No *TRUE* Determines whether or not to show this section\nName Description\n{section} loop
name and loop.name of the {section} can be anything you like, made up of letters, numbers and underscores, like PHP variables.{section} names must be unique from each other.loop attribute, usually an array of values, determines the number of times the {section} will loop. You can also pass an integer as the loop value.{section}, the {section} name must be given next to variable name within [brackets].{sectionelse} is executed when there are no values in the loop variable.{section} also has its own variables that handle {section} properties. These properties are accessible as: {$smarty.section.name.property} where \"name\" is the attribute name.{section} properties are index, index_prev, index_next, iteration, first, last, rownum, loop, show, total.assign() an array to Smarty<?php\n$data = array(1000,1001,1002);\n$smarty->assign('custid',$data);\n?>\n{* 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}\nid: 1000<br />\nid: 1001<br />\nid: 1002<br />\n<hr />\nid: 1002<br />\nid: 1001<br />\nid: 1000<br />\n\n\n\n\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}\n10 12 14 16 18\n<hr />\n20 18 16 14 12 10\nname 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{section}. Following is the php script to assign the $contacts array to Smarty.<?php\n$data = array(\n array('name' => 'John Smith', 'home' => '555-555-5555',\n 'cell' => '666-555-5555', 'email' => 'john@myexample.com'),\n array('name' => 'Jack Jones', 'home' => '777-555-5555',\n 'cell' => '888-555-5555', 'email' => 'jack@myexample.com'),\n array('name' => 'Jane Munson', 'home' => '000-555-5555',\n 'cell' => '123456', 'email' => 'jane@myexample.com')\n );\n$smarty->assign('contacts',$data);\n?>\n$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<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$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 = array(1001,1002,1003);\n$smarty->assign('custid',$id);\n\n$fullnames = array('John Smith','Jack Jones','Jane Munson');\n$smarty->assign('name',$fullnames);\n\n$addr = array('253 Abbey road', '417 Mulberry ln', '5605 apple st');\n$smarty->assign('address',$addr);\n\n?>\nloop 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<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.php script that assigns the arrays.<?php\n\n$id = array(1001,1002,1003);\n$smarty->assign('custid',$id);\n\n$fullnames = array('John Smith','Jack Jones','Jane Munson');\n$smarty->assign('name',$fullnames);\n\n$addr = array('253 N 45th', '417 Mulberry ln', '5605 apple st');\n$smarty->assign('address',$addr);\n\n$types = array(\n array( 'home phone', 'cell phone', 'e-mail'),\n array( 'home phone', 'web'),\n array( 'cell phone')\n );\n$smarty->assign('contact_type', $types);\n\n$info = array(\n array('555-555-5555', '666-555-5555', 'john@myexample.com'),\n array( '123-456-4', 'www.example.com'),\n array( '0457878')\n );\n$smarty->assign('contact_info', $info);\n\n?>\n{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<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<?php\n$sql = 'select id, name, home, cell, email from contacts '\n .\"where name like '$foo%' \";\n$smarty->assign('contacts', $db->getAll($sql));\n?>\n
"},{"location":"designers/language-builtin-functions/language-function-section/#index-sectionpropertyindex","title":".index {#section.property.index}","text":"<table>\n<tr><th> </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>\nindex 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.step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.$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
"},{"location":"designers/language-builtin-functions/language-function-section/#index_prev-sectionpropertyindexprev","title":".index_prev {#section.property.index.prev}","text":"0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nindex_prev is the previous loop index. On the first loop, this is set to -1.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 = array(1001,1002,1003,1004,1005);\n$smarty->assign('rows',$data);\n?>\n{* $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
"},{"location":"designers/language-builtin-functions/language-function-section/#iteration-sectionpropertyiteration","title":".iteration {#section.property.iteration}","text":"index id index_prev prev_id index_next next_id\n0 1001 -1 1 1002\n1 1002 0 1001 2 1003\n2 1003 1 1002 3 1004\n3 1004 2 1003 4 1005\n4 1005 3 1004 5\niteration contains the current loop iteration and starts at one.{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?>\n$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}\niteration=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 />\niteration 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> </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>\niteration 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{if $smarty.section.co.iteration % 5 == 1} will work just the same.first is set to TRUE if the current {section} iteration is the initial one.last is set to TRUE if the current section iteration is the final one.$customers array, outputs a header block on the first iteration and on the last outputs the footer block. Also uses the total property.
"},{"location":"designers/language-builtin-functions/language-function-section/#rownum-sectionpropertyrownum","title":".rownum {#section.property.rownum}","text":"{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}\nrownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.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
"},{"location":"designers/language-builtin-functions/language-function-section/#show-sectionpropertyshow","title":".show {#section.property.show}","text":"0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nThere are 3 customers shown above.\nshow 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.$show_customer_info has been passed from the PHP application, to regulate whether or not this section shows.{section name=customer loop=$customers show=$show_customer_info}\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
"},{"location":"designers/language-builtin-functions/language-function-section/#total-sectionpropertytotal","title":".total {#section.property.total}","text":"1 id: 1000<br />\n2 id: 1001<br />\n3 id: 1002<br />\n\nthe section was shown.\ntotal 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{foreach}, {for}, {while} and $smarty.section.{setfilter}...{/setfilter} block tag allows the definition of template instance\\'s variable filters.
{setfilter}...{/setfilter} blocks can be nested. The filter definition of inner blocks does replace the definition of the outer block.nofilter flag.<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 scope n/a string No *n/a* The scope of the assigned variable: \\'parent\\',\\'root\\' or \\'global\\'\nName Description\n{$name='Bob'}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n\n\n\n\n{$running_total=$running_total+$some_array[row].some_value}\n\n\n\n\n{$user.name=\"Bob\"}\n\n\n\n\n{$user.name.first=\"Bob\"}\n\n\n\n\n{$users[]=\"Bob\"}\n{include file=\"sub_template.tpl\"}\n...\n{* display variable assigned in sub_template *}\n{$foo}<br>\n...\nsub_template.tpl below...\n{* foo will be known also in the including template *}\n{$foo=\"something\" scope=parent}\n{* bar is assigned only local in the including template *}\n{$bar=\"value\"}\n...\n{assign} and {append}{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.{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 border='0'>\n <tr>\n <td>\n <a href=\"{$url}\">\n <font color=\"red\">This is a test</font>\n </a>\n </td>\n </tr>\n</table>\n{/strip}\n<table border='0'><tr><td><a href=\"http://. snipped...</a></td></tr></table>\nstrip modifier.{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. Qualifier Alternates Syntax Example Meaning PHP Equivalent\n == eq \\$a eq \\$b equals ==\n != ne, neq \\$a neq \\$b not equals !=\n \\> gt \\$a gt \\$b greater than \\>\n \\< lt \\$a lt \\$b less than \\<\n \\>= gte, ge \\$a ge \\$b greater than or equal \\>=\n \\<= lte, le \\$a le \\$b less than or equal \\<=\n === \\$a === 0 check for identity ===\n ! not not \\$a negation (unary) !\n \\% mod \\$a mod \\$b modulous \\%\n{while $foo > 0}\n {$foo--}\n{/while}\n{foreach}, {for} and {section}.{counter} is used to print out a count. {counter} will remember the count on each iteration. You can adjust the number, the interval and the direction of the count, as well as determine whether or not to print the value. You can run multiple counters concurrently by supplying a unique name for each one. If you do not supply a name, the name \"default\" will be used.assign attribute, the output of the {counter} function will be assigned to this template variable instead of being output to the template. name string No *default* The name of the counter\n start number No *1* The initial number to start counting from\n skip number No *1* The interval to count by\n direction string No *up* The direction to count (up/down)\n print boolean No *TRUE* Whether or not to print the value\n assign string No *n/a* the template variable the output will be assigned to\n\n\n{* initialize the count *}\n{counter start=0 skip=2}<br />\n{counter}<br />\n{counter}<br />\n{counter}<br />\n
"},{"location":"designers/language-custom-functions/language-function-cycle/","title":"{cycle} {#language.function.cycle}","text":"0<br />\n2<br />\n4<br />\n6<br />\n{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. name string No *default* The name of the cycle\n values mixed Yes *N/A* The values to cycle through, either a comma delimited list (see delimiter attribute), or an array of values\n print boolean No *TRUE* Whether to print the value or not\n advance boolean No *TRUE* Whether or not to advance to the next value\n delimiter string No *,* The delimiter to use in the values attribute\n assign string No *n/a* The template variable the output will be assigned to\n reset boolean No *FALSE* The cycle will be set to the first value and not advanced\n
{cycle} through more than one set of values in a template by supplying a name attribute. Give each {cycle} an unique name.print attribute set to FALSE. This would be useful for silently skipping a value.advance attribute is used to repeat a value. When set to FALSE, the next call to {cycle} will print the same value.assign attribute, the output of the {cycle} function will be assigned to a template variable instead of being output to the template.{section name=rows loop=$data}\n<tr class=\"{cycle values=\"odd,even\"}\">\n <td>{$data[rows]}</td>\n</tr>\n{/section}\n
"},{"location":"designers/language-custom-functions/language-function-debug/","title":"{debug} {#language.function.debug}","text":"<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{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. output string No *javascript* output type, html or javascript\n{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.assign attribute, the output of the {eval} function will be assigned to this template variable instead of being output to the template. var mixed Yes *n/a* Variable (or string) to evaluate\n assign string No *n/a* The template variable the output will be assigned to\n
{include file=\"string:{$template_code}\"} instead. This may cache the compiled state and thus doesn\\'t have to run the (comparably slow) compiler on every invocation.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{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}\nThis 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$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?>\n
"},{"location":"designers/language-custom-functions/language-function-fetch/","title":"{fetch} {#language.function.fetch}","text":" {eval var=$foo}\n{fetch} is used to retrieve files from the local file system, http, or ftp and display the contents.
http://, the web site page will be fetched and displayed.ftp://, the file will be downloaded from the ftp server and displayed.{fetch} will only allow files from within the $secure_dir path of the security policy. See the Security section for details.assign attribute is set, the output of the {fetch} function will be assigned to this template variable instead of being output to the template. file string Yes *n/a* The file, http or ftp site to fetch\n assign string No *n/a* The template variable the output will be assigned to\n\n\n{* 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{capture}, {eval}, {assign} and fetch().{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. name string No *checkbox* Name of checkbox list\n values array Yes, unless using options attribute *n/a* An array of values for checkbox buttons\n output array Yes, unless using options attribute *n/a* An array of output for checkbox buttons\n selected string/array No *empty* The selected checkbox element(s)\n options associative array Yes, unless using values and output *n/a* An associative array of values and output\n separator string No *empty* String of text to separate each checkbox item\n assign string No *empty* Assign checkbox tags to an array instead of output\n labels boolean No *TRUE* Add \\<label\\>-tags to the output\n label\\_ids boolean No *FALSE* Add id-attributes to \\<label\\> and \\<input\\> to the output\n escape boolean No *TRUE* Escape the output / content (values are always escaped)\n strict boolean No *FALSE* Will make the \\\"extra\\\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\\\"disabled\\\"* and *\\\"readonly\\\"* respectively\n
values and output, unless you use options instead.<?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\n?>\n{html_checkboxes name='id' values=$cust_ids output=$cust_names\n selected=$customer_id separator='<br />'}\n<?php\n\n$smarty->assign('cust_checkboxes', array(\n 1000 => 'Joe Schmoe',\n 1001 => 'Jack Smith',\n 1002 => 'Jane Johnson',\n 1003 => 'Charlie Brown')\n );\n$smarty->assign('customer_id', 1001);\n\n?>\n{html_checkboxes name='id' options=$cust_checkboxes\n selected=$customer_id separator='<br />'}\n<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\n\n\n\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\n?>\n{html_checkboxes name='contact_type_id' options=$contact_types\n selected=$contact.contact_type_id separator='<br />'}\n{html_radios} and {html_options}{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. file string Yes *n/a* name/path to image\n height string No *actual image height* Height to display image\n width string No *actual image width* Width to display image\n basedir string no *web server doc root* Directory to base relative paths from\n alt string no *\"\"* Alternative description of the image\n href string no *n/a* href value to link the image to\npath\\_prefix string no *n/a* Prefix for output path\n
basedir is the base directory that relative image paths are based from. If not given, the web server\\'s document root $_ENV['DOCUMENT_ROOT'] is used as the base. If security is enabled, then the image must be located in the $secure_dir path of the security policy. See the Security section for details.href is the href value to link the image to. If link is supplied, an <a href=\"LINKVALUE\"><a> tag is placed around the image tag.path_prefix is an optional prefix string you can give the output path. This is useful if you want to supply a different server name for the image.<img> tag.{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.{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
"},{"location":"designers/language-custom-functions/language-function-html-options/","title":"{html_options} {#language.function.html.options}","text":"<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{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. values array Yes, unless using options attribute *n/a* An array of values for dropdown\n output array Yes, unless using options attribute *n/a* An array of output for dropdown\n selected string/array No *empty* The selected option element(s)\n options associative array Yes, unless using values and output *n/a* An associative array of values and output\n name string No *empty* Name of select group\n strict boolean No *FALSE* Will make the \\\"extra\\\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\\\"disabled\\\"* and *\\\"readonly\\\"* respectively\n
values and output, unless you use the combined options instead.name attribute is given, the <select></select> tags are created, otherwise ONLY the <option> list is generated.<optgroup>, and display the groups. Recursion is supported with <optgroup>.<select> tag. They are ignored if the optional name is not given.<?php\n$smarty->assign('myOptions', array(\n 1800 => 'Joe Schmoe',\n 9904 => 'Jack Smith',\n 2003 => 'Charlie Brown')\n );\n$smarty->assign('mySelect', 9904);\n?>\nname attribute which creates the <select> tags.{html_options name=foo options=$myOptions selected=$mySelect}\n<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\n\n<?php\n$smarty->assign('cust_ids', array(56,92,13));\n$smarty->assign('cust_names', array(\n 'Joe Schmoe',\n 'Jane Johnson',\n 'Charlie Brown'));\n$smarty->assign('customer_id', 92);\n?>\ncount() 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<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\n\n\n\n\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\n?>\ntruncate 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\n\n\n\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?>\n{html_options name=foo options=$lookups selected=$fav}\n<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{html_checkboxes} and {html_radios}{html_radios} is a custom function that creates a HTML radio button group. It also takes care of which item is selected by default as well. name string No *radio* Name of radio list\n values array Yes, unless using options attribute *n/a* An array of values for radio buttons\n output array Yes, unless using options attribute *n/a* An array of output for radio buttons\n selected string No *empty* The selected radio element\n options associative array Yes, unless using values and output *n/a* An associative array of values and output\n separator string No *empty* String of text to separate each radio item\n assign string No *empty* Assign radio tags to an array instead of output\n labels boolean No *TRUE* Add \\<label\\>-tags to the output\n label\\_ids boolean No *FALSE* Add id-attributes to \\<label\\> and \\<input\\> to the output\n escape boolean No *TRUE* Escape the output / content (values are always escaped)\n strict boolean No *FALSE* Will make the \\\"extra\\\" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *\\\"disabled\\\"* and *\\\"readonly\\\"* respectively\n
values and output, unless you use options instead.<input>-tags.<?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\n?>\n{html_radios name='id' values=$cust_ids output=$cust_names\n selected=$customer_id separator='<br />'}\n\n\n\n\n<?php\n\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\n?>\n{html_radios name='id' options=$cust_radios\n selected=$customer_id separator='<br />'}\n<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\n\n\n\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\n?>\n{html_radios name='contact_type_id' options=$contact_types\n selected=$contact.contact_type_id separator='<br />'}\n{html_checkboxes} and {html_options}{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. Attribute Name Type Required Default Description\n prefix string No Date\\_ What to prefix the var name with\n time [timestamp](https://www.php.net/function.time), [DateTime](https://www.php.net/class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](https://www.php.net/strtotime), arrays as produced by this function if field\\_array is set. No current [timestamp](https://www.php.net/function.time) What date/time to pre-select. If an array is given, the attributes field\\_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL\n start\\_year string No current year The first year in the dropdown, either year number, or relative to current year (+/- N)\n end\\_year string No same as start\\_year The last year in the dropdown, either year number, or relative to current year (+/- N)\n display\\_days boolean No TRUE Whether to display days or not\n display\\_months boolean No TRUE Whether to display months or not\n display\\_years boolean No TRUE Whether to display years or not\n month\\_names array No null List of strings to display for months. array(1 =\\> \\'Jan\\', ..., 12 =\\> \\'Dec\\')\n month\\_format string No \\%B What format the month should be in (strftime)\n day\\_format string No \\%02d What format the day output should be in (sprintf)\nday\\_value\\_format string No \\%d What format the day value should be in (sprintf)\n year\\_as\\_text boolean No FALSE Whether or not to display the year as text\n reverse\\_years boolean No FALSE Display years in reverse order\n field\\_array string No null If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name\\[Day\\], name\\[Year\\], name\\[Month\\].\n day\\_size string No null Adds size attribute to select tag if given\n month\\_size string No null Adds size attribute to select tag if given\n year\\_size string No null Adds size attribute to select tag if given\n all\\_extra string No null Adds extra attributes to all select/input tags if given\n day\\_extra string No null Adds extra attributes to select/input tags if given\n month\\_extra string No null Adds extra attributes to select/input tags if given\n year\\_extra string No null Adds extra attributes to select/input tags if given\n all\\_id string No null Adds id-attribute to all select/input tags if given\n day\\_id string No null Adds id-attribute to select/input tags if given\n month\\_id string No null Adds id-attribute to select/input tags if given\n year\\_id string No null Adds id-attribute to select/input tags if given\n field\\_order string No MDY The order in which to display the fields\n field\\_separator string No \\\\n String printed between different fields\n{html_select_date} form values to a timestamp.{html_select_date}\n<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\n\n\n\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<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{html_select_time}, date_format, $smarty.now and the date tips page.{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.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(). Attribute Name Type Required Default Description\n prefix string No Time\\_ What to prefix the var name with\n time [timestamp](https://www.php.net/function.time), [DateTime](https://www.php.net/class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](https://www.php.net/strtotime), arrays as produced by this function if field\\_array is set. No current [timestamp](https://www.php.net/function.time) What date/time to pre-select. If an array is given, the attributes field\\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from.\n display\\_hours boolean No TRUE Whether or not to display hours\n display\\_minutes boolean No TRUE Whether or not to display minutes\n display\\_seconds boolean No TRUE Whether or not to display seconds\n display\\_meridian boolean No TRUE Whether or not to display meridian (am/pm)\n use\\_24\\_hours boolean No TRUE Whether or not to use 24 hour clock\n minute\\_interval integer No 1 Number interval in minute dropdown\n second\\_interval integer No 1 Number interval in second dropdown\n hour\\_format string No \\%02d What format the hour label should be in (sprintf)\nhour\\_value\\_format string No \\%20d What format the hour value should be in (sprintf)\n minute\\_format string No \\%02d What format the minute label should be in (sprintf)\n{html_select_time use_24_hours=true}\n<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$smarty.now, {html_select_date} and the date tips page.{html_table} is a custom function that dumps an array of data into an HTML <table>. loop array Yes *n/a* Array of data to loop through\n cols mixed No *3* Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array.\n rows integer No *empty* Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements.\n inner string No *cols* Direction of consecutive elements in the loop-array to be rendered. *cols* means elements are displayed col-by-col. *rows* means elements are displayed row-by-row.\n caption string No *empty* Text to be used for the `<caption>` element of the table\ntable\\_attr string No *border=\\\"1\\\"* Attributes for `<table>` tag\n th\\_attr string No *empty* Attributes for `<th>` tag (arrays are cycled)\n tr\\_attr string No *empty* attributes for `<tr>` tag (arrays are cycled)\n td\\_attr string No *empty* Attributes for `<td>` tag (arrays are cycled)\n trailpad string No * * Value to pad the trailing cells on last row with (if any)\n hdir string No *right* Direction of each row to be rendered. possible values: *right* (left-to-right), and *left* (right-to-left)\n vdir string No *down* Direction of each column to be rendered. possible values: *down* (top-to-bottom), *up* (bottom-to-top)\n
cols attribute determines how many columns will be in the table.table_attr, tr_attr and td_attr values determine the attributes given to the <table>, <tr> and <td> tags.tr_attr or td_attr are arrays, they will be cycled through.trailpad is the value put into the trailing cells on the last table row if there are any present.<?php\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?>\n
"},{"location":"designers/language-custom-functions/language-function-mailto/","title":"{mailto} {#language.function.mailto}","text":"{**** Example One ****}\n{html_table loop=$data}\n\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\n\n{**** Example Two ****}\n{html_table loop=$data cols=4 table_attr='border=\"0\"'}\n\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> </td><td> </td><td> </td></tr>\n</tbody>\n</table>\n\n\n{**** Example Three ****}\n{html_table loop=$data cols=\"first,second,third,fourth\" tr_attr=$tr}\n\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> </td><td> </td><td> </td></tr>\n</tbody>\n</table>\n{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. address string Yes *n/a* The e-mail address\n text string No *n/a* The text to display, default is the e-mail address\n encode string No *none* How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`.\n cc string No *n/a* Email addresses to carbon copy, separate entries by a comma.\n bcc string No *n/a* Email addresses to blind carbon copy, separate entries by a comma\n subject string No *n/a* Email subject\n newsgroups string No *n/a* Newsgroups to post to, separate entries by a comma.\n followupto string No *n/a* Addresses to follow up to, separate entries by a comma.\n extra string No *n/a* Any extra information you want passed to the link, such as style sheet classes\n\n\n{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\">m&..snipped...#x6f;m</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>\nescape, {textformat} and obfuscating email addresses.{math} allows the template designer to do math equations in the template.
assign attribute, the output of the {math} function will be assigned to this template variable instead of being output to the template.{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. equation string Yes *n/a* The equation to execute\n format string No *n/a* The format of the result (sprintf)\n var numeric Yes *n/a* Equation variable value\n assign string No *n/a* Template variable the output will be assigned to\n\\[var \\...\\] numeric Yes *n/a* Equation variable value\n {* $height=4, $width=5 *}\n\n {math equation=\"x + y\" x=$height y=$width}\n 9\n {* $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 100\n {* you can use parenthesis *}\n\n {math equation=\"(( x + y ) / z )\" x=2 y=10 z=2}\n 6\n {* you can supply a format parameter in sprintf format *}\n\n {math equation=\"x + y\" x=4.4444 y=5.0000 format=\"%.2f\"}\n
"},{"location":"designers/language-custom-functions/language-function-textformat/","title":"{textformat} {#language.function.textformat}","text":" 9.44\n{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. style string No *n/a* Preset style\n indent number No *0* The number of chars to indent every line\n {textformat wrap=40}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n This is foo. This is foo. This is foo.\n This is foo. This is foo. This 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 bar\n foo foo. bar foo bar foo foo. bar foo\n bar foo foo. bar foo bar foo foo.\n\n\n\n\n {textformat wrap=40 indent=4}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n 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\n\n\n\n {textformat wrap=40 indent=4 indent_first=4}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n 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\n\n\n\n {textformat style=\"email\"}\n\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n bar foo bar foo foo.\n\n {/textformat}\n This is foo. This is foo. This is foo. This is foo. This is foo. This is\n foo.\n\n This is bar.\n\n bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo\n bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo\n foo.\n{strip} and wordwrap.ucwords() function. 1 boolean No FALSE This determines whether or not words with digits will be uppercased\n 2 boolean No FALSE This determines whether or not Capital letters within words should be lowercased, e.g. \\\"aAa\\\" to \\\"Aaa\\\"\n\n\n<?php\n\n$smarty->assign('articleTitle', 'next x-men film, x3, delayed.');\n\n?>\n{$articleTitle}\n{$articleTitle|capitalize}\n{$articleTitle|capitalize:true}\nnext x-men film, x3, delayed.\nNext X-Men Film, x3, Delayed.\nNext X-Men Film, X3, Delayed.\nlower and upper 1 string No *empty* This value to catenate to the given variable.\n\n\n<?php\n\n$smarty->assign('articleTitle', \"Psychics predict world didn't end\");\n\n?>\n{$articleTitle|cat:' yesterday.'}\n
"},{"location":"designers/language-modifiers/language-modifier-count-characters/","title":"count_characters {#language.modifier.count.characters}","text":"Psychics predict world didn't end yesterday.\n 1 boolean No FALSE This determines whether or not to include whitespace characters in the count.\n\n\n<?php\n\n$smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.');\n\n?>\n{$articleTitle}\n{$articleTitle|count_characters}\n{$articleTitle|count_characters:true}\nCold Wave Linked to Temperatures.\n29\n33\ncount_words, count_sentences and count_paragraphs.<?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\n?>\n{$articleTitle}\n{$articleTitle|count_paragraphs}\nWar Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\nMan is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\n2\ncount_characters, count_sentences and count_words.<?php\n\n$smarty->assign('articleTitle',\n 'Two Soviet Ships Collide - One Dies.\n Enraged Cow Injures Farmer with Axe.'\n );\n\n?>\n{$articleTitle}\n{$articleTitle|count_sentences}\nTwo Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe.\n2\ncount_characters, count_paragraphs and count_words.<?php\n\n$smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n\n?>\n{$articleTitle}\n{$articleTitle|count_words}\nDealers Will Hear Car Talk at Noon.\n7\ncount_characters, count_paragraphs and count_sentences.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. 1 string No \\%b %e, %Y This is the format for the outputted date.\n 2 string No n/a This is the default date if the input is empty.\ndate_format are always (except for mysql timestamps, see below) interpreted as a unix timestamp.strtotime() in php (like YYYYMMDD) where sometimes (depending on the underlying implementation of strtotime()) interpreted as date strings and NOT as timestamps.YYYYMMDDHHMMSS), mysql timestamps have precedence over unix timestamps.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.<?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\n?>\n$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}\nJan 1, 2022\n01/01/22\n02:33 pm\nDec 31, 2021\nMonday, December 1, 2021\n14:33:00\ndate_format conversion specifiers:
$smarty.now, strftime(), {html_select_date} and the date tips page. 1 string No *empty* This is the default value to output if the variable is empty.\n\n\n<?php\n\n$smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n$smarty->assign('email', '');\n\n?>\n{$articleTitle|default:'no title'}\n{$myTitle|default:'no title'}\n{$email|default:'No email address available'}\nDealers Will Hear Car Talk at Noon.\nno title\nNo email address available\nescape is used to encode or escape a variable to html, url, single quotes, hex, hexentity, javascript and mail. By default its html. 1 string No `html`, `htmlall`, `url`, `urlpathinfo`, `quotes`, `hex`, `hexentity`, `javascript`, `mail` `html` This is the escape format to use.\n 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](https://www.php.net/htmlentities) `UTF-8` The character set encoding passed to htmlentities() et. al.\n 3 boolean No FALSE TRUE Double encode entites from & to &amp; (applys to `html` and `htmlall` only)\n\n\n<?php\n\n$smarty->assign('articleTitle',\n \"'Stiff Opposition Expected to Casketless Funeral Plan'\"\n );\n$smarty->assign('EmailAddress','smarty@example.com');\n\n?>\nescape template lines followed by the output{$articleTitle}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'html'} {* escapes & \" ' < > *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'htmlall'} {* escapes ALL html entities *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\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\">bob..snip..et</a>\n\n{'mail@example.com'|escape:'mail'}\nsmarty [AT] example [DOT] com\n\n\n\n\n{* the \"rewind\" parameter registers the current location *}\n<a href=\"$my_path?page=foo&rewind=$my_uri|urlencode}\">click here</a>\n{mailto}{* email address mangled *}\n<a href=\"mailto:{$EmailAddress|escape:'hex'}\">{$EmailAddress|escape:'mail'}</a>\n{mailto} and the obfuscating email addresses page.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. 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](https://www.php.net/mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be decoded from\n\"\\t\" for a tab. 1 integer No 4 This determines how many characters to indent to.\n 2 string No (one space) This is the character used to indent with.\n\n\n<?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?>\n{$articleTitle}\n\n{$articleTitle|indent}\n\n{$articleTitle|indent:10}\n\n{$articleTitle|indent:1:\"\\t\"}\nNJ 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.\nstrip, wordwrap and spacify.strtolower() function.<?php\n\n$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');\n\n?>\n{$articleTitle}\n{$articleTitle|lower}\nTwo Convicts Evade Noose, Jury Hung.\ntwo convicts evade noose, jury hung.\nupper and capitalize.\"\\n\" line breaks will be converted to html <br /> tags in the given variable. This is equivalent to the PHP\\'s nl2br() function.<?php\n\n$smarty->assign('articleTitle',\n \"Sun or rain expected\\ntoday, dark tonight\"\n );\n\n?>\n{$articleTitle|nl2br}\nSun or rain expected<br />today, dark tonight\nword_wrap, count_paragraphs and count_sentences.preg_replace() syntax from the PHP manual. 1 string Yes *n/a* This is the regular expression to be replaced.\n 2 string Yes *n/a* This is the string of text to replace with.\n\n\n<?php\n\n$smarty->assign('articleTitle', \"Infertility unlikely to\\nbe passed on, experts say.\");\n\n?>\n{* replace each carriage return, tab and new line with a space *}\n\n{$articleTitle}\n{$articleTitle|regex_replace:\"/[\\r\\t\\n]/\":\" \"}\nInfertility unlikely to\nbe passed on, experts say.\nInfertility unlikely to be passed on, experts say.\nreplace and escape.str_replace() function. 1 string Yes *n/a* This is the string of text to be replaced.\n 2 string Yes *n/a* This is the string of text to replace with.\n\n\n<?php\n\n$smarty->assign('articleTitle', \"Child's Stool Great for Use in Garden.\");\n\n?>\n{$articleTitle}\n{$articleTitle|replace:'Garden':'Vineyard'}\n{$articleTitle|replace:' ':' '}\nChild's Stool Great for Use in Garden.\nChild's Stool Great for Use in Vineyard.\nChild's Stool Great for Use in Garden.\nregex_replace and escape.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. 1 string No *one space* This what gets inserted between each character of the variable.\n\n\n<?php\n\n$smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.');\n\n?>\n{$articleTitle}\n{$articleTitle|spacify}\n{$articleTitle|spacify:\"^^\"}\nSomething 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^^.\nwordwrap and nl2br.sprintf() for the formatting. 1 string Yes *n/a* This is what format to use. (sprintf)\n\n\n<?php\n\n$smarty->assign('number', 23.5787446);\n\n?>\n{$number}\n{$number|string_format:\"%.2f\"}\n{$number|string_format:\"%d\"}\n23.5787446\n23.58\n23\ndate_format.< and >. 1 bool No TRUE This determines whether the tags are replaced by \\' \\' or \\'\\'\n\n\n<?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\n?>\n{$articleTitle}\n{$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *}\n{$articleTitle|strip_tags:false}\nBlind 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.\nreplace and regex_replace.{strip} function.<?php\n$smarty->assign('articleTitle', \"Grandmother of\\neight makes\\t hole in one.\");\n$smarty->display('index.tpl');\n?>\n{$articleTitle}\n{$articleTitle|strip}\n{$articleTitle|strip:' '}\nGrandmother of\neight makes hole in one.\nGrandmother of eight makes hole in one.\nGrandmother of eight makes hole in one.\n{strip} and truncate.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. 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](https://www.php.net/mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be encoded to\ntruncate 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. 1 integer No 80 This determines how many characters to truncate to.\n 2 string No \\... This is a text string that replaces the truncated text. Its length is included in the truncation length setting.\n 3 boolean No FALSE This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE.\n 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.\n\n\n<?php\n$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');\n?>\n{$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
"},{"location":"designers/language-modifiers/language-modifier-unescape/","title":"unescape {#language.modifier.unescape}","text":"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.\nunescape is used to decode entity, html and htmlall. It counters the effects of the escape modifier for the given types. 1 string No `html`, `htmlall`, `entity`, `html` This is the escape format to use.\n 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](https://www.php.net/htmlentities) `UTF-8` The character set encoding passed to html\\_entity\\_decode() or htmlspecialchars\\_decode() or mb\\_convert\\_encoding() et. al.\n\n\n<?php\n\n$smarty->assign('articleTitle',\n \"Germans use "Ümlauts" and pay in €uro\"\n );\n\n?>\nunescape template lines followed by the output{$articleTitle}\nGermans use "Ümlauts" and pay in €uro\n\n{$articleTitle|unescape:\"html\"}\nGermans use \"Ümlauts\" and pay in €uro\n\n{$articleTitle|unescape:\"htmlall\"}\nGermans use \"\u00dcmlauts\" and pay in \u20acuro\nstrtoupper() function.<?php\n$smarty->assign('articleTitle', \"If Strike isn't Settled Quickly it may Last a While.\");\n?>\n{$articleTitle}\n{$articleTitle|upper}\nIf Strike isn't Settled Quickly it may Last a While.\nIF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE.\nlower and capitalize.\"\\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. 1 integer No 80 This determines how many columns to wrap to.\n 2 string No \\\\n This is the string used to wrap words with.\n 3 boolean No FALSE This determines whether or not to wrap at a word boundary (FALSE), or at the exact character (TRUE).\n\n\n<?php\n\n$smarty->assign('articleTitle',\n \"Blind woman gets new kidney from dad she hasn't seen in years.\"\n );\n\n?>\n{$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}\nBlind 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.\nnl2br and {textformat}.$) sign.<?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\n?>\nindex.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
"},{"location":"designers/language-variables/language-assigned-variables/#associative-arrays-languagevariablesassocarrays","title":"Associative arrays {#language.variables.assoc.arrays}","text":"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<?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?>\nindex.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
"},{"location":"designers/language-variables/language-assigned-variables/#array-indexes-languagevariablesarrayindexes","title":"Array indexes {#language.variables.array.indexes}","text":"555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n<?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?>\nindex.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
"},{"location":"designers/language-variables/language-assigned-variables/#objects-languagevariablesobjects","title":"Objects {#language.variables.objects}","text":"555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\n-> symbol.name: {$person->name}<br />\nemail: {$person->email}<br />\n
"},{"location":"designers/language-variables/language-config-variables/","title":"Variables loaded from config files {#language.config.variables}","text":"name: Zaphod Beeblebrox<br />\nemail: zaphod@slartibartfast.example.com<br />\n#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.foo.conf:pageTitle = \"This is mine\"\nbodyBgColor = '#eeeeee'\ntableBorderSize = 3\ntableBgColor = \"#bbbbbb\"\nrowBgColor = \"#cccccc\"\n#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$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<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_load}.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.$smarty->display(...) or $smarty->fetch(...) calls are automatically linked to the Smarty object variable scope.// 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);\nassign(), createData() and createTemplate().{$smarty} variable can be used to access several environment and request variables. The full list of them follows.$_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{$SCRIPT_NAME} is short-hand 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{$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<?php\n// the constant defined in php\ndefine('MY_CONST_VAL','CHERRIES');\n?>\n{$smarty.const.MY_CONST_VAL}\n{capture}..{/capture} function can be accessed using the {$smarty.capture} variable. See the {capture} page for more information.{$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.{$smarty.section} variables can be used to refer to {section} loop properties. These have some very useful values such as .first, .index, etc.{$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/#smartyblockchild-languagevariablessmartyblockchild","title":"{\\$smarty.block.child} {#language.variables.smarty.block.child}","text":"<div id=\"footer\">Powered by Smarty {$smarty.version}</div>\n{ldelim},{rdelim}.
"},{"location":"programmers/api-functions/","title":"Smarty Class Methods {#api.functions}","text":""},{"location":"programmers/api-functions/#table-of-contents","title":"Table of contents","text":"
Changing settings by template section for how to use the functions for individual templates.
Changing settings by template section for how to change Smarty class variables for individual templates.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.
"},{"location":"programmers/charset/","title":"Charset Encoding {#charset}","text":""},{"location":"programmers/charset/#charset-encoding-charsetencoding","title":"Charset Encoding {#charset.encoding}","text":"Smarty::$_CHARSET, Smarty recognizes UTF-8 as the internal charset if Multibyte String is available, ISO-8859-1 if not.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.
"},{"location":"programmers/plugins/","title":"Extending Smarty With Plugins {#plugins}","text":""},{"location":"programmers/plugins/#table-of-contents","title":"Table of contents","text":"// 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
$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.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/smarty-constants/","title":"Constants {#smarty.constants}","text":""},{"location":"programmers/smarty-constants/#smarty_dir-constantsmartydir","title":"SMARTY_DIR {#constant.smarty.dir}","text":"<?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$smarty.const.
assign() objects to the templates and access them much like any other assigned variable.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?>\nindex.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)}\nregisterObject() and assign().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.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?>\nregisterFilter(), loadFilter(), $autoload_filters, postfilters and $plugins_dir.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?>\nindex.tpl look like:<!-- Created by Smarty! -->\n{* rest of template content... *}\nregisterFilter(), prefilters, outputfilters, and loadFilter().loadFilter() function or by setting the $autoload_filters variable.<?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?>\nregisterFilter(), postfilters and loadFilter().
$secure_dir is an array of template directories that are considered secure. $template_dir considered secure implicitly. The default is an empty array.$trusted_dir 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}. The default is an empty array.$trusted_uri is an array of regular expressions matching URIs that are considered trusted. This security directive used by {fetch} and {html_image}. URIs passed to these functions are reduced to {$PROTOCOL}://{$HOSTNAME} to allow simple regular expressions (without having to deal with edge cases like authentication-tokens).'#https?://.*smarty.net$#i' would allow accessing the following URIs:
http://smarty.net/foohttp://smarty.net/foohttp://www.smarty.net/foohttp://smarty.net/foohttps://foo.bar.www.smarty.net/foo/bla?blubb=1
http://smarty.com/foo (not matching top-level domain \\\"com\\\")ftp://www.smarty.net/foo (not matching protocol \\\"ftp\\\")http://www.smarty.net.otherdomain.com/foo (not matching end of domain \\\"smarty.net\\\")$static_classes is an array of classes that are considered trusted. The default is an empty array which allows access to all static classes. To disable access to all static classes set \\$static_classes = null.$php_functions is an array of PHP functions that are considered trusted and can be used from within template. To disable access to all PHP functions set \\$php_functions = null. An empty array ( \\$php_functions = array() ) will allow all PHP functions. The default is array(\\'isset\\', \\'empty\\', \\'count\\', \\'sizeof\\', \\'in_array\\', \\'is_array\\',\\'time\\',\\'nl2br\\').$php_modifiers is an array of PHP functions that are considered trusted and can be used from within template as modifier. To disable access to all PHP modifier set \\$php_modifier = null. An empty array ( \\$php_modifier = array() ) will allow all PHP functions. The default is array(\\'escape\\',\\'count\\').$streams is an array of streams that are considered trusted and can be used from within template. To disable access to all streams set \\$streams = null. An empty array ( \\$streams = array() ) will allow all streams. The default is array(\\'file\\').$allowed_modifiers is an array of (registered / autoloaded) modifiers that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.$disabled_modifiers is an array of (registered / autoloaded) modifiers that may not be accessible to the template.$allowed_tags is a boolean flag which controls if constants can function-, block and filter plugins that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.$disabled_tags is an array of (registered / autoloaded) function-, block and filter plugins that may not be accessible to the template.$allow_constants is a boolean flag which controls if constants can be accessed by the template. The default is \\\"true\\\".$allow_super_globals is a boolean flag which controls if the PHP super globals can be accessed by the template. The default is \\\"true\\\".<?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
"},{"location":"programmers/advanced-features/advanced-features-streams/","title":"Streams {#advanced.features.streams}","text":"{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{$foo:bar}\nTemplate Resources
{block} tags they override. Anything outside of {block} tags will be removed.{block} tags from child and parent templates can be merged by the append or prepend {block} tag option flags and {$smarty.block.parent} or {$smarty.block.child} placeholders.{include} tag it does have much better performance when rendering.{extends} tag, which must be the first line in the child template. Instead of using the {extends} tags in the template files you can define the whole template inheritance tree in the PHP script when you are calling fetch() or display() with the extends: template resource type. The later provides even more flexibility.$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.{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.<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{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{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 $smarty->display('mypage.tpl');\n<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{extends} tags in the template files you can define the inheritance tree in your PHP script by using the extends: resource type.<?php\n$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); \n?>\n{block}, {extends} and extends: resourceSmarty class variables. Furthermore you can register plugins, filters etc. with Smarty functions. Modifications done to the Smarty object will be global for all templates.
"},{"location":"programmers/api-functions/api-add-config-dir/","title":"Api add config dir","text":"<?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<?php\n\n// add directory where config files are stored\n$smarty->addConigDir('./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?>\ngetConfigDir(), setConfigDir() and $config_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?>\ngetPluginsDir(), setPluginsDir() and $plugins_dir.<?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?>\ngetTemplateDir(), setTemplateDir() and $template_dir.append() values to the templates by reference.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.<?php\n// appending name/value pairs\n$smarty->appendByRef('Name', $myname);\n$smarty->appendByRef('Address', $address);\n?>\nappend(), assign() and getTemplateVars().<?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?>\nappendByRef(), assign() and getTemplateVars()assign() values to the templates by reference.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?>\nassign(), clearAllAssign(), append(), {assign} and getTemplateVars().nocache parameter of TRUE, the variable is assigned as nocache variable. See Cacheability of Variables for details.<?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{* 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{foreach} and {section}assignByRef(), getTemplateVars(), clearAssign(), append() and {assign}<?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?>\nclearAssign(), clearConfig(), getTemplateVars(), assign() and append()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?>\nclearCache(), isCached() and the caching page.<?php\n// clear a single variable\n$smarty->clearAssign('Name');\n\n// clears multiple variables\n$smarty->clearAssign(array('Name', 'Address', 'Zip'));\n?>\nclearAllAssign(), clearConfig(), getTemplateVars(), assign() and append()
cache_id as the second parameter.$compile_id as a third parameter. You can group templates together so they can be removed as a group, see the caching section for more information.<?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?>\nclearAllCache() and caching section.$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?>\nclearCache().<?php\n// clear all assigned config variables.\n$smarty->clearConfig();\n\n// clear one variable\n$smarty->clearConfig('foobar');\n?>\ngetConfigVars(), config variables, config files, {config_load}, configLoad() and clearAssign().$config_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the config files. The default is \\\".conf\\\".force is an optional boolean which controls if only modified (false) or all (true) config files shall be compiled. The default is \\\"false\\\".timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.maxerror is an optional integer to set an error limit. If more config files failed to compile the function will be aborted. The default is no limit.
"},{"location":"programmers/api-functions/api-compile-all-templates/","title":"Api compile all templates","text":"<?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$template_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the template files. The default is \\\".tpl\\\".force is an optional boolean which controls if only modified (false) or all (true) templates shall be compiled. The default is \\\"false\\\".timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.maxerror is an optional integer to set an error limit. If more templates failed to compile the function will be aborted. The default is no limit.
"},{"location":"programmers/api-functions/api-config-load/","title":"Api config load","text":"<?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{config_load} function.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{config_load}, getConfigVars(), clearConfig(), and config variables
parent is an optional parameter. It is an uplink to the main Smarty object, a another user-created data object or to user-created template object. These objects can be chained. Templates can access variables assigned to any of the objects in it\\'s parent chain.<?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?>\ndisplay(), and createTemplate(),
template must be a valid template resource type and path.<?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?>\ndisplay(), and templateExists().enableSecurity(), and Security.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.<?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$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?>\nfetch() and templateExists().
securityclass is an optional parameter. It\\'s the name of the class with defines the security policy parameters.securityobject is an optional parameter. It\\'s the object with defines the security policy parameters.disableSecurity(), and Security.$cache id, see the caching section for more information.<?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?>\nemail_body.tpl templateDear {$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}\nmail() 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{fetch} display(), {eval}, and templateExists().<?php\n\n// get directory where compiled templates are stored\n$cacheDir = $smarty->getCacheDir();\n\n?>\nsetCacheDir() and $cache_dir.<?php\n\n// get directory where compiled templates are stored\n$compileDir = $smarty->getCompileDir();\n\n?>\nsetCompileDir() and $compile_dir.<?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?>\nsetConfigDir(), addConfigDir() and $config_dir.<?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?>\nclearConfig(), {config_load}, configLoad() and getTemplateVars().<?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?>\nsetPluginsDir(), addPluginsDir() and $plugins_dir.<?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?>\nregisterObject(), unregisterObject() and objects page
template is the template object.
"},{"location":"programmers/api-functions/api-get-template-dir/","title":"Api get template dir","text":"<?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<?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?>\nsetTemplateDir(), addTemplateDir() and $template_dir.<?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?>\nassign(), {assign}, append(), clearAssign(), clearAllAssign() and getConfigVars()
$caching is set to one of Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED to enable caching. See the caching section for more info.$cache_id as an optional second parameter in case you want multiple caches for the given template.$compile id as an optional third parameter. If you omit that parameter the persistent $compile_id is used if its set.$cache_id but want to pass a $compile_id you have to pass NULL as a $cache_id.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?>\nclearCache(), clearAllCache(), and caching section.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?>\nregisterFilter(), $autoload_filters and advanced features.$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.name of the CacheResource and the object extending Smarty_CacheResource. See Custom Cache Implementation for more information on how to create custom CacheResources.$cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.<?php\n$smarty->registerCacheResource('mysql', new Smarty_CacheResource_Mysql());\n?>\nunregisterCacheResource() and the Custom CacheResource Implementation section.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}\nregisterObject(), and Security.<?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?>\nunregisterFilter(), loadFilter(), $autoload_filters, template pre filters template post filters template output filters section.getRegisteredObject(), and unregisterObject().
cacheable and cache_attrs can be omitted in most cases. See controlling cacheability of plugins output on how to use them properly.<?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{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{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?>\nss to strip slashes.<?php\n{$var|ss}\n?>\nunregisterPlugin(), plugin functions, plugin block functions, plugin compiler functions, and the creating plugin modifiers section.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.$smarty->display('c:/path/to/index.tpl');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?>\nunregisterResource() and the template resources section.<?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?>\ngetCacheDir() and $cache_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?>\ngetCompileDir() and $compile_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?>\ngetConfigDir(), addConfigDir() and $config_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?>\ngetPluginsDir(), addPluginsDir() and $plugins_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?>\ngetTemplateDir(), addTemplateDir() and $template_dir.$_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<?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?>\ndisplay(), fetch(), {include} and {insert}
"},{"location":"programmers/api-functions/api-unregister-cacheresource/","title":"Api unregister cacheresource","text":"<?php\nrequire_once('Smarty.class.php');\n$smarty = new Smarty();\n$smarty->testInstall();\n?>\nname of the CacheResource.<?php\n\n$smarty->unregisterCacheResource('mysql');\n\n?>\nregisterCacheResource() and the Custom CacheResource Implementation section.registerFilter().registerObject() and objects section<?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?>\nregisterPlugin().name of the resource.<?php\n\n$smarty->unregisterResource('db');\n\n?>\nregisterResource() and template resources$allow_php_templates to TRUE will enable PHP template files.<?php\n$smarty->allow_php_templates = true;\n?>\n<?php\n$smarty->auto_literal = false;\n?>\n<?php\n$smarty->autoload_filters = array('pre' => array('trim', 'stamp'),\n 'output' => array('convert'));\n?>\nregisterFilter() and loadFilter()./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.$use_sub_dirs.getCacheDir() and setCacheDir() instead.getCacheDir(), setCacheDir(), $caching, $use_sub_dirs, $cache_lifetime, $cache_modified_check and the caching section.$cache_id to each and every function call, you can set this $cache_id and it will be used implicitly thereafter.$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.
$caching must be turned on (either Smarty::CACHING_LIFETIME_CURRENT or Smarty::CACHING_LIFETIME_SAVED) for $cache_lifetime to have any purpose.$cache_lifetime value of -1 will force the cache to never expire.$caching = Smarty::CACHING_OFF).$caching = Smarty::CACHING_LIFETIME_SAVED, then set $cache_lifetime to a unique value just before calling display() or fetch().$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.$cache_locking to TRUE.$locking_timeout'304: Not Modified' header will be sent instead of the content. This works only on cached content without {insert} tags.$caching, $cache_lifetime, and the caching section.file, enabling the internal filesystem based cache handler.$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.
$cache_lifetime variable to determine if the cache has expired.$cache_lifetime value at the time the cache was generated. This way you can set the $cache_lifetime just before fetching the template to have granular control over when that particular cache expires. See also isCached().$compile_check is enabled, the cached content will be regenerated if any of the templates or config files that are part of this cache are changed.$force_compile is enabled, the cached content will always be regenerated.$cache_dir, $cache_lifetime, $cache_modified_check, is_cached() and the caching section.$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.$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.$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.$force_compile and clearCompiledTemplate()../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.getCompileDir() and setCompileDir() instead.getCompileDir(), setCompileDir(), $compile_id and $use_sub_dirs.$compile_id to each and every function call, you can set this $compile_id and it will be used implicitly thereafter.$compile_id to keep the compiled template files separated.$compile_id and you will get a set of compiled templates for each language you use.<?php\n$smarty->compile_id = 'en';\n?>\n<?php\n\n$smarty->compile_id = $_SERVER['SERVER_NAME'];\n$smarty->compile_dir = '/path/to/shared_compile_dir';\n\n?>\n$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.$compile_locking to FALSE.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../configs, meaning that Smarty will look for the configs/ directory in the same directory as the executing php script.getConfigDir(), setConfigDir() and addConfigDir() instead.getConfigDir(), setConfigDir() and addConfigDir().{cycle} to output a table with alternating red/green/blue row colors with $config_overwrite = FALSE.# row colors\nrowColors = #FF0000\nrowColors = #00FF00\nrowColors = #0000FF\n{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{config_load}, getConfigVars(), clearConfig(), configLoad() and the config files section.debug.tpl and is located in the SMARTY_DIR.$debugging and the debugging console section.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$debugging and $smarty_debug_id.{assign} function.$debugging_ctrl.{debug}, $debug_tpl, and $debugging_ctrl.
"},{"location":"programmers/api-variables/variable-default-config-type/","title":"\\$default_config_type {#variable.default.config.type}","text":"<?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?>\nfile, meaning that $smarty->configLoad('test.conf') and $smarty->configLoad('file:test.conf') are identical in meaning. See the resource chapter for more details.array('escape:\"htmlall\"'). To make a variable exempt from default modifiers, add the \\'nofilter\\' attribute to the output tag such as {$var nofilter}.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-direct-access-security/","title":"\\$direct_access_security {#variable.direct.access.security}","text":"<?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$direct_access_security to FALSE.error_reporting level inside of display() and fetch().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.$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\"}.nofilter flag: {$variable nofilter}.nofilter flag.$caching level, but merely pretends the template has never been cached before.$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.{.$right_delimiter and escaping smarty parsing .$cache_locking$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.inline option flag within the {include} tag. $merge_compiled_includes does not have to be enabled for the inline merge.<?php\n$smarty->merge_compiled_includes = true;\n?>\n{include} tagplugins/ 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.$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.getPluginsDir(), setPluginsDir() and addPluginsDir() instead.getPluginsDir(), setPluginsDir() and addPluginsDir().}.$left_delimiter and escaping smarty parsing.$smarty_debug_id defines the URL keyword to enable debugging at browser level. The default value is SMARTY_DEBUG.$debugging and $debugging_ctrl../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.$template_dir are relative to directories known to the include_path you need to activate the $use_include_path option.getTemplateDir(), setTemplateDir() and addTemplateDir() instead.Template Resources, $use_include_path, getTemplateDir(), setTemplateDir() and addTemplateDir().$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}.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.$template_dir and $plugins_dir work as follows.
$directory in array (\\$template_dir or \\$plugins_dir) do$directory relative to the current working directory. If file found, return it.$path in include_path do$directory relative to the $path (possibly relative to the current working directory). If file found, return it.Template Resources and $template_dir$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.
$use_sub_dirs=true doesn\\'t work with safe_mode=On, that\\'s why it\\'s switchable and why it\\'s off by default.$use_sub_dirs=true on Windows can cause problems.$compile_id, $cache_dir, and $compile_dir.{nocache} and {/nocache} tags.Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\n
"},{"location":"programmers/caching/caching-cacheable/#cacheability-of-variables-cacheabilityvariables","title":"Cacheability of Variables {#cacheability.variables}","text":"Today's date is\n{$smarty.now|date_format nocache}\nassign() variables as not cachable. Any tag which uses such variable will be automatically executed in nocache mode.
"},{"location":"programmers/caching/caching-cacheable/#cacheability-of-plugins-cacheabilityplugins","title":"Cacheability of Plugins {#cacheability.plugins}","text":"// assign $foo as nocahe variable\n$smarty->assign('foo',time(),true);\n\n\nDynamic time value is {$foo}\nregisterPlugin() is called $cacheable and defaults to TRUE.$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.$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.{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?>\nindex.tpl is:Time Remaining: {remaining endtime=$obj->endtime}\n$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?>\nindex.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{dynamic}...{/dynamic} and be sure it will not be cached like the rest of the page.Cacheability of Template Section on how to disable caching of a template section by the built-in {nocache} and {/nocache} tags.$cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.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.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.
"},{"location":"programmers/caching/caching-groups/","title":"Cache Groups {#caching.groups}","text":"<?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$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.
'a|b|c' could be thought of as the directory structure '/a/b/c/'.clearCache(null,'a|b|c') would be like removing the files '/a/b/c/*'. clearCache(null,'a|b') would be like removing the files '/a/b/*'.$compile_id such as clearCache(null,'a|b','foo') it is treated as an appended cache group '/a/b/c/foo/'.clearCache('foo.tpl','a|b|c') then Smarty will attempt to remove '/a/b/c/foo.tpl'.'/a/b/*/foo.tpl', the cache grouping works left-to-right ONLY. You will need to group your templates under a single cache group hierarchy to be able to clear them as a group.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').
"},{"location":"programmers/caching/caching-multiple-caches/","title":"Multiple Caches Per Page {#caching.multiple.caches}","text":"<?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?>\ndisplay() 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$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.$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!$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$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$cache_id.$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?>\ndisplay('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.$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!$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$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$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.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{nocache}{/nocache} block function, the {insert} function, or by using the nocache parameter for most template functions.{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.clearAllCache() function, or individual cache files and groups with the clearCache() function.
"},{"location":"programmers/plugins/plugins-block-functions/","title":"Block Functions {#plugins.block.functions}","text":"<?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{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}.
$repeat below on how to change this.)$params variable as an associative array. The opening tag attributes are also accessible to your function when processing the closing tag.$content variable depends on whether your function is called for the opening or closing tag. In case of the opening tag, it will be NULL, and in case of the closing tag it will be the contents of the template block. Note that the template block will have already been processed by Smarty, so all you will receive is the template output, not the template source.$repeat is passed by reference to the function implementation and provides a possibility for it to control how many times the block is displayed. By default $repeat is TRUE at the first call of the block-function (the opening tag) and FALSE on all subsequent calls to the block function (the block\\'s closing tag). Each time the function implementation returns with $repeat being TRUE, the contents between {func}...{/func} are evaluated and the function implementation is called again with the new block contents in the parameter $content.$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?>\nregisterPlugin(), unregisterPlugin().<?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 gets executed at compile time only *}\n{tplheader}\n<?php\necho 'index.tpl compiled at 2002-02-20 20:02';\n?>\nregisterPlugin(), unregisterPlugin().$params as an associative array.{fetch} function. Alternatively, the function can simply perform some other task without any output, eg the {assign} function.$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?>\nQuestion: 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?>\nregisterPlugin(), unregisterPlugin().{insert} tags in the template.{insert} tag in the template.
"},{"location":"programmers/plugins/plugins-modifiers/","title":"Modifiers {#plugins.modifiers}","text":"<?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<?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?>\nregisterPlugin(), unregisterPlugin().type.name.php
type is one of these plugin types:
name should be a valid identifier; letters, numbers, and underscores only, see php variables.function.html_select_date.php, resource.db.php, modifier.spacify.php.smarty_type_name
type and name are the same as above.foo would be function smarty_modifier_foo().<?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?>\nregisterFilter(), unregisterFilter().<?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?>\nregisterFilter() and unregisterFilter().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.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.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{include file='mysql:extras/navigation.tpl'}\nregisterResource(), unregisterResource().<?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
"},{"location":"programmers/resources/resources-custom/","title":"Custom Template Resources {#resources.custom}","text":"$repeat after the Smarty_Internal_Template object to keep backwards compatibility to older versions of Smarty.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
"},{"location":"programmers/resources/resources-extends/","title":"Extends Template Resources {#resources.extends}","text":"{include file='mysql:extras/navigation.tpl'}\nextends: resource is used to define child/parent relationships for template inheritance from the PHP script. For details see section of Template Inheritance.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.<?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{block} and {extends}.file: is the default resource. The resource key file: must only be specified, if the $default_resource_type has been changed.$default_template_handler_func is invoked.$use_include_path is activated$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
"},{"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":"{include file='index.tpl'}\n{include file='file:index.tpl'} {* same as above *}\n$template_dir. This allows websites employing multiple sets of templates better control over which template to access.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
"},{"location":"programmers/resources/resources-file/#templates-from-any-directory-templatesfromanydir","title":"Templates from any directory {#templates.from.any.dir}","text":"{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$template_dir require the file: template resource type, followed by the absolute path to the template (with leading slash.)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
"},{"location":"programmers/resources/resources-file/#windows-filepaths-templateswindowsfilepath","title":"Windows Filepaths {#templates.windows.filepath}","text":"{include file='file:/usr/local/share/templates/navigation.tpl'}\nfile: 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
"},{"location":"programmers/resources/resources-streams/","title":"Stream Template Resources {#resources.streams}","text":"{include file='file:D:/usr/local/share/templates/navigation.tpl'}\n $smarty->display('foo:bar.tpl');\n
"},{"location":"programmers/resources/resources-string/","title":"String Template Resources {#resources.string}","text":" {include file=\"foo:bar.tpl\"}\nstring: or eval: resource.
string: resource behaves much the same as a template file. The template source is compiled from a string and stores the compiled template code for later reuse. Each unique template string will create a new compiled template file. If your template strings are accessed frequently, this is a good choice. If you have frequently changing template strings (or strings with low reuse value), the eval: resource may be a better choice, as it doesn\\'t save compiled templates to disk.eval: resource evaluates the template source every time a page is rendered. This is a good choice for strings with low reuse value. If the same string is accessed frequently, the string: resource may be a better choice.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{include file=\"string:$template_string\"} {* compiles for later reuse *}\n{include file=\"eval:$template_string\"} {* compiles every time *}\nstring: 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
"},{"location":"programmers/resources/template-resources/","title":"Resources {#resasdources}","text":" {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() *}\ndisplay() 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.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
"},{"location":"programmers/resources/template-resources/#default-template-handler-function-defaulttemplatehandlerfunction","title":"Default template handler function {#default.template.handler.function}","text":"{include file='mysql:extras/navigation.tpl'}\nStreams