smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-08-03 09:54:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
andrey
2001-01-12 20:39:27 +00:00
parent e2c0232cf9
commit bad3cdae5a
3 changed files with 111 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Smarty.class.php
View File

@@ -30,9 +30,6 @@ class Smarty
var $tpl_file_ext = ".tpl"; // template file extentions var $tpl_file_ext = ".tpl"; // template file extentions
var $max_recursion_depth = 10; // maximum recursion depth.
// this is to help catch infinite loops.
// 0 == unlimited recursion.
var $allow_php = false; // whether or not to allow embedded php var $allow_php = false; // whether or not to allow embedded php
// in the templates. By default, php tags // in the templates. By default, php tags
// are escaped. // are escaped.
@@ -206,12 +203,6 @@ class Smarty
function _traverse_files($tpl_dir, $depth) function _traverse_files($tpl_dir, $depth)
{ {
// exit if recursion depth is met
if($this->max_recursion_depth != 0 && $depth >= $this->max_recursion_depth) {
$this->_set_error_msg("recursion depth of $depth reached on $tpl_dir/$curr_file. exiting.");
return false;
}
if(is_dir($tpl_dir)) { if(is_dir($tpl_dir)) {
if($tpl_dir) if($tpl_dir)
$dir_handle = opendir($tpl_dir); $dir_handle = opendir($tpl_dir);

214
doc.sgm
View File

@@ -18,60 +18,68 @@
are separate. Consequently, the search for a templating solution ensues. are separate. Consequently, the search for a templating solution ensues.
</para> </para>
<para> <para>
In our company for example, the development of an application goes on In our company, for example, the development of an application goes on
as follows. After the requirements docs are done, the interface designer as follows. After the requirements docs are done, the interface
makes mockups of the interface and gives them to the programmer. The designer makes mockups of the interface and gives them to the
programmer implements business logic in PHP and uses interface mockups programmer. The programmer implements business logic in PHP and uses
to create skeleton templates. The project is then handed off to the HTML interface mockups to create skeleton templates. The project is then
designer/web page layout person who brings the templates up to their full handed off to the HTML designer/web page layout person who brings the
glory. The project may go back and forth between programming/HTML a couple templates up to their full glory. The project may go back and forth
of times. Thus, it's important to have good template support because between programming/HTML a couple of times. Thus, it's important to
programmers don't want anything to do with HTML and don't want HTML have good template support because programmers don't want anything to
designers mucking around with PHP code, and designers need support for do with HTML and don't want HTML designers mucking around with PHP
config files, dynamic blocks and other stuff, but they don't want to code, and designers need support for config files, dynamic blocks and
have to deal with intricacies of the PHP programming language. other stuff, but they don't want to have to deal with intricacies of
the PHP programming language.
</para> </para>
<para> <para>
Looking at many templating solutions available for PHP today, Looking at many templating solutions available for PHP today, most of
most of them provide a rudimentary way of substituting variables into them provide a rudimentary way of substituting variables into templates
templates and do a limited form of dynamic block functionality (a section and do a limited form of dynamic block functionality (a section of a
of a template that is looped over and over with a set of indexed variables). template that is looped over and over with a set of indexed variables).
But our needs were a bit more than that. We didn't want programmers to be But our needs required a bit more than that. We didn't want programmers
dealing with HTML layout at ALL, but this was almost inevitable. For to be dealing with HTML layout at ALL, but this was almost inevitable.
instance, if a designer wanted background colors to alternate on dynamic For instance, if a designer wanted background colors to alternate on
blocks, this had to be worked out with the programmer in advance. We also dynamic blocks, this had to be worked out with the programmer in
needed designers to be able to use their own configuration files, and pull advance. We also needed designers to be able to use their own
variables from them into the templates. The list goes on. configuration files, and pull variables from them into the templates.
The list goes on.
</para> </para>
<para> <para>
We started out writing out a spec for a template engine about a year ago. We started out writing out a spec for a template engine about a year
After finishing the spec, we began to work on a template engine written in ago. After finishing the spec, we began to work on a template engine
C that would hopefully be accepted for inclusion with PHP. Not only did we written in C that would hopefully be accepted for inclusion with PHP.
run into many complicated technical barriers, but there was also much heated Not only did we run into many complicated technical barriers, but there
debate about exactly what a template engine should and should not do. From was also much heated debate about exactly what a template engine should
this experience, we decided that the template engine should be written in PHP and should not do. From this experience, we decided that the template
as a class, for anyone to use as they see fit. So we wrote an engine that did engine should be written in PHP as a class, for anyone to use as they
just that. "SmartTemplate" came to existance (note: this class was never see fit. So we wrote an engine that did just that and
submitted to the public). It was a class that did almost everything we wanted: <emphasis>SmartTemplate</emphasis> came into existence (note: this
regular variable substitution, supported including other templates, integration class was never submitted to the public). It was a class that did
with config files, embedding PHP code, limited 'if' statement functionality and almost everything we wanted: regular variable substitution, supported
much more robust dynamic blocks which could be multiply nested. It did all this including other templates, integration with config files, embedding PHP
with regular expressions and the code turned out to be rather, shall we say, code, limited 'if' statement functionality and much more robust dynamic
impenetrable. It was also noticably slow in large applications from all the blocks which could be multiply nested. It did all this with regular
parsing and regular expression work it had to do on each invocation. expressions and the code turned out to be rather, shall we say,
impenetrable. It was also noticably slow in large applications from all
the parsing and regular expression work it had to do on each
invocation. But the main problem from programmer's point of view was
that you had to do a lot of work in the PHP script to setup and process
templates and dynamic blocks especially.
</para> </para>
<para> <para>
Then came the vision of what ultimately became Smarty. We know how fast PHP Then came the vision of what ultimately became Smarty. We know how fast
code is without the overhead of template parsing. We also know how meticulous PHP code is without the overhead of template parsing. We also know how
and overbearing the language may look to the average designer, and this could meticulous and overbearing the PHP language may look to the average
be masked with a much simpler templating syntax. So what if we combined the two designer, and this could be masked with a much simpler templating
strengths? Thus, Smarty was born... syntax. So what if we combined the two strengths? Thus, Smarty was
born...
</para> </para>
<sect1><title>What is Smarty?</title> <sect1><title>What is Smarty?</title>
<para> <para>
Smarty is a template engine for PHP. One of the unique aspects about Smarty is a template engine for PHP. One of the unique aspects about
Smarty that sets it apart from other templating solutions is that it Smarty that sets it apart from other templating solutions is that it
compiles the templates into native php scripts upon the first compiles the templates into native PHP scripts upon the first
invocation. After that, it merely executes the compiled PHP scripts. invocation. After that, it merely executes the compiled PHP scripts.
Therefore, there is no costly template file parsing for each request. Therefore, there is no costly template file parsing for each request.
</para> </para>
@@ -80,34 +88,36 @@
</para> </para>
<itemizedlist> <itemizedlist>
<listitem><para>It is extremely fast.</para></listitem> <listitem><para>It is extremely fast.</para></listitem>
<listitem><para>It is relatively simple since the PHP parser does the <listitem><para>It is efficient since the PHP parser does the
dirty work.</para></listitem> dirty work.</para></listitem>
<listitem><para>No template parsing overhead, only compiles once.</para></listitem> <listitem><para>No template parsing overhead, only compiles once.</para></listitem>
<listitem><para>It is smart about recompiling only the template <listitem><para>It is smart about recompiling only the template
files that have changed.</para></listitem> files that have changed.</para></listitem>
<listitem><para>You can make custom functions and custom variable modifiers, so <listitem><para>You can make <link linkend="custom.functions">custom
the template language is extremely extensible.</para></listitem> functions</link> and custom <link linkend="variable.modifiers">variable
modifiers</link>, so the template language is extremely extensible.</para></listitem>
<listitem><para>Configurable template delimiter tag syntax, so you can use <listitem><para>Configurable template delimiter tag syntax, so you can use
{}, {{}}, &lt;!--{}--&gt;, or whatever you like.</para></listitem> {}, {{}}, &lt;!--{}--&gt;, or whatever you like.</para></listitem>
<listitem><para>Template if/else/endif constructs are passed to the PHP parser, <listitem><para>The if/elseif/else/endif constructs are passed to the
so the if syntax can be as simple or as complex as you like.</para></listitem> PHP parser, so the if expression syntax can be as simple or as complex
<listitem><para>Unlimited nesting of sections,ifs, etc. allowed.</para></listitem> as you like.</para></listitem>
<listitem><para>It is possible to imbed PHP code right in your template files, <listitem><para>Unlimited nesting of sections, ifs, etc. allowed.</para></listitem>
although doubtfully needed since the engine is so customizable.</para></listitem> <listitem><para>It is possible to embed PHP code right in your template files,
although this may not be needed since the engine is so customizable.</para></listitem>
</itemizedlist> </itemizedlist>
</sect1> </sect1>
<sect1> <sect1>
<title>How Smarty works</title> <title>How Smarty works</title>
<sect2><title>compiling</title> <sect2><title>Compiling</title>
<para> <para>
Smarty compiles the templates into native PHP code on-the-fly. The actual Smarty compiles the templates into native PHP code on-the-fly. The actual
PHP scripts that are generated are created implicitly, so theoretically you PHP scripts that are generated are created implicitly, so theoretically you
should never have to worry about touching these files, or even know of their should never have to worry about touching these files, or even know of their
existance. The exception to this is debugging Smarty template syntax errors, existence. The exception to this is debugging Smarty template syntax errors,
discussed later in this document. discussed later in this document.
</para> </para>
</sect2> </sect2>
<sect2><title>caching</title> <sect2><title>Caching</title>
<para> <para>
Our initial intention was to build caching into Smarty. However, Our initial intention was to build caching into Smarty. However,
since the template engine is actually executing PHP scripts instead of since the template engine is actually executing PHP scripts instead of
@@ -122,31 +132,32 @@
<sect1> <sect1>
<title>Requirements</title> <title>Requirements</title>
<para> <para>
Smarty requires PHP 4.0.4pl1 or later. 4.0.4 contains a bug that Smarty requires PHP 4. 4.0.4 contains a bug that crashes PHP when
crashes PHP when certain Smarty features are used (such as the @count modifier). certain Smarty features are used (such as the @count modifier). 4.0.3
4.0.3 and earlier contain a bug in preg_grep() that won't allow the parser to and earlier contain a bug in preg_grep() that won't allow the parser to
function properly. We may make some adjusments to work around these function properly, so to preserve performance Smarty will automatically
issues in future versions of Smarty. For now, get the very latest version of PHP. use built-in preg_grep() when it can and use en emulated version of it
As of this writing, 4.0.4pl1 is not yet available, so a CVS snapshot is necessary. otherwise.
</para> </para>
</sect1> </sect1>
<sect1> <sect1>
<title>Installing Smarty</title> <title>Installing Smarty</title>
<para> <para>
Installing Smarty is fairly straight forward, there is just one thing you must Installing Smarty is fairly straightforward, there is just one thing you
be aware of. Remember that Smarty creates compiled versions of the template code. must be aware of. Remember that Smarty creates compiled versions of the
This usually means allowing user "nobody" (or whomever the web server runs template code. This usually means allowing user "nobody" (or whomever
as) to have permission to write the files. Each installation of a Smarty the web server runs as) to have permission to write the files. Each
application minimally needs a template directory, a config file directory and a compiled installation of a Smarty application minimally needs a templates
template directory. By default these are named "templates","configs" and "templates_c" directory and a compiled templates directory. If you use configuration
respectively. files you will also need a directory for those. By default these are
named "templates", and "templates_c" and "configs" respectively.
</para> </para>
<para> <para>
Copy the Smarty.class.php and Smarty.addons.php scripts to a Copy the Smarty.class.php and Smarty.addons.php scripts to a directory
directory that is in your PHP include_path. NOTE: php will try to create a that is in your PHP include_path. NOTE: PHP will try to create a
directory along side the index.php script called "templates_c". Be sure directory alongside the executing script called "templates_c". Be sure
that directory permissions allow this to happen. You will see appropriate that directory permissions allow this to happen. You will see PHP error
error messages if this fails. You can also create the directory yourself messages if this fails. You can also create the directory yourself
before hand, and change the file ownership accordingly. See below. before hand, and change the file ownership accordingly. See below.
</para> </para>
<example> <example>
@@ -157,7 +168,7 @@
# this assumes your web server runs as user "nobody" # this assumes your web server runs as user "nobody"
# and you are in a unix environment # and you are in a unix environment
gtar -zxvf Smarty-1.0.tar.gz gtar -zxvf Smarty-1.0.tar.gz
touch templates_c mkdir templates_c
chown nobody:nobody templates_c chown nobody:nobody templates_c
</programlisting> </programlisting>
</example> </example>
@@ -179,31 +190,36 @@ chown nobody:nobody templates_c
<sect2> <sect2>
<title>$compile_check</title> <title>$compile_check</title>
<para> <para>
Upon each invocation of the PHP application, Smarty traverses all the template Upon each invocation of the PHP application, Smarty recursively
files and searches for any that have changed (later datestamp) since the last time the traverses the template directory and its subdirectories and
application was invoked. For each one that has changed, it recompiles that searches for all the files with the template extension that have
template. By default this is set to true. The compile check has very changed (later time stamp) since the last time they were
minimal impact on the application performance. However, once an application compiled. For each one that has changed, it recompiles that
is put into production and it is initially compiled, the compile_check step template. By default this variable is set to true. The compile
is no longer needed. You may set this to "false" *after* the initial compile. Then check has very minimal impact on the application performance.
Smarty will no longer check for changed template files. Note that if you change However, once an application is put into production and it is
this to "false" and a template file is changed, you will *not* see the change since initially compiled, the compile_check step is no longer needed.
the template will not get recompiled. Set it to "true", invoke the application, You may set this to "false" *after* the initial compile. Then
Smarty will no longer check for changed template files. Note
that if you change this to "false" and a template file is
changed, you will *not* see the change since the template will
not get recompiled. Set it to "true", invoke the application,
then set it back to "false". then set it back to "false".
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
<title>$template_dir</title> <title>$template_dir</title>
<para> <para>
This is the directory name that template files are kept in. This is the directory where template files are located.
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
<title>$compile_dir_ext</title> <title>$compile_dir_ext</title>
<para> <para>
This is the extension used for the name of the directory that compiled templates This is the extension used for the name of the directory where
are kept in. By default this is "_c". Therefore if your template directory is compiled templates are located. By default this is "_c".
named "templates", then the compile directory will be named "templates_c". Therefore if your template directory is named "templates", then
the compiled templates directory will be named "templates_c".
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
@@ -213,33 +229,25 @@ chown nobody:nobody templates_c
All other files in the template directory are ignored. All other files in the template directory are ignored.
</para> </para>
</sect2> </sect2>
<sect2>
<title>$max_recursion_depth</title>
<para>
This is the maximum depth you can include other templates within templates.
This is to help catch infinite loops when template files accidentally include
each other.
</para>
</sect2>
<sect2> <sect2>
<title>$allow_php</title> <title>$allow_php</title>
<para> <para>
Whether or not to allow PHP code to be imbedded into the Whether or not to allow PHP code in the templates. If set to
templates. If set to false, PHP code is escaped and not interpreted. Imbedding false, PHP code is escaped and not interpreted. Embedding PHP
PHP code into templates is highly discouraged. Use custom functions or modifiers code into templates is highly discouraged. Use custom functions
instead. Default is "false". or modifiers instead. Default is "false".
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
<title>$left_delimiter</title> <title>$left_delimiter</title>
<para> <para>
This is the left delimiter syntax in the templates. Default is "{". This is the left delimiter used by the template language. Default is "{".
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
<title>$right_delimiter</title> <title>$right_delimiter</title>
<para> <para>
This is the right delimiter syntax in the templates. Default is "}". This is the right delimiter used by the template language. Default is "}".
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
@@ -1087,7 +1095,7 @@ OUTPUT:
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1 id="custom.functions">
<title>Custom Functions</title> <title>Custom Functions</title>
<para> <para>
Custom functions in Smarty work much the same as the built-in functions Custom functions in Smarty work much the same as the built-in functions
@@ -1273,7 +1281,7 @@ OUTPUT:
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1 id="variable.modifiers">
<title>Variable Modifiers</title> <title>Variable Modifiers</title>
<para> <para>
Variable modifiers are a bit different than custom functions. Variable modifiers are a bit different than custom functions.

9
libs/Smarty.class.php
View File

@@ -30,9 +30,6 @@ class Smarty
var $tpl_file_ext = ".tpl"; // template file extentions var $tpl_file_ext = ".tpl"; // template file extentions
var $max_recursion_depth = 10; // maximum recursion depth.
// this is to help catch infinite loops.
// 0 == unlimited recursion.
var $allow_php = false; // whether or not to allow embedded php var $allow_php = false; // whether or not to allow embedded php
// in the templates. By default, php tags // in the templates. By default, php tags
// are escaped. // are escaped.
@@ -206,12 +203,6 @@ class Smarty
function _traverse_files($tpl_dir, $depth) function _traverse_files($tpl_dir, $depth)
{ {
// exit if recursion depth is met
if($this->max_recursion_depth != 0 && $depth >= $this->max_recursion_depth) {
$this->_set_error_msg("recursion depth of $depth reached on $tpl_dir/$curr_file. exiting.");
return false;
}
if(is_dir($tpl_dir)) { if(is_dir($tpl_dir)) {
if($tpl_dir) if($tpl_dir)
$dir_handle = opendir($tpl_dir); $dir_handle = opendir($tpl_dir);