mirror of
https://github.com/smarty-php/smarty.git
synced 2026-08-04 12:34:33 +02:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Max Hayman
|
bace28e2eb | ||
 mohrt
|
478f8a29b4 | ||
 carpii
|
f8717a6cf7 | ||
 uwetews
|
957f9ce43a | ||
|
Uwe Tews
|
4ab9757b49 | ||
|
Uwe Tews
|
23d29f2ea3 | ||
 Christian Weiske
|
88cc17fe8e | ||
|
uwetews
|
5fb8387027 | ||
|
uwetews
|
c5c9d6514c | ||
|
uwetews
|
4cb07a89e2 | ||
|
Uwe Tews
|
47fa66cdcf | ||
|
Uwe Tews
|
e97b7d136c |
@@ -0,0 +1 @@
|
||||
templates_c
|
||||
+6
-14
@@ -1,19 +1,11 @@
|
||||
# Auto detect text files and perform LF normalization
|
||||
* text=auto
|
||||
|
||||
*.php text eol=lf
|
||||
*.y text eol=lf
|
||||
*.lex text eol=lf
|
||||
|
||||
# exclude from git export
|
||||
/tests export-ignore
|
||||
/utilities export-ignore
|
||||
/docker-compose.yml export-ignore
|
||||
/.github export-ignore
|
||||
/run_tests_for_all_php_versions.sh export-ignore
|
||||
/.gitattributes export-ignore
|
||||
/travis.ini export-ignore
|
||||
/myconfig.ini export-ignore
|
||||
/.travis.yml export-ignore
|
||||
/.gitignore export-ignore
|
||||
/make-release.sh export-ignore
|
||||
/phpunit.sh export-ignore
|
||||
/phpunit.xml export-ignore
|
||||
/TODO.md export-ignore
|
||||
/.gitattributes export-ignore
|
||||
/lexer/ export-ignore
|
||||
/utilities/ export-ignore
|
||||
|
||||
@@ -1,85 +0,0 @@
|
||||
# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- 'master'
|
||||
|
||||
name: CI
|
||||
|
||||
jobs:
|
||||
tests:
|
||||
name: Tests
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
||||
env:
|
||||
PHP_EXTENSIONS: dom, json, libxml, mbstring, pdo_sqlite, soap, xml, xmlwriter
|
||||
PHP_INI_VALUES: assert.exception=1, zend.assertions=1
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os:
|
||||
- ubuntu-latest
|
||||
|
||||
php-version:
|
||||
- "7.2"
|
||||
- "7.3"
|
||||
- "7.4"
|
||||
- "8.0"
|
||||
- "8.1"
|
||||
- "8.2"
|
||||
- "8.3"
|
||||
|
||||
compiler:
|
||||
- default
|
||||
|
||||
include:
|
||||
- os: ubuntu-latest
|
||||
php-version: "8.0"
|
||||
compiler: jit
|
||||
- os: ubuntu-latest
|
||||
php-version: "8.1"
|
||||
compiler: jit
|
||||
- os: ubuntu-latest
|
||||
php-version: "8.2"
|
||||
compiler: jit
|
||||
- os: ubuntu-latest
|
||||
php-version: "8.3"
|
||||
compiler: jit
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Override PHP ini values for JIT compiler
|
||||
if: matrix.compiler == 'jit'
|
||||
run: echo "PHP_INI_VALUES::assert.exception=1, zend.assertions=1, opcache.enable=1, opcache.enable_cli=1, opcache.optimization_level=-1, opcache.jit=1255, opcache.jit_buffer_size=32M" >> $GITHUB_ENV
|
||||
|
||||
- name: Install PHP with extensions
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php-version }}
|
||||
coverage: pcov
|
||||
extensions: ${{ env.PHP_EXTENSIONS }}
|
||||
ini-values: ${{ env.PHP_INI_VALUES }}
|
||||
|
||||
- name: Cache Composer packages
|
||||
id: composer-cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: vendor
|
||||
key: v5r2-${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }}
|
||||
restore-keys: |
|
||||
v5r1-${{ runner.os }}-php-${{ matrix.php-version }}-
|
||||
|
||||
- name: Install dependencies
|
||||
uses: php-actions/composer@v6
|
||||
|
||||
- name: Run make
|
||||
run: make -B
|
||||
|
||||
- name: Run tests with phpunit
|
||||
run: php ./vendor/phpunit/phpunit/phpunit
|
||||
+7
-7
@@ -1,9 +1,9 @@
|
||||
|
||||
.idea/
|
||||
|
||||
/site
|
||||
|
||||
phpunit*
|
||||
.phpunit.result.cache
|
||||
vendor/*
|
||||
composer.lock
|
||||
# Smarty
|
||||
lexer/*.php
|
||||
lexer/*.php.bak
|
||||
lexer/*.out
|
||||
utilies/*.php
|
||||
/composer.lock
|
||||
/vendor
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
Smarty is supported only in PHP 4.0.6 or later.
|
||||
|
||||
Smarty versions previous to 2.0 require the PEAR libraries. Be sure to include
|
||||
the path to the PEAR libraries in your php include_path. Config_file.class.php
|
||||
uses the PEAR library for its error handling routines. PEAR comes with the PHP
|
||||
distribution. Unix users check /usr/local/lib/php, windows users check
|
||||
C:/php/pear.
|
||||
-3707
File diff suppressed because it is too large
Load Diff
-119
@@ -1,119 +0,0 @@
|
||||
# Contributing to Smarty
|
||||
|
||||
First off, thanks for taking the time to contribute! ❤️
|
||||
|
||||
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
|
||||
> - Star the project
|
||||
> - Tell a friend about it
|
||||
> - Refer this project in your project's readme
|
||||
> - Mention the project at local meetups and tell your friends/colleagues
|
||||
|
||||
## I Have a Question
|
||||
|
||||
> If you want to ask a question, we assume that you have read the available [Documentation](https://smarty-php.github.io/smarty).
|
||||
|
||||
Before you ask a question, it is best to search for existing [Issues](https://github.com/smarty-php/smarty/issues) that might help you.
|
||||
In case you have found a suitable issue and still need clarification, you can write your question in this issue.
|
||||
It is also advisable to search the internet for answers first.
|
||||
|
||||
If you then still feel the need to ask a question and need clarification, we recommend the following:
|
||||
|
||||
- [Open an Issue](https://github.com/smarty-php/smarty/issues/new).
|
||||
- Provide as much context as you can about what you're running into.
|
||||
- Provide Smarty and PHP versions
|
||||
|
||||
We will then take care of the issue as soon as possible.
|
||||
|
||||
## I Want To Contribute
|
||||
|
||||
> ### Legal Notice
|
||||
> When contributing to this project, you must agree that you have authored 100% of the content,
|
||||
> that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
#### Before Submitting a Bug Report
|
||||
|
||||
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to
|
||||
investigate carefully, collect information and describe the issue in detail in your report. Please complete the
|
||||
following steps in advance to help us fix any potential bug as fast as possible.
|
||||
|
||||
- Make sure that you are using the latest version.
|
||||
- Determine if your bug is really a bug and not an error on your side. (Make sure that you have read the [documentation](https://smarty-php.github.io/smarty). If you are looking for support, you might want to check [this section](#i-have-a-question)).
|
||||
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/smarty-php/smarty/issues?q=label%3Abug).
|
||||
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
|
||||
- Collect information about the bug:
|
||||
- For an Exception: please provide the Stack trace
|
||||
- OS (Windows, Linux, macOS)
|
||||
- PHP version
|
||||
- Smarty version
|
||||
- A minimal snippet of (your) code that triggers the bug
|
||||
- Expected output versus actual output
|
||||
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
|
||||
|
||||
#### How Do I Submit a Good Bug Report?
|
||||
|
||||
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public.
|
||||
> For sensitive bugs, please see [SECURITY.md](SECURITY.md).
|
||||
|
||||
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
|
||||
|
||||
- Open an [Issue](https://github.com/smarty-php/smarty/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
|
||||
- Explain the behavior you would expect and the actual behavior.
|
||||
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
|
||||
- Provide the information you collected in the previous section.
|
||||
|
||||
Once it's filed:
|
||||
|
||||
- The project team will label the issue accordingly.
|
||||
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
|
||||
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be implemented by someone.
|
||||
|
||||
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
|
||||
|
||||
|
||||
#### Before Submitting an Enhancement
|
||||
|
||||
- Make sure that you are using the latest version.
|
||||
- Read the [documentation](https://smarty-php.github.io/smarty) carefully and find out if the functionality is already covered, maybe by an individual configuration.
|
||||
- Perform a [search](https://github.com/smarty-php/smarty/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
|
||||
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
|
||||
|
||||
|
||||
#### How Do I Submit a Good Enhancement Suggestion?
|
||||
|
||||
Enhancement suggestions are tracked as [GitHub issues](https://github.com/smarty-php/smarty/issues).
|
||||
|
||||
- Use a **clear and descriptive title** for the issue to identify the suggestion.
|
||||
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
|
||||
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
|
||||
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
|
||||
- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
|
||||
|
||||
|
||||
### Improving The Documentation
|
||||
|
||||
The [docs](docs/index.md) are written in markdown, configured in [mkdocs.yml](mkdocs.yml) and published
|
||||
to [GitHub pages](https://smarty-php.github.io/smarty) using [mkdocs](https://www.mkdocs.org/) and [mike](https://github.com/jimporter/mike).
|
||||
|
||||
To preview the docs while you are writing, run:
|
||||
```bash
|
||||
mkdocs serve
|
||||
```
|
||||
This should launch a local web server and give you a link to open in your browser.
|
||||
|
||||
When you are finished, commit your changes and provide a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
|
||||
|
||||
#### Publishing the docs
|
||||
If you are a maintainer, you can publish the document using [mike](https://github.com/jimporter/mike). Make sure you provide the correct version.
|
||||
|
||||
```bash
|
||||
mike deploy 5.x
|
||||
```
|
||||
|
||||
## Attribution
|
||||
This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!
|
||||
+458
@@ -0,0 +1,458 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
@@ -0,0 +1,284 @@
|
||||
QUESTION INDEX
|
||||
--------------
|
||||
|
||||
GENERAL
|
||||
|
||||
Q: What is Smarty?
|
||||
Q: What's the difference between Smarty and other template engines?
|
||||
Q: What do you mean "Compiled PHP Scripts" ?
|
||||
Q: Why can't I just use PHPA (http://php-accelerator.co.uk) or Zend Cache?
|
||||
Q: Why does smarty have a built in cache? Wouldn't it be better to handle this
|
||||
in a separate class?
|
||||
Q: Is Smarty faster than <insert other PHP template engine>?
|
||||
Q: How can I be sure to get the best performance from Smarty?
|
||||
Q: Do you have a mailing list?
|
||||
Q: Can you change the mailing list so reply-to sends to the list and not the
|
||||
user?
|
||||
|
||||
TROUBLESHOOTING
|
||||
|
||||
Q: Smarty doesn't work.
|
||||
Q: I get the following error when running Smarty:
|
||||
Warning: Smarty error: problem creating directory "templates_c/239/239105369"
|
||||
in /path/to/Smarty.class.php on line 542
|
||||
Q: I get the following error when running Smarty:
|
||||
Warning: Wrong parameter count for preg_replace() in
|
||||
Smarty.class.php on line 371
|
||||
Q: I get this error when passing variables to {include}:
|
||||
Fatal error: Call to undefined function: get_defined_vars() in
|
||||
/path/to/Smarty/templates_c/index.tpl.php on line 8
|
||||
Q: I get PHP errors in my {if} tag logic.
|
||||
Q: I'm changing my php code and/or templates, and my results are not getting
|
||||
updated.
|
||||
Q: I'm running Windows 2000 and I get blank content. My compiled PHP files are
|
||||
also zero length.
|
||||
Q: The template goes into an infinite loop when I include included templates
|
||||
that pass local variables
|
||||
Q: Javascript is causing Smarty errors in my templates.
|
||||
Q: I get "SAFE MODE Restriction in effect. ..."-errors when running smarty.
|
||||
|
||||
MISC
|
||||
|
||||
Q: Can I use Macromedia's Dreamweaver to edit my templates?
|
||||
Q: Dreamweaver is urlencoding the template delimiters when they are in a SRC or
|
||||
HREF link. How do I get around this?
|
||||
|
||||
HOWTO
|
||||
|
||||
Q: How do I generate different cache files per template based on arguments
|
||||
passed to the page?
|
||||
Q: How do I pass a template variable as a parameter? {function param={$varname}}
|
||||
does not work.
|
||||
Q: How do I include cached template(s) within a non-cached template?
|
||||
|
||||
|
||||
GENERAL
|
||||
-------
|
||||
|
||||
Q: What is Smarty?
|
||||
A: Smarty is a template engine for PHP... but be aware this isn't just another
|
||||
PHP template engine. It's much more than that.
|
||||
|
||||
Q: What's the difference between Smarty and other template engines?
|
||||
A: Most other template engines for PHP provide basic variable substitution and
|
||||
dynamic block functionality. Smarty takes a step further to be a "smart"
|
||||
template engine, adding features such as configuration files, template
|
||||
functions, variable modifiers (see the docs!) and making all of this
|
||||
functionality as easy as possible to use for both programmers and template
|
||||
designers. Smarty also compiles the templates into PHP scripts, eliminating
|
||||
the need to parse the templates on every invocation, making Smarty extremely
|
||||
scalable and manageable for large application needs.
|
||||
|
||||
Q: What do you mean "Compiled PHP Scripts" ?
|
||||
A: Smarty reads the template files and creates PHP scripts from them. Once
|
||||
these PHP scripts are created, Smarty executes these, never having to parse
|
||||
the template files again. If you change a template file, Smarty will
|
||||
recreate the PHP script for it. All this is done automatically by Smarty.
|
||||
Template designers never need to mess with the generated PHP scripts or even
|
||||
know of their existance. (NOTE: you can turn off this compile checking step
|
||||
in Smarty for increased performance.)
|
||||
|
||||
Q: Why can't I just use PHPA (http://php-accelerator.co.uk) or Zend Cache?
|
||||
A: You certainly can, and we highly recommend it! What PHPA does is caches
|
||||
compiled bytecode of your PHP scripts in shared memory or in a file. This
|
||||
speeds up server response and saves the compilation step. Smarty creates PHP
|
||||
scripts, which PHPA will cache nicely. Now, Smarty's built-in cache is
|
||||
something completely different. It caches the _output_ of the template
|
||||
contents. For example, if you have a template that requires several database
|
||||
queries, Smarty can cache this output, saving the need to call the database
|
||||
every time. Smarty and PHPA (or Zend Cache) complement each other nicely. If
|
||||
performance is of the utmost importance, we would recommend using one of
|
||||
these with any PHP application, using Smarty or not. As you can see in the
|
||||
benchmarks, Smartys performance _really_ excels in combination with a PHP
|
||||
accelerator.
|
||||
|
||||
Q: Why does Smarty have a built in cache? Wouldn't it be better to handle this
|
||||
in a separate class?
|
||||
A: Smarty's caching functionality is tightly integrated with the template
|
||||
engine, making it quite a bit more flexible than a simple caching wrapper.
|
||||
For instance, you can cache select portions of a template page. Let's say
|
||||
you have a polling box on your site. With Smarty, you can leave the poll
|
||||
dynamic and cache the rest of the page. You can also pass templates
|
||||
multiple cache ids, meaning that a template can have several caches
|
||||
depending on URL, cookies, etc.
|
||||
|
||||
Q: Is Smarty faster than <insert other PHP template engine>?
|
||||
A: See the benchmark page for some performance comparisons. Smarty's approach
|
||||
to templates is a bit different from some languages: it compiles templates
|
||||
into PHP scripts instead of parsing them on each invocation. This usually
|
||||
results in great performance gains, especially with complex templates.
|
||||
Coupled with the built-in caching of Smarty templates, the performance is
|
||||
outstanding.
|
||||
|
||||
Q: How can I be sure to get the best performance from Smarty?
|
||||
A: Be sure you set $compile_check=false once your templates are initially
|
||||
compiled. This will skip the unneeded step of testing if the template has
|
||||
changed since it was last compiled. If you have complex pages that don't
|
||||
change too often, turn on the caching engine and adjust your application so
|
||||
it doesn't do unnecessary work (like db calls) if a cached page is
|
||||
available. See the documentation for examples.
|
||||
|
||||
Q: Do you have a mailing list?
|
||||
A: We have a few mailing lists. "general" for you to share your ideas or ask
|
||||
questions, "dev" for those interested in the development efforts of Smarty,
|
||||
and "cvs" for those that would like to track the updates made in the cvs
|
||||
repository.
|
||||
|
||||
send a blank e-mail message to:
|
||||
smarty-general-subscribe@lists.php.net (subscribe to the general list)
|
||||
smarty-general-unsubscribe@lists.php.net (unsubscribe from the general list)
|
||||
smarty-general-digest-subscribe@lists.php.net (subscribe to digest)
|
||||
smarty-general-digest-unsubscribe@lists.php.net (unsubscribe from digest)
|
||||
smarty-dev-subscribe@lists.php.net (subscribe to the dev list)
|
||||
smarty-dev-unsubscribe@lists.php.net (unsubscribe from the dev list)
|
||||
smarty-cvs-subscribe@lists.php.net (subscribe to the cvs list)
|
||||
smarty-cvs-unsubscribe@lists.php.net (unsubscribe from the cvs list)
|
||||
You can also browse the mailing list archives at
|
||||
http://marc.theaimsgroup.com/?l=smarty&r=1&w=2
|
||||
|
||||
|
||||
|
||||
Q: Can you change the mailing list so Reply-To sends to the list and not the
|
||||
user?
|
||||
A: Yes we could, but no we won't. Use "Reply-All" in your e-mail client to send
|
||||
to the list. http://www.unicom.com/pw/reply-to-harmful.html
|
||||
|
||||
TROUBLESHOOTING
|
||||
---------------
|
||||
|
||||
Q: Smarty doesn't work.
|
||||
A: You must be using PHP 4.0.6 or later if you use any version of Smarty
|
||||
past 2.0.1. Read the BUGS file for more info.
|
||||
|
||||
Q: I get the following error when running Smarty:
|
||||
Warning: Smarty error: problem creating directory "templates_c/239/239105369"
|
||||
in /path/to/Smarty.class.php on line 542
|
||||
A: Your web server user does not have permission to write to the templates_c
|
||||
directory, or is unable to create the templates_c directory. Be sure the
|
||||
templates_c directory exists in the location defined in Smarty.class.php,
|
||||
and the web server user can write to it. If you do not know the web server
|
||||
user, chmod 777 the templates_c directory, reload the page, then check the
|
||||
file ownership of the files created in templates_c. Or, you can check the
|
||||
httpd.conf (usually in /usr/local/apache/conf) file for this setting:
|
||||
User nobody
|
||||
Group nobody
|
||||
|
||||
Q: I get the following error when running Smarty: Warning: Wrong parameter
|
||||
count for preg_replace() in Smarty.class.php on line 371
|
||||
A: preg_replace had a parameter added in PHP 4.0.2 that Smarty
|
||||
requires. Upgrade to at least 4.0.6 to fix all known PHP issues with
|
||||
Smarty.
|
||||
|
||||
Q: I get this error when passing variables to {include}:
|
||||
Fatal error: Call to undefined function: get_defined_vars() in
|
||||
/path/to/Smarty/templates_c/index.tpl.php on line 8
|
||||
A: get_defined_vars() was added to PHP 4.0.4. If you plan on passing
|
||||
variables to included templates, you will need PHP 4.0.6 or later.
|
||||
|
||||
Q: I get PHP errors in my {if} tag logic.
|
||||
A: All conditional qualifiers must be separated by spaces. This syntax will not
|
||||
work: {if $name=="Wilma"} You must instead do this: {if $name == "Wilma"}.
|
||||
The reason for this is syntax ambiguity. Both "==" and "eq" are equivalent
|
||||
in the template parser, so something like {if $nameeq"Wilma"} wouldn't be
|
||||
parsable by the tokenizer.
|
||||
|
||||
Q: I'm changing my php code and/or templates, and my results are not getting
|
||||
updated.
|
||||
A: This may be the result of your compile or cache settings. If you are
|
||||
changing your php code, your templates will not necessarily get recompiled
|
||||
to reflect the changes. Use $force_compile during develpment to avoid these
|
||||
situations. Also turn off caching during development when you aren't
|
||||
specifically testing it. You can also remove everything from your
|
||||
compile_dir and cache_dir and reload the page to be sure everything gets
|
||||
regenerated.
|
||||
|
||||
Q: I'm running Windows 2000 and I get blank content. My compiled PHP files are
|
||||
also zero length.
|
||||
A: There seems to be a problem with some W2k machines and exclusive file
|
||||
locking. Comment out the flock() call in _write_file to get around this,
|
||||
although be aware this could possibly cause a problem with simultaneous
|
||||
writes to a file, especially with caching turned on. NOTE: As of Smarty
|
||||
1.4.0, a workaround was put in place that should solve this.
|
||||
|
||||
Q: The template goes into an infinite loop when I include included templates
|
||||
that pass local variables
|
||||
A: This was fixed in 1.3.2 (new global attribute)
|
||||
|
||||
Q: Javascript is causing Smarty errors in my templates.
|
||||
A: Surround your javascript with {literal}{/literal} tags. See the docs.
|
||||
|
||||
Q: I get "SAFE MODE Restriction in effect. ..."-errors when running smarty.
|
||||
A: Use $smarty->use_sub_dirs = false when running php in safe mode.
|
||||
|
||||
MISC
|
||||
----
|
||||
|
||||
Q: Can I use Macromedia's Dreamweaver to edit my templates?
|
||||
A: Certainly. You might want to change your tag delimiters from {} to something
|
||||
that resembles valid HTML, like <!--{ }--> or <{ }> or something similar.
|
||||
This way the editor won't view the template tags as errors.
|
||||
|
||||
Q: Dreamweaver is urlencoding the template delimiters when they are in a SRC or
|
||||
HREF link. How do I get around this?
|
||||
A: In Edit - Properties - Rewrite HTML you can specify if Dreamweaver should
|
||||
change special letters to %-equivalent or not. The default is on which
|
||||
produces this error.
|
||||
|
||||
HOWTO
|
||||
-----
|
||||
|
||||
Q: How do I generate different cache files per template based on arguments
|
||||
passed to the page?
|
||||
A: Use your $REQUEST_URI as the cache_id when fetching the page:
|
||||
|
||||
global $REQUEST_URI; // if not already present
|
||||
$smarty->display('index.tpl',$REQUEST_URI);
|
||||
|
||||
This will create a separate cache file for each unique URL when you call
|
||||
index.tpl. See the documentation for display() and fetch()
|
||||
|
||||
Q: How do I pass a template variable as a parameter? {function param={$varname}}
|
||||
does not work.
|
||||
A: {function param=$varname} (You cannot nest template delimiters.)
|
||||
|
||||
Q: How do I include cached template(s) within a non-cached template?
|
||||
A: One way to do it:
|
||||
|
||||
$smarty->caching = true;
|
||||
$tpl1 = $smarty->fetch("internal1.tpl");
|
||||
$tpl2 = $smarty->fetch("internal2.tpl");
|
||||
$tpl3 = $smarty->fetch("internal3.tpl");
|
||||
|
||||
$smarty->assign("tpl1_contents",$tpl1);
|
||||
$smarty->assign("tpl2_contents",$tpl2);
|
||||
$smarty->assign("tpl3_contents",$tpl3);
|
||||
|
||||
$smarty->caching = false;
|
||||
$smarty->display('index.tpl');
|
||||
|
||||
index.tpl
|
||||
---------
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>{$tpl1_contents}</td>
|
||||
<td>{$tpl2_contents}</td>
|
||||
<td>{$tpl3_contents}</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
Another approach:
|
||||
|
||||
You could write a custom insert function to fetch your internal
|
||||
templates:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>{insert name=fetch_tpl tpl="internal1.tpl"}</td>
|
||||
<td>{insert name=fetch_tpl tpl="internal2.tpl"}</td>
|
||||
<td>{insert name=fetch_tpl tpl="internal3.tpl"}</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -0,0 +1,29 @@
|
||||
REQUIREMENTS:
|
||||
|
||||
Smarty requires PHP 4.0.6 or later.
|
||||
See the on-line documentation for complete install instructions.
|
||||
|
||||
INSTALLATION (quick):
|
||||
|
||||
* copy the files under the libs/ directory to a directory that is in your PHP
|
||||
include_path, or set the SMARTY_DIR constant and put them in this directory.
|
||||
(if you upgrade from versions before 2.5.0 be aware that up to Smarty 2.4.2
|
||||
all necessary files where in the distribution's root directory, but are now
|
||||
in libs/.)
|
||||
|
||||
* for each application using Smarty, create a "templates", "configs", and a
|
||||
"templates_c" directory, be sure to set the appropriate directory settings in
|
||||
Smarty for them. If they are located in the same directory as your
|
||||
application, they shouldn't need to be modified. Be sure the "templates_c"
|
||||
directory is writable by your web server user (usually nobody). chown
|
||||
nobody:nobody templates_c; chmod 700 templates_c You can also chmod 777 this
|
||||
directory, but be aware of security issues for multi-user systems. If you are
|
||||
using Smarty's built-in caching, create a "cache" directory and also chown
|
||||
nobody:nobody.
|
||||
|
||||
* setup your php and template files. A good working example is in the on-line
|
||||
documentation.
|
||||
|
||||
* TECHNICAL NOTE: If you do not have access to the php.ini file, you can change
|
||||
non-server settings (such as your include_path) with the ini_set() command.
|
||||
example: ini_set("include_path",".:/usr/local/lib/php");
|
||||
@@ -1,179 +0,0 @@
|
||||
Smarty: the PHP compiling template engine
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 3.0 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
See the GNU Lesser General Public License below for more details.
|
||||
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
@@ -1,19 +0,0 @@
|
||||
all: lexers parsers
|
||||
|
||||
lexers: src/Lexer/ConfigfileLexer.php src/Lexer/TemplateLexer.php
|
||||
parsers: src/Parser/ConfigfileParser.php src/Parser/TemplateParser.php
|
||||
|
||||
src/Lexer/ConfigfileLexer.php: src/Lexer/ConfigfileLexer.plex
|
||||
php ./utilities/make-lexer.php src/Lexer/ConfigfileLexer.plex src/Lexer/ConfigfileLexer.php
|
||||
|
||||
src/Lexer/TemplateLexer.php: src/Lexer/TemplateLexer.plex
|
||||
php ./utilities/make-lexer.php src/Lexer/TemplateLexer.plex src/Lexer/TemplateLexer.php
|
||||
|
||||
src/Parser/ConfigfileParser.php: src/Parser/ConfigfileParser.y
|
||||
php ./utilities/make-parser.php src/Parser/ConfigfileParser.y src/Parser/ConfigfileParser.php
|
||||
|
||||
src/Parser/TemplateParser.php: src/Parser/TemplateParser.y
|
||||
php ./utilities/make-parser.php src/Parser/TemplateParser.y src/Parser/TemplateParser.php
|
||||
|
||||
clean:
|
||||
rm -f src/Lexer/ConfigfileLexer.php src/Lexer/TemplateLexer.php src/Parser/ConfigfileParser.php src/Parser/TemplateParser.php
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
This is a simple guide to get Smarty setup and running quickly. The online
|
||||
documentation includes a very thorough explanation of a Smarty installation.
|
||||
This guide is meant to be a quick and painless way of getting Smarty working,
|
||||
and nothing more. The guide assumes you are familiar with the UNIX system
|
||||
environment. Windows users will need to make adjustments where necessary.
|
||||
|
||||
INSTALL SMARTY LIBRARY FILES
|
||||
|
||||
Copy the Smarty library files to your system. In our example, we place them in
|
||||
/usr/local/lib/php/Smarty/
|
||||
|
||||
$> cd YOUR_DOWNLOAD_DIRECTORY
|
||||
$> gtar -ztvf Smarty-2.6.7.tar.gz
|
||||
$> mkdir /usr/local/lib/php/Smarty
|
||||
$> cp -r Smarty-2.6.7/libs/* /usr/local/lib/php/Smarty
|
||||
|
||||
You should now have the following file structure:
|
||||
|
||||
/usr/local/lib/php/Smarty/
|
||||
Config_File.class.php
|
||||
debug.tpl
|
||||
internals/
|
||||
plugins/
|
||||
Smarty.class.php
|
||||
Smarty_Compiler.class.php
|
||||
|
||||
|
||||
SETUP SMARTY DIRECTORIES
|
||||
|
||||
You will need four directories setup for Smarty to work. These files are for
|
||||
templates, compiled templates, cached templates and config files. You may or
|
||||
may not use caching or config files, but it is a good idea to set them up
|
||||
anyways. It is also recommended to place them outside of the web server
|
||||
document root. The web server PHP user will need write access to the cache and
|
||||
compile directories as well.
|
||||
|
||||
In our example, the document root is /web/www.domain.com/docs and the
|
||||
web server username is "nobody". We will keep our Smarty files under
|
||||
/web/www.domain.com/smarty
|
||||
|
||||
$> cd /web/www.domain.com
|
||||
$> mkdir smarty
|
||||
$> mkdir smarty/templates
|
||||
$> mkdir smarty/templates_c
|
||||
$> mkdir smarty/cache
|
||||
$> mkdir smarty/configs
|
||||
$> chown nobody:nobody smarty/templates_c
|
||||
$> chown nobody:nobody smarty/cache
|
||||
$> chmod 775 smarty/templates_c
|
||||
$> chmod 775 smarty/cache
|
||||
|
||||
|
||||
SETUP SMARTY PHP SCRIPTS
|
||||
|
||||
Now we setup our application in the document root:
|
||||
|
||||
$> cd /web/www.domain.com/docs
|
||||
$> mkdir myapp
|
||||
$> cd myapp
|
||||
$> vi index.php
|
||||
|
||||
Edit the index.php file to look like the following:
|
||||
|
||||
<?php
|
||||
|
||||
// put full path to Smarty.class.php
|
||||
require('/usr/local/lib/php/Smarty/Smarty.class.php');
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->template_dir = '/web/www.domain.com/smarty/templates';
|
||||
$smarty->compile_dir = '/web/www.domain.com/smarty/templates_c';
|
||||
$smarty->cache_dir = '/web/www.domain.com/smarty/cache';
|
||||
$smarty->config_dir = '/web/www.domain.com/smarty/configs';
|
||||
|
||||
$smarty->assign('name', 'Ned');
|
||||
$smarty->display('index.tpl');
|
||||
|
||||
?>
|
||||
|
||||
|
||||
SETUP SMARTY TEMPLATE
|
||||
|
||||
$> vi /web/www.domain.com/smarty/templates/index.tpl
|
||||
|
||||
Edit the index.tpl file with the following:
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>Smarty</title>
|
||||
</head>
|
||||
<body>
|
||||
Hello, {$name}!
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
|
||||
Now go to your new application through the web browser,
|
||||
http://www.domain.com/myapp/index.php in our example. You should see the text
|
||||
"Hello Ned!" in your browser.
|
||||
|
||||
Once you get this far, you can continue on to the Smarty Crash Course to learn
|
||||
a few more simple things, or on to the documentation to learn it all.
|
||||
@@ -0,0 +1,86 @@
|
||||
|
||||
NAME:
|
||||
|
||||
Smarty - the PHP compiling template engine
|
||||
|
||||
VERSION: 2.6.18
|
||||
|
||||
AUTHORS:
|
||||
|
||||
Monte Ohrt <monte at ohrt dot com>
|
||||
Andrei Zmievski <andrei@php.net>
|
||||
|
||||
MAILING LISTS:
|
||||
|
||||
We have a few mailing lists. "discussion" for you to share your ideas or ask
|
||||
questions, "developers" for those interested in the development efforts of Smarty,
|
||||
and "svn" for those that would like to track the updates made in the svn
|
||||
repository.
|
||||
|
||||
send a blank e-mail message to:
|
||||
smarty-discussion-subscribe@googlecode.com(subscribe to the general discussion list)
|
||||
smarty-discussion-unsubscribe@googlecode.com (unsubscribe from the general discussion list)
|
||||
smarty-discussion-digest-subscribe@googlecode.com (subscribe to digest)
|
||||
smarty-discussion-digest-unsubscribe@googlecode.com (unsubscribe from digest)
|
||||
smarty-developers-subscribe@googlecode.com (subscribe to the dev list)
|
||||
smarty-developers-unsubscribe@googlecode.com (unsubscribe from the dev list)
|
||||
smarty-svn-subscribe@googlecode.com (subscribe to the svn list)
|
||||
smarty-svn-unsubscribe@googlecode.com (unsubscribe from the svn list)
|
||||
|
||||
You can also browse the mailing list archives at
|
||||
http://groups.google.com/group/smarty-discussion
|
||||
http://groups.google.com/group/smarty-developers
|
||||
|
||||
and the OLD list archives at
|
||||
http://marc.theaimsgroup.com/?l=smarty&r=1&w=2
|
||||
|
||||
SYNOPSIS:
|
||||
|
||||
require("Smarty.class.php");
|
||||
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->assign("Title","My Homepage");
|
||||
$smarty->assign("Names",array("John","Gary","Gregg","James"));
|
||||
|
||||
$smarty->display("index.tpl");
|
||||
|
||||
|
||||
DESCRIPTION:
|
||||
|
||||
What is Smarty?
|
||||
|
||||
Smarty is a template engine for PHP. Many other template engines for PHP
|
||||
provide basic variable substitution and dynamic block functionality.
|
||||
Smarty takes a step further to be a "smart" template engine, adding
|
||||
features such as configuration files, template functions, and variable
|
||||
modifiers, and making all of this functionality as easy as possible to
|
||||
use for both programmers and template designers. Smarty also converts
|
||||
the templates into PHP scripts, eliminating the need to parse the
|
||||
templates on every invocation. This makes Smarty extremely scalable and
|
||||
manageable for large application needs.
|
||||
|
||||
Some of Smarty's features:
|
||||
|
||||
* it is extremely fast
|
||||
* no template parsing overhead, only compiles once.
|
||||
* it is smart about recompiling only the template files that have
|
||||
changed.
|
||||
* the template language is remarkably extensible via the plugin
|
||||
architecture.
|
||||
* configurable template delimiter tag syntax, so you can use
|
||||
{}, {{}}, <!--{}-->, or whatever you like.
|
||||
* built-in caching of template output.
|
||||
* arbitrary template sources (filesystem, databases, etc.)
|
||||
* template if/elseif/else/endif constructs are passed to the PHP parser,
|
||||
so the if syntax can be as simple or as complex as you like.
|
||||
* unlimited nesting of sections, conditionals, etc. allowed
|
||||
* it is possible to embed PHP code right in your template files,
|
||||
although not recommended and doubtfully needed since the engine
|
||||
is so customizable.
|
||||
* and many more.
|
||||
|
||||
COPYRIGHT:
|
||||
Copyright (c) 2001-2005 New Digital Group, Inc. All rights reserved.
|
||||
This software is released under the GNU Lesser General Public License.
|
||||
Please read the disclaimer at the top of the Smarty.class.php file.
|
||||
@@ -1,20 +1,23 @@
|
||||
# Smarty template engine
|
||||
Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.
|
||||
# Smarty 2 template engine
|
||||
## Distribution repository
|
||||
Starting with Smarty 2.6.23 Composer has been configured to load the packages from github.
|
||||
|
||||
**NOTE: Because of this change you must clear your local composer cache with the "composer clearcache" command**
|
||||
|
||||
|
||||
To get the latest stable version use
|
||||
|
||||
## Documentation
|
||||
Read the [documentation](https://smarty-php.github.io/smarty/) to find out how to use it.
|
||||
"require": {
|
||||
"smarty/smarty": "~2.6"
|
||||
}
|
||||
|
||||
## Requirements
|
||||
Smarty v5 can be run with PHP 7.2 to PHP 8.3.
|
||||
in your composer.json file.
|
||||
|
||||
To get the trunk version use
|
||||
|
||||
## Installation
|
||||
Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/).
|
||||
"require": {
|
||||
"smarty/smarty": "~2.6@dev"
|
||||
}
|
||||
|
||||
The "smarty/smarty" package will start at libs/.... subfolder.
|
||||
|
||||
To get the latest stable version of Smarty use:
|
||||
```bash
|
||||
composer require smarty/smarty
|
||||
````
|
||||
|
||||
More in the [Getting Started](./docs/getting-started.md) section of the docs.
|
||||
|
||||
+428
@@ -0,0 +1,428 @@
|
||||
2.6.7
|
||||
-----
|
||||
|
||||
Those using Smarty with security enabled: a hole was found that allowed PHP code to be executed from within a template file. This has been fixed and you are engouraged to upgrade immediately. Note that this hole does NOT affect the security of your web server or PHP applications, only the ability for someone editing a template to execute PHP code. Other changes in this release can be found in the NEWS file.
|
||||
|
||||
2.5.0
|
||||
-----
|
||||
|
||||
Very minor adjustments since RC2, see the NEWS file for details.
|
||||
|
||||
2.5.0-RC2
|
||||
---------
|
||||
|
||||
Many fixes since the RC1 release. This one is as close to production quality as
|
||||
they come, so this will be the last release before 2.5.0. The SGML documentation
|
||||
files have also been removed from the tarball. If you want them, get them from
|
||||
the CVS repository.
|
||||
|
||||
2.5.0-RC1
|
||||
---------
|
||||
|
||||
Release Candidate 1. All $smarty vars can now be dynamic, such as
|
||||
$smarty.get.$foo. A new class function get_function_object() gets you a
|
||||
reference to an assigned object, useful within your own custom functions.
|
||||
append() can now merge as well as append with a third optional attribute. A new
|
||||
class function get_config_vars() was added, and get_template_vars() can now be
|
||||
used to get individual vars. Full variable syntax is now supported within
|
||||
double quotes via a backtick (`) syntax. Files created by smarty are now
|
||||
written to a tmp file then renamed to avoid file lock retention. html_radios,
|
||||
html_checkboxes, html_table, html_image, nl2br functions added, see the NEWS
|
||||
file for full details.
|
||||
|
||||
2.4.2
|
||||
-----
|
||||
Another point release. Added support for dynamic object reference syntax
|
||||
($foo->$bar), support for full variable syntax within quotes ("$foo[0].bar"),
|
||||
and other minor fixes. See the NEWS file for full details.
|
||||
|
||||
2.4.1
|
||||
-----
|
||||
|
||||
This is basically a point release, cleaning up a few things caught
|
||||
in the 2.4.0 release. See the NEWS file for full details.
|
||||
|
||||
2.4.0
|
||||
-----
|
||||
|
||||
Smarty now supports the ability to access objects within the templates. Two
|
||||
methods are available, one which closely follows Smartys conventions, and
|
||||
another that follows more traditional object syntax for those familiar with
|
||||
PHP.
|
||||
|
||||
The internal compiling engine has also undergone some major work. The regex
|
||||
parsing was rewritten to be much more strict, more secure and more
|
||||
maintainable. Config files are now compiled, which can speed up pages quite a
|
||||
bit that use config files extensively. Assigned variables are no longer
|
||||
extracted to PHP namespace, saving an extract call for every template. There is
|
||||
now support for applying modifiers to static values and functions. You can now
|
||||
access constants with $smarty.const.VAR. See the NEWS file for complete
|
||||
changes.
|
||||
|
||||
2.3.1
|
||||
-----
|
||||
|
||||
The mtime on compiled files will now match the source files, in the case where
|
||||
the source file may not get the current timestamp, recompiling will still work
|
||||
as expected. Proper support for open_basedir has been added, so Smarty should
|
||||
work correctly in safe mode. Added a few new features such as textformat block
|
||||
function, strip variable modifier and optgroup support for html_options. Also
|
||||
other minor bug fixes, see the Change Log.
|
||||
|
||||
2.3.0
|
||||
-----
|
||||
|
||||
Smarty now has a {debug} template function that brings up the debugging console
|
||||
right where {debug} is called, regardless of $debugging settings. This works a
|
||||
little different than turning on $debugging in the sense that it shows all the
|
||||
template variables available at the time {debug} is called, including local
|
||||
scope vars. It does not show the templates names however, since this
|
||||
executed during runtime of the template.
|
||||
|
||||
You can now supply an expire time when clearing cache or compile files. This is
|
||||
mostly useful for removing stale files via the API.
|
||||
|
||||
Plugins now stop execution upon error, instead of outputting a warning and
|
||||
continuing.
|
||||
|
||||
Two new API functions, assign_by_ref() and append_by_ref() were added. They
|
||||
allow assigning template variables by reference. This can make a significant
|
||||
performance gain, especially if you are assigning large arrays of data. PHP 5.0
|
||||
will do this implicitly, so these functions are basically workarounds.
|
||||
|
||||
Several misc bug fixes, see the Change Log for information.
|
||||
|
||||
|
||||
2.2.0
|
||||
-----
|
||||
|
||||
Smarty now allows an array of paths for the $plugin_dir class variable. The
|
||||
directories will be searched in the order they are given, so for efficiency keep
|
||||
the most-used plugins at the top. Also, absolute paths to the plugin directories are
|
||||
more efficient than relying on the PHP include_path.
|
||||
|
||||
Cache files can now be grouped with the cache_id. See the documentation under
|
||||
the new "Caching" section for details. compile_id also respects the same
|
||||
grouping syntax. The cache/compile file structure changed, so be sure to clear
|
||||
out all your cache and compile files when upgrading Smarty. Also if you are
|
||||
using PHP-accelerator, restart apache. I've seen some quirky things happen if
|
||||
the phpa files do not get cleared (known issue with phpa and parent
|
||||
class-member changes, so just clear 'em.)
|
||||
|
||||
Smarty now correctly respects the PHP include_path for $template_dir, $compile_dir,
|
||||
$cache_dir, $config_dir and $plugin_dir. Be aware that relying on the
|
||||
include_path is an overhead, try to use absolute pathnames when possible
|
||||
(or relative to working directory.)
|
||||
|
||||
Documentation has been updated and rearranged a bit. Most notably, the
|
||||
installation instructions are completely revamped, and a new Caching section
|
||||
explains Smarty's caching in detail along with the new grouping functionality.
|
||||
|
||||
Many misc. bug fixes and enhancements, see the full ChangeLog (NEWS file) for
|
||||
details.
|
||||
|
||||
2.1.1
|
||||
-----
|
||||
|
||||
There was a bug with template paths and the include_path, this has been fixed.
|
||||
Also register_outputfilter() did not work, this is fixed. A new template
|
||||
function named "cycle" has been added to the distribution, nice for cycling
|
||||
through a list (or array) of values.
|
||||
|
||||
2.1.0
|
||||
-----
|
||||
|
||||
This release has quite a few new features and fixes. Most notable are the
|
||||
introduction of block functions, so you can write plugins that work on a block
|
||||
of text with {func}{/func} notation. Also output filters were added, so you can
|
||||
apply a function against the output of your templates. This differs from the
|
||||
postfilter function, which works on the compiled template at compile time, and
|
||||
output filters work on the template output at runtime.
|
||||
|
||||
Many other features and bug fixes are noted in the NEWS file.
|
||||
|
||||
|
||||
2.0.1
|
||||
-----
|
||||
|
||||
This is a point release, fixing a few bugs and cleaning things up. A plugin
|
||||
was renamed, the dash "-" was removed from compiled template and cached file
|
||||
names. If you're upgrading, you might want to clear them out first. See the
|
||||
ChangeLog for details.
|
||||
|
||||
2.0.0
|
||||
-----
|
||||
|
||||
This release is a huge milestone for Smarty. Most notable new things are a
|
||||
plugin architecture, removal of PEAR dependency, and optimizations that
|
||||
drastically improve the performance of Smarty in most cases.
|
||||
|
||||
The plugin architecture allows modifiers, custom functions, compiler functions,
|
||||
prefilters, postfilters, resources, and insert functions to be added by
|
||||
simply dropping a file into the plugins directory. Once dropped in, they are
|
||||
automatically registered by the template engine. This makes user-contributed
|
||||
plugins easy to manage, as well as the internal workings of Smarty easy to
|
||||
control and customize. This new architecture depends on the __FILE__ constant,
|
||||
which contains the full path to the executing script. Some older versions of
|
||||
PHP incorrectly gave the script name and not the full filesystem path. Be sure
|
||||
your version of PHP populates __FILE__ correctly. If you use custom template
|
||||
resource functions, the format of these changed with the plugin architecture.
|
||||
Be sure to update your functions accordingly. See the template resource section
|
||||
of the documentation.
|
||||
|
||||
The PEAR dependancy was removed from Smarty. The Config_File class that comes
|
||||
with Smarty was actually what needed PEAR for error handling which Smarty didn't
|
||||
use, but now everything is self-contained.
|
||||
|
||||
Performance improvements are graphed on the benchmark page, you will see that
|
||||
overall performance has been sped up by as much as 80% in some cases.
|
||||
|
||||
Smarty-cached pages now support If-Modified-Since headers, meaning that if a
|
||||
cached template page has not changed since the last request, a "304 Not
|
||||
Modified" header will be sent instead of resending the same page. This is
|
||||
disabled by default, change the setting of $cache_modified_check.
|
||||
|
||||
|
||||
1.5.2
|
||||
-----
|
||||
|
||||
Mostly bug fixes, added a default template resource handler.
|
||||
|
||||
|
||||
1.5.1
|
||||
-----
|
||||
|
||||
Critical bug fix release. If you use caching, you'll need to upgrade.
|
||||
|
||||
|
||||
1.5.0
|
||||
-----
|
||||
|
||||
Several feature enhancements were made to this version, most notably the
|
||||
{foreach ...} command which is an alternative to {section ...} with an easier
|
||||
syntax for looping through a single array of values. Several functions were
|
||||
enhanced so that the output can be automatically assigned to a template
|
||||
variable instead of displayed (assign attribute). Cache files can now be
|
||||
controlled with a custom function as an alternative to the built-in file based
|
||||
method. Many code cleanups and bug fixed went into this release as well.
|
||||
|
||||
|
||||
1.4.6
|
||||
-----
|
||||
|
||||
The behavior with caching and compile_check has been slightly enhanced. If
|
||||
caching is enabled AND compile_check is enabled, the cache will immediately get
|
||||
regenerated if _any_ involved template or config file is updated. This imposes
|
||||
a slight performance hit because it must check all the files for changes, so be
|
||||
sure to run live sites with caching enabled and compile_check disabled for best
|
||||
performance. If you update a template or config file, simply turn on
|
||||
compile_check, load the page, then turn it back off. This will update the cache
|
||||
file with the new content. This is accomplished by maintaining a list of
|
||||
included/loaded templates and config files at the beginning of the cache file.
|
||||
Therefore it is advisable to remove all cache files after upgrading to 1.4.6
|
||||
(although not absolutely necessary, old cache files will regenerate)
|
||||
|
||||
The debug console now has script timing and array values printed. You MUST
|
||||
update your debug.tpl file with this version of Smarty. Also, the new debug.tpl
|
||||
will not work with older versions of Smarty.
|
||||
|
||||
|
||||
1.4.5
|
||||
-----
|
||||
|
||||
Mostly bug fixes and minor improvements. Added compile id for separate compiled
|
||||
versions of the same script. The directory format and filename convention for
|
||||
the files in templates_c has changed, so you may want to remove all of the
|
||||
existing ones before you upgrade.
|
||||
|
||||
|
||||
1.4.4
|
||||
-----
|
||||
|
||||
A few bug fixes, new section looping attributes and properties, debugging
|
||||
console function for control via URL, and overLib integration and access
|
||||
to request variables from within the template.
|
||||
|
||||
|
||||
1.4.3
|
||||
-----
|
||||
|
||||
This release has a few bug fixes and several enhancements. Smarty now supports
|
||||
template security for third-party template editing. These features disallow the
|
||||
ability for someone to execute commands or PHP code from the template language.
|
||||
Smarty also now has a built-in debugging console, which is a javascript pop-up
|
||||
window that displays all the included template names and assigned variables.
|
||||
|
||||
|
||||
1.4.2
|
||||
-----
|
||||
|
||||
This was mostly one bug fix with variable scoping within included templates
|
||||
and a few documentation changes and updates. See the ChangeLog file for full
|
||||
details.
|
||||
|
||||
|
||||
1.4.1
|
||||
-----
|
||||
|
||||
It seems that the EX_LOCK logic from the previous release didn't fix all the
|
||||
problems with windows platforms. Hopefully this one does. It basically
|
||||
disables file locking on windows, so there is a potential that two programs
|
||||
could write over the same file at the same time, fyi.
|
||||
|
||||
The reset is minor bug fixes, please refer to the ChangeLog file.
|
||||
|
||||
|
||||
1.4.0
|
||||
-----
|
||||
|
||||
IMPORTANT NOTICE
|
||||
|
||||
Smarty now has a new syntax for accessing elements within section loops. The
|
||||
new syntax is easier to use and nicely handles data structures of any
|
||||
complexity. Consequently, this breaks the old syntax.
|
||||
|
||||
Here is an example of the syntax change:
|
||||
|
||||
old syntax:
|
||||
{$sec1/sec2/sec3/customer.phone}
|
||||
|
||||
new syntax:
|
||||
{$customer[$sec1][$sec2][$sec3].phone}
|
||||
|
||||
The section names used to come first, followed by the variable name. Now the
|
||||
variable name always comes first, followed by the section names in brackets.
|
||||
You can access variable indexes anywhere, depending on how you passed the
|
||||
variables in.
|
||||
|
||||
To fix your current templates, we have provided a script that will adjust the
|
||||
syntax for you. Located in misc/fix_vars.php, run this script from the the
|
||||
command line, giving each template as an argument. Be sure to use absolute
|
||||
pathnames, or pathnames relative to the executing script. Probably the easiest
|
||||
way to do this is to copy the fix_vars.php script into your template directory
|
||||
and run 'php -q fix_vars.php *.tpl' Be sure you have proper write permission,
|
||||
and backup your scripts first to be safe! The examples in the 1.4.0
|
||||
documentation have been updated to reflect the changes.
|
||||
|
||||
cd /path/to/templates
|
||||
cp /path/to/fix_vars.php .
|
||||
find . -name "*.tpl" -exec php -q ./fix_vars.php {} \;
|
||||
|
||||
NEW AND IMPROVED COMPILATION PROCESS
|
||||
|
||||
Smarty 1.4.0 also has a new compilation process. Instead of compiling all the
|
||||
templates up front, it now compiles them at runtime. This has several
|
||||
advantages. First of all, there is no longer a need to have a single template
|
||||
directory. You can now have arbitrary template sources, such as multiple
|
||||
directories or even database calls. This also speeds the performance of Smarty
|
||||
when $compile_check is enabled, since it is only checking the template that is
|
||||
being executed instead of everything found in the template directory. The
|
||||
$tpl_file_ext is no longer needed, but kept for backward compatability.
|
||||
Templates can now be named anything you like with any extension.
|
||||
|
||||
MINOR FIXES
|
||||
|
||||
A workaround for LOCK_EX on Windows systems was added, and changed a couple of
|
||||
file permissions for better security on public servers.
|
||||
|
||||
$show_info_header is now defaulted to false instead of true. This header causes
|
||||
problems when displaying content other than HTML, so now you must explicitly
|
||||
set this flag to true to show the header information (or change the default in
|
||||
your copy of Smarty.)
|
||||
|
||||
Documentation is written in docbook format. I updated the docbook -> HTML
|
||||
generating software & style-sheets, and consequently the examples are no longer
|
||||
in a different background color. If anyone wants to contribute a better
|
||||
stylesheet or help with documentation, drop me a line. <monte at ohrt dot com>
|
||||
|
||||
CHANGES/ENHANCEMENTS/UPDATES
|
||||
|
||||
date_format, html_select_date and html_select_time used to require a unix
|
||||
timestamp as the format of the date passed into the template. Smarty is now a
|
||||
bit smarter at this. It will take a unix timestamp, a mysql timestamp, or any
|
||||
date string that is parsable by strtotime, such as 10/01/2001 or 2001-10-01,
|
||||
etc. Just give some formats a try and see what works.
|
||||
|
||||
Smarty now has template prefilters, meaning that you can run your templates
|
||||
through custom functions before they are compiled. This is good for things like
|
||||
removing unwanted comments, keeping an eye on words or functionality people are
|
||||
putting in templates, translating XML -> HTML, etc. See the register_prefilter
|
||||
documentation for more info.
|
||||
|
||||
Another addition are the so-called compiler functions. These are custom
|
||||
functions registered by the user that are executed at compilation time of the
|
||||
template. They can be used to inject PHP code or time-sensitive static content
|
||||
into the compiled template.
|
||||
|
||||
The run-time custom functions are now passed the Smarty object as the second
|
||||
parameter. This can be used, for example, to assign or clear template variables
|
||||
from inside the custom function.
|
||||
|
||||
clear_compile_dir() was added for clearing out compiled versions of your
|
||||
templates. Not something normally needed, but you may have a need for this if
|
||||
you have $compile_check set to false and you periodically update templates via
|
||||
some automated process. As of 1.4.0, uncompiled templates _always_ get
|
||||
compiled regardless of $compile_check setting, although they won't be checked
|
||||
for recompile if $compile_check is set to false.
|
||||
|
||||
You can now refer to properties of objects assigned from PHP by using the '->'
|
||||
symbol and specifying the property name after it, e.g. $foo->bar.
|
||||
|
||||
{php}{/php} tags were added to embed php into the templates. Not normally
|
||||
needed, but some circumstances may call for it. Check out the "componentized
|
||||
templates" tip in the documentation for an example.
|
||||
|
||||
{capture}{/capture} and {counter} functions were added. See the documentation
|
||||
for a complete description and examples.
|
||||
|
||||
UPGRADE NOTES
|
||||
|
||||
The format of the files created in the $compile_dir are now a bit different.
|
||||
The compiled template filename is the template resource name url-encoded.
|
||||
Therefore, all compiled files are now in the top directory of $compile_dir.
|
||||
This was done to make way for arbitrary template resources. Each compiled
|
||||
template also has a header that states what template resource was used to
|
||||
create it. From a unix command prompt, you can use "head -2 *" to see the first
|
||||
two lines of each file.
|
||||
|
||||
When upgrading to 1.4.0, you will want to clear out all your old files in the
|
||||
$compile_dir. If you have $compile_check set to false and the compiled template
|
||||
does not yet exist, it will compile it regardless of this setting. This way you
|
||||
can clear out the $compile_dir and not worry about setting $compile_check to
|
||||
true to get the inital compilation under way.
|
||||
|
||||
|
||||
1.3.2
|
||||
-----
|
||||
|
||||
Smarty now has (an optional) header prepended to the output of the Smarty
|
||||
templates. This displays the Smarty version and the date/time when the page was
|
||||
generated. This is useful for debugging your cache routines, and purely
|
||||
informational so there is evidence that the page was generated by Smarty. Set
|
||||
$show_info_header to false to disable it.
|
||||
|
||||
{config_load ...} performance was tuned by placing the loaded variables into a
|
||||
global array, so basically a config file is read from the file system and
|
||||
placed into a php array structure only once, no matter how many times it is
|
||||
called in any of the templates. The scope of the loaded variables has changed a
|
||||
bit as well. Variables loaded by config_load used to be treated as global
|
||||
variables, meaning that parent templates (templates that included the current
|
||||
template) could see them. Now the default behavior is such that loaded
|
||||
variables are only visible by the current template and child templates (all
|
||||
templates included after the {config_load ...} is called.) To mimic the
|
||||
original behavior, provide the attribute "global=yes" like so: {config_load
|
||||
file="mystuff.conf" global=yes}. Now when you load in mystuff.conf, the
|
||||
variables will be visible to parent templates (merged with any existing config
|
||||
variables.)
|
||||
|
||||
A formatting attribute was added to the {math ...} function, adding the ability
|
||||
to control the format of the output. Use the same formatting syntax as the PHP
|
||||
function sprintf().
|
||||
|
||||
{html_select_time ...} was added, a custom function that works much like
|
||||
{html_select_date ...} except it displays time elements instead of dates.
|
||||
|
||||
A few custom modifiers were added: count_characters, count_words,
|
||||
count_sentences, count_paragraphs. All pretty self-explanatory.
|
||||
|
||||
/* vim: set et: */
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Smarty currently supports the latest minor version of Smarty 4 and Smarty 5.
|
||||
|
||||
| Version | Supported |
|
||||
|---------|--------------------|
|
||||
| 5.0.x | :white_check_mark: |
|
||||
| 4.3.x | :white_check_mark: |
|
||||
| < 4.3 | :x: |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you have discovered a security issue with Smarty, please contact us at mail [at] simonwisselink.nl. Do not
|
||||
disclose your findings publicly and **PLEASE** do not file an Issue (because that would disclose your findings
|
||||
publicly.)
|
||||
|
||||
We will try to confirm the vulnerability and develop a fix if appropriate. When we release the fix, we will publish
|
||||
a security release. Please let us know if you want to be credited.
|
||||
@@ -0,0 +1,10 @@
|
||||
* handle asp style tags in $php_handler
|
||||
* fix all E_NOTICE warnings
|
||||
* make simple math easier
|
||||
* caching all but parts of the template
|
||||
* change plugins so $smarty variable always comes first
|
||||
* get cache ttl with function call
|
||||
FIX: make inserts use normal functions before plugins
|
||||
UPD: change it so that if template comes from some resource,
|
||||
that resource stays as the default, no need to specify it
|
||||
in includes.
|
||||
@@ -1,32 +0,0 @@
|
||||
# @TODO
|
||||
|
||||
## CI-building optimization
|
||||
- compiled & cached templates should not contain references to local filesystem paths. Add an optional rootpath param
|
||||
to `(add|set)TemplateDir` or as a separate method. Make it default to `getcwd()`. If a relative path is passed to
|
||||
`(add|set)TemplateDir`, prefix it with the rootpath at runtime, but do not store the path.
|
||||
|
||||
## Review direct variable property access
|
||||
- review ->value{$index} in ForTag
|
||||
|
||||
## include inline
|
||||
- Re-introduce merge_compiled_includes and the {include inline} attribute?
|
||||
|
||||
## Output buffering
|
||||
- Fix ob_ output buffering commands being scattered around the codebase
|
||||
|
||||
## Review public static vars
|
||||
- such as _CHARSET and _IS_WINDOWS
|
||||
|
||||
## Block / inheritance
|
||||
- Consider phasing out $smarty.block.child as this reverses the inheritance hierarchy and might cause infinite loops
|
||||
when combined with $smarty.block.parent
|
||||
|
||||
## Plugin system
|
||||
- fix template security checks in one place in compiler
|
||||
|
||||
## Beatify output
|
||||
- compiled templates could be proper classes, possibly using [nette/php-generator](https://packagist.org/packages/nette/php-generator)
|
||||
|
||||
## Unrelated / other
|
||||
- review (and avoid) use of 'clone' keyword
|
||||
- what is 'user literal support', why are unit tests skipped?
|
||||
+12
-26
@@ -2,10 +2,8 @@
|
||||
"name": "smarty/smarty",
|
||||
"type": "library",
|
||||
"description": "Smarty - the compiling PHP template engine",
|
||||
"keywords": [
|
||||
"templating"
|
||||
],
|
||||
"homepage": "https://smarty-php.github.io/smarty/",
|
||||
"keywords": ["templating"],
|
||||
"homepage": "http://www.smarty.net",
|
||||
"license": "LGPL-3.0",
|
||||
"authors": [
|
||||
{
|
||||
@@ -15,39 +13,27 @@
|
||||
{
|
||||
"name": "Uwe Tews",
|
||||
"email": "uwe.tews@googlemail.com"
|
||||
},
|
||||
{
|
||||
"name": "Rodney Rehm",
|
||||
"email": "rodney.rehm@medialize.de"
|
||||
},
|
||||
{
|
||||
"name": "Simon Wisselink",
|
||||
"homepage": "https://www.iwink.nl/"
|
||||
}
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/smarty-php/smarty/issues",
|
||||
"forum": "https://github.com/smarty-php/smarty/discussions"
|
||||
"irc": "irc://irc.freenode.org/smarty",
|
||||
"issues": "http://code.google.com/p/smarty-php/issues/list",
|
||||
"forum": "http://www.smarty.net/forums/"
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2 || ^8.0",
|
||||
"symfony/polyfill-mbstring": "^1.27"
|
||||
"php": ">=5.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4" : {
|
||||
"Smarty\\" : "src/"
|
||||
},
|
||||
"files": [
|
||||
"src/functions.php"
|
||||
"classmap": [
|
||||
"libs/Smarty.class.php",
|
||||
"libs/Smarty_Compiler.class.php",
|
||||
"libs/Config_File.class.php"
|
||||
]
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "5.0.x-dev"
|
||||
"dev-master": "2.6.x-dev"
|
||||
}
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^8.5 || ^7.5",
|
||||
"smarty/smarty-lexer": "^4.0.2"
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
+18
-28
@@ -1,35 +1,25 @@
|
||||
<?php
|
||||
/**
|
||||
* Example Application
|
||||
*
|
||||
|
||||
*/
|
||||
require '../libs/Smarty.class.php';
|
||||
|
||||
$smarty = new \Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->compile_check = true;
|
||||
$smarty->debugging = true;
|
||||
$smarty->caching = true;
|
||||
$smarty->cache_lifetime = 120;
|
||||
$smarty->assign("Name", "Fred Irving Johnathan Bradley Peppergill", true);
|
||||
$smarty->assign("FirstName", array("John", "Mary", "James", "Henry"));
|
||||
$smarty->assign("LastName", array("Doe", "Smith", "Johnson", "Case"));
|
||||
$smarty->assign(
|
||||
"Class",
|
||||
array(
|
||||
array("A", "B", "C", "D"),
|
||||
array("E", "F", "G", "H"),
|
||||
array("I", "J", "K", "L"),
|
||||
array("M", "N", "O", "P")
|
||||
)
|
||||
);
|
||||
$smarty->assign(
|
||||
"contacts",
|
||||
array(
|
||||
array("phone" => "1", "fax" => "2", "cell" => "3"),
|
||||
array("phone" => "555-4444", "fax" => "555-3333", "cell" => "760-1234")
|
||||
)
|
||||
);
|
||||
$smarty->assign("option_values", array("NY", "NE", "KS", "IA", "OK", "TX"));
|
||||
$smarty->assign("option_output", array("New York", "Nebraska", "Kansas", "Iowa", "Oklahoma", "Texas"));
|
||||
|
||||
$smarty->assign("Name","Fred Irving Johnathan Bradley Peppergill");
|
||||
$smarty->assign("FirstName",array("John","Mary","James","Henry"));
|
||||
$smarty->assign("LastName",array("Doe","Smith","Johnson","Case"));
|
||||
$smarty->assign("Class",array(array("A","B","C","D"), array("E", "F", "G", "H"),
|
||||
array("I", "J", "K", "L"), array("M", "N", "O", "P")));
|
||||
|
||||
$smarty->assign("contacts", array(array("phone" => "1", "fax" => "2", "cell" => "3"),
|
||||
array("phone" => "555-4444", "fax" => "555-3333", "cell" => "760-1234")));
|
||||
|
||||
$smarty->assign("option_values", array("NY","NE","KS","IA","OK","TX"));
|
||||
$smarty->assign("option_output", array("New York","Nebraska","Kansas","Iowa","Oklahoma","Texas"));
|
||||
$smarty->assign("option_selected", "NE");
|
||||
|
||||
$smarty->display('index.tpl');
|
||||
|
||||
?>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
{popup_init src="/javascripts/overlib.js"}
|
||||
<TITLE>{$title} - {$Name}</TITLE>
|
||||
</HEAD>
|
||||
<BODY bgcolor="#ffffff">
|
||||
|
||||
+41
-45
@@ -1,19 +1,21 @@
|
||||
{config_load file="test.conf" section="setup"}
|
||||
{config_load file=test.conf section="setup"}
|
||||
{include file="header.tpl" title=foo}
|
||||
|
||||
<PRE>
|
||||
|
||||
{* bold and title are read from the config file *}
|
||||
{if #bold#}<b>{/if}
|
||||
{* capitalize the first letters of each word of the title *}
|
||||
Title: {#title#|capitalize}
|
||||
{if #bold#}</b>{/if}
|
||||
{if #bold#}<b>{/if}
|
||||
{* capitalize the first letters of each word of the title *}
|
||||
Title: {#title#|capitalize}
|
||||
{if #bold#}</b>{/if}
|
||||
|
||||
The current date and time is {$smarty.now|date_format:"%Y-%m-%d %H:%M:%S"}
|
||||
The current date and time is {$smarty.now|date_format:"%Y-%m-%d %H:%M:%S"}
|
||||
|
||||
Example of accessing server environment variable SERVER_NAME: {$smarty.server.SERVER_NAME}
|
||||
The value of global assigned variable $SCRIPT_NAME is {$SCRIPT_NAME}
|
||||
|
||||
The value of {ldelim}$Name{rdelim} is <b>{$Name}</b>
|
||||
Example of accessing server environment variable SERVER_NAME: {$smarty.server.SERVER_NAME}
|
||||
|
||||
The value of {ldelim}$Name{rdelim} is <b>{$Name}</b>
|
||||
|
||||
variable modifier example of {ldelim}$Name|upper{rdelim}
|
||||
|
||||
@@ -22,64 +24,58 @@ variable modifier example of {ldelim}$Name|upper{rdelim}
|
||||
|
||||
An example of a section loop:
|
||||
|
||||
{section name=outer
|
||||
loop=$FirstName}
|
||||
{if $smarty.section.outer.index is odd by 2}
|
||||
{$smarty.section.outer.rownum} . {$FirstName[outer]} {$LastName[outer]}
|
||||
{else}
|
||||
{$smarty.section.outer.rownum} * {$FirstName[outer]} {$LastName[outer]}
|
||||
{/if}
|
||||
{sectionelse}
|
||||
none
|
||||
{/section}
|
||||
{section name=outer loop=$FirstName}
|
||||
{if $smarty.section.outer.index is odd by 2}
|
||||
{$smarty.section.outer.rownum} . {$FirstName[outer]} {$LastName[outer]}
|
||||
{else}
|
||||
{$smarty.section.outer.rownum} * {$FirstName[outer]} {$LastName[outer]}
|
||||
{/if}
|
||||
{sectionelse}
|
||||
none
|
||||
{/section}
|
||||
|
||||
An example of section looped key values:
|
||||
An example of section looped key values:
|
||||
|
||||
{section name=sec1 loop=$contacts}
|
||||
phone: {$contacts[sec1].phone}
|
||||
<br>
|
||||
{section name=sec1 loop=$contacts}
|
||||
phone: {$contacts[sec1].phone}<br>
|
||||
fax: {$contacts[sec1].fax}<br>
|
||||
cell: {$contacts[sec1].cell}<br>
|
||||
{/section}
|
||||
<p>
|
||||
|
||||
fax: {$contacts[sec1].fax}
|
||||
<br>
|
||||
|
||||
cell: {$contacts[sec1].cell}
|
||||
<br>
|
||||
{/section}
|
||||
<p>
|
||||
|
||||
testing strip tags
|
||||
{strip}
|
||||
testing strip tags
|
||||
{strip}
|
||||
<table border=0>
|
||||
<tr>
|
||||
<td>
|
||||
<A HREF="{$SCRIPT_NAME}">
|
||||
<font color="red">This is a test </font>
|
||||
</A>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<A HREF="{$SCRIPT_NAME}">
|
||||
<font color="red">This is a test </font>
|
||||
</A>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
{/strip}
|
||||
{/strip}
|
||||
|
||||
</PRE>
|
||||
|
||||
This is an example of the html_select_date function:
|
||||
|
||||
<form>
|
||||
{html_select_date start_year=1998 end_year=2010}
|
||||
{html_select_date start_year=1998 end_year=2010}
|
||||
</form>
|
||||
|
||||
This is an example of the html_select_time function:
|
||||
|
||||
<form>
|
||||
{html_select_time use_24_hours=false}
|
||||
{html_select_time use_24_hours=false}
|
||||
</form>
|
||||
|
||||
This is an example of the html_options function:
|
||||
|
||||
<form>
|
||||
<select name=states>
|
||||
{html_options values=$option_values selected=$option_selected output=$option_output}
|
||||
</select>
|
||||
<select name=states>
|
||||
{html_options values=$option_values selected=$option_selected output=$option_output}
|
||||
</select>
|
||||
</form>
|
||||
|
||||
{include file="footer.tpl"}
|
||||
|
||||
@@ -1,75 +0,0 @@
|
||||
version: "2"
|
||||
services:
|
||||
base:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ./utilities/testrunners/php72/Dockerfile
|
||||
volumes:
|
||||
- smarty-code:/app
|
||||
working_dir: /app
|
||||
php72:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php72/Dockerfile
|
||||
php73:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php73/Dockerfile
|
||||
php74:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php74/Dockerfile
|
||||
php80:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php80/Dockerfile
|
||||
php81:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php81/Dockerfile
|
||||
php82:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php82/Dockerfile
|
||||
php83:
|
||||
extends:
|
||||
service: base
|
||||
build:
|
||||
dockerfile: ./utilities/testrunners/php83/Dockerfile
|
||||
volumes:
|
||||
smarty-code:
|
||||
|
||||
x-mutagen:
|
||||
sync:
|
||||
defaults:
|
||||
symlink:
|
||||
mode: "posix-raw"
|
||||
ignore:
|
||||
vcs: true
|
||||
paths:
|
||||
- ".docker"
|
||||
- ".env.docker"
|
||||
- ".bundles"
|
||||
- "docker-compose.yml"
|
||||
- ".idea"
|
||||
- ".DS_Store"
|
||||
mode: "two-way-resolved"
|
||||
configurationBeta:
|
||||
permissions:
|
||||
defaultOwner: "id:${APP_USER_ID}"
|
||||
defaultGroup: "id:${APP_GROUP_ID}"
|
||||
defaultFileMode: 0666
|
||||
defaultDirectoryMode: 0755
|
||||
permissions:
|
||||
defaultOwner: "id:${APP_USER_ID}"
|
||||
defaultGroup: "id:${APP_GROUP_ID}"
|
||||
smarty-code:
|
||||
alpha: "."
|
||||
beta: "volume://smarty-code"
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
theme: jekyll-theme-minimal
|
||||
@@ -1,93 +0,0 @@
|
||||
# Basics
|
||||
|
||||
## Installation
|
||||
For installation instructies, please see the [getting started section](../getting-started.md).
|
||||
|
||||
## Rendering a template
|
||||
Here's how you create an instance of Smarty in your PHP scripts:
|
||||
```php
|
||||
<?php
|
||||
|
||||
require 'vendor/autoload.php';
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
```
|
||||
|
||||
You now have a Smarty object that you can use to render templates.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require 'vendor/autoload.php';
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->display('string:The current smarty version is: {$smarty.version}.');
|
||||
// or
|
||||
echo $smarty->fetch('string:The current smarty version is: {$smarty.version}.');
|
||||
```
|
||||
|
||||
## Using file-based templates
|
||||
You probably want to manage your templates as files. Create a subdirectory called 'templates' and
|
||||
then configure Smarty to use that:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require 'vendor/autoload.php';
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->setTemplateDir(__DIR__ . '/templates');
|
||||
```
|
||||
|
||||
Say you have a template file called 'version.tpl', stored in the 'templates' directory like this:
|
||||
```smarty
|
||||
<h1>Hi</h1>
|
||||
The current smarty version is: {$smarty.version|escape}.
|
||||
```
|
||||
|
||||
You can now render this, using:
|
||||
```php
|
||||
<?php
|
||||
|
||||
require 'vendor/autoload.php';
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->setTemplateDir(__DIR__ . '/templates');
|
||||
$smarty->display('version.tpl');
|
||||
```
|
||||
|
||||
## Assigning variables
|
||||
|
||||
Templates start to become really useful once you add variables to the mix.
|
||||
|
||||
Create a template called 'footer.tpl' in the 'templates' directory like this:
|
||||
```smarty
|
||||
<small>Copyright {$companyName|escape}</small>
|
||||
```
|
||||
|
||||
Now assign a value to the 'companyName' variable and render your template like this:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require 'vendor/autoload.php';
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->setTemplateDir(__DIR__ . '/templates');
|
||||
$smarty->assign('companyName', 'AC & ME Corp.');
|
||||
$smarty->display('footer.tpl');
|
||||
```
|
||||
|
||||
Run this, and you will see:
|
||||
|
||||
```html
|
||||
<small>Copyright AC & ME Corp.</small>
|
||||
```
|
||||
|
||||
Note how the [escape modifier](../designers/language-modifiers/language-modifier-escape.md)
|
||||
translated the `&` character into the proper HTML syntax `&`.
|
||||
Read more about auto-escaping in the [next section](./configuring.md).
|
||||
@@ -1,184 +0,0 @@
|
||||
# Caching
|
||||
|
||||
Caching is used to speed up the rendering of a template by saving and re-using the output.
|
||||
|
||||
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 templates can include or extend other templates, one
|
||||
cache file could conceivably be made up of several template files,
|
||||
config files, etc.
|
||||
|
||||
> ** Note **
|
||||
>
|
||||
> 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.
|
||||
|
||||
## Setting Up Caching
|
||||
|
||||
The first thing to do is enable caching by calling `Smarty::setCaching()` with either
|
||||
`\Smarty\Smarty::CACHING_LIFETIME_CURRENT` or `\Smarty\Smarty::CACHING_LIFETIME_SAVED`.
|
||||
Or with `\Smarty\Smarty::CACHING_OFF` to disable caching again.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
// enable caching, using the current lifetime (see below)
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
// enable caching, using the lifetime set when the cache was saved (see below)
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);
|
||||
|
||||
// disable caching
|
||||
$smarty->setCaching(Smarty::CACHING_OFF);
|
||||
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
With caching enabled, the function call to `$smarty->display('index.tpl')` will
|
||||
render the template as usual, but also saves a copy of its output. On the
|
||||
next call to `$smarty->display('index.tpl')`, the cached copy will be used
|
||||
instead of rendering the template again.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> By default, Smarty saved its caches as files in a dir called `cache` relative to the current
|
||||
> directory. The default directory can be changed using `$smarty->setCacheDir('/some/cache/dir');`
|
||||
> The files 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
|
||||
|
||||
Each cached page has a limited lifetime. The default value is 3600
|
||||
seconds, or one hour. After that time expires, the cache is regenerated.
|
||||
|
||||
You can change the lifetime as follows:
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
// or $smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);
|
||||
|
||||
// set the cache_lifetime to 5 minutes
|
||||
$smarty->setCacheLifetime(5 * 60);
|
||||
```
|
||||
|
||||
Setting caching to a value of `\Smarty\Smarty::CACHING_LIFETIME_CURRENT` tells Smarty to use
|
||||
the current lifetime to determine if the cache has expired.
|
||||
|
||||
A value of `\Smarty\Smarty::CACHING\_LIFETIME\_SAVED` tells Smarty to use the lifetime value at the time the
|
||||
cache was generated. This way you can set the just before rendering a template to have granular control over
|
||||
when that particular cache expires.
|
||||
|
||||
An example:
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
// retain current cache lifetime for each specific display call
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);
|
||||
|
||||
// set the cache_lifetime for index.tpl to 5 minutes
|
||||
$smarty->setCacheLifetime(300);
|
||||
$smarty->display('index.tpl');
|
||||
|
||||
// set the cache_lifetime for home.tpl to 1 hour
|
||||
$smarty->setCacheLifetime(3600);
|
||||
$smarty->display('home.tpl');
|
||||
|
||||
// NOTE: the following $cache_lifetime setting will not work when $caching
|
||||
// is set to Smarty::CACHING_LIFETIME_SAVED.
|
||||
// The cache lifetime for home.tpl has already been set
|
||||
// to 1 hour, and will no longer respect the value of $cache_lifetime.
|
||||
// The home.tpl cache will still expire after 1 hour.
|
||||
$smarty->setCacheLifetime(30); // 30 seconds
|
||||
$smarty->display('home.tpl');
|
||||
```
|
||||
|
||||
## Compile check
|
||||
|
||||
By 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, disable this on a production environment:
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
$smarty->setCompileCheck(Smarty::COMPILECHECK_OFF);
|
||||
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
## Checking if a template is cached
|
||||
|
||||
Smarty's `isCached() method 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
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
if (!$smarty->isCached('index.tpl')) {
|
||||
// No cache available, do variable assignments here.
|
||||
$smarty->assign('data', do_expensive_database_calls());
|
||||
}
|
||||
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
## Nocache-blocks
|
||||
You can keep parts of a page dynamic (disable caching) with the
|
||||
[`{nocache}{/nocache}`](../../designers/language-builtin-functions/language-function-nocache.md) block function,
|
||||
or by using the `nocache` parameter for most template functions.
|
||||
|
||||
Let's say the whole page can be cached except for a banner that is
|
||||
displayed down the side of the page. By using a [`{nocache}{/nocache}`](../../designers/language-builtin-functions/language-function-nocache.md)
|
||||
block for the banner, you can
|
||||
keep this element dynamic within the cached content.
|
||||
|
||||
## Clearing the cache
|
||||
You can clear all the cache files with Smarty's `clearAllCache()` method, or individual cache
|
||||
files with the `clearCache()` method.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
// clear only cache for index.tpl
|
||||
$smarty->clearCache('index.tpl');
|
||||
|
||||
// clear out all cache files
|
||||
$smarty->clearAllCache();
|
||||
|
||||
// clear out all cache files older than one hour
|
||||
$smarty->clearAllCache(3600);
|
||||
|
||||
// or, clear all expired caches
|
||||
$smarty->clearAllCache(Smarty::CLEAR_EXPIRED);
|
||||
```
|
||||
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
# Custom cache storage layers
|
||||
|
||||
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.
|
||||
|
||||
With a custom cache implementation you could replace the slow filesystem by a
|
||||
faster storage engine, centralize the cache to be accessible to multiple
|
||||
servers.
|
||||
|
||||
Smarty requires implementations to extend `\Smarty\Cacheresource\Base`, but encourages you to either extend
|
||||
`\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.
|
||||
- `\Smarty\Cacheresource\KeyValueStore` allows you to turn any
|
||||
KeyValue-Store (like APC or Memcache) into a full-featured
|
||||
CacheResource implementation. Everything around deep
|
||||
cache-groups like "a|b|c" is being handled for you in a way that
|
||||
guarantees clearing the cache-group "a" will clear all nested groups
|
||||
as well - even though KeyValue-Stores don't allow this kind of
|
||||
hierarchy by nature.
|
||||
|
||||
Custom CacheResources must be registered on
|
||||
runtime with `Smarty\Smarty::setCacheResource()`:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->setCacheResource(new My_CacheResource_Mysql());
|
||||
```
|
||||
|
||||
@@ -1,137 +0,0 @@
|
||||
# Multiple caches per template
|
||||
|
||||
## Introduction
|
||||
|
||||
You can have multiple cache files for a single call to
|
||||
`display()` or `fetch()`.
|
||||
|
||||
Let's say that
|
||||
a call to `$smarty->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
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
$my_cache_id = (int) $_GET['article_id'];
|
||||
|
||||
$smarty->display('index.tpl', $my_cache_id);
|
||||
```
|
||||
|
||||
|
||||
Above, we are passing the variable `$my_cache_id` to
|
||||
[`display()`](#api.display) as the `$cache_id`. For each unique value of
|
||||
`$my_cache_id`, a separate cache will be generated for `index.tpl`. In
|
||||
this example, `article_id` was passed in the URL and is used as the
|
||||
`$cache_id`.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Be very cautious when passing values from a client (web browser) into
|
||||
> Smarty or any PHP application. Although the above example of using the
|
||||
> article_id from the URL looks handy, it could have bad consequences.
|
||||
> The `$cache_id` is used to create a directory on the file system, so
|
||||
> if the user decided to 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 example, you might want to check if
|
||||
> the article_id is a valid ID in the database.
|
||||
|
||||
Be sure to pass the same `$cache_id` as the second parameter to
|
||||
`isCached()` and `clearCache()`.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
$my_cache_id = (int) $_GET['article_id'];
|
||||
|
||||
if (!$smarty->isCached('index.tpl', $my_cache_id)) {
|
||||
// ...
|
||||
}
|
||||
|
||||
$smarty->display('index.tpl', $my_cache_id);
|
||||
```
|
||||
|
||||
## Clearing specific caches
|
||||
|
||||
You can clear all caches for a particular `$cache_id` by passing NULL as
|
||||
the first parameter to `clearCache()`.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
// clear all caches with "sports" as the $cache_id
|
||||
$smarty->clearCache(null, 'sports');
|
||||
|
||||
$smarty->display('index.tpl', 'sports');
|
||||
```
|
||||
|
||||
In this manner, you can "group" your caches together by giving them the
|
||||
same `$cache_id`.
|
||||
|
||||
## Advanced cache grouping
|
||||
|
||||
You can do more elaborate grouping by setting up `$cache_id` groups.
|
||||
This is accomplished by separating each sub-group with a vertical bar
|
||||
`|` in the `$cache_id` value. You can have as many sub-groups as you
|
||||
like.
|
||||
|
||||
- You can think of cache groups like a directory hierarchy. For
|
||||
instance, a cache group of `'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/*'`.
|
||||
|
||||
- If you specify a template name such as
|
||||
`clearCache('foo.tpl', 'a|b|c')` then Smarty will attempt to remove
|
||||
`'/a/b/c/foo.tpl'`.
|
||||
|
||||
- You CANNOT remove a specified template name under multiple cache
|
||||
groups such as `'/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.
|
||||
|
||||
Cache grouping should not be confused with your template directory
|
||||
hierarchy, the cache grouping has no knowledge of how your templates are
|
||||
structured. So for example, if you have a template structure like
|
||||
`themes/blue/index.tpl` and you want to be able to clear all the cache
|
||||
files for the "blue" theme, you will need to create a cache group
|
||||
structure that mimics your template file structure, such as
|
||||
`display('themes/blue/index.tpl', 'themes|blue')`, then clear them with
|
||||
`clearCache(null, 'themes|blue')`.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);
|
||||
|
||||
// clear all caches with 'sports|basketball' as the first two cache_id groups
|
||||
$smarty->clearCache(null, 'sports|basketball');
|
||||
|
||||
// clear all caches with "sports" as the first cache_id group. This would
|
||||
// include "sports|basketball", or "sports|(anything)|(anything)|(anything)|..."
|
||||
$smarty->clearCache(null, 'sports');
|
||||
|
||||
// clear the foo.tpl cache file with "sports|basketball" as the cache_id
|
||||
$smarty->clearCache('foo.tpl', 'sports|basketball');
|
||||
|
||||
$smarty->display('index.tpl', 'sports|basketball');
|
||||
```
|
||||
|
||||
|
||||
@@ -1,193 +0,0 @@
|
||||
# Configuring Smarty
|
||||
|
||||
## Setting the template path
|
||||
By default, Smarty looks for templates to render in `./templates`.
|
||||
|
||||
You can change this, or even use multiple paths to use when looking for templates.
|
||||
|
||||
If you need to change this, you can use `setTemplateDir()` or `addTemplateDir()`.
|
||||
Use `getTemplateDir()` to retrieve the configured paths.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// set a single directory where the config files are stored
|
||||
$smarty->setTemplateDir('./config');
|
||||
|
||||
// set multiple directories where config files are stored
|
||||
$smarty->setTemplateDir(['./config', './config_2', './config_3']);
|
||||
|
||||
// add directory where config files are stored to the current list of dirs
|
||||
$smarty->addTemplateDir('./config_1');
|
||||
|
||||
// add multiple directories to the current list of dirs
|
||||
$smarty->addTemplateDir([
|
||||
'./config_2',
|
||||
'./config_3',
|
||||
]);
|
||||
|
||||
// chaining of method calls
|
||||
$smarty->setTemplateDir('./config')
|
||||
->addTemplateDir('./config_1')
|
||||
->addTemplateDir('./config_2');
|
||||
|
||||
// get all directories where config files are stored
|
||||
$template_dirs = $smarty->getTemplateDir();
|
||||
var_dump($template_dirs); // array
|
||||
|
||||
// get directory identified by key
|
||||
$template_dir = $smarty->getTemplateDir(0);
|
||||
var_dump($template_dir); // string
|
||||
```
|
||||
|
||||
## Setting the path for compiled templates
|
||||
Smarty compiles templates to native PHP to be as fast as possible.
|
||||
The default path where these PHP-files are stored is `./templates_c`.
|
||||
|
||||
If you need to change this, you can use `setCompileDir()`.
|
||||
Use `getCompileDir()` to retrieve the configured path.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// set another path to store compiled templates
|
||||
$smarty->setCompileDir('/data/compiled_templates');
|
||||
|
||||
// get directory where compiled templates are stored
|
||||
$compileDir = $smarty->getCompileDir();
|
||||
```
|
||||
|
||||
|
||||
## Setting the config path
|
||||
Smarty can [load data from config files](./variables/config-files.md).
|
||||
By default, Smarty loads the config files from `./configs`.
|
||||
|
||||
You can change this, or even use multiple paths to use when looking for config files.
|
||||
|
||||
If you need to change this, you can use `setConfigDir()` or `addConfigDir()`.
|
||||
Use `getConfigDir()` to retrieve the configured paths.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// set a single directory where the config files are stored
|
||||
$smarty->setConfigDir('./config');
|
||||
|
||||
// set multiple directories where config files are stored
|
||||
$smarty->setConfigDir(['./config', './config_2', './config_3']);
|
||||
|
||||
// add directory where config files are stored to the current list of dirs
|
||||
$smarty->addConfigDir('./config_1');
|
||||
|
||||
// add multiple directories to the current list of dirs
|
||||
$smarty->addConfigDir([
|
||||
'./config_2',
|
||||
'./config_3',
|
||||
]);
|
||||
|
||||
// chaining of method calls
|
||||
$smarty->setConfigDir('./config')
|
||||
->addConfigDir('./config_1', 'one')
|
||||
->addConfigDir('./config_2', 'two');
|
||||
|
||||
// get all directories where config files are stored
|
||||
$config_dirs = $smarty->getConfigDir();
|
||||
var_dump($config_dirs); // array
|
||||
|
||||
// get directory identified by key
|
||||
$config_dir = $smarty->getConfigDir(0);
|
||||
var_dump($config_dir); // string
|
||||
```
|
||||
|
||||
## Setting the path for caches
|
||||
Even though Smarty runs templates as native PHP for maximum speed, it still needs to
|
||||
execute the PHP code on each call. If your data doesn't change all that often, you
|
||||
may be able to speed up your application even more by using output caching.
|
||||
|
||||
Output caching can be a tricky subject, so we devoted an entire [section to caching](./caching/basics.md).
|
||||
Be sure to read that if you want to use caching.
|
||||
|
||||
By default, Smarty stores caches to PHP-files in a subdirectory named `./cache`.
|
||||
|
||||
If you need to change this, you can use `setCacheDir()`.
|
||||
Use `getCacheDir()` to retrieve the configured path.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// set another path to store caches
|
||||
$smarty->setCacheDir('/data/caches');
|
||||
|
||||
// get directory where cached templates are stored
|
||||
$cacheDir = $smarty->getCacheDir();
|
||||
```
|
||||
|
||||
## Enabling auto-escaping
|
||||
By default, Smarty does not escape anything you render in your templates. If you use
|
||||
Smarty to render a HTML-page, this means that you will have to make sure that you do
|
||||
not render any characters that have a special meaning in HTML, such as `&`, `<` and `>`,
|
||||
or apply the [escape modifier](../designers/language-modifiers/language-modifier-escape.md)
|
||||
to anything you want to render.
|
||||
|
||||
If you forget to do so, you may break your HTML page, or even create a vulnerability for
|
||||
attacks known as [XSS or Cross Site Scripting](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html).
|
||||
|
||||
Luckily, you can tell Smarty to automatically apply the escape modifier to any dynamic part of your template.
|
||||
It's like Smarty magically adds `|escape` to every variable you use on a web page.
|
||||
|
||||
Enable auto-escaping for HTML as follows:
|
||||
```php
|
||||
$smarty->setEscapeHtml(true);
|
||||
```
|
||||
|
||||
## Disabling compile check
|
||||
By default, Smarty tests to see if the
|
||||
current template has changed since the last time
|
||||
it was compiled. If it has changed, it recompiles that template.
|
||||
|
||||
Once an application is put into production, this compile-check step
|
||||
is usually no longer needed and the extra checks can significantly hurt performance.
|
||||
Be sure to disable compile checking on production for maximum performance.
|
||||
```php
|
||||
<?php
|
||||
$smarty->setCompileCheck(\Smarty\Smarty::COMPILECHECK_OFF);
|
||||
```
|
||||
|
||||
If [`caching`](./caching/basics.md) is enabled and compile-check is
|
||||
enabled, then the cache files will get regenerated if an involved
|
||||
template file or config file was updated.
|
||||
|
||||
## Charset encoding
|
||||
|
||||
There are a variety of encodings for textual data, ISO-8859-1 (Latin1)
|
||||
and UTF-8 being the most popular. Unless you change `\Smarty\Smarty::$_CHARSET`,
|
||||
Smarty recognizes `UTF-8` as the internal charset.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> `ISO-8859-1` has been PHP\'s default internal charset since the
|
||||
> beginning. Unicode has been evolving since 1991. Since then, it has
|
||||
> become the one charset to conquer them all, as it is capable of
|
||||
> encoding most of the known characters even across different character
|
||||
> systems (latin, cyrillic, japanese, ...). `UTF-8` is unicode\'s most
|
||||
> used encoding, as it allows referencing the thousands of character
|
||||
> with the smallest size overhead possible.
|
||||
>
|
||||
> Since unicode and UTF-8 are very widespread nowadays, their use is
|
||||
> strongly encouraged.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Smarty\'s internals and core plugins are truly UTF-8 compatible since
|
||||
> Smarty 3.1.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// use japanese character encoding
|
||||
mb_internal_charset('EUC-JP');
|
||||
|
||||
\Smarty\Smarty::$_CHARSET = 'EUC-JP';
|
||||
$smarty = new \Smarty\Smarty();
|
||||
```
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
# Custom block tags
|
||||
|
||||
Block tags are tags of the form: `{func} .. {/func}`. In other
|
||||
words, they enclose a template block and operate on the contents of this
|
||||
block.
|
||||
|
||||
Block functions take precedence over normal tags of the same name, that is, you
|
||||
cannot have both custom tag `{func}` and block tag `{func}..{/func}`.
|
||||
|
||||
- By default, your function implementation is called twice by Smarty:
|
||||
once for the opening tag, and once for the closing tag. (See
|
||||
`$repeat` below on how to change this.)
|
||||
|
||||
- Only the opening tag of the block has attributes. All attributes are contained in the `$params`
|
||||
variable as an associative array. The opening tag attributes are
|
||||
also accessible to your function when processing the closing tag.
|
||||
|
||||
- The value of the `$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.
|
||||
|
||||
- The parameter `$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`.
|
||||
|
||||
Example:
|
||||
```php
|
||||
<?php
|
||||
|
||||
function smarty_block_translate($params, $content, \Smarty\Template $template, &$repeat) {
|
||||
// only output on the closing tag
|
||||
if (!$repeat){
|
||||
if (isset($content)) {
|
||||
$lang = $params['lang'];
|
||||
// do some intelligent translation thing here with $content
|
||||
return $translation;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$smarty->registerPlugin(Smarty\Smarty::PLUGIN_BLOCK, 'translate', 'smarty_block_translate');
|
||||
```
|
||||
|
||||
This can now be used in your templates as follows:
|
||||
|
||||
```smarty
|
||||
{translate lang='nl'}
|
||||
Quia omnis nulla omnis iusto est id et.
|
||||
{/translate}
|
||||
```
|
||||
@@ -1,101 +0,0 @@
|
||||
# Creating an extension
|
||||
|
||||
## Default extensions
|
||||
|
||||
In order to organize your custom tags and modifiers, you can create an Extension.
|
||||
In fact, most of Smarty itself is organized into two extensions:
|
||||
|
||||
- the core extension, which provides the basic language tags such as `{if}`, `{for}` and `{assign}`.
|
||||
- the default extension, which provides all default modifiers such as `|escape`, `|nl2br` and `|number_format`
|
||||
and tags such as `{html_image}`, `{mailto}` and `{textformat}` that are enabled by default, but not necessarily universal.
|
||||
|
||||
> ** Note **
|
||||
>
|
||||
> There is also the 'BCPluginsAdapter' extension, which does not add any new functionality, but
|
||||
> wraps calls to deprecated methods such as `Smarty\Smarty::addPluginsDir()` and `Smarty\Smarty::loadFilter()`.
|
||||
|
||||
## Writing your own extension
|
||||
|
||||
In order to write your own custom extension, you must write a class that implements `Smarty\Extension\ExtensionInterface`.
|
||||
However, it is usually easier to extend `Smarty\Extension\Base` which provides empty implementation for each of the methods
|
||||
required by `Smarty\Extension\ExtensionInterface`. This allows you to only override the method(s) you need.
|
||||
|
||||
Example:
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Extension\Base;
|
||||
|
||||
class MyExtension extends Base {
|
||||
|
||||
public function getModifierCompiler(string $modifier): ?\Smarty\Compile\Modifier\ModifierCompilerInterface {
|
||||
|
||||
switch ($modifier) {
|
||||
case 'array_escape': return new MyArrayEscapeModifierCompiler();
|
||||
case 'array_unescape': return new MyArrayUnescapeModifierCompiler();
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
Another example, that would allow you to use any valid PHP callable as a modifier in your templates:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Extension\Base;
|
||||
|
||||
class MyCallablePassThroughExtension extends Base {
|
||||
|
||||
public function getModifierCallback(string $modifierName) {
|
||||
|
||||
if (is_callable($modifierName)) {
|
||||
return $modifierName;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
Writing an extension allows you to add a group of tags, block tags and modifiers to the Smarty language.
|
||||
It also allows you to register pre-, post- and output-filters in a structured way.
|
||||
The files in `src/Extension/` in the `smarty/smarty` dir should give you all the information you need to start
|
||||
writing your own extension.
|
||||
|
||||
## Registering an extension
|
||||
|
||||
When you have written your extension, add it to a Smarty instance as follows:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->addExtension(new MyCustomExtension());
|
||||
```
|
||||
|
||||
This will add `MyCustomExtension` to the end of the extension list, meaning that you cannot override tags or modifiers
|
||||
from one of Smarty's default extensions.
|
||||
|
||||
Should you wish to insert your extension at the top of the extension list, or create a very limited Smarty version that
|
||||
only contains the core extension, you can use `Smarty\Smarty::setExtensions()` to override the list of extensions.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->setExtensions([
|
||||
new Smarty\Extension\CoreExtension(),
|
||||
new MyCustomExtension(),
|
||||
new Smarty\Extension\DefaultExtension(),
|
||||
]);
|
||||
```
|
||||
@@ -1,10 +0,0 @@
|
||||
# Extending Smarty
|
||||
|
||||
By default, Smarty is already very complete and powerful. However, you can unlock its real potential by
|
||||
extending Smarty.
|
||||
|
||||
There are various ways to extend Smarty for it to suit your needs. You can create custom
|
||||
[tags](tags.md), [block tags](block-tags.md) and [modifiers](modifiers.md) by registering a method as a plugin.
|
||||
|
||||
If this becomes too messy, you can group your custom tags, modifiers, and more into an [Extension](extensions.md).
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
# Custom modifiers
|
||||
|
||||
Modifiers are little functions that are applied
|
||||
to a variable in the template before it is displayed or used in some
|
||||
other context. Smarty comes with a bunch of [modifiers](../../designers/language-modifiers/index.md), but you can
|
||||
easily add your own.
|
||||
|
||||
In order to do so, you must write a function that accepts as its first parameter 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.
|
||||
|
||||
For example:
|
||||
```php
|
||||
<?php
|
||||
|
||||
function smarty_modifier_substr($string, $offset, $length) {
|
||||
return substr($string, $offset, $length);
|
||||
}
|
||||
|
||||
$smarty->registerPlugin(Smarty\Smarty::PLUGIN_MODIFIER, 'substr', 'smarty_modifier_substr');
|
||||
```
|
||||
|
||||
You can now use this in your templates as follows:
|
||||
```smarty
|
||||
{$applicationName|substr:0:20}
|
||||
```
|
||||
@@ -1,84 +0,0 @@
|
||||
# Custom tags
|
||||
|
||||
You can add your own tags to the Smarty language.
|
||||
|
||||
## Runtime tags
|
||||
|
||||
Usually, you'll add a runtime tag. Adding a runtime tag requires you to provide a callback function that accepts
|
||||
two parameters:
|
||||
|
||||
- `$params`: all attributes from the template as an associative array.
|
||||
- `$template`: a `Smarty\Template` object representing the template where tag was used.
|
||||
|
||||
The output (return value) of the function will be substituted in place
|
||||
of the tag in the template.
|
||||
|
||||
If the function needs to assign some variables to the template or use
|
||||
some other Smarty-provided functionality, it can use the supplied
|
||||
`$template` object to do so.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
function smarty_tag_eightball($params, \Smarty\Template $template): string {
|
||||
$answers = [
|
||||
'Yes',
|
||||
'No',
|
||||
'No way',
|
||||
'Outlook not so good',
|
||||
'Ask again soon',
|
||||
'Maybe in your reality'
|
||||
];
|
||||
|
||||
$result = array_rand($answers);
|
||||
return $answers[$result];
|
||||
}
|
||||
|
||||
$smarty->registerPlugin(Smarty\Smarty::PLUGIN_FUNCTION, 'eightball', 'smarty_tag_eightball');
|
||||
```
|
||||
|
||||
Which can now be used in the template as:
|
||||
|
||||
```smarty
|
||||
Question: Will we ever have time travel?
|
||||
Answer: {eightball}.
|
||||
```
|
||||
|
||||
## Compiler tags
|
||||
|
||||
Compiler tags 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 runtime tag registered under the same name,
|
||||
the compiler function has precedence.
|
||||
|
||||
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.
|
||||
|
||||
Example:
|
||||
```php
|
||||
<?php
|
||||
|
||||
function smarty_compiler_tplheader($params, Smarty $smarty) {
|
||||
return "<?php\necho '" . $smarty->_current_file . " compiled at " . date('Y-m-d H:M'). "';\n?>";
|
||||
}
|
||||
|
||||
$smarty->registerPlugin(Smarty\Smarty::PLUGIN_COMPILER, 'tplheader', 'smarty_compiler_tplheader');
|
||||
```
|
||||
|
||||
This function can be called from the template as:
|
||||
|
||||
```smarty
|
||||
{* this function gets executed at compile time only *}
|
||||
{tplheader}
|
||||
```
|
||||
|
||||
The resulting PHP code in the compiled template would be something like
|
||||
this:
|
||||
|
||||
```php
|
||||
<?php
|
||||
echo 'index.tpl compiled at 2023-02-20 20:02';
|
||||
```
|
||||
@@ -1,35 +0,0 @@
|
||||
# Output filters
|
||||
|
||||
When a template is rendered, its output can be sent through one or more
|
||||
output filters.
|
||||
|
||||
> **Note**
|
||||
> This differs from [`prefilters`](prefilters.md) and
|
||||
> [`postfilters`](postfilters.md) because, pre- and postfilters
|
||||
> operate on compiled templates before they are saved to the disk, whereas
|
||||
> output filters operate on the template output when it is executed.
|
||||
|
||||
Smarty will pass the template output as the first argument, and expect the function
|
||||
to return the result of the processing.
|
||||
|
||||
Output filters can be either added as part of an [Extension](../extending/extensions.md) or
|
||||
registered as shown below.
|
||||
|
||||
This will provide a rudimentary protection against spambots:
|
||||
```php
|
||||
<?php
|
||||
|
||||
function protect_email($tpl_output, \Smarty\Template\ $template)
|
||||
{
|
||||
return preg_replace(
|
||||
'!(\S+)@([a-zA-Z0-9\.\-]+\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',
|
||||
'$1%40$2',
|
||||
$tpl_output
|
||||
);
|
||||
}
|
||||
|
||||
// register the outputfilter
|
||||
$smarty->registerFilter("output", "protect_email");
|
||||
$smarty->display("index.tpl');
|
||||
|
||||
```
|
||||
@@ -1,33 +0,0 @@
|
||||
# Postfilters
|
||||
|
||||
Template postfilters are PHP functions that your templates are ran
|
||||
through *after they are compiled*.
|
||||
|
||||
Smarty will
|
||||
pass the compiled template code as the first argument, and expect the
|
||||
function to return the result of the processing, which must also be valid PHP code.
|
||||
|
||||
Prefilters can be either added as part of an [Extension](../extending/extensions.md) or
|
||||
registered as shown below.
|
||||
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
function add_header_comment($tpl_source, \Smarty\Template\ $template)
|
||||
{
|
||||
return "<?php echo \"<!-- Created by Smarty! -->\n\"; ?>\n".$tpl_source;
|
||||
}
|
||||
|
||||
// register the postfilter
|
||||
$smarty->registerFilter('post', 'add_header_comment');
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
The postfilter above will make the compiled Smarty template `index.tpl`
|
||||
look like:
|
||||
|
||||
```smarty
|
||||
<!-- Created by Smarty! -->
|
||||
{* rest of template content... *}
|
||||
```
|
||||
@@ -1,26 +0,0 @@
|
||||
# Prefilters
|
||||
|
||||
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.
|
||||
|
||||
Smarty will pass the template source code as the first argument, and
|
||||
expect the function to return the resulting template source code.
|
||||
|
||||
Prefilters can be either added as part of an [Extension](../extending/extensions.md) or
|
||||
registered as shown below.
|
||||
|
||||
This will remove all the html comments in the template source:
|
||||
```php
|
||||
<?php
|
||||
|
||||
function remove_dw_comments($tpl_source, \Smarty\Template\ $template)
|
||||
{
|
||||
return preg_replace("/<!--#.*-->/U",'',$tpl_source);
|
||||
}
|
||||
|
||||
// register the prefilter
|
||||
$smarty->registerFilter('pre', 'remove_dw_comments');
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
@@ -1,130 +0,0 @@
|
||||
# Template Inheritance
|
||||
|
||||
Inheritance allows you to define base templates that can
|
||||
be extended by child templates. Extending means that the child template
|
||||
can override all or some of the named block areas in the base template.
|
||||
|
||||
When you render the child template, the result will as if you rendered
|
||||
the base template, with only the block(s) that you have overridden in the
|
||||
child templates differing.
|
||||
|
||||
- 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 [`{block}`](../designers/language-builtin-functions/language-function-block.md) tags they override.
|
||||
Anything outside of [`{block}`](../designers/language-builtin-functions/language-function-block.md) tags will
|
||||
be removed.
|
||||
|
||||
- Template inheritance is a compile time process which creates a
|
||||
single compiled template file. Compared to corresponding solutions
|
||||
based on subtemplates included with the
|
||||
[`{include}`](../designers/language-builtin-functions/language-function-include.md) tag it does have much
|
||||
better performance when rendering.
|
||||
|
||||
## Basic inheritance
|
||||
|
||||
First, create a base template with one or more [blocks](../designers/language-builtin-functions/language-function-block.md).
|
||||
Then, create a child template. The child template
|
||||
must have an [{extends} tag](../designers/language-builtin-functions/language-function-extends.md) on its first line.
|
||||
|
||||
The child template can redefine one or more blocks defined in the base template.
|
||||
|
||||
See below for a simple example.
|
||||
|
||||
layout.tpl (base)
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{block name=title}Default Page Title{/block}</title>
|
||||
{block name=head}{/block}
|
||||
</head>
|
||||
<body>
|
||||
{block name=body}{/block}
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
|
||||
myproject.tpl (child)
|
||||
|
||||
```smarty
|
||||
{extends file='layout.tpl'}
|
||||
{block name=head}
|
||||
<link href="/css/mypage.css" rel="stylesheet" type="text/css"/>
|
||||
<script src="/js/mypage.js"></script>
|
||||
{/block}
|
||||
```
|
||||
|
||||
mypage.tpl (grandchild)
|
||||
|
||||
```smarty
|
||||
{extends file='myproject.tpl'}
|
||||
{block name=title}My Page Title{/block}
|
||||
{block name=head}
|
||||
<link href="/css/mypage.css" rel="stylesheet" type="text/css"/>
|
||||
<script src="/js/mypage.js"></script>
|
||||
{/block}
|
||||
{block name=body}My HTML Page Body goes here{/block}
|
||||
```
|
||||
|
||||
|
||||
To render the above, you would use:
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->display('mypage.tpl');
|
||||
```
|
||||
|
||||
The resulting output is:
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>My Page Title</title>
|
||||
<link href="/css/mypage.css" rel="stylesheet" type="text/css"/>
|
||||
<script src="/js/mypage.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
My HTML Page Body goes here
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> When [compile-check](./configuring.md#disabling-compile-check) is enabled, all files
|
||||
> in the inheritance tree
|
||||
> are checked for modifications upon each invocation. You may want to
|
||||
> disable compile-check on production servers for this reason.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> If you have a subtemplate which is included with
|
||||
> [`{include}`](../designers/language-builtin-functions/language-function-include.md) and it contains
|
||||
> [`{block}`](../designers/language-builtin-functions/language-function-block.md) areas it works only if the
|
||||
> [`{include}`](../designers/language-builtin-functions/language-function-include.md) itself is called from within
|
||||
> a surrounding [`{block}`](../designers/language-builtin-functions/language-function-block.md). In the final
|
||||
> parent template you may need a dummy
|
||||
> [`{block}`](../designers/language-builtin-functions/language-function-block.md) for it.
|
||||
|
||||
|
||||
## Using append and prepend
|
||||
The content of [`{block}`](../designers/language-builtin-functions/language-function-block.md) tags from child
|
||||
and parent templates can be merged by the `append` or `prepend`
|
||||
[`{block}`](../designers/language-builtin-functions/language-function-block.md) tag option flags and
|
||||
`{$smarty.block.parent}` or `{$smarty.block.child}` placeholders.
|
||||
|
||||
## Extends resource type
|
||||
Instead of using [`{extends}`](../designers/language-builtin-functions/language-function-extends.md) tags in the
|
||||
template files you can define the inheritance tree in your PHP script by
|
||||
using the [`extends:` resource](resources.md#the-extends-resource) type.
|
||||
|
||||
The code below will return same result as the example above.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl');
|
||||
```
|
||||
@@ -1,86 +0,0 @@
|
||||
# Rendering templates
|
||||
|
||||
## Fetching or rendering templates directly
|
||||
As explained in [basics](basics.md), you can use `$smarty->fetch()` or `$smarty->display()`
|
||||
to render a template directly.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->display('homepage.tpl');
|
||||
|
||||
// or
|
||||
|
||||
$output = $smarty->fetch('homepage.tpl');
|
||||
```
|
||||
|
||||
When you use `display()`, Smarty renders the template to the standard output stream.
|
||||
`fetch()` returns the output instead of echoing it.
|
||||
|
||||
The example above uses simple filenames to load the template. Smarty also supports
|
||||
[loading templates from resources](resources.md).
|
||||
|
||||
## Creating a template object
|
||||
You can also create a template object which later can be prepared first,
|
||||
and rendered later. This can be useful, for example if you plan to re-use several
|
||||
templates.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
// create template object with its private variable scope
|
||||
$tpl = $smarty->createTemplate('index.tpl');
|
||||
|
||||
// assign a variable (available only to this template)
|
||||
$tpl->assign('title', 'My Homepage!');
|
||||
|
||||
// display the template
|
||||
$tpl->display();
|
||||
```
|
||||
|
||||
More on assigning variables in [using data in templates](variables/assigning.md).
|
||||
|
||||
|
||||
## Testing if a template exists
|
||||
You can use `templateExists()` to check whether a template exists before you attempt to use it.
|
||||
|
||||
It accepts either a path to the template on the filesystem or a
|
||||
resource string specifying the template.
|
||||
|
||||
This example uses `$_GET['page']` to
|
||||
[`{include}`](../designers/language-builtin-functions/language-function-include.md) a content template. If the
|
||||
template does not exist then an error page is displayed instead. First,
|
||||
the `page_container.tpl`
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{$title|escape}</title>
|
||||
</head>
|
||||
<body>
|
||||
{* include middle content page *}
|
||||
{include file=$content_template}
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
And the php script:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// set the filename eg index.inc.tpl
|
||||
$mid_template = $_GET['page'].'.inc.tpl';
|
||||
|
||||
if (!$smarty->templateExists($mid_template)){
|
||||
$mid_template = 'page_not_found.tpl';
|
||||
}
|
||||
$smarty->assign('content_template', $mid_template);
|
||||
|
||||
$smarty->display('page_container.tpl');
|
||||
```
|
||||
@@ -1,322 +0,0 @@
|
||||
# Template resources
|
||||
|
||||
## The filesystem resource
|
||||
|
||||
So far in our examples, we have used simple filenames or paths when loading a template.
|
||||
|
||||
For example, to load a template file called `homepage.tpl`, from the filesystem, you could write:
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->display('homepage.tpl');
|
||||
```
|
||||
|
||||
The filesystem is the default resource. Templates, however, may come
|
||||
from a variety of sources. When you render a template, or
|
||||
when you include a template from within another template, you supply a
|
||||
resource type, followed by `:` and the appropriate path and template name.
|
||||
|
||||
If a resource is not explicitly given, the default resource type is assumed.
|
||||
The resource type for the filesystem is `file`, which means that the previous example
|
||||
can be rewritten as follows:
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->display('file:homepage.tpl');
|
||||
```
|
||||
|
||||
The file resource pulls templates source files from the directories
|
||||
specified using `Smarty::setTemplateDir()` (see [Configuring Smarty](configuring.md)).
|
||||
|
||||
`setTemplateDir` accepts a single path, but can also ben called with an array of paths.
|
||||
In that case, the list of directories is traversed in the order they appear in the array. The
|
||||
first template found is the one to process.
|
||||
|
||||
### Templates from a specific directory
|
||||
|
||||
Smarty 3.1 introduced the bracket-syntax for specifying an element from
|
||||
`Smarty::setTemplateDir()`. This allows websites
|
||||
employing multiple sets of templates better control over which template
|
||||
to access.
|
||||
|
||||
The bracket-syntax can be used as follows:
|
||||
```php
|
||||
<?php
|
||||
|
||||
// setup template directories
|
||||
$smarty->setTemplateDir([
|
||||
'./templates', // element: 0, index: 0
|
||||
'./templates_2', // element: 1, index: 1
|
||||
'10' => 'templates_10', // element: 2, index: '10'
|
||||
'foo' => 'templates_foo', // element: 3, index: 'foo'
|
||||
]);
|
||||
|
||||
/*
|
||||
assume the template structure
|
||||
./templates/foo.tpl
|
||||
./templates_2/foo.tpl
|
||||
./templates_2/bar.tpl
|
||||
./templates_10/foo.tpl
|
||||
./templates_10/bar.tpl
|
||||
./templates_foo/foo.tpl
|
||||
*/
|
||||
|
||||
// regular access
|
||||
$smarty->display('file:foo.tpl');
|
||||
// will load ./templates/foo.tpl
|
||||
|
||||
// using numeric index
|
||||
$smarty->display('file:[1]foo.tpl');
|
||||
// will load ./templates_2/foo.tpl
|
||||
|
||||
// using numeric string index
|
||||
$smarty->display('file:[10]foo.tpl');
|
||||
// will load ./templates_10/foo.tpl
|
||||
|
||||
// using string index
|
||||
$smarty->display('file:[foo]foo.tpl');
|
||||
// will load ./templates_foo/foo.tpl
|
||||
|
||||
// using "unknown" numeric index (using element number)
|
||||
$smarty->display('file:[2]foo.tpl');
|
||||
// will load ./templates_10/foo.tpl
|
||||
```
|
||||
|
||||
And, from within a Smarty template:
|
||||
|
||||
```smarty
|
||||
{include file="file:foo.tpl"}
|
||||
{* will load ./templates/foo.tpl *}
|
||||
|
||||
{include file="file:[1]foo.tpl"}
|
||||
{* will load ./templates_2/foo.tpl *}
|
||||
|
||||
{include file="file:[foo]foo.tpl"}
|
||||
{* will load ./templates_foo/foo.tpl *}
|
||||
```
|
||||
|
||||
### Using absolute paths
|
||||
|
||||
Templates outside the specified template directories
|
||||
require the `file:` template resource type, followed by the absolute
|
||||
path to the template (with leading slash).
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->display('file:/export/templates/index.tpl');
|
||||
$smarty->display('file:/path/to/my/templates/menu.tpl');
|
||||
````
|
||||
|
||||
And from within a Smarty template:
|
||||
```smarty
|
||||
{include file='file:/usr/local/share/templates/navigation.tpl'}
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> With [`Security`](security.md) enabled, access to
|
||||
> templates outside of the specified templates directories is
|
||||
> not allowed unless you whitelist those directories.
|
||||
|
||||
### Windows file paths
|
||||
If you are running on Windows, file paths usually include a drive
|
||||
letter (such as `C:`) at the beginning of the pathname. Be sure to use `file:` in
|
||||
the path to avoid namespace conflicts and get the desired results.
|
||||
```php
|
||||
<?php
|
||||
$smarty->display('file:C:/export/templates/index.tpl');
|
||||
$smarty->display('file:F:/path/to/my/templates/menu.tpl');
|
||||
```
|
||||
|
||||
And from within Smarty template:
|
||||
```smarty
|
||||
{include file='file:D:/usr/local/share/templates/navigation.tpl'}
|
||||
```
|
||||
|
||||
### Handling missing templates
|
||||
If the file resource cannot find the requested template, it will check if there is
|
||||
a default template handler to call. By default, there is none, and Smarty will return an error,
|
||||
but you can register a default template handler calling `Smarty::registerDefaultTemplateHandler`
|
||||
with any [callable](https://www.php.net/manual/en/language.types.callable.php).
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$smarty->registerDefaultTemplateHandler([$this, 'handleMissingTemplate']);
|
||||
|
||||
// ...
|
||||
|
||||
public function handleMissingTemplate($type, $name, &$content, &$modified, Smarty $smarty) {
|
||||
if (/* ... */) {
|
||||
// return corrected filepath
|
||||
return "/tmp/some/foobar.tpl";
|
||||
} elseif (/* ... */) {
|
||||
// return a template directly
|
||||
$content = "the template source";
|
||||
$modified = time();
|
||||
return true;
|
||||
} else {
|
||||
// tell smarty that we failed
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## The string and eval resources
|
||||
|
||||
Smarty can render templates from a string by using the `string:` or
|
||||
`eval:` resource.
|
||||
|
||||
- The `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.
|
||||
|
||||
- The `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.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> With a `string:` resource type, each unique string generates a
|
||||
> compiled file. Smarty cannot detect a string that has changed, and
|
||||
> therefore will generate a new compiled file for each unique string. It
|
||||
> is important to choose the correct resource so that you do not fill
|
||||
> your disk space with wasted compiled strings.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('foo', 'value');
|
||||
$template_string = 'display {$foo} here';
|
||||
$smarty->display('string:' . $template_string); // compiles for later reuse
|
||||
$smarty->display('eval:' . $template_string); // compiles every time
|
||||
```
|
||||
From within a Smarty template:
|
||||
```smarty
|
||||
{include file="string:$template_string"} {* compiles for later reuse *}
|
||||
{include file="eval:$template_string"} {* compiles every time *}
|
||||
```
|
||||
|
||||
Both `string:` and `eval:` resources may be encoded with
|
||||
[`urlencode()`](https://www.php.net/urlencode) or
|
||||
[`base64_encode()`](https://www.php.net/urlencode). This is not necessary
|
||||
for the usual use of `string:` and `eval:`, but is required when using
|
||||
either of them in conjunction with the [`extends resource`](#the-extends-resource).
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('foo','value');
|
||||
$template_string_urlencode = urlencode('display {$foo} here');
|
||||
$template_string_base64 = base64_encode('display {$foo} here');
|
||||
$smarty->display('eval:urlencode:' . $template_string_urlencode); // will decode string using urldecode()
|
||||
$smarty->display('eval:base64:' . $template_string_base64); // will decode string using base64_decode()
|
||||
```
|
||||
|
||||
From within a Smarty template:
|
||||
```smarty
|
||||
{include file="string:urlencode:$template_string_urlencode"} {* will decode string using urldecode() *}
|
||||
{include file="eval:base64:$template_string_base64"} {* will decode string using base64_decode() *}
|
||||
```
|
||||
|
||||
## The extends resource
|
||||
|
||||
The `extends:` resource is used to define child/parent relationships. For details see section of
|
||||
[Template inheritance](inheritance.md).
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Using the extends resource is usually not necessary. If you have a choice, it is normally more flexible and
|
||||
> intuitive to handle inheritance chains from within the templates using the [{extends} tag](inheritance.md).
|
||||
|
||||
When `string:` and `eval:` templates are used, make sure they are properly url or base64 encoded.
|
||||
|
||||
The templates within an inheritance chain are not compiled separately. Only a single compiled template will be generated.
|
||||
(If an `eval:` resource is found within an inheritance chain, its "don't save a compile file" property is superseded by
|
||||
the `extends:` resource.)
|
||||
|
||||
Example:
|
||||
```php
|
||||
<?php
|
||||
$smarty->display('extends:parent.tpl|child.tpl|grandchild.tpl');
|
||||
|
||||
// inheritance from multiple template sources
|
||||
$smarty->display('extends:db:parent.tpl|file:child.tpl|grandchild.tpl|eval:{block name="fooBazVar_"}hello world{/block}');
|
||||
```
|
||||
|
||||
## The stream resource
|
||||
|
||||
Smarty allow you to use [PHP streams](https://www.php.net/manual/en/function.stream-wrapper-register.php)
|
||||
as a template resource. 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.
|
||||
|
||||
For example,
|
||||
```php
|
||||
<?php
|
||||
stream_wrapper_register('myresource', MyResourceStream::class);
|
||||
$smarty->display('myresource:bar.tpl');
|
||||
```
|
||||
|
||||
Or, from within a template:
|
||||
```smarty
|
||||
{include file="myresource:bar.tpl"}
|
||||
```
|
||||
|
||||
## Adding your own resource type
|
||||
You can create a class that extends `Smarty\Resource\CustomPlugin` to add your own resource type,
|
||||
for example to load template from a database.
|
||||
|
||||
For example:
|
||||
```php
|
||||
<?php
|
||||
class HelloWorldResource extends Smarty\Resource\CustomPlugin {
|
||||
|
||||
protected function fetch($name, &$source, &$mtime) {
|
||||
$source = '{$x="hello world"}{$x}'; // load your template here based on $name
|
||||
$mtime = time();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// ..
|
||||
|
||||
$smarty->registerResource('helloworld', new HelloWorldResource());
|
||||
```
|
||||
|
||||
If a Resource's templates should not be run through the Smarty
|
||||
compiler, the Custom Resource may extend `\Smarty\Resource\UncompiledPlugin`.
|
||||
The Resource Handler must then implement the function
|
||||
`renderUncompiled(\Smarty\Template $_template)`. `$_template` is
|
||||
a reference to the current template and contains all assigned variables
|
||||
which the implementor can access via
|
||||
`$_template->getSmarty()->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
|
||||
`src/Resource/PhpPlugin.php` for an example.
|
||||
|
||||
If the Resource's compiled templates should not be cached on disk, the
|
||||
Custom Resource may extend `\Smarty\Resource\RecompiledPlugin`. These Resources
|
||||
are compiled every time they are accessed. This may be an expensive
|
||||
overhead. See `src/Resource/StringEval.php` for an
|
||||
example.
|
||||
|
||||
## Changing the default resource type
|
||||
The default resource type is `file`. If you want to change it, use `Smarty::setDefaultResourceType`.
|
||||
|
||||
The following example will change the default resource type to `mysql`:
|
||||
```php
|
||||
<?php
|
||||
$smarty->setDefaultResourceType('mysql');
|
||||
```
|
||||
@@ -1,119 +0,0 @@
|
||||
# Security
|
||||
|
||||
Security is good for situations when you have untrusted parties editing
|
||||
the templates, and you want to reduce the risk of system
|
||||
security compromises through the template language.
|
||||
|
||||
The settings of the security policy are defined by overriding public properties of an
|
||||
instance of the \Smarty\Security class. These are the possible settings:
|
||||
|
||||
- `$secure_dir` is an array of template directories that are
|
||||
considered secure. A directory configured using `$smarty->setTemplateDir()` is
|
||||
considered secure implicitly. The default is an empty array.
|
||||
- `$trusted_uri` is an array of regular expressions matching URIs that
|
||||
are considered trusted. This security directive is used by
|
||||
[`{fetch}`](../designers/language-custom-functions/language-function-fetch.md) and
|
||||
[`{html_image}`](../designers/language-custom-functions/language-function-html-image.md). 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).
|
||||
|
||||
The expression `'#https?://.*smarty.net$#i'` would allow accessing
|
||||
the following URIs:
|
||||
|
||||
- `http://smarty.net/foo`
|
||||
- `http://smarty.net/foo`
|
||||
- `http://www.smarty.net/foo`
|
||||
- `http://smarty.net/foo`
|
||||
- `https://foo.bar.www.smarty.net/foo/bla?blubb=1`
|
||||
|
||||
but deny access to these URIs:
|
||||
|
||||
- `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.
|
||||
|
||||
- `$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 = [] ) 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".
|
||||
|
||||
If security is enabled, no private methods, functions or properties of
|
||||
static classes or assigned objects can be accessed (beginning with
|
||||
'_') by the template.
|
||||
|
||||
To customize the security policy settings you can extend the
|
||||
\Smarty\Security class or create an instance of it.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
|
||||
class My_Security_Policy extends \Smarty\Security {
|
||||
public $allow_constants = false;
|
||||
}
|
||||
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->enableSecurity('My_Security_Policy');
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
|
||||
$smarty = new Smarty();
|
||||
|
||||
$my_security_policy = new \Smarty\Security($smarty);
|
||||
$my_security_policy->allow_constants = false;
|
||||
|
||||
$smarty->enableSecurity($my_security_policy);
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
|
||||
$smarty = new Smarty();
|
||||
|
||||
// enable default security
|
||||
$smarty->enableSecurity();
|
||||
```
|
||||
|
||||
> **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.
|
||||
@@ -1,139 +0,0 @@
|
||||
# Assigning variables
|
||||
|
||||
Templates start to become really useful once you know how to use variables.
|
||||
|
||||
## Basic assigning
|
||||
Let's revisit the example from the [basics section](../basics.md). The following script assigns a value to
|
||||
the 'companyName' variable and renders the template:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$smarty->assign('companyName', 'AC & ME Corp.');
|
||||
|
||||
$smarty->display('footer.tpl');
|
||||
```
|
||||
|
||||
footer.tpl:
|
||||
```smarty
|
||||
<small>Copyright {$companyName|escape}</small>
|
||||
```
|
||||
|
||||
Smarty will apply the [escape modifier](../../designers/language-modifiers/language-modifier-escape.md)
|
||||
to the value assigned to the variable
|
||||
`companyName` and replace `{$companyName|escape}` with the result.
|
||||
|
||||
```html
|
||||
<small>Copyright AC & ME Corp.</small>
|
||||
```
|
||||
|
||||
Using `$smarty->assign()` is the most common way of assigning data to templates, but there are several other methods.
|
||||
|
||||
## Appending data to an existing variable
|
||||
Using `append()`, you can add data to an existing variable, usually an array.
|
||||
|
||||
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.
|
||||
|
||||
Examples:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// This is effectively the same as assign()
|
||||
$smarty->append('foo', 'Fred');
|
||||
// After this line, foo will now be seen as an array in the template
|
||||
$smarty->append('foo', 'Albert');
|
||||
|
||||
$array = [1 => 'one', 2 => 'two'];
|
||||
$smarty->append('X', $array);
|
||||
$array2 = [3 => 'three', 4 => 'four'];
|
||||
// The following line will add a second element to the X array
|
||||
$smarty->append('X', $array2);
|
||||
|
||||
// passing an associative array
|
||||
$smarty->append(['city' => 'Lincoln', 'state' => 'Nebraska']);
|
||||
```
|
||||
|
||||
## Assigning to template objects
|
||||
When you use a template objects, as explained in [rendering a template](../rendering.md#creating-a-template-object),
|
||||
you can assign data to the template objects directly instead of assigning it to Smarty. This way, you can use different
|
||||
sets of data for different templates.
|
||||
|
||||
For example:
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty();
|
||||
|
||||
$tplBlue = $smarty->createTemplate('blue.tpl');
|
||||
$tplBlue->assign('name', 'The one');
|
||||
$tplBlue->display();
|
||||
|
||||
$tplRed = $smarty->createTemplate('red.tpl');
|
||||
$tplRed->assign('name', 'Neo');
|
||||
$tplRed->display();
|
||||
```
|
||||
|
||||
## Using data objects
|
||||
For more complex use cases, Smarty supports the concept of data objects.
|
||||
Data objects are containers to hold data. Data objects can be attached to templates when creating them.
|
||||
This allows for fine-grained re-use of data.
|
||||
|
||||
For example:
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
$smarty = new Smarty;
|
||||
|
||||
// create a data object
|
||||
$data = $smarty->createData();
|
||||
|
||||
// assign variable to the data object
|
||||
$data->assign('name', 'Neo');
|
||||
|
||||
// create template object which will use variables from the data object
|
||||
$tpl = $smarty->createTemplate('index.tpl', $data);
|
||||
|
||||
// display the template
|
||||
$tpl->display();
|
||||
```
|
||||
|
||||
## Clearing assigned data
|
||||
When re-using templates, you may need to clear data assigned in a previous run. Use `clearAllAssign()` to
|
||||
clear the values of all assigned variables on data objects, template objects or the Smarty object.
|
||||
|
||||
Examples:
|
||||
```php
|
||||
<?php
|
||||
// assigning data to the Smarty object
|
||||
$smarty->assign('Name', 'Fred');
|
||||
// ...
|
||||
$smarty->clearAllAssign();
|
||||
|
||||
// using a data object
|
||||
$data = $smarty->createData();
|
||||
$data->assign('name', 'Neo');
|
||||
// ...
|
||||
$data->clearAllAssign();
|
||||
|
||||
// using a template
|
||||
$tplBlue = $smarty->createTemplate('blue.tpl');
|
||||
$tplBlue->assign('name', 'The one');
|
||||
// ...
|
||||
$tplBlue->clearAllAssign();
|
||||
```
|
||||
|
||||
Note that there it's only useful to clear assigned data if you:
|
||||
|
||||
1. repeatedly re-use templates, and
|
||||
2. the variables used may change on each repetition
|
||||
|
||||
If your script simply runs once and then ends, or you always assign the same variables, clearing assigned data
|
||||
is of no use.
|
||||
@@ -1,88 +0,0 @@
|
||||
# Loading data from config files
|
||||
|
||||
Instead of [assigning data to templates from PHP](assigning.md), you can also
|
||||
use a config file.
|
||||
|
||||
## Example config file
|
||||
Config files are best suited to manage template settings
|
||||
from one file. One example is a multi-language application.
|
||||
Instead of writing multiple templates to support different languages,
|
||||
you can write a single template file and load your language dependent strings
|
||||
from config files.
|
||||
|
||||
Example `lang.en.ini`:
|
||||
```ini
|
||||
# global variables
|
||||
pageTitle = "Main Menu"
|
||||
|
||||
[Customer]
|
||||
pageTitle = "Customer Info"
|
||||
|
||||
[Login]
|
||||
pageTitle = "Login"
|
||||
focus = "username"
|
||||
Intro = """This is a value that spans more
|
||||
than one line. you must enclose
|
||||
it in triple quotes."""
|
||||
|
||||
```
|
||||
|
||||
Values of [config file variables](../../designers/language-variables/language-config-variables.md) can be in
|
||||
quotes, but not necessary. You can use either single or double quotes.
|
||||
If you have a value that spans more than one line, enclose the entire
|
||||
value with triple quotes \("""\). You can put comments into config
|
||||
files by any syntax that is not a valid config file syntax. We recommend
|
||||
using a `#` (hash) at the beginning of the line.
|
||||
|
||||
The example config file above has two sections. Section names are
|
||||
enclosed in \[brackets\]. Section names can be arbitrary strings not
|
||||
containing `[` or `]` symbols. The variable at the top is a global
|
||||
variable. Global 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.
|
||||
|
||||
## Loading a config file
|
||||
|
||||
Config files are loaded into templates with the built-in template
|
||||
function [`{config_load}`](../../designers/language-builtin-functions/language-function-config-load.md) or by calling
|
||||
`configLoad()` from PHP:
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->configLoad('lang.en.ini');
|
||||
```
|
||||
|
||||
Load a specific section with:
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->configLoad('lang.en.ini', 'Customer');
|
||||
```
|
||||
|
||||
Note that the global section will always be loaded.
|
||||
|
||||
## Retrieving config variables in PHP
|
||||
|
||||
|
||||
## Loading from a resource
|
||||
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 [resources](../resources.md)
|
||||
for more information.
|
||||
|
||||
## Config overwrite
|
||||
If you name two variables the same within a section,
|
||||
the last one will be used unless you call:
|
||||
```php
|
||||
<?php
|
||||
$smarty->setConfigOverwrite(false);
|
||||
```
|
||||
When config overwrite is disabled, Smarty will create arrays of config file variables when it encounters
|
||||
multiple entries with the same name.
|
||||
|
||||
See also [`{config_load}`](../../designers/language-builtin-functions/language-function-config-load.md),
|
||||
[`$default_config_handler_func`](../../programmers/api-variables/variable-default-config-handler-func.md),
|
||||
[`getConfigVars()`](../../programmers/api-functions/api-get-config-vars.md),
|
||||
[`clearConfig()`](../../programmers/api-functions/api-clear-config.md) and
|
||||
[`configLoad()`](../../programmers/api-functions/api-config-load.md)
|
||||
@@ -1,106 +0,0 @@
|
||||
# Objects
|
||||
|
||||
Smarty allows access to PHP [objects](https://www.php.net/object) 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.
|
||||
|
||||
## Assign the object
|
||||
You can assign objects to a template and access them much like any other assigned variable.
|
||||
|
||||
Example:
|
||||
```php
|
||||
<?php
|
||||
// the object
|
||||
|
||||
class My_Object {
|
||||
public function meth1($params, $smarty_obj) {
|
||||
return 'this is my meth1';
|
||||
}
|
||||
}
|
||||
|
||||
// We can also assign objects. assign_by_ref when possible.
|
||||
$smarty->assign('myobj', new My_Object());
|
||||
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
And here's how to access your object in `index.tpl`:
|
||||
|
||||
```smarty
|
||||
{$myobj->meth1('foo',$bar)}
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Register the object
|
||||
Registerd objects use a different template syntax. Also, 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.
|
||||
|
||||
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 tags](../../designers/language-custom-functions/index.md) get
|
||||
them. An associative array is passed as the first parameter, and the
|
||||
smarty object as the second. If you want the parameters passed one at a
|
||||
time for each argument like traditional object parameter passing, set
|
||||
the fourth registration parameter to FALSE.
|
||||
|
||||
The optional fifth parameter has only effect with `format` being TRUE
|
||||
and contains a list of methods that should be treated as blocks. That
|
||||
means these methods have a closing tag in the template
|
||||
(`{foobar->meth2}...{/foobar->meth2}`) and the parameters to the methods
|
||||
have the same synopsis as the parameters for
|
||||
[`block tags`](../extending/block-tags.md): They get the four
|
||||
parameters `$params`, `$content`, `$smarty` and `&$repeat` and they also
|
||||
behave like block tags.
|
||||
|
||||
```php
|
||||
<?php
|
||||
// the object
|
||||
|
||||
class My_Object {
|
||||
function meth1($params, $smarty_obj) {
|
||||
return 'this is my meth1';
|
||||
}
|
||||
}
|
||||
|
||||
$myobj = new My_Object;
|
||||
|
||||
// registering the object
|
||||
$smarty->registerObject('foobar', $myobj);
|
||||
|
||||
// if we want to restrict access to certain methods or properties, list them
|
||||
$smarty->registerObject('foobar', $myobj, array('meth1','meth2','prop1'));
|
||||
|
||||
// if you want to use the traditional object parameter format, pass a boolean of false
|
||||
$smarty->registerObject('foobar', $myobj, null, false);
|
||||
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
And here's how to access your objects in `index.tpl`:
|
||||
|
||||
```smarty
|
||||
{* access our registered object *}
|
||||
{foobar->meth1 p1='foo' p2=$bar}
|
||||
|
||||
{* you can also assign the output *}
|
||||
{foobar->meth1 p1='foo' p2=$bar assign='output'}
|
||||
the output was {$output}
|
||||
```
|
||||
@@ -1,39 +0,0 @@
|
||||
# Static Classes
|
||||
|
||||
You can directly access static classes. The syntax is roughly 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.
|
||||
|
||||
## Examples
|
||||
|
||||
**class constant BAR**
|
||||
```smarty
|
||||
{assign var=foo value=myclass::BAR}
|
||||
```
|
||||
|
||||
**method result**
|
||||
```smarty
|
||||
{assign var=foo value=myclass::method()}
|
||||
```
|
||||
|
||||
**method chaining**
|
||||
```smarty
|
||||
{assign var=foo value=myclass::method1()->method2}
|
||||
```
|
||||
|
||||
**property bar of class myclass**
|
||||
```smarty
|
||||
{assign var=foo value=myclass::$bar}
|
||||
```
|
||||
|
||||
**using Smarty variable bar as class name**
|
||||
```smarty
|
||||
{assign var=foo value=$bar::method}
|
||||
```
|
||||
@@ -1,16 +0,0 @@
|
||||
# Streams
|
||||
|
||||
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.
|
||||
|
||||
```smarty
|
||||
{$foo:bar}
|
||||
```
|
||||
|
||||
NB. Support for using streams to call variables is deprecated since Smarty v5.1 and will be removed
|
||||
in a future version.
|
||||
|
||||
See also [`Template Resources`](../resources.md)
|
||||
@@ -1,273 +0,0 @@
|
||||
# Tips & Tricks
|
||||
|
||||
## Blank Variable Handling
|
||||
|
||||
There may be times when you want to print a default value for an empty
|
||||
variable instead of printing nothing, such as printing ` ` so that
|
||||
html table backgrounds work properly. Many would use an
|
||||
[`{if}`](../designers/language-builtin-functions/language-function-if.md) statement to handle this, but there is a
|
||||
shorthand way with Smarty, using the
|
||||
[`default`](../designers/language-modifiers/language-modifier-default.md) variable modifier.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> "Undefined variable" errors will show an E\_NOTICE if not disabled in
|
||||
> PHP's [`error_reporting()`](https://www.php.net/error_reporting) level or
|
||||
> Smarty's [`$error_reporting`](../programmers/api-variables/variable-error-reporting.md) property and
|
||||
> a variable had not been assigned to Smarty.
|
||||
|
||||
```smarty
|
||||
|
||||
{* the long way *}
|
||||
{if $title eq ''}
|
||||
|
||||
{else}
|
||||
{$title}
|
||||
{/if}
|
||||
|
||||
{* the short way *}
|
||||
{$title|default:' '}
|
||||
|
||||
```
|
||||
|
||||
See also [`default`](../designers/language-modifiers/language-modifier-default.md) modifier and [default
|
||||
variable handling](#default-variable-handling).
|
||||
|
||||
## Default Variable Handling
|
||||
|
||||
If a variable is used frequently throughout your templates, applying the
|
||||
[`default`](../designers/language-modifiers/language-modifier-default.md) 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}`](../designers/language-builtin-functions/language-function-assign.md) function.
|
||||
|
||||
|
||||
{* do this somewhere at the top of your template *}
|
||||
{assign var='title' value=$title|default:'no title'}
|
||||
|
||||
{* if $title was empty, it now contains the value "no title" when you use it *}
|
||||
{$title}
|
||||
|
||||
|
||||
|
||||
See also [`default`](../designers/language-modifiers/language-modifier-default.md) modifier and [blank
|
||||
variable handling](#blank-variable-handling).
|
||||
|
||||
## Passing variable title to header template
|
||||
|
||||
When the majority of your templates use the same headers and footers, it
|
||||
is common to split those out into their own templates and
|
||||
[`{include}`](../designers/language-builtin-functions/language-function-include.md) 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](../designers/language-basic-syntax/language-syntax-attributes.md) 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.
|
||||
|
||||
```smarty
|
||||
|
||||
{include file='header.tpl' title='Main Page'}
|
||||
{* template body goes here *}
|
||||
{include file='footer.tpl'}
|
||||
|
||||
```
|
||||
|
||||
`archives.tpl` - When the archives page is drawn, the title will be
|
||||
"Archives". Notice in the archive example, we are using a variable from
|
||||
the `archives_page.conf` file instead of a hard coded variable.
|
||||
|
||||
```smarty
|
||||
|
||||
{config_load file='archive_page.conf'}
|
||||
|
||||
{include file='header.tpl' title=#archivePageTitle#}
|
||||
{* template body goes here *}
|
||||
{include file='footer.tpl'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
`header.tpl` - Notice that "Smarty News" is printed if the `$title`
|
||||
variable is not set, using the [`default`](../designers/language-modifiers/language-modifier-default.md)
|
||||
variable modifier.
|
||||
|
||||
```smarty
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>{$title|default:'Smarty News'}</title>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
```
|
||||
|
||||
|
||||
`footer.tpl`
|
||||
|
||||
```smarty
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
```
|
||||
|
||||
|
||||
## Dates
|
||||
|
||||
As a rule of thumb, always pass dates to Smarty as
|
||||
[timestamps](https://www.php.net/time). This allows template designers to
|
||||
use the [`date_format`](../designers/language-modifiers/language-modifier-date-format.md) modifier for
|
||||
full control over date formatting, and also makes it easy to compare
|
||||
dates if necessary.
|
||||
|
||||
```smarty
|
||||
{$startDate|date_format}
|
||||
```
|
||||
|
||||
|
||||
This will output:
|
||||
|
||||
```
|
||||
Jan 4, 2009
|
||||
```
|
||||
|
||||
```smarty
|
||||
|
||||
{$startDate|date_format:"%Y/%m/%d"}
|
||||
|
||||
```
|
||||
|
||||
|
||||
This will output:
|
||||
|
||||
```
|
||||
2009/01/04
|
||||
```
|
||||
|
||||
Dates can be compared in the template by timestamps with:
|
||||
|
||||
```smarty
|
||||
|
||||
{if $order_date < $invoice_date}
|
||||
...do something..
|
||||
{/if}
|
||||
|
||||
```
|
||||
|
||||
When using [`{html_select_date}`](../designers/language-custom-functions/language-function-html-select-date.md)
|
||||
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
|
||||
|
||||
<?php
|
||||
|
||||
// this assumes your form elements are named
|
||||
// startDate_Day, startDate_Month, startDate_Year
|
||||
|
||||
$startDate = makeTimeStamp($startDate_Year, $startDate_Month, $startDate_Day);
|
||||
|
||||
function makeTimeStamp($year='', $month='', $day='')
|
||||
{
|
||||
if(empty($year)) {
|
||||
$year = strftime('%Y');
|
||||
}
|
||||
if(empty($month)) {
|
||||
$month = strftime('%m');
|
||||
}
|
||||
if(empty($day)) {
|
||||
$day = strftime('%d');
|
||||
}
|
||||
|
||||
return mktime(0, 0, 0, $month, $day, $year);
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
See also [`{html_select_date}`](../designers/language-custom-functions/language-function-html-select-date.md),
|
||||
[`{html_select_time}`](../designers/language-custom-functions/language-function-html-select-time.md),
|
||||
[`date_format`](../designers/language-modifiers/language-modifier-date-format.md) and
|
||||
[`$smarty.now`](../designers/language-variables/language-variables-smarty.md#smarty-now),
|
||||
|
||||
## Componentized Templates
|
||||
|
||||
Traditionally, programming templates into your applications goes as
|
||||
follows: First, you accumulate your variables within your PHP
|
||||
application, (maybe with database queries.) Then, you instantiate your
|
||||
Smarty object, [`assign()`](../programmers/api-functions/api-assign.md) the variables and
|
||||
[`display()`](../programmers/api-functions/api-display.md) the template. So lets say for example we
|
||||
have a stock ticker on our template. We would collect the stock data in
|
||||
our application, then assign these variables in the template and display
|
||||
it. Now wouldn't it be nice if you could add this stock ticker to any
|
||||
application by merely including the template, and not worry about
|
||||
fetching the data up front?
|
||||
|
||||
You can do this by writing a custom plugin for fetching the content and
|
||||
assigning it to a template variable.
|
||||
|
||||
`function.load_ticker.php`
|
||||
|
||||
```php
|
||||
|
||||
<?php
|
||||
|
||||
// setup our function for fetching stock data
|
||||
function fetch_ticker($symbol)
|
||||
{
|
||||
// put logic here that fetches $ticker_info
|
||||
// from some ticker resource
|
||||
return $ticker_info;
|
||||
}
|
||||
|
||||
function smarty_function_load_ticker($params, $smarty)
|
||||
{
|
||||
// call the function
|
||||
$ticker_info = fetch_ticker($params['symbol']);
|
||||
|
||||
// assign template variable
|
||||
$smarty->assign($params['assign'], $ticker_info);
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
`index.tpl`
|
||||
|
||||
```smarty
|
||||
|
||||
{load_ticker symbol='SMARTY' assign='ticker'}
|
||||
|
||||
Stock Name: {$ticker.name} Stock Price: {$ticker.price}
|
||||
|
||||
```
|
||||
|
||||
See also: [`{include}`](../designers/language-builtin-functions/language-function-include.md).
|
||||
|
||||
## Obfuscating E-mail Addresses
|
||||
|
||||
Do you ever wonder how your email address gets on so many spam mailing
|
||||
lists? One way spammers collect email addresses is from web pages. To
|
||||
help combat this problem, you can make your email address show up in
|
||||
scrambled javascript in the HTML source, yet it it will look and work
|
||||
correctly in the browser. This is done with the
|
||||
[`{mailto}`](../designers/language-custom-functions/language-function-mailto.md) plugin.
|
||||
|
||||
```smarty
|
||||
|
||||
<div id="contact">Send inquiries to
|
||||
{mailto address=$EmailAddress encode='javascript' subject='Hello'}
|
||||
</div>
|
||||
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> This method isn\'t 100% foolproof. A spammer could conceivably program
|
||||
> his e-mail collector to decode these values, but not likely\....
|
||||
> hopefully..yet \... wheres that quantum computer :-?.
|
||||
|
||||
See also [`escape`](../designers/language-modifiers/language-modifier-escape.md) modifier and
|
||||
[`{mailto}`](../designers/language-custom-functions/language-function-mailto.md).
|
||||
@@ -1,104 +0,0 @@
|
||||
# Troubleshooting
|
||||
|
||||
## Smarty/PHP errors
|
||||
|
||||
Smarty can catch many errors such as missing tag attributes or malformed
|
||||
variable names. If this happens, you will see an error similar to the
|
||||
following:
|
||||
|
||||
```
|
||||
Warning: Smarty: [in index.tpl line 4]: syntax error: unknown tag - '%blah'
|
||||
in /path/to/smarty/Smarty.class.php on line 1041
|
||||
|
||||
Fatal error: Smarty: [in index.tpl line 28]: syntax error: missing section name
|
||||
in /path/to/smarty/Smarty.class.php on line 1041
|
||||
```
|
||||
|
||||
|
||||
Smarty shows you the template name, the line number and the error. After
|
||||
that, the error consists of the actual line number in the Smarty class
|
||||
that the error occurred.
|
||||
|
||||
There are certain errors that Smarty cannot catch, such as missing close
|
||||
tags. These types of errors usually end up in PHP compile-time parsing
|
||||
errors.
|
||||
|
||||
`Parse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75`
|
||||
|
||||
When you encounter a PHP parsing error, the error line number will
|
||||
correspond to the compiled PHP script, NOT the template itself. Usually
|
||||
you can look at the template and spot the syntax error. Here are some
|
||||
common things to look for: missing close tags for
|
||||
[`{if}{/if}`](../designers/language-builtin-functions/language-function-if.md) or
|
||||
[`{section}{/section}`](../designers/language-builtin-functions/language-function-section.md),
|
||||
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...
|
||||
```
|
||||
or
|
||||
```
|
||||
Warning: Smarty error: unable to read resource: "site.conf" in...
|
||||
```
|
||||
|
||||
- The [`$template_dir`](../programmers/api-variables/variable-template-dir.md) is incorrect, doesn't
|
||||
exist or the file `index.tpl` is not in the `templates/` directory
|
||||
|
||||
- A [`{config_load}`](../designers/language-builtin-functions/language-function-config-load.md) function is
|
||||
within a template (or [`configLoad()`](../programmers/api-functions/api-config-load.md) has been
|
||||
called) and either [`$config_dir`](../programmers/api-variables/variable-config-dir.md) 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,
|
||||
or is not a directory...
|
||||
```
|
||||
|
||||
- Either the [`$compile_dir`](../programmers/api-variables/variable-compile-dir.md)is 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 '....
|
||||
```
|
||||
|
||||
|
||||
- The [`$compile_dir`](../programmers/api-variables/variable-compile-dir.md) is not writable by the
|
||||
web server. See the bottom of the [installing
|
||||
smarty](../getting-started.md#installation) page for more about permissions.
|
||||
|
||||
```
|
||||
Fatal error: Smarty error: the $cache_dir 'cache' does not exist,
|
||||
or is not a directory. in /..
|
||||
```
|
||||
|
||||
- This means that [`$caching`](../programmers/api-variables/variable-caching.md) is enabled and
|
||||
either; the [`$cache_dir`](../programmers/api-variables/variable-cache-dir.md) 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 '/...
|
||||
```
|
||||
|
||||
- This means that [`$caching`](../programmers/api-variables/variable-caching.md) is enabled and the
|
||||
[`$cache_dir`](../programmers/api-variables/variable-cache-dir.md) is not writable by the web
|
||||
server. See the bottom of the [installing
|
||||
smarty](../getting-started.md#installation) page for permissions.
|
||||
|
||||
```
|
||||
Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php
|
||||
in /path/to/smarty/libs/sysplugins/smarty_resource.php
|
||||
```
|
||||
|
||||
- This means that your application registered a custom error handler
|
||||
(using [set_error_handler()](https://www.php.net/set_error_handler))
|
||||
which is not respecting the given `$errno` as it should. If, for
|
||||
whatever reason, this is the desired behaviour of your custom error
|
||||
handler, please call
|
||||
[`muteExpectedErrors()`](../programmers/api-functions/api-mute-expected-errors.md) after you've
|
||||
registered your custom error handler.
|
||||
|
||||
See also [debugging](../designers/chapter-debugging-console.md).
|
||||
@@ -1,39 +0,0 @@
|
||||
# Debugging Console
|
||||
|
||||
There is a debugging console included with Smarty. The console informs
|
||||
you of all the [included](./language-builtin-functions/language-function-include.md) templates,
|
||||
[assigned](../programmers/api-functions/api-assign.md) variables and
|
||||
[config](./language-variables/language-config-variables.md) file variables for the current
|
||||
invocation of the template. A template file named `debug.tpl` is
|
||||
included with the distribution of Smarty which controls the formatting
|
||||
of the console.
|
||||
|
||||
Set [`$debugging`](../programmers/api-variables/variable-debugging.md) to TRUE in Smarty, and if needed
|
||||
set [`$debug_tpl`](../programmers/api-variables/variable-debug-template.md) to the template resource
|
||||
path to `debug.tpl`. When you load the page, a Javascript console window will pop
|
||||
up and give you the names of all the included templates and assigned
|
||||
variables for the current page.
|
||||
|
||||
To see the available variables for a particular template, see the
|
||||
[`{debug}`](./language-builtin-functions/language-function-debug.md) template function. To disable the
|
||||
debugging console, set [`$debugging`](../programmers/api-variables/variable-debugging.md) to FALSE. You
|
||||
can also temporarily turn on the debugging console by putting
|
||||
`SMARTY_DEBUG` in the URL if you enable this option with
|
||||
[`$debugging_ctrl`](../programmers/api-variables/variable-debugging-ctrl.md).
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The debugging console does not work when you use the
|
||||
> [`fetch()`](../programmers/api-functions/api-fetch.md) API, only when using
|
||||
> [`display()`](../programmers/api-functions/api-display.md). It is a set of javascript statements
|
||||
> added to the very bottom of the generated template. If you do not like
|
||||
> javascript, you can edit the `debug.tpl` template to format the output
|
||||
> however you like. Debug data is not cached and `debug.tpl` info is not
|
||||
> included in the output of the debug console.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The load times of each template and config file are in seconds, or
|
||||
> fractions thereof.
|
||||
|
||||
See also [troubleshooting](../appendixes/troubleshooting.md).
|
||||
@@ -1,74 +0,0 @@
|
||||
# Config Files
|
||||
|
||||
Config files are handy for designers to manage global template variables
|
||||
from one file. One example is template colors. Normally if you wanted to
|
||||
change the color scheme of an application, you would have to go through
|
||||
each and every template file and change the colors. With a config file,
|
||||
the colors can be kept in one place, and only one file needs to be
|
||||
updated.
|
||||
|
||||
```ini
|
||||
# global variables
|
||||
pageTitle = "Main Menu"
|
||||
bodyBgColor = #000000
|
||||
tableBgColor = #000000
|
||||
rowBgColor = #00ff00
|
||||
|
||||
[Customer]
|
||||
pageTitle = "Customer Info"
|
||||
|
||||
[Login]
|
||||
pageTitle = "Login"
|
||||
focus = "username"
|
||||
Intro = """This is a value that spans more
|
||||
than one line. you must enclose
|
||||
it in triple quotes."""
|
||||
|
||||
# hidden section
|
||||
[.Database]
|
||||
host=my.example.com
|
||||
db=ADDRESSBOOK
|
||||
user=php-user
|
||||
pass=foobar
|
||||
```
|
||||
|
||||
|
||||
Values of [config file variables](./language-variables/language-config-variables.md) can be in
|
||||
quotes, but not necessary. You can use either single or double quotes.
|
||||
If you have a value that spans more than one line, enclose the entire
|
||||
value with triple quotes \("""\). You can put comments into config
|
||||
files by any syntax that is not a valid config file syntax. We recommend
|
||||
using a `#` (hash) at the beginning of the line.
|
||||
|
||||
The example config file above has two sections. Section names are
|
||||
enclosed in \[brackets\]. Section names can be arbitrary strings not
|
||||
containing `[` or `]` symbols. The four variables at the top are global
|
||||
variables, or variables not within a section. These variables are always
|
||||
loaded from the config file. If a particular section is loaded, then the
|
||||
global variables and the variables from that section are also loaded. If
|
||||
a variable exists both as a global and in a section, the section
|
||||
variable is used. If you name two variables the same within a section,
|
||||
the last one will be used unless
|
||||
[`$config_overwrite`](../programmers/api-variables/variable-config-overwrite.md) is disabled.
|
||||
|
||||
Config files are loaded into templates with the built-in template
|
||||
function [`{config_load}`](./language-builtin-functions/language-function-config-load.md) or the API
|
||||
[`configLoad()`](../programmers/api-functions/api-config-load.md) function.
|
||||
|
||||
You can hide variables or entire sections by prepending the variable
|
||||
name or section name with a period(.) eg `[.hidden]`. This is useful if
|
||||
your application reads the config files and gets sensitive data from
|
||||
them that the template engine does not need. If you have third parties
|
||||
doing template editing, you can be certain that they cannot read
|
||||
sensitive data from the config file by loading it into the template.
|
||||
|
||||
Config files (or resources) are loaded by the same resource facilities
|
||||
as templates. That means that a config file can also be loaded from a db
|
||||
`$smarty->configLoad("db:my.conf")`.
|
||||
|
||||
See also [`{config_load}`](./language-builtin-functions/language-function-config-load.md),
|
||||
[`$config_overwrite`](../programmers/api-variables/variable-config-overwrite.md),
|
||||
[`$default_config_handler_func`](../programmers/api-variables/variable-default-config-handler-func.md),
|
||||
[`getConfigVars()`](../programmers/api-functions/api-get-config-vars.md),
|
||||
[`clearConfig()`](../programmers/api-functions/api-clear-config.md) and
|
||||
[`configLoad()`](../programmers/api-functions/api-config-load.md)
|
||||
@@ -1,33 +0,0 @@
|
||||
# Basic Syntax
|
||||
|
||||
A simple Smarty template could look like this:
|
||||
```smarty
|
||||
<h1>{$title|escape}</h1>
|
||||
<ul>
|
||||
{foreach $cities as $city}
|
||||
<li>{$city.name|escape} ({$city.population})</li>
|
||||
{foreachelse}
|
||||
<li>no cities found</li>
|
||||
{/foreach}
|
||||
</ul>
|
||||
```
|
||||
|
||||
All Smarty template tags are enclosed within delimiters. By default
|
||||
these are `{` and `}`, but they can be
|
||||
[changed](../../designers/language-basic-syntax/language-escaping.md).
|
||||
|
||||
For the examples in this manual, we will assume that you are using the
|
||||
default delimiters. In Smarty, all content outside of delimiters is
|
||||
displayed as static content, or unchanged. When Smarty encounters
|
||||
template tags, it attempts to interpret them, and displays the
|
||||
appropriate output in their place.
|
||||
|
||||
The basic components of the Smarty syntax are:
|
||||
|
||||
- [Comments](language-syntax-comments.md)
|
||||
- [Variables](language-syntax-variables.md)
|
||||
- [Operators](language-syntax-operators.md)
|
||||
- [Tags](language-syntax-tags.md)
|
||||
- [Attributes](language-syntax-attributes.md)
|
||||
- [Quotes](language-syntax-quotes.md)
|
||||
- [Escaping](language-escaping.md)
|
||||
@@ -1,78 +0,0 @@
|
||||
# Escaping Smarty parsing
|
||||
|
||||
It is sometimes desirable or even necessary to have Smarty ignore
|
||||
sections it would otherwise parse. A classic example is embedding
|
||||
Javascript or CSS code in a template. The problem arises as those
|
||||
languages use the { and } characters which are also the default
|
||||
[delimiters](../language-builtin-functions/language-function-ldelim.md) for Smarty.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> A good practice for avoiding escapement altogether is by separating
|
||||
> your Javascript/CSS into their own files and use standard HTML methods
|
||||
> to access them. This will also take advantage of browser script
|
||||
> caching. When you need to embed Smarty variables/functions into your
|
||||
> Javascript/CSS, then the following applies.
|
||||
|
||||
In Smarty templates, the { and } braces will be ignored so long as they
|
||||
are surrounded by white space. This behavior can be disabled by setting
|
||||
the Smarty class variable [`$auto_literal`](../../programmers/api-variables/variable-auto-literal.md) to
|
||||
false.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
<script>
|
||||
// the following braces are ignored by Smarty
|
||||
// since they are surrounded by whitespace
|
||||
function foobar {
|
||||
alert('foobar!');
|
||||
}
|
||||
// this one will need literal escapement
|
||||
{literal}
|
||||
function bazzy {alert('foobar!');}
|
||||
{/literal}
|
||||
</script>
|
||||
```
|
||||
|
||||
[`{literal}..{/literal}`](../language-builtin-functions/language-function-literal.md) blocks are used
|
||||
for escaping blocks of template logic. You can also escape the braces
|
||||
individually with
|
||||
[`{ldelim}`, `{rdelim}`](../language-builtin-functions/language-function-ldelim.md) tags or
|
||||
[`{$smarty.ldelim}`,`{$smarty.rdelim}`](../language-variables/language-variables-smarty.md#smartyldelim-smartyrdelim-languagevariablessmartyldelim)
|
||||
variables.
|
||||
|
||||
Smarty's default delimiters { and } cleanly represent presentational
|
||||
content. However, if another set of delimiters suit your needs better,
|
||||
you can change them with Smarty's
|
||||
`setLeftDelimiter()` and `setRightDelimiter()` methods.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Changing delimiters affects ALL template syntax and escapement. Be
|
||||
> sure to clear out cache and compiled files if you decide to change
|
||||
> them.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$smarty->setLeftDelimiter('<!--{');
|
||||
$smarty->setRightDelimiter('}-->');
|
||||
|
||||
$smarty->assign('foo', 'bar');
|
||||
$smarty->assign('name', 'Albert');
|
||||
$smarty->display('example.tpl');
|
||||
```
|
||||
|
||||
Where the template is:
|
||||
|
||||
```smarty
|
||||
Welcome <!--{$name}--> to Smarty
|
||||
<script>
|
||||
var foo = <!--{$foo}-->;
|
||||
function dosomething() {
|
||||
alert("foo is " + foo);
|
||||
}
|
||||
dosomething();
|
||||
</script>
|
||||
```
|
||||
@@ -1,49 +0,0 @@
|
||||
# Attributes
|
||||
|
||||
Most of the [tags](./language-syntax-tags.md) take attributes that
|
||||
specify or modify their behavior. Attributes to Smarty functions are
|
||||
much like HTML attributes. Static values don't have to be enclosed in
|
||||
quotes, but it is required for literal strings. Variables with or
|
||||
without modifiers may also be used, and should not be in quotes. You can
|
||||
even use PHP function results, plugin results and complex expressions.
|
||||
|
||||
Some attributes require boolean values (TRUE or FALSE). These can be
|
||||
specified as `true` and `false`. If an attribute has no value assigned
|
||||
it gets the default boolean value of true.
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
{include file="header.tpl"}
|
||||
|
||||
{include file="header.tpl" nocache} // is equivalent to nocache=true
|
||||
|
||||
{include file="header.tpl" attrib_name="attrib value"}
|
||||
|
||||
{include file=$includeFile}
|
||||
|
||||
{include file=#includeFile# title="My Title"}
|
||||
|
||||
{assign var=foo value={counter}} // plugin result
|
||||
|
||||
{assign var=foo value=substr($bar,2,5)} // PHP function result
|
||||
|
||||
{assign var=foo value=$bar|strlen} // using modifier
|
||||
|
||||
{assign var=foo value=$buh+$bar|strlen} // more complex expression
|
||||
|
||||
{html_select_date display_days=true}
|
||||
|
||||
{mailto address="smarty@example.com"}
|
||||
|
||||
<select name="company_id">
|
||||
{html_options options=$companies selected=$company_id}
|
||||
</select>
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Although Smarty can handle some very complex expressions and syntax,
|
||||
> it is a good rule of thumb to keep the template syntax minimal and
|
||||
> focused on presentation. If you find your template syntax getting too
|
||||
> complex, it may be a good idea to move the bits that do not deal
|
||||
> explicitly with presentation to PHP by way of plugins or modifiers.
|
||||
@@ -1,69 +0,0 @@
|
||||
# Comments
|
||||
|
||||
Template comments are surrounded by asterisks, and that is surrounded by
|
||||
the [delimiter](../../designers/language-basic-syntax/language-escaping.md) tags like so:
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{* this is a comment *}
|
||||
```
|
||||
|
||||
Smarty comments are NOT displayed in the final output of the template,
|
||||
unlike `<!-- HTML comments -->`. These are useful for making internal
|
||||
notes in the templates which no one will see ;-)
|
||||
|
||||
```smarty
|
||||
{* I am a Smarty comment, I don't exist in the compiled output *}
|
||||
<html>
|
||||
<head>
|
||||
<title>{$title}</title>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
{* another single line smarty comment *}
|
||||
<!-- HTML comment that is sent to the browser -->
|
||||
|
||||
{* this multiline smarty
|
||||
comment is
|
||||
not sent to browser
|
||||
*}
|
||||
|
||||
{*********************************************************
|
||||
Multi line comment block with credits block
|
||||
@ author: bg@example.com
|
||||
@ maintainer: support@example.com
|
||||
@ para: var that sets block style
|
||||
@ css: the style output
|
||||
**********************************************************}
|
||||
|
||||
{* The header file with the main logo and stuff *}
|
||||
{include file='header.tpl'}
|
||||
|
||||
|
||||
{* Dev note: the $includeFile var is assigned in foo.php script *}
|
||||
<!-- Displays main content block -->
|
||||
{include file=$includeFile}
|
||||
|
||||
{* this <select> block is redundant *}
|
||||
{*
|
||||
<select name="company">
|
||||
{html_options options=$vals selected=$selected_id}
|
||||
</select>
|
||||
*}
|
||||
|
||||
<!-- Show header from affiliate is disabled -->
|
||||
{* $affiliate|upper *}
|
||||
|
||||
{* you cannot nest comments *}
|
||||
{*
|
||||
<select name="company">
|
||||
{* <option value="0">-- none -- </option> *}
|
||||
{html_options options=$vals selected=$selected_id}
|
||||
</select>
|
||||
*}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
@@ -1,88 +0,0 @@
|
||||
# Operators
|
||||
|
||||
## Basic
|
||||
|
||||
Various basic operators can be applied directly to variable values.
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
{$foo + 1}
|
||||
|
||||
{$foo * $bar}
|
||||
|
||||
{$foo->bar - $bar[1] * $baz->foo->bar() -3 * 7}
|
||||
|
||||
{if ($foo + $bar.test % $baz * 134232 + 10 + $b + 10)}
|
||||
...
|
||||
{/if}
|
||||
|
||||
{$foo = $foo + $bar}
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Although Smarty can handle some very complex expressions and syntax,
|
||||
> it is a good rule of thumb to keep the template syntax minimal and
|
||||
> focused on presentation. If you find your template syntax getting too
|
||||
> complex, it may be a good idea to move the bits that do not deal
|
||||
> explicitly with presentation to PHP by way of plugins or modifiers.
|
||||
|
||||
## List
|
||||
The following is a list of recognized operators, which must be
|
||||
separated from surrounding elements by spaces. Note that items listed in
|
||||
\[brackets\] are optional. PHP equivalents are shown where applicable.
|
||||
|
||||
| Operator | Alternates | Syntax Example | Meaning | PHP Equivalent |
|
||||
|--------------------|------------|----------------------|--------------------------------|--------------------|
|
||||
| == | eq | $a eq $b | equals | == |
|
||||
| != | ne, neq | $a neq $b | not equals | != |
|
||||
| > | gt | $a gt $b | greater than | > |
|
||||
| < | lt | $a lt $b | less than | < |
|
||||
| >= | gte, ge | $a ge $b | greater than or equal | >= |
|
||||
| <= | lte, le | $a le $b | less than or equal | <= |
|
||||
| === | | $a === 0 | check for identity | === |
|
||||
| ! | not | not $a | negation (unary) | ! |
|
||||
| % | mod | $a mod $b | modulo | % |
|
||||
| is \[not\] div by | | $a is not div by 4 | divisible by | $a % $b == 0 |
|
||||
| is \[not\] even | | $a is not even | \[not\] an even number (unary) | $a % 2 == 0 |
|
||||
| is \[not\] even by | | $a is not even by $b | grouping level \[not\] even | ($a / $b) % 2 == 0 |
|
||||
| is \[not\] odd | | $a is not odd | \[not\] an odd number (unary) | $a % 2 != 0 |
|
||||
| is \[not\] odd by | | $a is not odd by $b | \[not\] an odd grouping | ($a / $b) % 2 != 0 |
|
||||
| is in | | $a is in $b | exists in array | in_array($a, $b) |
|
||||
| is \[not\] in | | $a is not in $b | does not exist in array | !in_array($a, $b) |
|
||||
|
||||
## Ternary
|
||||
You can use the `?:` (or ternary) operator to test one expression and present the value
|
||||
of the second or third expression, based on the result of the test.
|
||||
|
||||
In other words:
|
||||
```smarty
|
||||
{$test ? "OK" : "FAIL"}
|
||||
```
|
||||
will result in OK if `$test` is set to true, and in FAIL otherwise.
|
||||
|
||||
There is also a shorthand `?:` operator:
|
||||
```smarty
|
||||
{$myVar ?: "empty"}
|
||||
```
|
||||
will result in 'empty' if `$myVar` is not set or set to something that evaluates to false, such as an empty string.
|
||||
If `$myVar` is set to something that evaluates to true, the value of `$myVar` is returned. So, the following will
|
||||
return 'hello':
|
||||
```smarty
|
||||
{$myVar="hello"}
|
||||
{$myVar ?: "empty"}
|
||||
```
|
||||
|
||||
## Testing for null
|
||||
If "something that evaluates to false" is to broad a test for you, you can use the `??` (or null coalescing) operator
|
||||
to trigger only if the tested value is undefined or set to null.
|
||||
```smarty
|
||||
{$myVar ?? "empty"}
|
||||
```
|
||||
will result in 'empty' if `$myVar` is not set or set to null.
|
||||
If `$myVar` is set to something that evaluates to anything else, the value of `$myVar` is returned. So, the following will
|
||||
return an empty string (''):
|
||||
```smarty
|
||||
{$myVar=""}
|
||||
{$myVar ?: "this is not shown"}
|
||||
```
|
||||
@@ -1,54 +0,0 @@
|
||||
# Embedding Vars in Double Quotes
|
||||
|
||||
- Smarty will recognize [assigned](../../programmers/api-functions/api-assign.md)
|
||||
[variables](./language-syntax-variables.md) embedded in "double
|
||||
quotes" so long as the variable name contains only numbers, letters
|
||||
and under_scores. See [naming](https://www.php.net/language.variables)
|
||||
for more detail.
|
||||
|
||||
- With any other characters, for example a period(.) or
|
||||
`$object->reference`, then the variable must be surrounded by `` `backticks` ``.
|
||||
|
||||
- In addition, Smarty does allow embedded Smarty tags in double-quoted
|
||||
strings. This is useful if you want to include variables with
|
||||
modifiers, plugin or PHP function results.
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
{func var="test $foo test"} // sees $foo
|
||||
{func var="test $foo_bar test"} // sees $foo_bar
|
||||
{func var="test `$foo[0]` test"} // sees $foo[0]
|
||||
{func var="test `$foo[bar]` test"} // sees $foo[bar]
|
||||
{func var="test $foo.bar test"} // sees $foo (not $foo.bar)
|
||||
{func var="test `$foo.bar` test"} // sees $foo.bar
|
||||
{func var="test `$foo.bar` test"|escape} // modifiers outside quotes!
|
||||
{func var="test {$foo|escape} test"} // modifiers inside quotes!
|
||||
{func var="test {time()} test"} // PHP function result
|
||||
{func var="test {counter} test"} // plugin result
|
||||
{func var="variable foo is {if !$foo}not {/if} defined"} // Smarty block function
|
||||
|
||||
{* will replace $tpl_name with value *}
|
||||
{include file="subdir/$tpl_name.tpl"}
|
||||
|
||||
{* does NOT replace $tpl_name *}
|
||||
{include file='subdir/$tpl_name.tpl'} // vars require double quotes!
|
||||
|
||||
{* must have backticks as it contains a dot "." *}
|
||||
{cycle values="one,two,`$smarty.config.myval`"}
|
||||
|
||||
{* must have backticks as it contains a dot "." *}
|
||||
{include file="`$module.contact`.tpl"}
|
||||
|
||||
{* can use variable with dot syntax *}
|
||||
{include file="`$module.$view`.tpl"}
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Although Smarty can handle some very complex expressions and syntax,
|
||||
> it is a good rule of thumb to keep the template syntax minimal and
|
||||
> focused on presentation. If you find your template syntax getting too
|
||||
> complex, it may be a good idea to move the bits that do not deal
|
||||
> explicitly with presentation to PHP by way of plugins or modifiers.
|
||||
|
||||
See also [`escape`](../language-modifiers/language-modifier-escape.md).
|
||||
@@ -1,39 +0,0 @@
|
||||
# Tags
|
||||
|
||||
Every Smarty tag either prints a [variable](./language-syntax-variables.md) or
|
||||
invokes some sort of function. These are processed and displayed by
|
||||
enclosing the function and its [attributes](./language-syntax-attributes.md)
|
||||
within delimiters like so: `{funcname attr1="val1" attr2="val2"}`.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{config_load file="colors.conf"}
|
||||
|
||||
{include file="header.tpl"}
|
||||
|
||||
{if $logged_in}
|
||||
Welcome, <span style="color:{#fontColor#}">{$name}!</span>
|
||||
{else}
|
||||
hi, {$name}
|
||||
{/if}
|
||||
|
||||
{include file="footer.tpl"}
|
||||
```
|
||||
|
||||
- Both [built-in functions](../language-builtin-functions/index.md) and [custom
|
||||
functions](../language-custom-functions/index.md) have the same syntax within
|
||||
templates.
|
||||
|
||||
- Built-in functions are the **inner** workings of Smarty, such as
|
||||
[`{if}`](../language-builtin-functions/language-function-if.md),
|
||||
[`{section}`](../language-builtin-functions/language-function-section.md) and
|
||||
[`{strip}`](../language-builtin-functions/language-function-strip.md). There should be no need to
|
||||
change or modify them.
|
||||
|
||||
- Custom tags are **additional** tags implemented via
|
||||
[plugins](../../api/extending/introduction.md). They can be modified to your liking, or you can
|
||||
create new ones. [`{html_options}`](../language-custom-functions/language-function-html-options.md)
|
||||
is an example of a custom function.
|
||||
|
||||
See also [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md)
|
||||
@@ -1,106 +0,0 @@
|
||||
# Variables
|
||||
|
||||
Template variables start with the $dollar sign. They can contain
|
||||
numbers, letters and underscores, much like a [PHP
|
||||
variable](https://www.php.net/language.variables). You can reference arrays
|
||||
by index numerically or non-numerically. Also reference object
|
||||
properties and methods.
|
||||
|
||||
[Config file variables](../language-variables/language-config-variables.md) are an exception to
|
||||
the \$dollar syntax and are instead referenced with surrounding
|
||||
\#hashmarks\#, or via the [`$smarty.config`](../language-variables/language-variables-smarty.md#smartyconfig-languagevariablessmartyconfig) variable.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{$foo} <-- displaying a simple variable (non array/object)
|
||||
{$foo[4]} <-- display the 5th element of a zero-indexed array
|
||||
{$foo.bar} <-- display the "bar" key value of an array, similar to PHP $foo['bar']
|
||||
{$foo.$bar} <-- display variable key value of an array, similar to PHP $foo[$bar]
|
||||
{$foo->bar} <-- display the object property "bar"
|
||||
{$foo->bar()} <-- display the return value of object method "bar"
|
||||
{#foo#} <-- display the config file variable "foo"
|
||||
{$smarty.config.foo} <-- synonym for {#foo#}
|
||||
{$foo[bar]} <-- syntax only valid in a section loop, see {section}
|
||||
{assign var=foo value='baa'}{$foo} <-- displays "baa", see {assign}
|
||||
|
||||
Many other combinations are allowed
|
||||
|
||||
{$foo.bar.baz}
|
||||
{$foo.$bar.$baz}
|
||||
{$foo[4].baz}
|
||||
{$foo[4].$baz}
|
||||
{$foo.bar.baz[4]}
|
||||
{$foo->bar($baz,2,$bar)} <-- passing parameters
|
||||
{"foo"} <-- static values are allowed
|
||||
|
||||
{* display the server variable "SERVER_NAME" ($_SERVER['SERVER_NAME'])*}
|
||||
{$smarty.server.SERVER_NAME}
|
||||
|
||||
Math and embedding tags:
|
||||
|
||||
{$x+$y} // will output the sum of x and y.
|
||||
{assign var=foo value=$x+$y} // in attributes
|
||||
{$foo[$x+3]} // as array index
|
||||
{$foo={counter}+3} // tags within tags
|
||||
{$foo="this is message {counter}"} // tags within double quoted strings
|
||||
|
||||
Defining Arrays:
|
||||
|
||||
{assign var=foo value=[1,2,3]}
|
||||
{assign var=foo value=['y'=>'yellow','b'=>'blue']}
|
||||
{assign var=foo value=[1,[9,8],3]} // can be nested
|
||||
|
||||
Short variable assignment:
|
||||
|
||||
{$foo=$bar+2}
|
||||
{$foo = strlen($bar)} // function in assignment
|
||||
{$foo = myfunct( ($x+$y)*3 )} // as function parameter
|
||||
{$foo.bar=1} // assign to specific array element
|
||||
{$foo.bar.baz=1}
|
||||
{$foo[]=1} // appending to an array
|
||||
|
||||
Smarty "dot" syntax (note: embedded {} are used to address ambiguities):
|
||||
|
||||
{$foo.a.b.c} => $foo['a']['b']['c']
|
||||
{$foo.a.$b.c} => $foo['a'][$b]['c'] // with variable index
|
||||
{$foo.a.{$b+4}.c} => $foo['a'][$b+4]['c'] // with expression as index
|
||||
{$foo.a.{$b.c}} => $foo['a'][$b['c']] // with nested index
|
||||
|
||||
PHP-like syntax, alternative to "dot" syntax:
|
||||
|
||||
{$foo[1]} // normal access
|
||||
{$foo['bar']}
|
||||
{$foo['bar'][1]}
|
||||
{$foo[$x+$x]} // index may contain any expression
|
||||
{$foo[$bar[1]]} // nested index
|
||||
{$foo[section_name]} // smarty {section} access, not array access!
|
||||
|
||||
Variable variables:
|
||||
|
||||
$foo // normal variable
|
||||
$foo_{$bar} // variable name containing other variable
|
||||
$foo_{$x+$y} // variable name containing expressions
|
||||
$foo_{$bar}_buh_{$blar} // variable name with multiple segments
|
||||
{$foo_{$x}} // will output the variable $foo_1 if $x has a value of 1.
|
||||
|
||||
Object chaining:
|
||||
|
||||
{$object->method1($x)->method2($y)}
|
||||
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Although Smarty can handle some very complex expressions and syntax,
|
||||
> it is a good rule of thumb to keep the template syntax minimal and
|
||||
> focused on presentation. If you find your template syntax getting too
|
||||
> complex, it may be a good idea to move the bits that do not deal
|
||||
> explicitly with presentation to PHP by way of plugins or modifiers.
|
||||
|
||||
Request variables such as `$_GET`, `$_SESSION`, etc are available via
|
||||
the reserved [`$smarty`](../language-variables/language-variables-smarty.md) variable.
|
||||
|
||||
See also [`$smarty`](../language-variables/language-variables-smarty.md), [config
|
||||
variables](../language-variables/language-config-variables.md)
|
||||
[`{assign}`](../language-builtin-functions/language-function-assign.md) and [`assign()`](../../programmers/api-functions/api-assign.md).
|
||||
@@ -1,35 +0,0 @@
|
||||
# Built-in Functions
|
||||
|
||||
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 tags](../language-custom-functions/index.md) with the same name; and you
|
||||
should not need to modify the built-in functions.
|
||||
|
||||
A few of these functions have an `assign` attribute which collects the
|
||||
result the function to a named template variable instead of being
|
||||
output; much like the [`{assign}`](language-function-assign.md) function.
|
||||
|
||||
- [{append}](language-function-append.md)
|
||||
- [{assign} or {$var=...}](language-function-assign.md)
|
||||
- [{block}](language-function-block.md)
|
||||
- [{call}](language-function-call.md)
|
||||
- [{capture}](language-function-capture.md)
|
||||
- [{config_load}](language-function-config-load.md)
|
||||
- [{debug}](language-function-debug.md)
|
||||
- [{extends}](language-function-extends.md)
|
||||
- [{for}](language-function-for.md)
|
||||
- [{foreach}, {foreachelse}](language-function-foreach.md)
|
||||
- [{function}](language-function-function.md)
|
||||
- [{if}, {elseif}, {else}](language-function-if.md)
|
||||
- [{include}](language-function-include.md)
|
||||
- [{insert}](language-function-insert.md)
|
||||
- [{ldelim}, {rdelim}](language-function-ldelim.md)
|
||||
- [{literal}](language-function-literal.md)
|
||||
- [{nocache}](language-function-nocache.md)
|
||||
- [{section}, {sectionelse}](language-function-section.md)
|
||||
- [{setfilter}](language-function-setfilter.md)
|
||||
- [{strip}](language-function-strip.md)
|
||||
- [{while}](language-function-while.md)
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
# {append}
|
||||
|
||||
`{append}` is used for creating or appending template variable arrays
|
||||
**during the execution of a template**.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute | Required | Description |
|
||||
|-----------|------------|----------------------------------------------------------------------------------------------------|
|
||||
| var | | The name of the variable being assigned |
|
||||
| value | | The value being assigned |
|
||||
| index | (optional) | The index for the new array element. If not specified the value is append to the end of the array. |
|
||||
| scope | (optional) | The scope of the assigned variable: parent, root or global. Defaults to local if omitted. |
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|-----------------------------------------------------|
|
||||
| nocache | Assigns the variable with the 'nocache' attribute |
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Assignment of variables in-template is essentially placing application
|
||||
> logic into the presentation that may be better handled in PHP. Use at
|
||||
> your own discretion.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{append var='name' value='Bob' index='first'}
|
||||
{append var='name' value='Meyer' index='last'}
|
||||
// or
|
||||
{append 'name' 'Bob' index='first'} {* short-hand *}
|
||||
{append 'name' 'Meyer' index='last'} {* short-hand *}
|
||||
|
||||
The first name is {$name.first}.<br>
|
||||
The last name is {$name.last}.
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
|
||||
The first name is Bob.
|
||||
The last name is Meyer.
|
||||
|
||||
|
||||
|
||||
See also [`append()`](#api.append) and
|
||||
[`getTemplateVars()`](#api.get.template.vars).
|
||||
@@ -1,148 +0,0 @@
|
||||
# {assign}, {$var=...}
|
||||
|
||||
`{assign}` or `{$var=...}` is used for assigning template variables **during the
|
||||
execution of a template**.
|
||||
|
||||
## Attributes of the {assign} syntax
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|------------|-----------------------------------------------------------------------|
|
||||
| var | | The name of the variable being assigned |
|
||||
| value | | The value being assigned |
|
||||
| scope | (optional) | The scope of the assigned variable: 'parent','root' or 'global' |
|
||||
|
||||
## Attributes of the {$var=...} syntax
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|------------|-----------------------------------------------------------------------|
|
||||
| scope | (optional) | The scope of the assigned variable: 'parent','root' or 'global' |
|
||||
|
||||
## Option Flags
|
||||
| Name | Description |
|
||||
|---------|---------------------------------------------------|
|
||||
| nocache | Assigns the variable with the 'nocache' attribute |
|
||||
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Assignment of variables in-template is essentially placing application
|
||||
> logic into the presentation that may be better handled in PHP. Use at
|
||||
> your own discretion.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{assign var="name" value="Bob"} {* or *}
|
||||
{assign "name" "Bob"} {* short-hand, or *}
|
||||
{$name='Bob'}
|
||||
|
||||
The value of $name is {$name}.
|
||||
```
|
||||
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
The value of $name is Bob.
|
||||
```
|
||||
|
||||
|
||||
```smarty
|
||||
{assign var="name" value="Bob" nocache} {* or *}
|
||||
{assign "name" "Bob" nocache} {* short-hand, or *}
|
||||
{$name='Bob' nocache}
|
||||
|
||||
The value of $name is {$name}.
|
||||
```
|
||||
The above example will output:
|
||||
```
|
||||
The value of $name is Bob.
|
||||
```
|
||||
|
||||
|
||||
```smarty
|
||||
{assign var=running_total value=$running_total+$some_array[$row].some_value} {* or *}
|
||||
{$running_total=$running_total+$some_array[row].some_value}
|
||||
```
|
||||
|
||||
Variables assigned in the included template will be seen in the
|
||||
including template.
|
||||
|
||||
```smarty
|
||||
{include file="sub_template.tpl"}
|
||||
|
||||
{* display variable assigned in sub_template *}
|
||||
{$foo}<br>
|
||||
```
|
||||
|
||||
The template above includes the example `sub_template.tpl` below:
|
||||
|
||||
```smarty
|
||||
|
||||
{* foo will be known also in the including template *}
|
||||
{assign var="foo" value="something" scope=parent}
|
||||
{$foo="something" scope=parent}
|
||||
|
||||
{* bar is assigned only local in the including template *}
|
||||
{assign var="bar" value="value"} {* or *}
|
||||
{$var="value"}
|
||||
|
||||
```
|
||||
|
||||
You can assign a variable to root of the current root tree. The variable
|
||||
is seen by all templates using the same root tree.
|
||||
|
||||
```smarty
|
||||
{assign var=foo value="bar" scope="root"}
|
||||
```
|
||||
|
||||
A global variable is seen by all templates.
|
||||
|
||||
```smarty
|
||||
{assign var=foo value="bar" scope="global"} {* or *}
|
||||
{assign "foo" "bar" scope="global"} {* short-hand, or *}
|
||||
{$foo="bar" scope="global"}
|
||||
```
|
||||
|
||||
For more information on variable scope, please read the page on [variable scopes](../language-variables/language-variable-scopes.md).
|
||||
|
||||
To access `{assign}` variables from a php script use
|
||||
[`getTemplateVars()`](../../programmers/api-functions/api-get-template-vars.md).
|
||||
Here's the template that creates the variable `$foo`.
|
||||
|
||||
```smarty
|
||||
{assign var="foo" value="Smarty"} {* or *}
|
||||
{$foo="Smarty"}
|
||||
```
|
||||
|
||||
The template variables are only available after/during template
|
||||
execution as in the following script.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
// this will output nothing as the template has not been executed
|
||||
echo $smarty->getTemplateVars('foo');
|
||||
|
||||
// fetch the template to a variable
|
||||
$whole_page = $smarty->fetch('index.tpl');
|
||||
|
||||
// this will output 'smarty' as the template has been executed
|
||||
echo $smarty->getTemplateVars('foo');
|
||||
|
||||
$smarty->assign('foo','Even smarter');
|
||||
|
||||
// this will output 'Even smarter'
|
||||
echo $smarty->getTemplateVars('foo');
|
||||
```
|
||||
|
||||
The following functions can also *optionally* assign template variables: [`{capture}`](#language.function.capture),
|
||||
[`{include}`](#language.function.include),
|
||||
[`{counter}`](#language.function.counter),
|
||||
[`{cycle}`](#language.function.cycle),
|
||||
[`{eval}`](#language.function.eval),
|
||||
[`{fetch}`](#language.function.fetch),
|
||||
[`{math}`](#language.function.math) and
|
||||
[`{textformat}`](#language.function.textformat).
|
||||
|
||||
See also [`{append}`](./language-function-append.md),
|
||||
[`assign()`](#api.assign) and
|
||||
[`getTemplateVars()`](#api.get.template.vars).
|
||||
@@ -1,201 +0,0 @@
|
||||
# {block}
|
||||
|
||||
`{block}` is used to define a named area of template source for template
|
||||
inheritance. For details see section of [Template
|
||||
Inheritance](../../api/inheritance.md).
|
||||
|
||||
The `{block}` template source area of a child template will replace the
|
||||
corresponding areas in the parent template(s).
|
||||
|
||||
Optionally `{block}` areas of child and parent templates can be merged
|
||||
into each other. You can append or prepend the parent `{block}` content
|
||||
by using the `append` or `prepend` option flag with the child's `{block}`
|
||||
definition. With `{$smarty.block.parent}` the `{block}` content of
|
||||
the parent template can be inserted at any location of the child
|
||||
`{block}` content. `{$smarty.block.child}` inserts the `{block}` content
|
||||
of the child template at any location of the parent `{block}`.
|
||||
|
||||
`{blocks}'s` can be nested.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|----------------------------------------------------------------------------------------------------------------------|
|
||||
| name | yes | The name of the template source block |
|
||||
| assign | no | The name of variable to assign the output of the block to. |
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The assign attribute only works on the block that actually gets executed, so you may need
|
||||
> to add it to each child block as well.
|
||||
|
||||
|
||||
## Option Flags (in child templates only):
|
||||
|
||||
| Name | Description |
|
||||
|---------|-----------------------------------------------------------------------------------------|
|
||||
| append | The `{block}` content will be appended to the content of the parent template `{block}` |
|
||||
| prepend | The `{block}` content will be prepended to the content of the parent template `{block}` |
|
||||
| hide | Ignore the block content if no child block of same name is existing. |
|
||||
| nocache | Disables caching of the `{block}` content |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
parent.tpl
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{block name="title"}Default Title{/block}</title>
|
||||
<title>{block "title"}Default Title{/block}</title> {* short-hand *}
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
|
||||
child.tpl
|
||||
|
||||
```smarty
|
||||
{extends file="parent.tpl"}
|
||||
{block name="title"}
|
||||
Page Title
|
||||
{/block}
|
||||
```
|
||||
|
||||
|
||||
The result would look like
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>Page Title</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
parent.tpl
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{block name="title"}Title - {/block}</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
|
||||
child.tpl
|
||||
|
||||
```smarty
|
||||
{extends file="parent.tpl"}
|
||||
{block name="title" append}
|
||||
Page Title
|
||||
{/block}
|
||||
```
|
||||
|
||||
|
||||
The result would look like
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>Title - Page Title</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
parent.tpl
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{block name="title"} is my title{/block}</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
child.tpl
|
||||
|
||||
```smarty
|
||||
{extends file="parent.tpl"}
|
||||
{block name="title" prepend}
|
||||
Page Title
|
||||
{/block}
|
||||
```
|
||||
|
||||
|
||||
The result would look like
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>Page title is my titel</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
parent.tpl
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{block name="title"}The {$smarty.block.child} was inserted here{/block}</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
child.tpl
|
||||
|
||||
```smarty
|
||||
{extends file="parent.tpl"}
|
||||
{block name="title"}
|
||||
Child Title
|
||||
{/block}
|
||||
```
|
||||
|
||||
The result would look like
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>The Child Title was inserted here</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
parent.tpl
|
||||
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{block name="title"}Parent Title{/block}</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
|
||||
child.tpl
|
||||
|
||||
```smarty
|
||||
{extends file="parent.tpl"}
|
||||
{block name="title"}
|
||||
You will see now - {$smarty.block.parent} - here
|
||||
{/block}
|
||||
```
|
||||
|
||||
The result would look like
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>You will see now - Parent Title - here</title>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
See also [Template
|
||||
Inheritance](../../api/inheritance.md),
|
||||
[`$smarty.block.parent`](../language-variables/language-variables-smarty.md#smartyblockparent-languagevariablessmartyblockparent),
|
||||
[`$smarty.block.child`](../language-variables/language-variables-smarty.md#smartyblockchild-languagevariablessmartyblockchild), and
|
||||
[`{extends}`](./language-function-extends.md)
|
||||
@@ -1,77 +0,0 @@
|
||||
# {call}
|
||||
|
||||
`{call}` is used to call a template function defined by the
|
||||
[`{function}`](./language-function-function.md) tag just like a plugin
|
||||
function.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Template functions are defined global. Since the Smarty compiler is a
|
||||
> single-pass compiler, The `{call}` tag must
|
||||
> be used to call a template function defined externally from the given
|
||||
> template. Otherwise you can directly use the function as
|
||||
> `{funcname ...}` in the template.
|
||||
|
||||
- The `{call}` tag must have the `name` attribute which contains the
|
||||
name of the template function.
|
||||
|
||||
- Values for variables can be passed to the template function as
|
||||
[attributes](../language-basic-syntax/language-syntax-attributes.md).
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|------------------------------------------------------------------------------------------|
|
||||
| name | Yes | The name of the template function |
|
||||
| assign | No | The name of the variable that the output of called template function will be assigned to |
|
||||
| [var ...] | No | variable to pass local to template function |
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|--------------------------------------------|
|
||||
| nocache | Call the template function in nocache mode |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{* define the function *}
|
||||
{function name=menu level=0}
|
||||
<ul class="level{$level}">
|
||||
{foreach $data as $entry}
|
||||
{if is_array($entry)}
|
||||
<li>{$entry@key}</li>
|
||||
{call name=menu data=$entry level=$level+1}
|
||||
{else}
|
||||
<li>{$entry}</li>
|
||||
{/if}
|
||||
{/foreach}
|
||||
</ul>
|
||||
{/function}
|
||||
|
||||
{* create an array to demonstrate *}
|
||||
{$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>
|
||||
['item3-3-1','item3-3-2']],'item4']}
|
||||
|
||||
{* run the array through the function *}
|
||||
{call name=menu data=$menu}
|
||||
{call menu data=$menu} {* short-hand *}
|
||||
```
|
||||
|
||||
|
||||
Will generate the following output
|
||||
|
||||
```
|
||||
* item1
|
||||
* item2
|
||||
* item3
|
||||
o item3-1
|
||||
o item3-2
|
||||
o item3-3
|
||||
+ item3-3-1
|
||||
+ item3-3-2
|
||||
* item4
|
||||
```
|
||||
|
||||
See also [`{function}`](./language-function-function.md).
|
||||
@@ -1,75 +0,0 @@
|
||||
# {capture}
|
||||
|
||||
`{capture}` is used to collect the output of the template between the
|
||||
tags into a variable instead of displaying it. Any content between
|
||||
`{capture name='foo'}` and `{/capture}` is collected into the variable
|
||||
specified in the `name` attribute.
|
||||
|
||||
The captured content can be used in the template from the variable
|
||||
[`$smarty.capture.foo`](../language-variables/language-variables-smarty.md#smartycapture-languagevariablessmartycapture) where "foo"
|
||||
is the value passed in the `name` attribute. If you do not supply the
|
||||
`name` attribute, then "default" will be used as the name ie
|
||||
`$smarty.capture.default`.
|
||||
|
||||
`{capture}'s` can be nested.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|----------------------------------------------------------------------|
|
||||
| name | Yes | The name of the captured block |
|
||||
| assign | No | The variable name where to assign the captured output to |
|
||||
| append | No | The name of an array variable where to append the captured output to |
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|-----------------------------------------|
|
||||
| nocache | Disables caching of this captured block |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{* we don't want to print a div tag unless content is displayed *}
|
||||
{capture name="banner"}
|
||||
{capture "banner"} {* short-hand *}
|
||||
{include file="get_banner.tpl"}
|
||||
{/capture}
|
||||
|
||||
{if $smarty.capture.banner ne ""}
|
||||
<div id="banner">{$smarty.capture.banner}</div>
|
||||
{/if}
|
||||
```
|
||||
|
||||
This example demonstrates the capture function.
|
||||
```smarty
|
||||
|
||||
{capture name=some_content assign=popText}
|
||||
{capture some_content assign=popText} {* short-hand *}
|
||||
The server is {$my_server_name|upper} at {$my_server_addr}<br>
|
||||
Your ip is {$my_ip}.
|
||||
{/capture}
|
||||
<a href="#">{$popText}</a>
|
||||
```
|
||||
|
||||
|
||||
This example also demonstrates how multiple calls of capture can be used
|
||||
to create an array with captured content.
|
||||
|
||||
```smarty
|
||||
{capture append="foo"}hello{/capture}I say just {capture append="foo"}world{/capture}
|
||||
{foreach $foo as $text}{$text} {/foreach}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
I say just hello world
|
||||
```
|
||||
|
||||
|
||||
See also [`$smarty.capture`](../language-variables/language-variables-smarty.md#smartycapture-languagevariablessmartycapture),
|
||||
[`{eval}`](../language-custom-functions/language-function-eval.md),
|
||||
[`{fetch}`](../language-custom-functions/language-function-fetch.md), [`fetch()`](../../programmers/api-functions/api-fetch.md) and
|
||||
[`{assign}`](./language-function-assign.md).
|
||||
@@ -1,88 +0,0 @@
|
||||
# {config_load}
|
||||
|
||||
`{config_load}` is used for loading config
|
||||
[`#variables#`](#language.config.variables) from a [configuration file](#config.files) into the template.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| file | Yes | The name of the config file to include |
|
||||
| section | No | The name of the section to load |
|
||||
| scope | no | How the scope of the loaded variables are treated, which must be one of local, parent or global. local means variables are loaded into the local template context. parent means variables are loaded into both the local context and the parent template that called it. global means variables are available to all templates. |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
The `example.conf` file.
|
||||
|
||||
```ini
|
||||
#this is config file comment
|
||||
|
||||
# global variables
|
||||
pageTitle = "Main Menu"
|
||||
bodyBgColor = #000000
|
||||
tableBgColor = #000000
|
||||
rowBgColor = #00ff00
|
||||
|
||||
#customer variables section
|
||||
[Customer]
|
||||
pageTitle = "Customer Info"
|
||||
```
|
||||
|
||||
and the template
|
||||
|
||||
```smarty
|
||||
{config_load file="example.conf"}
|
||||
{config_load "example.conf"} {* short-hand *}
|
||||
|
||||
<html>
|
||||
<title>{#pageTitle#|default:"No title"}</title>
|
||||
<body bgcolor="{#bodyBgColor#}">
|
||||
<table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}">
|
||||
<tr bgcolor="{#rowBgColor#}">
|
||||
<td>First</td>
|
||||
<td>Last</td>
|
||||
<td>Address</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
[Config Files](#config.files) may also contain sections. You can load
|
||||
variables from within a section with the added attribute `section`. Note
|
||||
that global config variables are always loaded along with section
|
||||
variables, and same-named section variables overwrite the globals.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Config file *sections* and the built-in template function called
|
||||
> [`{section}`](../language-builtin-functions/language-function-section.md) have nothing to do with each
|
||||
> other, they just happen to share a common naming convention.
|
||||
|
||||
```smarty
|
||||
{config_load file='example.conf' section='Customer'}
|
||||
{config_load 'example.conf' 'Customer'} {* short-hand *}
|
||||
|
||||
<html>
|
||||
<title>{#pageTitle#}</title>
|
||||
<body bgcolor="{#bodyBgColor#}">
|
||||
<table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}">
|
||||
<tr bgcolor="{#rowBgColor#}">
|
||||
<td>First</td>
|
||||
<td>Last</td>
|
||||
<td>Address</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
See [`$config_overwrite`](../../programmers/api-variables/variable-config-overwrite.md) to create arrays
|
||||
of config file variables.
|
||||
|
||||
See also the [config files](../config-files.md) page, [config variables](../language-variables/language-config-variables.md) page,
|
||||
[`$config_dir`](../../programmers/api-variables/variable-config-dir.md),
|
||||
[`getConfigVars()`](../../programmers/api-functions/api-get-config-vars.md) and
|
||||
[`configLoad()`](../../programmers/api-functions/api-config-load.md).
|
||||
@@ -1,17 +0,0 @@
|
||||
# {debug}
|
||||
|
||||
`{debug}` dumps the debug console to the page. This works regardless of
|
||||
the [debug](../chapter-debugging-console.md) settings in the php script.
|
||||
Since this gets executed at runtime, this is only able to show the
|
||||
[assigned](../../programmers/api-functions/api-assign.md) variables; not the templates that are in use.
|
||||
However, you can see all the currently available variables within the
|
||||
scope of a template.
|
||||
|
||||
If caching is enabled and a page is loaded from cache `{debug}` does
|
||||
show only the variables which assigned for the cached page.
|
||||
|
||||
In order to see also the variables which have been locally assigned
|
||||
within the template it does make sense to place the `{debug}` tag at the
|
||||
end of the template.
|
||||
|
||||
See also the [debugging console page](../chapter-debugging-console.md).
|
||||
@@ -1,37 +0,0 @@
|
||||
# {extends}
|
||||
|
||||
`{extends}` tags are used in child templates in template inheritance for
|
||||
extending parent templates. For details see section of [Template
|
||||
Inheritance](../../api/inheritance.md).
|
||||
|
||||
- The `{extends}` tag must be on the first line of the template.
|
||||
|
||||
- If a child template extends a parent template with the `{extends}`
|
||||
tag it may contain only `{block}` tags. Any other template content
|
||||
is ignored.
|
||||
|
||||
- Use the syntax for [template resources](../../api/resources.md) to extend files
|
||||
outside the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md) directory.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute | Required | Description |
|
||||
|-----------|----------|-------------------------------------------------|
|
||||
| file | Yes | The name of the template file which is extended |
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> When extending a variable parent like `{extends file=$parent_file}`,
|
||||
> make sure you include `$parent_file` in the
|
||||
> [`$compile_id`](../../programmers/api-variables/variable-compile-id.md). Otherwise, Smarty cannot
|
||||
> distinguish between different `$parent_file`s.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{extends file='parent.tpl'}
|
||||
{extends 'parent.tpl'} {* short-hand *}
|
||||
```
|
||||
|
||||
See also [Template Inheritance](../../api/inheritance.md)
|
||||
and [`{block}`](./language-function-block.md).
|
||||
@@ -1,91 +0,0 @@
|
||||
# {for}
|
||||
|
||||
The `{for}{forelse}` tag is used to create simple loops. The following different formats are supported:
|
||||
|
||||
- `{for $var=$start to $end}` simple loop with step size of 1.
|
||||
|
||||
- `{for $var=$start to $end step $step}` loop with individual step
|
||||
size.
|
||||
|
||||
`{forelse}` is executed when the loop is not iterated.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute | Required | Description |
|
||||
|-----------|----------|--------------------------------|
|
||||
| max | No | Limit the number of iterations |
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|--------------------------------------|
|
||||
| nocache | Disables caching of the `{for}` loop |
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
<ul>
|
||||
{for $foo=1 to 3}
|
||||
<li>{$foo}</li>
|
||||
{/for}
|
||||
</ul>
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>1</li>
|
||||
<li>2</li>
|
||||
<li>3</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('to',10);
|
||||
```
|
||||
|
||||
```smarty
|
||||
<ul>
|
||||
{for $foo=3 to $to max=3}
|
||||
<li>{$foo}</li>
|
||||
{/for}
|
||||
</ul>
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>3</li>
|
||||
<li>4</li>
|
||||
<li>5</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('start',10);
|
||||
$smarty->assign('to',5);
|
||||
```
|
||||
|
||||
```smarty
|
||||
<ul>
|
||||
{for $foo=$start to $to}
|
||||
<li>{$foo}</li>
|
||||
{forelse}
|
||||
no iteration
|
||||
{/for}
|
||||
</ul>
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
no iteration
|
||||
```
|
||||
|
||||
See also [`{foreach}`](./language-function-foreach.md),
|
||||
[`{section}`](./language-function-section.md) and
|
||||
[`{while}`](./language-function-while.md)
|
||||
@@ -1,389 +0,0 @@
|
||||
# {foreach},{foreachelse}
|
||||
|
||||
`{foreach}` is used for looping over arrays of data. `{foreach}` has a
|
||||
simpler and cleaner syntax than the
|
||||
[`{section}`](./language-function-section.md) loop, and can also loop over
|
||||
associative arrays.
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|------------------------------------------|
|
||||
| nocache | Disables caching of the `{foreach}` loop |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
|
||||
{foreach $arrayvar as $itemvar}
|
||||
{$itemvar|escape}
|
||||
{/foreach}
|
||||
|
||||
{foreach $arrayvar as $keyvar=>$itemvar}
|
||||
{$keyvar}: {$itemvar|escape}
|
||||
{/foreach}
|
||||
|
||||
```
|
||||
> **Note**
|
||||
>
|
||||
> This foreach syntax does not accept any named attributes. This syntax
|
||||
> is new to Smarty 3, however the Smarty 2.x syntax
|
||||
> `{foreach from=$myarray key="mykey" item="myitem"}` is still
|
||||
> supported.
|
||||
|
||||
- `{foreach}` loops can be nested.
|
||||
|
||||
- The `array` variable, usually an array of values, determines the
|
||||
number of times `{foreach}` will loop. You can also pass an integer
|
||||
for arbitrary loops.
|
||||
|
||||
- `{foreachelse}` is executed when there are no values in the `array`
|
||||
variable.
|
||||
|
||||
- `{foreach}` properties are [`@index`](#index),
|
||||
[`@iteration`](#iteration),
|
||||
[`@first`](#first),
|
||||
[`@last`](#last),
|
||||
[`@show`](#show),
|
||||
[`@total`](#total).
|
||||
|
||||
- `{foreach}` constructs are [`{break}`](#break),
|
||||
[`{continue}`](#continue).
|
||||
|
||||
- Instead of specifying the `key` variable you can access the current
|
||||
key of the loop item by `{$item@key}` (see examples below).
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The `$var@property` syntax is new to Smarty 3, however when using the
|
||||
> Smarty 2 `{foreach from=$myarray key="mykey" item="myitem"}` style
|
||||
> syntax, the `$smarty.foreach.name.property` syntax is still supported.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Although you can retrieve the array key with the syntax
|
||||
> `{foreach $myArray as $myKey => $myValue}`, the key is always
|
||||
> available as `$myValue@key` within the foreach loop.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$arr = array('red', 'green', 'blue');
|
||||
$smarty->assign('myColors', $arr);
|
||||
```
|
||||
|
||||
Template to output `$myColors` in an un-ordered list
|
||||
|
||||
```smarty
|
||||
<ul>
|
||||
{foreach $myColors as $color}
|
||||
<li>{$color}</li>
|
||||
{/foreach}
|
||||
</ul>
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>red</li>
|
||||
<li>green</li>
|
||||
<li>blue</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');
|
||||
$smarty->assign('myPeople', $people);
|
||||
```
|
||||
|
||||
Template to output `$myArray` as key/value pairs.
|
||||
|
||||
```smarty
|
||||
<ul>
|
||||
{foreach $myPeople as $value}
|
||||
<li>{$value@key}: {$value}</li>
|
||||
{/foreach}
|
||||
</ul>
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>fname: John</li>
|
||||
<li>lname: Doe</li>
|
||||
<li>email: j.doe@example.com</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
Assign an array to Smarty, the key contains the key for each looped
|
||||
value.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign(
|
||||
'contacts',
|
||||
[
|
||||
['phone' => '555-555-1234', 'fax' => '555-555-5678', 'cell' => '555-555-0357'],
|
||||
['phone' => '800-555-4444', 'fax' => '800-555-3333', 'cell' => '800-555-2222'],
|
||||
]
|
||||
);
|
||||
```
|
||||
|
||||
The template to output `$contact`.
|
||||
|
||||
```smarty
|
||||
{* key always available as a property *}
|
||||
{foreach $contacts as $contact}
|
||||
{foreach $contact as $value}
|
||||
{$value@key}: {$value}
|
||||
{/foreach}
|
||||
{/foreach}
|
||||
|
||||
{* accessing key the PHP syntax alternate *}
|
||||
{foreach $contacts as $contact}
|
||||
{foreach $contact as $key => $value}
|
||||
{$key}: {$value}
|
||||
{/foreach}
|
||||
{/foreach}
|
||||
```
|
||||
|
||||
Either of the above examples will output:
|
||||
|
||||
```
|
||||
phone: 555-555-1234
|
||||
fax: 555-555-5678
|
||||
cell: 555-555-0357
|
||||
phone: 800-555-4444
|
||||
fax: 800-555-3333
|
||||
cell: 800-555-2222
|
||||
```
|
||||
|
||||
A database (PDO) example of looping over search results. This example is
|
||||
looping over a PHP iterator instead of an array().
|
||||
|
||||
```php
|
||||
<?php
|
||||
use Smarty\Smarty;
|
||||
|
||||
$smarty = new Smarty;
|
||||
|
||||
$dsn = 'mysql:host=localhost;dbname=test';
|
||||
$login = 'test';
|
||||
$passwd = 'test';
|
||||
|
||||
// setting PDO to use buffered queries in mysql is
|
||||
// important if you plan on using multiple result cursors
|
||||
// in the template.
|
||||
|
||||
$db = new PDO($dsn, $login, $passwd, array(
|
||||
PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true));
|
||||
|
||||
$res = $db->prepare("select * from users");
|
||||
$res->execute();
|
||||
$res->setFetchMode(PDO::FETCH_LAZY);
|
||||
|
||||
// assign to smarty
|
||||
$smarty->assign('res',$res);
|
||||
|
||||
$smarty->display('index.tpl');?>
|
||||
```
|
||||
|
||||
```smarty
|
||||
{foreach $res as $r}
|
||||
{$r.id}
|
||||
{$r.name}
|
||||
{foreachelse}
|
||||
.. no results ..
|
||||
{/foreach}
|
||||
```
|
||||
|
||||
The above is assuming the results contain the columns named `id` and
|
||||
`name`.
|
||||
|
||||
What is the advantage of an iterator vs. looping over a plain old array?
|
||||
With an array, all the results are accumulated into memory before being
|
||||
looped. With an iterator, each result is loaded/released within the
|
||||
loop. This saves processing time and memory, especially for very large
|
||||
result sets.
|
||||
|
||||
## @index
|
||||
|
||||
`index` contains the current array index, starting with zero.
|
||||
|
||||
```smarty
|
||||
{* output empty row on the 4th iteration (when index is 3) *}
|
||||
<table>
|
||||
{foreach $items as $i}
|
||||
{if $i@index eq 3}
|
||||
{* put empty table row *}
|
||||
<tr><td>nbsp;</td></tr>
|
||||
{/if}
|
||||
<tr><td>{$i.label}</td></tr>
|
||||
{/foreach}
|
||||
</table>
|
||||
```
|
||||
|
||||
|
||||
## @iteration
|
||||
|
||||
`iteration` contains the current loop iteration and always starts at
|
||||
one, unlike [`index`](#index). It is incremented by one
|
||||
on each iteration.
|
||||
|
||||
The *"is div by"* operator can be used to detect a specific iteration.
|
||||
Here we bold-face the name every 4th iteration.
|
||||
|
||||
```smarty
|
||||
{foreach $myNames as $name}
|
||||
{if $name@iteration is div by 4}
|
||||
<b>{$name}</b>
|
||||
{/if}
|
||||
{$name}
|
||||
{/foreach}
|
||||
```
|
||||
|
||||
The *"is even by"* and *"is odd by"* operators can be used to
|
||||
alternate something every so many iterations. Choosing between even or
|
||||
odd rotates which one starts. Here we switch the font color every 3rd
|
||||
iteration.
|
||||
|
||||
```smarty
|
||||
{foreach $myNames as $name}
|
||||
{if $name@index is even by 3}
|
||||
<span style="color: #000">{$name}</span>
|
||||
{else}
|
||||
<span style="color: #eee">{$name}</span>
|
||||
{/if}
|
||||
{/foreach}
|
||||
```
|
||||
|
||||
This will output something similar to this:
|
||||
|
||||
```html
|
||||
<span style="color: #000">...</span>
|
||||
<span style="color: #000">...</span>
|
||||
<span style="color: #000">...</span>
|
||||
<span style="color: #eee">...</span>
|
||||
<span style="color: #eee">...</span>
|
||||
<span style="color: #eee">...</span>
|
||||
<span style="color: #000">...</span>
|
||||
<span style="color: #000">...</span>
|
||||
<span style="color: #000">...</span>
|
||||
<span style="color: #eee">...</span>
|
||||
<span style="color: #eee">...</span>
|
||||
<span style="color: #eee">...</span>
|
||||
...
|
||||
```
|
||||
|
||||
## @first
|
||||
|
||||
`first` is TRUE if the current `{foreach}` iteration is the initial one.
|
||||
Here we display a table header row on the first iteration.
|
||||
|
||||
```smarty
|
||||
{* show table header at first iteration *}
|
||||
<table>
|
||||
{foreach $items as $i}
|
||||
{if $i@first}
|
||||
<tr>
|
||||
<th>key</td>
|
||||
<th>name</td>
|
||||
</tr>
|
||||
{/if}
|
||||
<tr>
|
||||
<td>{$i@key}</td>
|
||||
<td>{$i.name}</td>
|
||||
</tr>
|
||||
{/foreach}
|
||||
</table>
|
||||
```
|
||||
|
||||
## @last
|
||||
|
||||
`last` is set to TRUE if the current `{foreach}` iteration is the final
|
||||
one. Here we display a horizontal rule on the last iteration.
|
||||
|
||||
```smarty
|
||||
{* Add horizontal rule at end of list *}
|
||||
{foreach $items as $item}
|
||||
<a href="#{$item.id}">{$item.name}</a>{if $item@last}<hr>{else},{/if}
|
||||
{foreachelse}
|
||||
... no items to loop ...
|
||||
{/foreach}
|
||||
```
|
||||
|
||||
## @show
|
||||
|
||||
The show `show` property can be used after the execution of a
|
||||
`{foreach}` loop to detect if data has been displayed or not. `show` is
|
||||
a boolean value.
|
||||
|
||||
```smarty
|
||||
<ul>
|
||||
{foreach $myArray as $name}
|
||||
<li>{$name}</li>
|
||||
{/foreach}
|
||||
</ul>
|
||||
{if $name@show} do something here if the array contained data {/if}
|
||||
```
|
||||
|
||||
## @total
|
||||
|
||||
`total` contains the number of iterations that this `{foreach}` will
|
||||
loop. This can be used inside or after the `{foreach}`.
|
||||
|
||||
```smarty
|
||||
{* show number of rows at end *}
|
||||
{foreach $items as $item}
|
||||
{$item.name}<hr/>
|
||||
{if $item@last}
|
||||
<div id="total">{$item@total} items</div>
|
||||
{/if}
|
||||
{foreachelse}
|
||||
... no items to loop ...
|
||||
{/foreach}
|
||||
```
|
||||
|
||||
See also [`{section}`](./language-function-section.md),
|
||||
[`{for}`](./language-function-for.md) and
|
||||
[`{while}`](./language-function-while.md)
|
||||
|
||||
## {break}
|
||||
|
||||
`{break}` aborts the iteration of the array
|
||||
|
||||
```smarty
|
||||
{$data = [1,2,3,4,5]}
|
||||
{foreach $data as $value}
|
||||
{if $value == 3}
|
||||
{* abort iterating the array *}
|
||||
{break}
|
||||
{/if}
|
||||
{$value}
|
||||
{/foreach}
|
||||
{*
|
||||
prints: 1 2
|
||||
*}
|
||||
```
|
||||
|
||||
## {continue}
|
||||
|
||||
`{continue}` leaves the current iteration and begins with the next
|
||||
iteration.
|
||||
|
||||
```smarty
|
||||
{$data = [1,2,3,4,5]}
|
||||
{foreach $data as $value}
|
||||
{if $value == 3}
|
||||
{* skip this iteration *}
|
||||
{continue}
|
||||
{/if}
|
||||
{$value}
|
||||
{/foreach}
|
||||
{*
|
||||
prints: 1 2 4 5
|
||||
*}
|
||||
```
|
||||
@@ -1,89 +0,0 @@
|
||||
# {function}
|
||||
|
||||
`{function}` is used to create functions within a template and call them
|
||||
just like a plugin function. Instead of writing a plugin that generates
|
||||
presentational content, keeping it in the template is often a more
|
||||
manageable choice. It also simplifies data traversal, such as deeply
|
||||
nested menus.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Template functions are defined global. Since the Smarty compiler is a
|
||||
> single-pass compiler, The [`{call}`](#language.function.call) tag must
|
||||
> be used to call a template function defined externally from the given
|
||||
> template. Otherwise, you can directly use the function as
|
||||
> `{funcname ...}` in the template.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|---------------------------------------------------------------|
|
||||
| name | Yes | The name of the template function |
|
||||
| \[var \...\] | No | default variable value to pass local to the template function |
|
||||
|
||||
- The `{function}` tag must have the `name` attribute which contains
|
||||
the name of the template function. A tag with this name can be
|
||||
used to call the template function.
|
||||
|
||||
- Default values for variables can be passed to the template function
|
||||
as [attributes](../language-basic-syntax/language-syntax-attributes.md). Like in PHP function
|
||||
declarations you can only use scalar values as default. The default
|
||||
values can be overwritten when the template function is being
|
||||
called.
|
||||
|
||||
- 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.
|
||||
|
||||
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> You can pass any number of parameter to the template function when it
|
||||
> is called. The parameter variables must not be declared in the
|
||||
> `{funcname ...}` tag unless you what to use default values. Default
|
||||
> values must be scalar and can not be variable. Variables must be
|
||||
> passed when the template is called.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{* define the function *}
|
||||
{function name=menu level=0}
|
||||
{function menu level=0} {* short-hand *}
|
||||
<ul class="level{$level}">
|
||||
{foreach $data as $entry}
|
||||
{if is_array($entry)}
|
||||
<li>{$entry@key}</li>
|
||||
{menu data=$entry level=$level+1}
|
||||
{else}
|
||||
<li>{$entry}</li>
|
||||
{/if}
|
||||
{/foreach}
|
||||
</ul>
|
||||
{/function}
|
||||
|
||||
{* create an array to demonstrate *}
|
||||
{$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>
|
||||
['item3-3-1','item3-3-2']],'item4']}
|
||||
|
||||
{* run the array through the function *}
|
||||
{menu data=$menu}
|
||||
```
|
||||
|
||||
Will generate the following output
|
||||
|
||||
```
|
||||
* item1
|
||||
* item2
|
||||
* item3
|
||||
o item3-1
|
||||
o item3-2
|
||||
o item3-3
|
||||
+ item3-3-1
|
||||
+ item3-3-2
|
||||
* item4
|
||||
```
|
||||
|
||||
See also [`{call}`](./language-function-call.md)
|
||||
@@ -1,92 +0,0 @@
|
||||
# {if},{elseif},{else}
|
||||
|
||||
`{if}` statements in Smarty have much the same flexibility as PHP
|
||||
[if](https://www.php.net/if) statements, with a few added features for the
|
||||
template engine. Every `{if}` must be paired with a matching `{/if}`.
|
||||
`{else}` and `{elseif}` are also permitted. All [operators](../language-basic-syntax/language-syntax-operators.md) are recognized, such as *==*,
|
||||
*\|\|*, *or*, *&&*, *and*, etc and you can use modifiers as functions, such as *is_array()*.
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
{if $name eq 'Fred'}
|
||||
Welcome Sir.
|
||||
{elseif $name eq 'Wilma'}
|
||||
Welcome Ma'am.
|
||||
{else}
|
||||
Welcome, whatever you are.
|
||||
{/if}
|
||||
|
||||
{* an example with "or" logic *}
|
||||
{if $name eq 'Fred' or $name eq 'Wilma'}
|
||||
...
|
||||
{/if}
|
||||
|
||||
{* same as above *}
|
||||
{if $name == 'Fred' || $name == 'Wilma'}
|
||||
...
|
||||
{/if}
|
||||
|
||||
|
||||
{* parenthesis are allowed *}
|
||||
{if ( $amount < 0 or $amount > 1000 ) and $volume >= #minVolAmt#}
|
||||
...
|
||||
{/if}
|
||||
|
||||
|
||||
{* you can also embed php function calls *}
|
||||
{if count($var) gt 0}
|
||||
...
|
||||
{/if}
|
||||
|
||||
{* check for array. *}
|
||||
{if is_array($foo) }
|
||||
.....
|
||||
{/if}
|
||||
|
||||
{* check for not null. *}
|
||||
{if isset($foo) }
|
||||
.....
|
||||
{/if}
|
||||
|
||||
|
||||
{* test if values are even or odd *}
|
||||
{if $var is even}
|
||||
...
|
||||
{/if}
|
||||
{if $var is odd}
|
||||
...
|
||||
{/if}
|
||||
{if $var is not odd}
|
||||
...
|
||||
{/if}
|
||||
|
||||
|
||||
{* test if var is divisible by 4 *}
|
||||
{if $var is div by 4}
|
||||
...
|
||||
{/if}
|
||||
|
||||
|
||||
{*
|
||||
test if var is even, grouped by two. i.e.,
|
||||
0=even, 1=even, 2=odd, 3=odd, 4=even, 5=even, etc.
|
||||
*}
|
||||
{if $var is even by 2}
|
||||
...
|
||||
{/if}
|
||||
|
||||
{* 0=even, 1=even, 2=even, 3=odd, 4=odd, 5=odd, etc. *}
|
||||
{if $var is even by 3}
|
||||
...
|
||||
{/if}
|
||||
|
||||
{if isset($name) && $name == 'Blog'}
|
||||
{* do something *}
|
||||
{elseif $name == $foo}
|
||||
{* do something *}
|
||||
{/if}
|
||||
|
||||
{if is_array($foo) && count($foo) > 0}
|
||||
{* do a foreach loop *}
|
||||
{/if}
|
||||
```
|
||||
@@ -1,187 +0,0 @@
|
||||
# {include}
|
||||
|
||||
`{include}` tags are used for including other templates in the current
|
||||
template. Any variables available in the current template are also
|
||||
available within the included template.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|--------------------------------------------------------------------------------------------|
|
||||
| file | Yes | The name of the template file to include |
|
||||
| assign | No | The name of the variable that the output of include will be assigned to |
|
||||
| cache_lifetime | No | Enable caching of this subtemplate with an individual cache lifetime |
|
||||
| compile_id | No | Compile this subtemplate with an individual compile_id |
|
||||
| cache_id | No | Enable caching of this subtemplate with an individual cache_id |
|
||||
| scope | No | Define the scope of all in the subtemplate assigned variables: 'parent','root' or 'global' |
|
||||
| \[var \...\] | No | variable to pass local to template |
|
||||
|
||||
|
||||
- The `{include}` tag must have the `file` attribute which contains
|
||||
the template resource path.
|
||||
|
||||
- Setting the optional `assign` attribute specifies the template
|
||||
variable that the output of `{include}` is assigned to, instead of
|
||||
being displayed. Similar to [`{assign}`](./language-function-assign.md).
|
||||
|
||||
- Variables can be passed to included templates as
|
||||
[attributes](../language-basic-syntax/language-syntax-attributes.md). Any variables explicitly
|
||||
passed to an included template are only available within the scope
|
||||
of the included file. Attribute variables override current template
|
||||
variables, in the case when they are named the same.
|
||||
|
||||
- You can use all variables from the including template inside the
|
||||
included template. But changes to variables or new created variables
|
||||
inside the included template have local scope and are not visible
|
||||
inside the including template after the `{include}` statement. This
|
||||
default behaviour can be changed for all variables assigned in the
|
||||
included template by using the scope attribute at the `{include}`
|
||||
statement or for individual variables by using the scope attribute
|
||||
at the [`{assign}`](./language-function-assign.md) statement. The later
|
||||
is useful to return values from the included template to the
|
||||
including template.
|
||||
|
||||
- Use the syntax for [template resources](../../api/resources.md) to `{include}`
|
||||
files outside of the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md)
|
||||
directory.
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|--------------------------------------------------------------------------------------|
|
||||
| nocache | Disables caching of this subtemplate |
|
||||
| caching | Enable caching of this subtemplate |
|
||||
| inline | If set, merge the compile-code of the subtemplate into the compiled calling template |
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
<html>
|
||||
<head>
|
||||
<title>{$title}</title>
|
||||
</head>
|
||||
<body>
|
||||
{include file='page_header.tpl'}
|
||||
|
||||
{* body of template goes here, the $tpl_name variable
|
||||
is replaced with a value eg 'contact.tpl'
|
||||
*}
|
||||
{include file="$tpl_name.tpl"}
|
||||
|
||||
{* using shortform file attribute *}
|
||||
{include 'page_footer.tpl'}
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
```smarty
|
||||
|
||||
{include 'links.tpl' title='Newest links' links=$link_array}
|
||||
{* body of template goes here *}
|
||||
{include 'footer.tpl' foo='bar'}
|
||||
|
||||
```
|
||||
|
||||
The template above includes the example `links.tpl` below
|
||||
|
||||
```smarty
|
||||
<div id="box">
|
||||
<h3>{$title}</h3>
|
||||
<ul>
|
||||
{foreach from=$links item=l}
|
||||
.. do stuff ...
|
||||
{/foreach}
|
||||
</ul>
|
||||
</div>
|
||||
```
|
||||
Variables assigned in the included template will be seen in the
|
||||
including template.
|
||||
|
||||
```smarty
|
||||
{include 'sub_template.tpl' scope=parent}
|
||||
...
|
||||
{* display variables assigned in sub_template *}
|
||||
{$foo}<br>
|
||||
{$bar}<br>
|
||||
...
|
||||
```
|
||||
|
||||
The template above includes the example `sub_template.tpl` below
|
||||
|
||||
```smarty
|
||||
...
|
||||
{assign var=foo value='something'}
|
||||
{assign var=bar value='value'}
|
||||
...
|
||||
```
|
||||
|
||||
The included template will not be cached.
|
||||
|
||||
```smarty
|
||||
{include 'sub_template.tpl' nocache}
|
||||
...
|
||||
```
|
||||
|
||||
In this example included template will be cached with an individual
|
||||
cache lifetime of 500 seconds.
|
||||
|
||||
```smarty
|
||||
{include 'sub_template.tpl' cache_lifetime=500}
|
||||
...
|
||||
```
|
||||
|
||||
In this example included template will be cached independent of the
|
||||
global caching setting.
|
||||
|
||||
```smarty
|
||||
{include 'sub_template.tpl' caching}
|
||||
...
|
||||
```
|
||||
|
||||
This example assigns the contents of `nav.tpl` to the `$navbar`
|
||||
variable, which is then output at both the top and bottom of the page.
|
||||
|
||||
```smarty
|
||||
<body>
|
||||
{include 'nav.tpl' assign=navbar}
|
||||
{include 'header.tpl' title='Smarty is cool'}
|
||||
{$navbar}
|
||||
{* body of template goes here *}
|
||||
{$navbar}
|
||||
{include 'footer.tpl'}
|
||||
</body>
|
||||
```
|
||||
|
||||
This example includes another template relative to the directory of the
|
||||
current template.
|
||||
|
||||
```smarty
|
||||
{include 'template-in-a-template_dir-directory.tpl'}
|
||||
{include './template-in-same-directory.tpl'}
|
||||
{include '../template-in-parent-directory.tpl'}
|
||||
```
|
||||
|
||||
```smarty
|
||||
{* absolute filepath *}
|
||||
{include file='/usr/local/include/templates/header.tpl'}
|
||||
|
||||
{* absolute filepath (same thing) *}
|
||||
{include file='file:/usr/local/include/templates/header.tpl'}
|
||||
|
||||
{* windows absolute filepath (MUST use "file:" prefix) *}
|
||||
{include file='file:C:/www/pub/templates/header.tpl'}
|
||||
|
||||
{* include from template resource named "db" *}
|
||||
{include file='db:header.tpl'}
|
||||
|
||||
{* include a $variable template - eg $module = 'contacts' *}
|
||||
{include file="$module.tpl"}
|
||||
|
||||
{* wont work as its single quotes ie no variable substitution *}
|
||||
{include file='$module.tpl'}
|
||||
|
||||
{* include a multi $variable template - eg amber/links.view.tpl *}
|
||||
{include file="$style_dir/$module.$view.tpl"}
|
||||
```
|
||||
|
||||
See also [template resources](../../api/resources.md) and
|
||||
[componentized templates](../../appendixes/tips.md#componentized-templates).
|
||||
@@ -1,51 +0,0 @@
|
||||
# {ldelim}, {rdelim}
|
||||
|
||||
`{ldelim}` and `{rdelim}` are used for [escaping](../language-basic-syntax/language-escaping.md)
|
||||
template delimiters, by default **{** and **}**. You can also use
|
||||
[`{literal}{/literal}`](./language-function-literal.md) to escape blocks of
|
||||
text eg Javascript or CSS. See also the complementary
|
||||
[`{$smarty.ldelim}`](../../designers/language-basic-syntax/language-escaping.md).
|
||||
|
||||
```smarty
|
||||
{* this will print literal delimiters out of the template *}
|
||||
|
||||
{ldelim}funcname{rdelim} is how functions look in Smarty!
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
{funcname} is how functions look in Smarty!
|
||||
```
|
||||
|
||||
Another example with some Javascript
|
||||
|
||||
```smarty
|
||||
<script>
|
||||
function foo() {ldelim}
|
||||
... code ...
|
||||
{rdelim}
|
||||
</script>
|
||||
```
|
||||
|
||||
will output
|
||||
|
||||
```html
|
||||
<script>
|
||||
function foo() {
|
||||
.... code ...
|
||||
}
|
||||
</script>
|
||||
```
|
||||
|
||||
```smarty
|
||||
<script>
|
||||
function myJsFunction(){ldelim}
|
||||
alert("The server name\n{$smarty.server.SERVER_NAME|escape:javascript}\n{$smarty.server.SERVER_ADDR|escape:javascript}");
|
||||
{rdelim}
|
||||
</script>
|
||||
<a href="javascript:myJsFunction()">Click here for Server Info</a>
|
||||
```
|
||||
|
||||
See also [`{literal}`](./language-function-literal.md) and [escaping Smarty
|
||||
parsing](../language-basic-syntax/language-escaping.md).
|
||||
@@ -1,34 +0,0 @@
|
||||
# {literal}
|
||||
|
||||
`{literal}` tags allow a block of data to be taken literally. This is
|
||||
typically used around Javascript or stylesheet blocks where {curly
|
||||
braces} would interfere with the template
|
||||
[delimiter](../../designers/language-basic-syntax/language-escaping.md) syntax. Anything within
|
||||
`{literal}{/literal}` tags is not interpreted, but displayed as-is. If
|
||||
you need template tags embedded in a `{literal}` block, consider using
|
||||
[`{ldelim}{rdelim}`](./language-function-ldelim.md) to escape the individual
|
||||
delimiters instead.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> `{literal}{/literal}` tags are normally not necessary, as Smarty
|
||||
> ignores delimiters that are surrounded by whitespace. Be sure your
|
||||
> javascript and CSS curly braces are surrounded by whitespace. This is
|
||||
> new behavior to Smarty 3.
|
||||
|
||||
```smarty
|
||||
<script>
|
||||
// the following braces are ignored by Smarty
|
||||
// since they are surrounded by whitespace
|
||||
function myFoo {
|
||||
alert('Foo!');
|
||||
}
|
||||
// this one will need literal escapement
|
||||
{literal}
|
||||
function myBar {alert('Bar!');}
|
||||
{/literal}
|
||||
</script>
|
||||
```
|
||||
|
||||
See also [`{ldelim} {rdelim}`](./language-function-ldelim.md) and the
|
||||
[escaping Smarty parsing](../language-basic-syntax/language-escaping.md) page.
|
||||
@@ -1,20 +0,0 @@
|
||||
# {nocache}
|
||||
|
||||
`{nocache}` is used to disable caching of a template section. Every
|
||||
`{nocache}` must be paired with a matching `{/nocache}`.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Be sure any variables used within a non-cached section are also
|
||||
> assigned from PHP when the page is loaded from the cache.
|
||||
|
||||
```smarty
|
||||
Today's date is
|
||||
{nocache}
|
||||
{$smarty.now|date_format}
|
||||
{/nocache}
|
||||
```
|
||||
|
||||
The above code will output the current date on a cached page.
|
||||
|
||||
See also the [caching section](../../api/caching/basics.md).
|
||||
@@ -1,610 +0,0 @@
|
||||
# {section}, {sectionelse}
|
||||
|
||||
A `{section}` is for looping over **sequentially indexed arrays of
|
||||
data**, unlike [`{foreach}`](./language-function-foreach.md) which is used
|
||||
to loop over a **single associative array**. Every `{section}` tag must
|
||||
be paired with a closing `{/section}` tag.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The [`{foreach}`](./language-function-foreach.md) loop can do everything a
|
||||
> {section} loop can do, and has a simpler and easier syntax. It is
|
||||
> usually preferred over the {section} loop.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> {section} loops cannot loop over associative arrays, they must be
|
||||
> numerically indexed, and sequential (0,1,2,\...). For associative
|
||||
> arrays, use the [`{foreach}`](./language-function-foreach.md) loop.
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| name | Yes | The name of the section |
|
||||
| loop | Yes | Value to determine the number of loop iterations |
|
||||
| start | No | The index position that the section will begin looping. If the value is negative, the start position is calculated from the end of the array. For example, if there are seven values in the loop array and start is -2, the start index is 5. Invalid values (values outside of the length of the loop array) are automatically truncated to the closest valid value. Defaults to 0. |
|
||||
| step | No | The step value that will be used to traverse the loop array. For example, step=2 will loop on index 0, 2, 4, etc. If step is negative, it will step through the array backwards. Defaults to 1. |
|
||||
| max | No | Sets the maximum number of times the section will loop. |
|
||||
| show | No | Determines whether to show this section (defaults to true) |
|
||||
|
||||
## Option Flags
|
||||
|
||||
| Name | Description |
|
||||
|---------|------------------------------------------|
|
||||
| nocache | Disables caching of the `{section}` loop |
|
||||
|
||||
- Required attributes are `name` and `loop`.
|
||||
|
||||
- The `name` of the `{section}` can be anything you like, made up of
|
||||
letters, numbers and underscores, like [PHP
|
||||
variables](https://www.php.net/language.variables).
|
||||
|
||||
- {section}'s can be nested, and the nested `{section}` names must be
|
||||
unique from each other.
|
||||
|
||||
- The `loop` attribute, usually an array of values, determines the
|
||||
number of times the `{section}` will loop. You can also pass an
|
||||
integer as the loop value.
|
||||
|
||||
- When printing a variable within a `{section}`, the `{section}`
|
||||
`name` must be given next to variable name within \[brackets\].
|
||||
|
||||
- `{sectionelse}` is executed when there are no values in the loop
|
||||
variable.
|
||||
|
||||
- A `{section}` also has its own variables that handle `{section}`
|
||||
properties. These properties are accessible as:
|
||||
[`{$smarty.section.name.property}`](../language-variables/language-variables-smarty.md#smartysection-languagevariablessmartyloops)
|
||||
where "name" is the attribute `name`.
|
||||
|
||||
- `{section}` properties are [`index`](#index),
|
||||
[`index_prev`](#index_prev),
|
||||
[`index_next`](#index_next),
|
||||
[`iteration`](#iteration),
|
||||
[`first`](#first),
|
||||
[`last`](#last),
|
||||
[`rownum`](#rownum),
|
||||
[`loop`](#loop), [`show`](#show),
|
||||
[`total`](#total).
|
||||
|
||||
[`assign()`](../../programmers/api-functions/api-assign.md) an array to Smarty
|
||||
|
||||
## Examples
|
||||
|
||||
```php
|
||||
<?php
|
||||
$data = [1000, 1001, 1002];
|
||||
$smarty->assign('custid', $data);
|
||||
```
|
||||
|
||||
The template that outputs the array
|
||||
|
||||
```smarty
|
||||
{* this example will print out all the values of the $custid array *}
|
||||
{section name=customer loop=$custid}
|
||||
{section customer $custid} {* short-hand *}
|
||||
id: {$custid[customer]}<br />
|
||||
{/section}
|
||||
<hr />
|
||||
{* print out all the values of the $custid array reversed *}
|
||||
{section name=foo loop=$custid step=-1}
|
||||
{section foo $custid step=-1} {* short-hand *}
|
||||
{$custid[foo]}<br />
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
id: 1000<br />
|
||||
id: 1001<br />
|
||||
id: 1002<br />
|
||||
<hr />
|
||||
id: 1002<br />
|
||||
id: 1001<br />
|
||||
id: 1000<br />
|
||||
```
|
||||
|
||||
```smarty
|
||||
{section name=foo start=10 loop=20 step=2}
|
||||
{$smarty.section.foo.index}
|
||||
{/section}
|
||||
<hr />
|
||||
{section name=bar loop=21 max=6 step=-2}
|
||||
{$smarty.section.bar.index}
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
10 12 14 16 18
|
||||
<hr />
|
||||
20 18 16 14 12 10
|
||||
```
|
||||
|
||||
The `name` of the `{section}` can be anything you like, see [PHP
|
||||
variables](https://www.php.net/language.variables). It is used to reference
|
||||
the data within the `{section}`.
|
||||
|
||||
```smarty
|
||||
{section name=anything loop=$myArray}
|
||||
{$myArray[anything].foo}
|
||||
{$name[anything]}
|
||||
{$address[anything].bar}
|
||||
{/section}
|
||||
```
|
||||
|
||||
This is an example of printing an associative array of data with a
|
||||
`{section}`. Following is the php script to assign the `$contacts` array
|
||||
to Smarty.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$data = [
|
||||
['name' => 'John Smith', 'home' => '555-555-5555',
|
||||
'cell' => '666-555-5555', 'email' => 'john@myexample.com'],
|
||||
['name' => 'Jack Jones', 'home' => '777-555-5555',
|
||||
'cell' => '888-555-5555', 'email' => 'jack@myexample.com'],
|
||||
['name' => 'Jane Munson', 'home' => '000-555-5555',
|
||||
'cell' => '123456', 'email' => 'jane@myexample.com']
|
||||
];
|
||||
$smarty->assign('contacts',$data);
|
||||
```
|
||||
|
||||
The template to output `$contacts`
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$contacts}
|
||||
<p>
|
||||
name: {$contacts[customer].name}<br />
|
||||
home: {$contacts[customer].home}<br />
|
||||
cell: {$contacts[customer].cell}<br />
|
||||
e-mail: {$contacts[customer].email}
|
||||
</p>
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<p>
|
||||
name: John Smith<br />
|
||||
home: 555-555-5555<br />
|
||||
cell: 666-555-5555<br />
|
||||
e-mail: john@myexample.com
|
||||
</p>
|
||||
<p>
|
||||
name: Jack Jones<br />
|
||||
home phone: 777-555-5555<br />
|
||||
cell phone: 888-555-5555<br />
|
||||
e-mail: jack@myexample.com
|
||||
</p>
|
||||
<p>
|
||||
name: Jane Munson<br />
|
||||
home phone: 000-555-5555<br />
|
||||
cell phone: 123456<br />
|
||||
e-mail: jane@myexample.com
|
||||
</p>
|
||||
```
|
||||
|
||||
This example assumes that `$custid`, `$name` and `$address` are all
|
||||
arrays containing the same number of values. First the php script that
|
||||
assign's the arrays to Smarty.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$id = [1001,1002,1003];
|
||||
$smarty->assign('custid',$id);
|
||||
|
||||
$fullnames = ['John Smith','Jack Jones','Jane Munson'];
|
||||
$smarty->assign('name',$fullnames);
|
||||
|
||||
$addr = ['253 Abbey road', '417 Mulberry ln', '5605 apple st'];
|
||||
$smarty->assign('address',$addr);
|
||||
```
|
||||
|
||||
The `loop` variable only determines the number of times to loop. You can
|
||||
access ANY variable from the template within the `{section}`. This is
|
||||
useful for looping multiple arrays. You can pass an array which will
|
||||
determine the loop count by the array size, or you can pass an integer
|
||||
to specify the number of loops.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$custid}
|
||||
<p>
|
||||
id: {$custid[customer]}<br />
|
||||
name: {$name[customer]}<br />
|
||||
address: {$address[customer]}
|
||||
</p>
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<p>
|
||||
id: 1000<br />
|
||||
name: John Smith<br />
|
||||
address: 253 Abbey road
|
||||
</p>
|
||||
<p>
|
||||
id: 1001<br />
|
||||
name: Jack Jones<br />
|
||||
address: 417 Mulberry ln
|
||||
</p>
|
||||
<p>
|
||||
id: 1002<br />
|
||||
name: Jane Munson<br />
|
||||
address: 5605 apple st
|
||||
</p>
|
||||
```
|
||||
|
||||
{section}'s can be nested as deep as you like. With nested
|
||||
{section}'s, you can access complex data structures, such as
|
||||
multidimensional arrays. This is an example `.php` script that
|
||||
assigns the arrays.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$id = [1001,1002,1003];
|
||||
$smarty->assign('custid',$id);
|
||||
|
||||
$fullnames = ['John Smith','Jack Jones','Jane Munson'];
|
||||
$smarty->assign('name',$fullnames);
|
||||
|
||||
$addr = ['253 N 45th', '417 Mulberry ln', '5605 apple st'];
|
||||
$smarty->assign('address',$addr);
|
||||
|
||||
$types = [
|
||||
[ 'home phone', 'cell phone', 'e-mail'],
|
||||
[ 'home phone', 'web'],
|
||||
[ 'cell phone']
|
||||
];
|
||||
$smarty->assign('contact_type', $types);
|
||||
|
||||
$info = [
|
||||
['555-555-5555', '666-555-5555', 'john@myexample.com'],
|
||||
[ '123-456-4', 'www.example.com'],
|
||||
[ '0457878']
|
||||
];
|
||||
$smarty->assign('contact_info', $info);
|
||||
```
|
||||
|
||||
In this template, *$contact_type\[customer\]* is an array of contact
|
||||
types for the current customer.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$custid}
|
||||
<hr>
|
||||
id: {$custid[customer]}<br />
|
||||
name: {$name[customer]}<br />
|
||||
address: {$address[customer]}<br />
|
||||
{section name=contact loop=$contact_type[customer]}
|
||||
{$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br />
|
||||
{/section}
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<hr>
|
||||
id: 1000<br />
|
||||
name: John Smith<br />
|
||||
address: 253 N 45th<br />
|
||||
home phone: 555-555-5555<br />
|
||||
cell phone: 666-555-5555<br />
|
||||
e-mail: john@myexample.com<br />
|
||||
<hr>
|
||||
id: 1001<br />
|
||||
name: Jack Jones<br />
|
||||
address: 417 Mulberry ln<br />
|
||||
home phone: 123-456-4<br />
|
||||
web: www.example.com<br />
|
||||
<hr>
|
||||
id: 1002<br />
|
||||
name: Jane Munson<br />
|
||||
address: 5605 apple st<br />
|
||||
cell phone: 0457878<br />
|
||||
```
|
||||
|
||||
Results of a database search (eg ADODB or PEAR) are assigned to Smarty
|
||||
|
||||
```php
|
||||
<?php
|
||||
$sql = 'select id, name, home, cell, email from contacts '
|
||||
."where name like '$foo%' ";
|
||||
$smarty->assign('contacts', $db->getAll($sql));
|
||||
```
|
||||
|
||||
The template to output the database result in a HTML table
|
||||
|
||||
```smarty
|
||||
<table>
|
||||
<tr><th> </th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>
|
||||
{section name=co loop=$contacts}
|
||||
<tr>
|
||||
<td><a href="view.php?id={$contacts[co].id}">view</a></td>
|
||||
<td>{$contacts[co].name}</td>
|
||||
<td>{$contacts[co].home}</td>
|
||||
<td>{$contacts[co].cell}</td>
|
||||
<td>{$contacts[co].email}</td>
|
||||
<tr>
|
||||
{sectionelse}
|
||||
<tr><td colspan="5">No items found</td></tr>
|
||||
{/section}
|
||||
</table>
|
||||
```
|
||||
|
||||
## .index
|
||||
`index` contains the current array index, starting with zero or the
|
||||
`start` attribute if given. It increments by one or by the `step`
|
||||
attribute if given.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> If the `step` and `start` properties are not modified, then this works
|
||||
> the same as the [`iteration`](#iteration) property,
|
||||
> except it starts at zero instead of one.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> `$custid[customer.index]` and `$custid[customer]` are identical.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$custid}
|
||||
{$smarty.section.customer.index} id: {$custid[customer]}<br />
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
0 id: 1000<br />
|
||||
1 id: 1001<br />
|
||||
2 id: 1002<br />
|
||||
```
|
||||
|
||||
|
||||
## .index_prev
|
||||
|
||||
`index_prev` is the previous loop index. On the first loop, this is set to -1.
|
||||
|
||||
## .index_next
|
||||
|
||||
`index_next` is the next loop index. On the last loop, this is still one
|
||||
more than the current index, respecting the setting of the `step`
|
||||
attribute, if given.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$data = [1001,1002,1003,1004,1005];
|
||||
$smarty->assign('rows',$data);
|
||||
```
|
||||
|
||||
Template to output the above array in a table
|
||||
|
||||
```smarty
|
||||
{* $rows[row.index] and $rows[row] are identical in meaning *}
|
||||
<table>
|
||||
<tr>
|
||||
<th>index</th><th>id</th>
|
||||
<th>index_prev</th><th>prev_id</th>
|
||||
<th>index_next</th><th>next_id</th>
|
||||
</tr>
|
||||
{section name=row loop=$rows}
|
||||
<tr>
|
||||
<td>{$smarty.section.row.index}</td><td>{$rows[row]}</td>
|
||||
<td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td>
|
||||
<td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td>
|
||||
</tr>
|
||||
{/section}
|
||||
</table>
|
||||
```
|
||||
|
||||
The above example will output a table containing the following:
|
||||
|
||||
```
|
||||
index id index_prev prev_id index_next next_id
|
||||
0 1001 -1 1 1002
|
||||
1 1002 0 1001 2 1003
|
||||
2 1003 1 1002 3 1004
|
||||
3 1004 2 1003 4 1005
|
||||
4 1005 3 1004 5
|
||||
```
|
||||
|
||||
## .iteration
|
||||
|
||||
`iteration` contains the current loop iteration and starts at one.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> This is not affected by the `{section}` properties `start`, `step` and
|
||||
> `max`, unlike the [`index`](#index) property.
|
||||
> `iteration` also starts with one instead of zero unlike `index`.
|
||||
> [`rownum`](#rownum) is an alias to `iteration`, they
|
||||
> are identical.
|
||||
|
||||
```php
|
||||
<?php
|
||||
// array of 3000 to 3015
|
||||
$id = range(3000,3015);
|
||||
$smarty->assign('arr', $id);
|
||||
```
|
||||
|
||||
Template to output every other element of the `$arr` array as `step=2`
|
||||
|
||||
```smarty
|
||||
{section name=cu loop=$arr start=5 step=2}
|
||||
iteration={$smarty.section.cu.iteration}
|
||||
index={$smarty.section.cu.index}
|
||||
id={$custid[cu]}<br />
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
iteration=1 index=5 id=3005<br />
|
||||
iteration=2 index=7 id=3007<br />
|
||||
iteration=3 index=9 id=3009<br />
|
||||
iteration=4 index=11 id=3011<br />
|
||||
iteration=5 index=13 id=3013<br />
|
||||
iteration=6 index=15 id=3015<br />
|
||||
```
|
||||
|
||||
Another example that uses the `iteration` property to output a table
|
||||
header block every five rows.
|
||||
|
||||
```smarty
|
||||
<table>
|
||||
{section name=co loop=$contacts}
|
||||
{if $smarty.section.co.iteration is div by 5}
|
||||
<tr><th> </th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>
|
||||
{/if}
|
||||
<tr>
|
||||
<td><a href="view.php?id={$contacts[co].id}">view<a></td>
|
||||
<td>{$contacts[co].name}</td>
|
||||
<td>{$contacts[co].home}</td>
|
||||
<td>{$contacts[co].cell}</td>
|
||||
<td>{$contacts[co].email}</td>
|
||||
<tr>
|
||||
{/section}
|
||||
</table>
|
||||
```
|
||||
|
||||
An example that uses the `index` property to alternate a text color every
|
||||
third row.
|
||||
|
||||
```smarty
|
||||
<table>
|
||||
{section name=co loop=$contacts}
|
||||
{if $smarty.section.co.index is even by 3}
|
||||
<span style="color: #ffffff">{$contacts[co].name}</span>
|
||||
{else}
|
||||
<span style="color: #dddddd">{$contacts[co].name}</span>
|
||||
{/if}
|
||||
{/section}
|
||||
</table>
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The *"is div by"* syntax is a simpler alternative to the PHP mod
|
||||
> operator syntax. The mod operator is allowed:
|
||||
> `{if $smarty.section.co.iteration % 5 == 1}` will work just the same.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> You can also use *"is odd by"* to reverse the alternating.
|
||||
|
||||
## .first
|
||||
|
||||
`first` is set to TRUE if the current `{section}` iteration is the initial one.
|
||||
|
||||
## .last
|
||||
|
||||
`last` is set to TRUE if the current section iteration is the final one.
|
||||
|
||||
This example loops the `$customers` array, outputs a header block on the
|
||||
first iteration and on the last outputs the footer block. Also uses the
|
||||
[`total`](#total) property.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$customers}
|
||||
{if $smarty.section.customer.first}
|
||||
<table>
|
||||
<tr><th>id</th><th>customer</th></tr>
|
||||
{/if}
|
||||
|
||||
<tr>
|
||||
<td>{$customers[customer].id}}</td>
|
||||
<td>{$customers[customer].name}</td>
|
||||
</tr>
|
||||
|
||||
{if $smarty.section.customer.last}
|
||||
<tr><td></td><td>{$smarty.section.customer.total} customers</td></tr>
|
||||
</table>
|
||||
{/if}
|
||||
{/section}
|
||||
```
|
||||
|
||||
## .rownum
|
||||
|
||||
`rownum` contains the current loop iteration, starting with one. It is
|
||||
an alias to [`iteration`](#iteration), they work
|
||||
identically.
|
||||
|
||||
## .loop
|
||||
|
||||
`loop` contains the last index number that this {section} looped. This
|
||||
can be used inside or after the `{section}`.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$custid}
|
||||
{$smarty.section.customer.index} id: {$custid[customer]}<br />
|
||||
{/section}
|
||||
There are {$smarty.section.customer.loop} customers shown above.
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
0 id: 1000<br />
|
||||
1 id: 1001<br />
|
||||
2 id: 1002<br />
|
||||
There are 3 customers shown above.
|
||||
```
|
||||
|
||||
## .show
|
||||
|
||||
`show` is used as a parameter to section and is a boolean value. If
|
||||
FALSE, the section will not be displayed. If there is a `{sectionelse}`
|
||||
present, that will be alternately displayed.
|
||||
|
||||
Boolean `$show_customer_info` has been passed from the PHP application,
|
||||
to regulate whether this section shows.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$customers show=$show_customer_info}
|
||||
{$smarty.section.customer.rownum} id: {$customers[customer]}<br />
|
||||
{/section}
|
||||
|
||||
{if $smarty.section.customer.show}
|
||||
the section was shown.
|
||||
{else}
|
||||
the section was not shown.
|
||||
{/if}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
1 id: 1000<br />
|
||||
2 id: 1001<br />
|
||||
3 id: 1002<br />
|
||||
|
||||
the section was shown.
|
||||
```
|
||||
|
||||
|
||||
## .total
|
||||
|
||||
`total` contains the number of iterations that this `{section}` will
|
||||
loop. This can be used inside or after a `{section}`.
|
||||
|
||||
```smarty
|
||||
{section name=customer loop=$custid step=2}
|
||||
{$smarty.section.customer.index} id: {$custid[customer]}<br />
|
||||
{/section}
|
||||
There are {$smarty.section.customer.total} customers shown above.
|
||||
```
|
||||
|
||||
See also [`{foreach}`](./language-function-foreach.md),
|
||||
[`{for}`](./language-function-for.md), [`{while}`](./language-function-while.md)
|
||||
and [`$smarty.section`](../language-variables/language-variables-smarty.md#smartysection-languagevariablessmartyloops).
|
||||
@@ -1,43 +0,0 @@
|
||||
# {setfilter}
|
||||
|
||||
The `{setfilter}...{/setfilter}` block tag allows the definition of
|
||||
template instance's variable filters.
|
||||
|
||||
SYNTAX: `{setfilter filter1\|filter2\|filter3\....}\...{/setfilter}`
|
||||
|
||||
The filter can be:
|
||||
|
||||
- A variable filter plugin specified by it's name.
|
||||
|
||||
- A modifier specified by it's name and optional additional
|
||||
parameter.
|
||||
|
||||
`{setfilter}...{/setfilter}` blocks can be nested. The filter definition
|
||||
of inner blocks does replace the definition of the outer block.
|
||||
|
||||
Template instance filters run in addition to other modifiers and
|
||||
filters. They run in the following order: modifier, default_modifier,
|
||||
$escape_html, registered variable filters, autoloaded variable
|
||||
filters, template instance's variable filters. Everything after
|
||||
default_modifier can be disabled with the `nofilter` flag.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The setting of template instance filters does not affect the output of
|
||||
> included subtemplates.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
<script>
|
||||
{setfilter filter1}
|
||||
{$foo} {* filter1 runs on output of $foo *}
|
||||
{setfilter filter2|mod:true}
|
||||
{$bar} {* filter2 and modifier mod runs on output of $bar *}
|
||||
{/setfilter}
|
||||
{$buh} {* filter1 runs on output of $buh *}
|
||||
{/setfilter}
|
||||
{$blar} {* no template instance filter runs on output of $blar}
|
||||
</script>
|
||||
```
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
# {strip}
|
||||
|
||||
Many times web designers run into the issue where white space and
|
||||
carriage returns affect the output of the rendered HTML (browser
|
||||
"features"), so you must run all your tags together in the template to
|
||||
get the desired results. This usually ends up in unreadable or
|
||||
unmanageable templates.
|
||||
|
||||
Anything within `{strip}{/strip}` tags are stripped of the extra spaces
|
||||
or carriage returns at the beginnings and ends of the lines before they
|
||||
are displayed. This way you can keep your templates readable, and not
|
||||
worry about extra white space causing problems.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> `{strip}{/strip}` does not affect the contents of template variables,
|
||||
> see the [strip modifier](../language-modifiers/language-modifier-strip.md) instead.
|
||||
|
||||
```smarty
|
||||
{* the following will be all run into one line upon output *}
|
||||
{strip}
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="#">
|
||||
This is a test
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
{/strip}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```html
|
||||
<table><tr><td><a href="#">This is a test</a></td></tr></table>
|
||||
```
|
||||
|
||||
Notice that in the above example, all the lines begin and end with HTML
|
||||
tags. Be aware that all the lines are run together. If you have plain
|
||||
text at the beginning or end of any line, they will be run together, and
|
||||
may not be desired results.
|
||||
|
||||
See also the [`strip`](../language-modifiers/language-modifier-strip.md) modifier.
|
||||
@@ -1,20 +0,0 @@
|
||||
# {while}
|
||||
|
||||
`{while}` loops in Smarty have much the same flexibility as PHP
|
||||
[while](https://www.php.net/while) statements, with a few added features for
|
||||
the template engine. Every `{while}` must be paired with a matching
|
||||
`{/while}`. All [operators](../language-basic-syntax/language-syntax-operators.md) are recognized, such as *==*,
|
||||
*\|\|*, *or*, *&&*, *and*, etc and you can use modifiers as functions, such as *is_array()*.
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
{while $foo > 0}
|
||||
{$foo--}
|
||||
{/while}
|
||||
```
|
||||
|
||||
The above example will count down the value of $foo until 1 is reached.
|
||||
|
||||
See also [`{foreach}`](./language-function-foreach.md),
|
||||
[`{for}`](./language-function-for.md) and
|
||||
[`{section}`](./language-function-section.md).
|
||||
@@ -1,32 +0,0 @@
|
||||
# Combining Modifiers
|
||||
|
||||
You can apply any number of modifiers to a variable. They will be
|
||||
applied in the order they are combined, from left to right. They must be
|
||||
separated with a `|` (pipe) character.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');
|
||||
```
|
||||
|
||||
where template is:
|
||||
|
||||
```smarty
|
||||
{$articleTitle}
|
||||
{$articleTitle|upper|spacify}
|
||||
{$articleTitle|lower|spacify|truncate}
|
||||
{$articleTitle|lower|truncate:30|spacify}
|
||||
{$articleTitle|lower|spacify|truncate:30:". . ."}
|
||||
```
|
||||
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
Smokers are Productive, but Death Cuts Efficiency.
|
||||
S M O K E R S A R ....snip.... H C U T S E F F I C I E N C Y .
|
||||
s m o k e r s a r ....snip.... b u t d e a t h c u t s...
|
||||
s m o k e r s a r e p r o d u c t i v e , b u t . . .
|
||||
s m o k e r s a r e p. . .
|
||||
```
|
||||
@@ -1,19 +0,0 @@
|
||||
# Custom Tags
|
||||
|
||||
Smarty comes with several custom plugin functions that you can use in
|
||||
the templates.
|
||||
|
||||
- [{counter}](language-function-counter.md)
|
||||
- [{cycle}](language-function-cycle.md)
|
||||
- [{eval}](language-function-eval.md)
|
||||
- [{fetch}](language-function-fetch.md)
|
||||
- [{html_checkboxes}](language-function-html-checkboxes.md)
|
||||
- [{html_image}](language-function-html-image.md)
|
||||
- [{html_options}](language-function-html-options.md)
|
||||
- [{html_radios}](language-function-html-radios.md)
|
||||
- [{html_select_date}](language-function-html-select-date.md)
|
||||
- [{html_select_time}](language-function-html-select-time.md)
|
||||
- [{html_table}](language-function-html-table.md)
|
||||
- [{mailto}](language-function-mailto.md)
|
||||
- [{math}](language-function-math.md)
|
||||
- [{textformat}](language-function-textformat.md)
|
||||
@@ -1,45 +0,0 @@
|
||||
# {counter}
|
||||
|
||||
`{counter}` is used to print out a count. `{counter}` will remember the
|
||||
count on each iteration. You can adjust the number, the interval and the
|
||||
direction of the count, as well as determine whether to print the
|
||||
value. You can run multiple counters concurrently by supplying a unique
|
||||
name for each one. If you do not supply a name, the name "default" will
|
||||
be used.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|-----------------------------------------------------------|
|
||||
| name | No | The name of the counter |
|
||||
| start | No | The initial number to start counting from (defaults to 1) |
|
||||
| skip | No | The interval to count by (defaults to 1) |
|
||||
| direction | No | The direction to count (up/down) (defaults to 'up') |
|
||||
| print | No | Whether or not to print the value (defaults to true) |
|
||||
| assign | No | the template variable the output will be assigned to |
|
||||
|
||||
If you supply the `assign` attribute, the output of the `{counter}`
|
||||
function will be assigned to this template variable instead of being
|
||||
output to the template.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
|
||||
{* initialize the count *}
|
||||
{counter start=0 skip=2}<br />
|
||||
{counter}<br />
|
||||
{counter}<br />
|
||||
{counter}<br />
|
||||
|
||||
```
|
||||
|
||||
this will output:
|
||||
|
||||
```html
|
||||
0<br />
|
||||
2<br />
|
||||
4<br />
|
||||
6<br />
|
||||
```
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
# {cycle}
|
||||
|
||||
`{cycle}` is used to alternate a set of values. This makes it easy to
|
||||
for example, alternate between two or more colors in a table, or cycle
|
||||
through an array of values.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|-------------------------------------------------------------------------------------------------------------|
|
||||
| name | No | The name of the cycle |
|
||||
| values | Yes | The values to cycle through, either a comma delimited list (see delimiter attribute), or an array of values |
|
||||
| print | No | Whether to print the value or not (defaults to true) |
|
||||
| advance | No | Whether or not to advance to the next value (defaults to true) |
|
||||
| delimiter | No | The delimiter to use in the values attribute (defaults to ',') |
|
||||
| assign | No | The template variable the output will be assigned to |
|
||||
| reset | No | The cycle will be set to the first value and not advanced (defaults to false) |
|
||||
|
||||
- You can `{cycle}` through more than one set of values in a template
|
||||
by supplying a `name` attribute. Give each `{cycle}` a unique
|
||||
`name`.
|
||||
|
||||
- You can force the current value not to print with the `print`
|
||||
attribute set to FALSE. This would be useful for silently skipping a
|
||||
value.
|
||||
|
||||
- The `advance` attribute is used to repeat a value. When set to
|
||||
FALSE, the next call to `{cycle}` will print the same value.
|
||||
|
||||
- If you supply the `assign` attribute, the output of the `{cycle}`
|
||||
function will be assigned to a template variable instead of being
|
||||
output to the template.
|
||||
|
||||
## Examples
|
||||
```smarty
|
||||
{section name=rows loop=$data}
|
||||
<tr class="{cycle values="odd,even"}">
|
||||
<td>{$data[rows]}</td>
|
||||
</tr>
|
||||
{/section}
|
||||
```
|
||||
|
||||
The above template would output:
|
||||
|
||||
```html
|
||||
<tr class="odd">
|
||||
<td>1</td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td>2</td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td>3</td>
|
||||
</tr>
|
||||
```
|
||||
@@ -1,14 +0,0 @@
|
||||
# {debug}
|
||||
|
||||
`{debug}` dumps the debug console to the page. This works regardless of
|
||||
the [debug](../chapter-debugging-console.md) settings in the php script.
|
||||
Since this gets executed at runtime, this is only able to show the
|
||||
[assigned](../../programmers/api-functions/api-assign.md) variables; not the templates that are in use.
|
||||
However, you can see all the currently available variables within the
|
||||
scope of a template.
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|------------------------------------------------------------|
|
||||
| output | No | output type, html or javascript (defaults to 'javascript') |
|
||||
|
||||
See also the [debugging console page](../chapter-debugging-console.md).
|
||||
@@ -1,81 +0,0 @@
|
||||
# {eval}
|
||||
|
||||
`{eval}` is used to evaluate a variable as a template. This can be used
|
||||
for things like embedding template tags/variables into variables or
|
||||
tags/variables into config file variables.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|------------------------------------------------------|
|
||||
| var | Yes | Variable (or string) to evaluate |
|
||||
| assign | No | The template variable the output will be assigned to |
|
||||
|
||||
If you supply the `assign` attribute, the output of the `{eval}`
|
||||
function will be assigned to this template variable instead of being
|
||||
output to the template.
|
||||
|
||||
> **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](../../api/caching/basics.md)
|
||||
> enabled, the output will be cached with the rest of the template.
|
||||
>
|
||||
> - If the content to evaluate doesn't change often, or is used
|
||||
> repeatedly, consider using
|
||||
> `{include file="string:{$template_code}"}` instead. This may cache
|
||||
> the compiled state and thus doesn't have to run the (comparably
|
||||
> slow) compiler on every invocation.
|
||||
|
||||
## Examples
|
||||
|
||||
The contents of the config file, `setup.conf`.
|
||||
|
||||
```ini
|
||||
emphstart = <strong>
|
||||
emphend = </strong>
|
||||
title = Welcome to {$company}'s home page!
|
||||
ErrorCity = You must supply a {#emphstart#}city{#emphend#}.
|
||||
ErrorState = You must supply a {#emphstart#}state{#emphend#}.
|
||||
```
|
||||
|
||||
Where the template is:
|
||||
|
||||
```smarty
|
||||
{config_load file='setup.conf'}
|
||||
|
||||
{eval var=$foo}
|
||||
{eval var=#title#}
|
||||
{eval var=#ErrorCity#}
|
||||
{eval var=#ErrorState# assign='state_error'}
|
||||
{$state_error}
|
||||
```
|
||||
|
||||
The above template will output:
|
||||
|
||||
```html
|
||||
This is the contents of foo.
|
||||
Welcome to Foobar Pub & Grill's home page!
|
||||
You must supply a <strong>city</strong>.
|
||||
You must supply a <strong>state</strong>.
|
||||
```
|
||||
|
||||
This outputs the server name (in uppercase) and IP. The assigned
|
||||
variable `$str` could be from a database query.
|
||||
|
||||
```php
|
||||
<?php
|
||||
$str = 'The server name is {$smarty.server.SERVER_NAME|upper} '
|
||||
.'at {$smarty.server.SERVER_ADDR}';
|
||||
$smarty->assign('foo',$str);
|
||||
```
|
||||
|
||||
Where the template is:
|
||||
|
||||
```smarty
|
||||
{eval var=$foo}
|
||||
```
|
||||
@@ -1,61 +0,0 @@
|
||||
# {fetch}
|
||||
|
||||
`{fetch}` is used to retrieve files from the local file system, http, or
|
||||
ftp and display the contents.
|
||||
|
||||
## Attributes
|
||||
| Attribute | Required | Description |
|
||||
|-----------|----------|------------------------------------------------------|
|
||||
| file | Yes | The file, http or ftp site to fetch |
|
||||
| assign | No | The template variable the output will be assigned to |
|
||||
|
||||
- If the file name begins with `http://`, the website page will be
|
||||
fetched and displayed.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> This will not support http redirects, be sure to include a
|
||||
> trailing slash on your web page fetches where necessary.
|
||||
|
||||
- If the file name begins with `ftp://`, the file will be downloaded
|
||||
from the ftp server and displayed.
|
||||
|
||||
- For local files, either a full system file path must be given, or a
|
||||
path relative to the executed php script.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> If security is enabled, and you are fetching a file from the local
|
||||
> file system, `{fetch}` will only allow files from within the
|
||||
> `$secure_dir` path of the security policy. See the
|
||||
> [Security](../../api/security.md) section for details.
|
||||
|
||||
- If the `assign` attribute is set, the output of the `{fetch}`
|
||||
function will be assigned to this template variable instead of being
|
||||
output to the template.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{* include some javascript in your template *}
|
||||
{fetch file='/export/httpd/www.example.com/docs/navbar.js'}
|
||||
|
||||
{* embed some weather text in your template from another web site *}
|
||||
{fetch file='http://www.myweather.com/68502/'}
|
||||
|
||||
{* fetch a news headline file via ftp *}
|
||||
{fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'}
|
||||
{* as above but with variables *}
|
||||
{fetch file="ftp://`$user`:`$password`@`$server`/`$path`"}
|
||||
|
||||
{* assign the fetched contents to a template variable *}
|
||||
{fetch file='http://www.myweather.com/68502/' assign='weather'}
|
||||
{if $weather ne ''}
|
||||
<div id="weather">{$weather}</div>
|
||||
{/if}
|
||||
```
|
||||
|
||||
|
||||
See also [`{capture}`](../language-builtin-functions/language-function-capture.md),
|
||||
[`{eval}`](language-function-eval.md),
|
||||
[`{assign}`](../language-builtin-functions/language-function-assign.md) and [`fetch()`](../../programmers/api-functions/api-fetch.md).
|
||||
@@ -1,102 +0,0 @@
|
||||
# {html_checkboxes}
|
||||
|
||||
`{html_checkboxes}` is a [custom function](index.md)
|
||||
that creates an html checkbox group with provided data. It takes care of
|
||||
which item(s) are selected by default as well.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| name | No | Name of checkbox list (defaults to 'checkbox') |
|
||||
| values | Yes, unless using options attribute | An array of values for checkbox buttons |
|
||||
| output | Yes, unless using options attribute | An array of output for checkbox buttons |
|
||||
| selected | No | The selected checkbox element(s) as a string or array |
|
||||
| options | Yes, unless using values and output | An associative array of values and output |
|
||||
| separator | No | String of text to separate each checkbox item |
|
||||
| assign | No | Assign checkbox tags to an array instead of output |
|
||||
| labels | No | Add <label\>-tags to the output (defaults to true) |
|
||||
| label\_ids | No | Add id-attributes to <label\> and <input\> to the output (defaults to false) |
|
||||
| escape | No | Escape the output / content (values are always escaped) (defaults to true) |
|
||||
| strict | No | Will make the "extra" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *"disabled"* and *"readonly"* respectively (defaults to false) |
|
||||
|
||||
- Required attributes are `values` and `output`, unless you use `options` instead.
|
||||
|
||||
- All output is XHTML compliant.
|
||||
|
||||
- All parameters that are not in the list above are printed as
|
||||
name/value-pairs inside each of the created <input\>-tags.
|
||||
|
||||
## Examples
|
||||
```php
|
||||
<?php
|
||||
|
||||
$smarty->assign('cust_ids', array(1000,1001,1002,1003));
|
||||
$smarty->assign('cust_names', array(
|
||||
'Joe Schmoe',
|
||||
'Jack Smith',
|
||||
'Jane Johnson',
|
||||
'Charlie Brown')
|
||||
);
|
||||
$smarty->assign('customer_id', 1001);
|
||||
```
|
||||
|
||||
where template is
|
||||
|
||||
```smarty
|
||||
{html_checkboxes name='id' values=$cust_ids output=$cust_names selected=$customer_id separator='<br />'}
|
||||
```
|
||||
|
||||
or where PHP code is:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$smarty->assign(
|
||||
'cust_checkboxes',
|
||||
[
|
||||
1000 => 'Joe Schmoe',
|
||||
1001 => 'Jack Smith',
|
||||
1002 => 'Jane Johnson',
|
||||
1003 => 'Charlie Brown',
|
||||
]
|
||||
);
|
||||
$smarty->assign('customer_id', 1001);
|
||||
```
|
||||
|
||||
and the template is
|
||||
|
||||
```smarty
|
||||
{html_checkboxes name='id' options=$cust_checkboxes selected=$customer_id separator='<br />'}
|
||||
```
|
||||
|
||||
both examples will output:
|
||||
|
||||
```html
|
||||
<label><input type="checkbox" name="id[]" value="1000" />Joe Schmoe</label><br />
|
||||
<label><input type="checkbox" name="id[]" value="1001" checked="checked" />Jack Smith</label>
|
||||
<br />
|
||||
<label><input type="checkbox" name="id[]" value="1002" />Jane Johnson</label><br />
|
||||
<label><input type="checkbox" name="id[]" value="1003" />Charlie Brown</label><br />
|
||||
```
|
||||
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$sql = 'select type_id, types from contact_types order by type';
|
||||
$smarty->assign('contact_types',$db->getAssoc($sql));
|
||||
|
||||
$sql = 'select contact_id, contact_type_id, contact '
|
||||
.'from contacts where contact_id=12';
|
||||
$smarty->assign('contact',$db->getRow($sql));
|
||||
```
|
||||
|
||||
The results of the database queries above would be output with.
|
||||
|
||||
```smarty
|
||||
{html_checkboxes name='contact_type_id' options=$contact_types selected=$contact.contact_type_id separator='<br />'}
|
||||
```
|
||||
|
||||
See also [`{html_radios}`](./language-function-html-radios.md) and
|
||||
[`{html_options}`](./language-function-html-options.md)
|
||||
@@ -1,58 +0,0 @@
|
||||
# {html_image}
|
||||
|
||||
`{html_image}` is a [custom function](index.md) that
|
||||
generates an HTML `<img>` tag. The `height` and `width` are
|
||||
automatically calculated from the image file if they are not supplied.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|-------------------------------------------------------------------------|
|
||||
| file | Yes | name/path to image |
|
||||
| height | No | Height to display image (defaults to actual image height) |
|
||||
| width | No | Width to display image (defaults to actual image width) |
|
||||
| basedir | no | Directory to base relative paths from (defaults to web server doc root) |
|
||||
| alt | no | Alternative description of the image |
|
||||
| href | no | href value to link the image to |
|
||||
| path\_prefix | no | Prefix for output path |
|
||||
|
||||
- `basedir` is the base directory that relative image paths are based
|
||||
from. If not given, the web server's document root
|
||||
`$_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](../../api/security.md)
|
||||
section for details.
|
||||
|
||||
- `href` is the href value to link the image to. If link is supplied,
|
||||
an `<a href="LINKVALUE"><a>` tag is placed around the image tag.
|
||||
|
||||
- `path_prefix` is an optional prefix string you can give the output
|
||||
path. This is useful if you want to supply a different server name
|
||||
for the image.
|
||||
|
||||
- All parameters that are not in the list above are printed as
|
||||
name/value-pairs inside the created `<img>` tag.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> `{html_image}` requires a hit to the disk to read the image and
|
||||
> calculate the height and width. If you don't use template
|
||||
> [caching](../../api/caching/basics.md), it is generally better to avoid `{html_image}`
|
||||
> and leave image tags static for optimal performance.
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{html_image file='pumpkin.jpg'}
|
||||
{html_image file='/path/from/docroot/pumpkin.jpg'}
|
||||
{html_image file='../path/relative/to/currdir/pumpkin.jpg'}
|
||||
```
|
||||
|
||||
Example output of the above template would be:
|
||||
|
||||
```html
|
||||
<img src="pumpkin.jpg" alt="" width="44" height="68" />
|
||||
<img src="/path/from/docroot/pumpkin.jpg" alt="" width="44" height="68" />
|
||||
<img src="../path/relative/to/currdir/pumpkin.jpg" alt="" width="44" height="68" />
|
||||
```
|
||||
|
||||
@@ -1,146 +0,0 @@
|
||||
# {html_options}
|
||||
|
||||
`{html_options}` is a [custom function](index.md) that
|
||||
creates the html `<select><option>` group with the assigned data. It
|
||||
takes care of which item(s) are selected by default as well.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| values | Yes, unless using options attribute | An array of values for dropdown |
|
||||
| output | Yes, unless using options attribute | An array of output for dropdown |
|
||||
| selected | No | The selected option element(s) as a string or array |
|
||||
| options | Yes, unless using values and output | An associative array of values and output |
|
||||
| name | No | Name of select group |
|
||||
| strict | No | Will make the "extra" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *"disabled"* and *"readonly"* respectively (defaults to false) |
|
||||
|
||||
- Required attributes are `values` and `output`, unless you use the
|
||||
combined `options` instead.
|
||||
|
||||
- If the optional `name` attribute is given, the `<select></select>`
|
||||
tags are created, otherwise ONLY the `<option>` list is generated.
|
||||
|
||||
- If a given value is an array, it will treat it as an html
|
||||
`<optgroup>`, and display the groups. Recursion is supported with
|
||||
`<optgroup>`.
|
||||
|
||||
- All parameters that are not in the list above are printed as
|
||||
name/value-pairs inside the `<select>` tag. They are ignored if the
|
||||
optional `name` is not given.
|
||||
|
||||
- All output is XHTML compliant.
|
||||
|
||||
## Examples
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('myOptions', [
|
||||
1800 => 'Joe Schmoe',
|
||||
9904 => 'Jack Smith',
|
||||
2003 => 'Charlie Brown']
|
||||
);
|
||||
$smarty->assign('mySelect', 9904);
|
||||
```
|
||||
|
||||
The following template will generate a drop-down list. Note the presence
|
||||
of the `name` attribute which creates the `<select>` tags.
|
||||
|
||||
```smarty
|
||||
{html_options name=foo options=$myOptions selected=$mySelect}
|
||||
```
|
||||
|
||||
Output of the above example would be:
|
||||
|
||||
```html
|
||||
<select name="foo">
|
||||
<option value="1800">Joe Schmoe</option>
|
||||
<option value="9904" selected="selected">Jack Smith</option>
|
||||
<option value="2003">Charlie Brown</option>
|
||||
</select>
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('cust_ids', [56,92,13]);
|
||||
$smarty->assign('cust_names', [
|
||||
'Joe Schmoe',
|
||||
'Jane Johnson',
|
||||
'Charlie Brown']);
|
||||
$smarty->assign('customer_id', 92);
|
||||
```
|
||||
|
||||
The above arrays would be output with the following template (note the
|
||||
use of the php [`count()`](https://www.php.net/function.count) function as a
|
||||
modifier to set the select size).
|
||||
|
||||
```smarty
|
||||
<select name="customer_id" size="{$cust_names|@count}">
|
||||
{html_options values=$cust_ids output=$cust_names selected=$customer_id}
|
||||
</select>
|
||||
```
|
||||
|
||||
The above example would output:
|
||||
|
||||
```html
|
||||
<select name="customer_id" size="3">
|
||||
<option value="56">Joe Schmoe</option>
|
||||
<option value="92" selected="selected">Jane Johnson</option>
|
||||
<option value="13">Charlie Brown</option>
|
||||
</select>
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$sql = 'select type_id, types from contact_types order by type';
|
||||
$smarty->assign('contact_types',$db->getAssoc($sql));
|
||||
|
||||
$sql = 'select contact_id, name, email, contact_type_id
|
||||
from contacts where contact_id='.$contact_id;
|
||||
$smarty->assign('contact',$db->getRow($sql));
|
||||
|
||||
```
|
||||
|
||||
Where a template could be as follows. Note the use of the
|
||||
[`truncate`](../language-modifiers/language-modifier-truncate.md) modifier.
|
||||
|
||||
```smarty
|
||||
<select name="type_id">
|
||||
<option value='null'>-- none --</option>
|
||||
{html_options options=$contact_types|truncate:20 selected=$contact.type_id}
|
||||
</select>
|
||||
```
|
||||
|
||||
```php
|
||||
<?php
|
||||
$arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim');
|
||||
$arr['Rest'] = array(3 => 'Sauna',1 => 'Massage');
|
||||
$smarty->assign('lookups', $arr);
|
||||
$smarty->assign('fav', 7);
|
||||
```
|
||||
|
||||
The script above and the following template
|
||||
|
||||
```smarty
|
||||
{html_options name=foo options=$lookups selected=$fav}
|
||||
```
|
||||
|
||||
would output:
|
||||
|
||||
```html
|
||||
<select name="foo">
|
||||
<optgroup label="Sport">
|
||||
<option value="6">Golf</option>
|
||||
<option value="9">Cricket</option>
|
||||
<option value="7" selected="selected">Swim</option>
|
||||
</optgroup>
|
||||
<optgroup label="Rest">
|
||||
<option value="3">Sauna</option>
|
||||
<option value="1">Massage</option>
|
||||
</optgroup>
|
||||
</select>
|
||||
```
|
||||
|
||||
See also [`{html_checkboxes}`](./language-function-html-checkboxes.md) and
|
||||
[`{html_radios}`](./language-function-html-radios.md)
|
||||
@@ -1,104 +0,0 @@
|
||||
# {html_radios}
|
||||
|
||||
`{html_radios}` is a [custom function](index.md) that
|
||||
creates an HTML radio button group. It also takes care of which item is
|
||||
selected by default as well.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| name | No | Name of radio list |
|
||||
| values | Yes, unless using options attribute | An array of values for radio buttons |
|
||||
| output | Yes, unless using options attribute | An array of output for radio buttons |
|
||||
| selected | No | The selected radio element |
|
||||
| options | Yes, unless using values and output | An associative array of values and output |
|
||||
| separator | No | String of text to separate each radio item |
|
||||
| assign | No | Assign radio tags to an array instead of output |
|
||||
| labels | No | Add <label>-tags to the output (defaults to true) |
|
||||
| label\_ids | No | Add id-attributes to <label\> and <input\> to the output (defaults to false) |
|
||||
| escape | No | Escape the output / content (values are always escaped) (defaults to true) |
|
||||
| strict | No | Will make the "extra" attributes *disabled* and *readonly* only be set, if they were supplied with either boolean *TRUE* or string *"disabled"* and *"readonly"* respectively (defaults to false) |
|
||||
|
||||
- Required attributes are `values` and `output`, unless you use
|
||||
`options` instead.
|
||||
|
||||
- All output is XHTML compliant.
|
||||
|
||||
- All parameters that are not in the list above are output as
|
||||
name/value-pairs inside each of the created `<input>`-tags.
|
||||
|
||||
## Examples
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
$smarty->assign('cust_ids', array(1000,1001,1002,1003));
|
||||
$smarty->assign('cust_names', array(
|
||||
'Joe Schmoe',
|
||||
'Jack Smith',
|
||||
'Jane Johnson',
|
||||
'Charlie Brown')
|
||||
);
|
||||
$smarty->assign('customer_id', 1001);
|
||||
```
|
||||
|
||||
Where template is:
|
||||
|
||||
```smarty
|
||||
{html_radios name='id' values=$cust_ids output=$cust_names
|
||||
selected=$customer_id separator='<br />'}
|
||||
```
|
||||
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign('cust_radios', array(
|
||||
1000 => 'Joe Schmoe',
|
||||
1001 => 'Jack Smith',
|
||||
1002 => 'Jane Johnson',
|
||||
1003 => 'Charlie Brown'));
|
||||
$smarty->assign('customer_id', 1001);
|
||||
|
||||
```
|
||||
|
||||
Where template is:
|
||||
|
||||
```smarty
|
||||
|
||||
{html_radios name='id' options=$cust_radios
|
||||
selected=$customer_id separator='<br />'}
|
||||
```
|
||||
|
||||
Both examples will output:
|
||||
|
||||
```html
|
||||
<label><input type="radio" name="id" value="1000" />Joe Schmoe</label><br />
|
||||
<label><input type="radio" name="id" value="1001" checked="checked" />Jack Smith</label><br />
|
||||
<label><input type="radio" name="id" value="1002" />Jane Johnson</label><br />
|
||||
<label><input type="radio" name="id" value="1003" />Charlie Brown</label><br />
|
||||
```
|
||||
|
||||
```php
|
||||
|
||||
<?php
|
||||
|
||||
$sql = 'select type_id, types from contact_types order by type';
|
||||
$smarty->assign('contact_types',$db->getAssoc($sql));
|
||||
|
||||
$sql = 'select contact_id, name, email, contact_type_id '
|
||||
.'from contacts where contact_id='.$contact_id;
|
||||
$smarty->assign('contact',$db->getRow($sql));
|
||||
|
||||
```
|
||||
|
||||
The variable assigned from the database above would be output with the
|
||||
template:
|
||||
|
||||
```smarty
|
||||
{html_radios name='contact_type_id' options=$contact_types
|
||||
selected=$contact.contact_type_id separator='<br />'}
|
||||
```
|
||||
|
||||
See also [`{html_checkboxes}`](language-function-html-checkboxes.md) and
|
||||
[`{html_options}`](language-function-html-options.md)
|
||||
@@ -1,118 +0,0 @@
|
||||
# {html_select_date}
|
||||
|
||||
`{html_select_date}` is a [custom function](index.md)
|
||||
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.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Default | Description |
|
||||
|--------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| prefix | Date_ | What to prefix the var name with |
|
||||
| time | | What date/time to pre-select. Accepts timestamps, DateTime objects or any string parseable by [strtotime()](https://www.php.net/strtotime). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL. |
|
||||
| start_year | current year | The first year in the dropdown, either year number, or relative to current year (+/- N) |
|
||||
| end_year | same as start_year | The last year in the dropdown, either year number, or relative to current year (+/- N) |
|
||||
| display_days | TRUE | Whether to display days or not |
|
||||
| display_months | TRUE | Whether to display months or not |
|
||||
| display_years | TRUE | Whether to display years or not |
|
||||
| month_names | | List of strings to display for months. array(1 =\> 'Jan', ..., 12 =\> 'Dec') |
|
||||
| month_format | \%B | What format the month should be in (strftime) |
|
||||
| day_format | \%02d | What format the day output should be in (sprintf) |
|
||||
| day_value_format | \%d | What format the day value should be in (sprintf) |
|
||||
| year_as_text | FALSE | Whether or not to display the year as text |
|
||||
| reverse_years | FALSE | Display years in reverse order |
|
||||
| field_array | | If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name\[Day\], name\[Year\], name\[Month\]. |
|
||||
| day_size | | Adds size attribute to select tag if given |
|
||||
| month_size | | Adds size attribute to select tag if given |
|
||||
| year_size | | Adds size attribute to select tag if given |
|
||||
| all_extra | | Adds extra attributes to all select/input tags if given |
|
||||
| day_extra | | Adds extra attributes to select/input tags if given |
|
||||
| month_extra | | Adds extra attributes to select/input tags if given |
|
||||
| year_extra | | Adds extra attributes to select/input tags if given |
|
||||
| all_id | | Adds id-attribute to all select/input tags if given |
|
||||
| day_id | | Adds id-attribute to select/input tags if given |
|
||||
| month_id | | Adds id-attribute to select/input tags if given |
|
||||
| year_id | | Adds id-attribute to select/input tags if given |
|
||||
| field_order | MDY | The order in which to display the fields |
|
||||
| field_separator | \\n | String printed between different fields |
|
||||
| month_value_format | \%m | strftime() format of the month values, default is %m for month numbers. |
|
||||
| all_empty | | If supplied then the first element of any select-box has this value as it's label and "" as it's value. This is useful to make the select-boxes read "Please select" for example. |
|
||||
| year_empty | | If supplied then the first element of the year's select-box has this value as it's label and "" as it's value. This is useful to make the select-box read "Please select a year" for example. Note that you can use values like "-MM-DD" as time-attribute to indicate an unselected year. |
|
||||
| month_empty | | If supplied then the first element of the month's select-box has this value as it's label and "" as it's value. . Note that you can use values like "YYYY\--DD" as time-attribute to indicate an unselected month. |
|
||||
| day_empty | | If supplied then the first element of the day's select-box has this value as it's label and "" as it's value. Note that you can use values like "YYYY-MM-" as time-attribute to indicate an unselected day. |
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> There is an useful php function on the [date tips page](../../appendixes/tips.md)
|
||||
> for converting `{html_select_date}` form values to a timestamp.
|
||||
|
||||
## Exaples
|
||||
|
||||
Template code
|
||||
|
||||
```smarty
|
||||
{html_select_date}
|
||||
```
|
||||
|
||||
This will output:
|
||||
|
||||
```html
|
||||
<select name="Date_Month">
|
||||
<option value="1">January</option>
|
||||
<option value="2">February</option>
|
||||
<option value="3">March</option>
|
||||
..... snipped .....
|
||||
<option value="10">October</option>
|
||||
<option value="11">November</option>
|
||||
<option value="12" selected="selected">December</option>
|
||||
</select>
|
||||
<select name="Date_Day">
|
||||
<option value="1">01</option>
|
||||
<option value="2">02</option>
|
||||
<option value="3">03</option>
|
||||
..... snipped .....
|
||||
<option value="11">11</option>
|
||||
<option value="12">12</option>
|
||||
<option value="13" selected="selected">13</option>
|
||||
<option value="14">14</option>
|
||||
<option value="15">15</option>
|
||||
..... snipped .....
|
||||
<option value="29">29</option>
|
||||
<option value="30">30</option>
|
||||
<option value="31">31</option>
|
||||
</select>
|
||||
<select name="Date_Year">
|
||||
<option value="2006" selected="selected">2006</option>
|
||||
</select>
|
||||
```
|
||||
|
||||
```smarty
|
||||
{* start and end year can be relative to current year *}
|
||||
{html_select_date prefix='StartDate' time=$time start_year='-5'
|
||||
end_year='+1' display_days=false}
|
||||
```
|
||||
|
||||
With 2000 as the current year the output:
|
||||
|
||||
```html
|
||||
<select name="StartDateMonth">
|
||||
<option value="1">January</option>
|
||||
<option value="2">February</option>
|
||||
.... snipped ....
|
||||
<option value="11">November</option>
|
||||
<option value="12" selected="selected">December</option>
|
||||
</select>
|
||||
<select name="StartDateYear">
|
||||
<option value="1995">1995</option>
|
||||
.... snipped ....
|
||||
<option value="1999">1999</option>
|
||||
<option value="2000" selected="selected">2000</option>
|
||||
<option value="2001">2001</option>
|
||||
</select>
|
||||
```
|
||||
|
||||
See also [`{html_select_time}`](language-function-html-select-time.md),
|
||||
[`date_format`](../language-modifiers/language-modifier-date-format.md),
|
||||
[`$smarty.now`](../language-variables/language-variables-smarty.md#smartynow-languagevariablessmartynow) and the [date tips
|
||||
page](../../appendixes/tips.md#dates).
|
||||
@@ -1,100 +0,0 @@
|
||||
# {html_select_time}
|
||||
|
||||
`{html_select_time}` is a [custom function](index.md)
|
||||
that creates time dropdowns for you. It can display any or all of: hour,
|
||||
minute, second and meridian.
|
||||
|
||||
The `time` attribute can have different formats. It can be a unique
|
||||
timestamp, a string of the format `YYYYMMDDHHMMSS` or a string that is
|
||||
parseable by PHP's [`strtotime()`](https://www.php.net/strtotime).
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Default | Description |
|
||||
|-----------------------|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| prefix | Time\_ | What to prefix the var name with |
|
||||
| time | current [timestamp](https://www.php.net/function.time) | What date/time to pre-select. Accepts [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). If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. |
|
||||
| display\_hours | TRUE | Whether or not to display hours |
|
||||
| display\_minutes | TRUE | Whether or not to display minutes |
|
||||
| display\_seconds | TRUE | Whether or not to display seconds |
|
||||
| display\_meridian | TRUE | Whether or not to display meridian (am/pm) |
|
||||
| use\_24\_hours | TRUE | Whether or not to use 24 hour clock |
|
||||
| minute\_interval | 1 | Number interval in minute dropdown |
|
||||
| second\_interval | 1 | Number interval in second dropdown |
|
||||
| hour\_format | \%02d | What format the hour label should be in (sprintf) |
|
||||
| hour\_value\_format | \%20d | What format the hour value should be in (sprintf) |
|
||||
| minute\_format | \%02d | What format the minute label should be in (sprintf) |
|
||||
| minute\_value\_format | \%20d | What format the minute value should be in (sprintf) |
|
||||
| second\_format | \%02d | What format the second label should be in (sprintf) |
|
||||
| second\_value\_format | \%20d | What format the second value should be in (sprintf) |
|
||||
| field\_array | n/a | Outputs values to array of this name |
|
||||
| all\_extra | null | Adds extra attributes to select/input tags if given |
|
||||
| hour\_extra | null | Adds extra attributes to select/input tags if given |
|
||||
| minute\_extra | null | Adds extra attributes to select/input tags if given |
|
||||
| second\_extra | null | Adds extra attributes to select/input tags if given |
|
||||
| meridian\_extra | null | Adds extra attributes to select/input tags if given |
|
||||
| field\_separator | \\n | String printed between different fields |
|
||||
| option\_separator | \\n | String printed between different options of a field |
|
||||
| all\_id | null | Adds id-attribute to all select/input tags if given |
|
||||
| hour\_id | null | Adds id-attribute to select/input tags if given |
|
||||
| minute\_id | null | Adds id-attribute to select/input tags if given |
|
||||
| second\_id | null | Adds id-attribute to select/input tags if given |
|
||||
| meridian\_id | null | Adds id-attribute to select/input tags if given |
|
||||
| all\_empty | null | If supplied then the first element of any select-box has this value as it's label and "" as it's value. This is useful to make the select-boxes read "Please select" for example. |
|
||||
| hour\_empty | null | If supplied then the first element of the hour's select-box has this value as it's label and "" as it's value. This is useful to make the select-box read "Please select an hour" for example. |
|
||||
| minute\_empty | null | If supplied then the first element of the minute's select-box has this value as it's label and "" as it's value. This is useful to make the select-box read "Please select an minute" for example. |
|
||||
| second\_empty | null | If supplied then the first element of the second's select-box has this value as it's label and "" as it's value. This is useful to make the select-box read "Please select an second" for example. |
|
||||
| meridian\_empty | null | If supplied then the first element of the meridian's select-box has this value as it's label and "" as it's value. This is useful to make the select-box read "Please select an meridian" for example. |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{html_select_time use_24_hours=true}
|
||||
```
|
||||
|
||||
At 9:20 and 23 seconds in the morning the template above would output:
|
||||
|
||||
```html
|
||||
<select name="Time_Hour">
|
||||
<option value="00">00</option>
|
||||
<option value="01">01</option>
|
||||
... snipped ....
|
||||
<option value="08">08</option>
|
||||
<option value="09" selected>09</option>
|
||||
<option value="10">10</option>
|
||||
... snipped ....
|
||||
<option value="22">22</option>
|
||||
<option value="23">23</option>
|
||||
</select>
|
||||
<select name="Time_Minute">
|
||||
<option value="00">00</option>
|
||||
<option value="01">01</option>
|
||||
... snipped ....
|
||||
<option value="19">19</option>
|
||||
<option value="20" selected>20</option>
|
||||
<option value="21">21</option>
|
||||
... snipped ....
|
||||
<option value="58">58</option>
|
||||
<option value="59">59</option>
|
||||
</select>
|
||||
<select name="Time_Second">
|
||||
<option value="00">00</option>
|
||||
<option value="01">01</option>
|
||||
... snipped ....
|
||||
<option value="22">22</option>
|
||||
<option value="23" selected>23</option>
|
||||
<option value="24">24</option>
|
||||
... snipped ....
|
||||
<option value="58">58</option>
|
||||
<option value="59">59</option>
|
||||
</select>
|
||||
<select name="Time_Meridian">
|
||||
<option value="am" selected>AM</option>
|
||||
<option value="pm">PM</option>
|
||||
</select>
|
||||
```
|
||||
|
||||
See also [`$smarty.now`](../language-variables/language-variables-smarty.md#smartynow-languagevariablessmartynow),
|
||||
[`{html_select_date}`](language-function-html-select-date.md) and the
|
||||
[date tips page](../../appendixes/tips.md#dates).
|
||||
@@ -1,93 +0,0 @@
|
||||
# {html_table}
|
||||
|
||||
`{html_table}` is a [custom function](index.md) that
|
||||
dumps an array of data into an HTML `<table>`.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| loop | Yes | Array of data to loop through |
|
||||
| cols | No | Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array. |
|
||||
| rows | No | Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements. |
|
||||
| inner | No | Direction of consecutive elements in the loop-array to be rendered. *cols* means elements are displayed col-by-col. *rows* means elements are displayed row-by-row. |
|
||||
| caption | No | Text to be used for the `<caption>` element of the table |
|
||||
| table\_attr | No | Attributes for `<table>` tag (defaults to 'border="1"') |
|
||||
| th\_attr | No | Attributes for `<th>` tag (arrays are cycled) |
|
||||
| tr\_attr | No | attributes for `<tr>` tag (arrays are cycled) |
|
||||
| td\_attr | No | Attributes for `<td>` tag (arrays are cycled) |
|
||||
| trailpad | No | Value to pad the trailing cells on last row with (if any) (defaults to ' ') |
|
||||
| hdir | No | Direction of each row to be rendered. possible values: *right* (left-to-right), and *left* (right-to-left) (defaults to 'right') |
|
||||
| vdir | No | Direction of each column to be rendered. possible values: *down* (top-to-bottom), *up* (bottom-to-top) (defaults to 'down') |
|
||||
|
||||
- The `cols` attribute determines how many columns will be in the
|
||||
table.
|
||||
|
||||
- The `table_attr`, `tr_attr` and `td_attr` values determine the
|
||||
attributes given to the `<table>`, `<tr>` and `<td>` tags.
|
||||
|
||||
- If `tr_attr` or `td_attr` are arrays, they will be cycled through.
|
||||
|
||||
- `trailpad` is the value put into the trailing cells on the last
|
||||
table row if there are any present.
|
||||
|
||||
## Examples
|
||||
|
||||
```php
|
||||
<?php
|
||||
$smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) );
|
||||
$smarty->assign( 'tr', array('bgcolor="#eeeeee"','bgcolor="#dddddd"') );
|
||||
$smarty->display('index.tpl');
|
||||
```
|
||||
|
||||
The variables assigned from php could be displayed as these three
|
||||
examples demonstrate. Each example shows the template followed by
|
||||
output.
|
||||
|
||||
** Example 1 **
|
||||
```smarty
|
||||
{html_table loop=$data}
|
||||
```
|
||||
```html
|
||||
<table border="1">
|
||||
<tbody>
|
||||
<tr><td>1</td><td>2</td><td>3</td></tr>
|
||||
<tr><td>4</td><td>5</td><td>6</td></tr>
|
||||
<tr><td>7</td><td>8</td><td>9</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
** Example 2 **
|
||||
```smarty
|
||||
{html_table loop=$data cols=4 table_attr='border="0"'}
|
||||
```
|
||||
```html
|
||||
<table border="0">
|
||||
<tbody>
|
||||
<tr><td>1</td><td>2</td><td>3</td><td>4</td></tr>
|
||||
<tr><td>5</td><td>6</td><td>7</td><td>8</td></tr>
|
||||
<tr><td>9</td><td> </td><td> </td><td> </td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
** Example 3 **
|
||||
```smarty
|
||||
{html_table loop=$data cols="first,second,third,fourth" tr_attr=$tr}
|
||||
```
|
||||
```html
|
||||
<table border="1">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>first</th><th>second</th><th>third</th><th>fourth</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr bgcolor="#eeeeee"><td>1</td><td>2</td><td>3</td><td>4</td></tr>
|
||||
<tr bgcolor="#dddddd"><td>5</td><td>6</td><td>7</td><td>8</td></tr>
|
||||
<tr bgcolor="#eeeeee"><td>9</td><td> </td><td> </td><td> </td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
@@ -1,61 +0,0 @@
|
||||
# {mailto}
|
||||
|
||||
`{mailto}` automates the creation of a `mailto:` anchor links and
|
||||
optionally encodes them. Encoding emails makes it more difficult for web
|
||||
spiders to lift email addresses off of a site.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|-----------------------------------------------------------------------------------------------|
|
||||
| address | Yes | The e-mail address |
|
||||
| text | No | The text to display, default is the e-mail address |
|
||||
| encode | No | How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`. |
|
||||
| cc | No | Email addresses to carbon copy, separate entries by a comma. |
|
||||
| bcc | No | Email addresses to blind carbon copy, separate entries by a comma |
|
||||
| subject | No | Email subject |
|
||||
| newsgroups | No | Newsgroups to post to, separate entries by a comma. |
|
||||
| followupto | No | Addresses to follow up to, separate entries by a comma. |
|
||||
| extra | No | Any extra information you want passed to the link, such as style sheet classes |
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Javascript is probably the most thorough form of encoding, although
|
||||
> you can use hex encoding too.
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
```smarty
|
||||
{mailto address="me@example.com"}
|
||||
<a href="mailto:me@example.com" >me@example.com</a>
|
||||
|
||||
{mailto address="me@example.com" text="send me some mail"}
|
||||
<a href="mailto:me@example.com" >send me some mail</a>
|
||||
|
||||
{mailto address="me@example.com" encode="javascript"}
|
||||
<script>
|
||||
eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))
|
||||
</script>
|
||||
|
||||
{mailto address="me@example.com" encode="hex"}
|
||||
<a href="mailto:%6d%65.. snipped..3%6f%6d">m&..snipped...#x6f;m</a>
|
||||
|
||||
{mailto address="me@example.com" subject="Hello to you!"}
|
||||
<a href="mailto:me@example.com?subject=Hello%20to%20you%21" >me@example.com</a>
|
||||
|
||||
{mailto address="me@example.com" cc="you@example.com,they@example.com"}
|
||||
<a href="mailto:me@example.com?cc=you@example.com,they@example.com" >me@example.com</a>
|
||||
|
||||
{mailto address="me@example.com" extra='class="email"'}
|
||||
<a href="mailto:me@example.com" class="email">me@example.com</a>
|
||||
|
||||
{mailto address="me@example.com" encode="javascript_charcode"}
|
||||
<script>
|
||||
{document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}
|
||||
</script>
|
||||
```
|
||||
|
||||
See also [`escape`](../language-modifiers/language-modifier-escape.md),
|
||||
[`{textformat}`](../language-custom-functions/language-function-textformat.md) and [obfuscating email
|
||||
addresses](../../appendixes/tips.md#obfuscating-e-mail-addresses).
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user