8fd949ac5d
* WIP converting code to PSR-4
* More PSR4 rewriting
* Removed autoload filters
* WIP making compile classes PSR-4
* WIP making compile classes PSR-4
* Replace Smarty:: with symfony/polyfill-mbstring
* WIP making compile classes PSR-4
* finished rewriting all compile classes into PSR-4
* Rewrote all Compile and Compiler classes to PSR-4
* WIP rewriting smarty_internal_method_*
* Finished moving smarty_internal_method_*
* smarty_internal_resource_* to PSR-4
* Refactored all _runtime_* by merging them into the proper classes or by transforming them into Runtime Extensions.
* src/Template/* to PSR-4
* src/sysplugins/* to PSR-4
* Entire src dir now PSR-4 compatible
* Add makefile, PSR-4 ModifierCompilers
* Rewrote all default modifiers and functions from the plugins folder to PSR-4 classes
* Rewrote remaining plugins to PSR-4, plugins dir is now gone.
* WIP moving Smarty to PSR-4.
* fixed pre/post/output filters and removed some old todo-comments
* filter tests passing
* Fixed TemplateObject test
* Fix CustomResourceAmbiguousTest
* Fixed CacheResource implementation and tests
* Fixed setfilter
* Fixed DefaultPluginHandlerTest for function plugins (blocks still break)
* move runPluginFromDefaultHandler to new Runtime class
* Introduce formatParamsArray method for recurring code fragment
* Fix code duplication in block compilers and fix (most) BlockPluginTests. Default plugin handler blocks still need fixing.
* minor fixes
* Implemented the DefaultHandlerBlockCompiler, made the dependencies of the template compiler into properties, fixed a couple of unit tests
* Removed support for PHP include path, and removed the ::loadPlugin method.
* Removed now unneeded PHPunit annotations @run(Tests)InSeparateProcess, @preserveGlobalState and @backupStaticAttributes. Made CacheResourceTestCommon abstract to prevent the base class from running tests (and always failing). Unregister a previously registered stream wrapper. Fixes a lot of tests.
* Fix scoping / global state problems in tests by using DI in Default Extension. Also removing a bunch of old fashioned phpdoc annotations that are superseded by namespaces.
* Make DefaultExtension lazy load again.
* Removed deprecated extends_recursion property and fix bug in CodeFrame compiler due to use of clone.
* Fixed BC loading of resource pluging from dir and all ResourcePluginTest tests
* Removed PHP functions and checks for the already removed php modifiers. Re-implemented functions as regular functions. Probably should compile these directly.
* Fixed stream resources
* 2 small fixes for unit tests
* Fixed modifiercompiler handling multiple/chained modifiers
* Rewrote global static global_tpl_vars to getters/setters on Smarty class, fixing several test cases. Added a ::getValue() method to Variable.
* Fixed issue related to scoping of left/right delimiter overrides
* Added strlen function, fixing some unit tests
* Fix bug in calling BC function handlers.
* WIP replacing direct access tpl_vars with proper getter/setters.
* WIP
* WIP rewriting variable scopes
* WIP fixing the complicated variables scopes architecture. Right now more tests are failing than before... :(
* Fixed minor unit tests
* Made variable scoping more sensible
* Fix configfile tests
* removed phpplugin, removed now unused uncompiled handler and all checks for this, fixed a refactorbug in InheritanceRuntime. Moved getRenderedTemplateCode method to Smarty\Template. Renamed Cache en Compiled base class to GeneratedPhpFile for more clarity and distinction from Resource classes. Inlined Cached::create into its only caller. Some other minor improvements. Removed php7.1 CI tests.
* Removed the allowUndefinedVars check from the smarty error handlers, because undefined vars no longer throw an error, unless smarty->error_unassigned is set to true.
* Replace direct access to inheritance property on Template object by proper getter.
* converted 3 public properties on Template into getters/setters. unified Template creation code. Provided a getter/setter for the has_nocache_code property. Removed the useless DataObject class. Fixed a few tests. Removed the variable-allow-php-templates property from the docs.
* Simplified the (no)caching architecture by:
- removing support for $cache_attrs for registered plugins,
- removing the undocumented {make_nocache} tag and the deprecated {insert} tag and associated code
- removing support for a compile_id property on include tags.
Fixes a bug in extends: resources by propagating the nocache-hashes between a master template and it's subtemplates in \Smarty\Template::_subTemplateRender. This might need further improvement.
* Removed unneeded magic setters/getters/destructors and the like.
* Replaced a bunch of direct property access with getters/setters.
* Update test runners: no longer support PHP7.1, add PHP8.2
* Fixed scope in variable assignments in included and extended templates, fixed dependencies for testing freshness of caches. Added some unit tests and fixed a class reference to pass some more tests.
* Fix searchParents parameter, fixing GetTemplateVarsTest
* @var integer > @var int for vsCode
* Fix function caching function name
* Fixed cacheability of block plugins.
* Moved handling of smarty.block.* to special compilers, because they aren't real tags. Organized tag-stack handling in compiler, unified nocache handling in compiler.
* Fixed block append/prepend functionality
* Fix testRegisterCompilerFunction by parsing argument correctly.
* Made exception msgs exactly the same again, fixing some unit tests
* Fix default plugin handler
* Simply the "isFresh" method by not including the first param anymore. Fix a couple of unit tests by respecting tag_nocache set by nocache vars used in a tag.
* Removed the undocumented {block_parent} and {parent} alternatives to {$smarty.block.parent}
and {block_child} and {child} alternatives to {$smarty.block.child}
* Fix inhertiance implementation for $smarty.block.child
* Fixed all inheritance issues
* Handle BC registered compilers and missed parameters for openTag and closeTag.
* Fix all foreach unit tests
* Fixed the {if} failures.
* Fix major {include} bug
* Fixed bug in {include} variable assignment and removed some unused/unrequired code
* Fix function call compilation using {functionname} syntax for in-template defined functions.
* Drop a unit tests bc we no longer support direct access to PHP-functinos such as sin()
* Fixed all scope assignment bugs
* Convert isset and empty to modifiercomilers, and smooth the error handling to fix unit tests.
* Fixed getCachedContent
* Add TODO list
* Run composer install before online test run
* Attempt to fix CI
* revise CI/CD workflows, bypass packagist for lexer
* Update ci.yml
* Update ci.yml
* fixes in source files
* Update ci.yml
* Update ci.yml
* attempt to load smarty-lexer directly from zip file
* Shouldnt need Github token now
* correct type of repository
* Updated the changelog
* Re-organized rendering (read source / compile / cache) process to avoid circular dependencies.
Deactivated merge_compiled_includes and the {include inline} attribute. They don't seem to do much in terms of performance, but we'll
have to check back.
* updated todo
* Fix smarty-lexer dependency for the time being
* Fix smarty-lexer dependency for the time being (remove direct ref to github)
* Pushed Lexers/Parsers into VCS again in order to be able to deliver using Packagist/Composer
* Re-organized rendering (read source / compile / cache) process to avoid circular dependencies.
* Run make regardless of timestamps, so we are sure unit tests run with the generated PHP code, not with accidental human made changes to Lexer/Parser.
* Update composer packages cache key
Update composer packages cache key to trigger refresh on lexer
* 4.0.2 of smarty-lexer is released, use that
* Throw compile error when using a modifier where it won't work. Fixes #526.
* verify that native PHP functions cannot be used as a modifier and verify that an easy userland workaround exists. Fixes #813.
* Add test for registering compiler plugin with positional params. Fixes #164
* move test methods because some other test methods rely on their relative positions
* Smarty no longer calls `mb_internal_encoding()` and doesn't check for deprecated `mbstring.func_overload` ini directive.
Fixes #480.
* Generated `<script>` tags lo longer have deprecated `type="text/javascript"` or `language="Javascript"` attributes.
Fixes #815.
* Fix error in docs on prepend/append. Fixes #818.
* Move all creating of templates to Smarty::createTemplate, adding a private property containing previously generated templates for speed.
* Load compiled object in template constructor so it will be cached.
* WIP for performance improvements.
Removed $smarty->_current_file and $smarty->allow_ambiguous_resources properties, both unused. Removed public Source::filepath property.
Cached an Compiled files (and Exceptions) no longer rely on the filepath being set. Removed explicit tests for cached and compiled filenames. The exact implementation is not important. Added tests for compile_check property, fixing a file_exists check that would always be done on source template files, even when compile_check was true. Remove code duplication between Source en Config classes. Added a local $_smarty_current_dir to the generated code files for backwards compatability for {$smarty.current_dir}.
* remove additional calls to getCached()
* updated todo
* Add mkdocs for docs
* add missing folder for unit tests
* Revert latest CI changes, we'll update docs by hand for now
* multiversion mkdocs config
* fixes to docs
* WIP improving the docs
* Improved another chunk of the designers docs
* Finished improving designers docs
* Update code examples to use Smarty\Smarty and autoload instead of require_once calls and new Smarty
* Further WIP improving docs
* Updated changelog and todo list
* WIP on API docs
* WIP docs (added page on config)
* Fixed markdown syntax. Fixes #879
* Added full support and documentation for ternary operator.
Fixes #881
* updated changelog
* fixed error in the mkdocs TOC
* Added support for null coalescing operator
Fixes #882
* Add docs for null coalescing
* more docs
* Improved docs on compile checking and inheritance
* Rewrote docs on filters and resources.
* Add makefile entries for generating docs
* Docs on caching
* finished docs on security and extending smarty
* Added Smarty::setExtensions(), fixed unit test for the null coalescing operator. Updated docs about registering a custom extension.
* updated todos
* fix template invalidation when migrating to 5.0
7.6 KiB
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} statement to handle this, but there is a
shorthand way with Smarty, using the
default variable modifier.
Note
"Undefined variable" errors will show an E_NOTICE if not disabled in PHP's
error_reporting()level or Smarty's$error_reportingproperty and a variable had not been assigned to Smarty.
{* the long way *}
{if $title eq ''}
{else}
{$title}
{/if}
{* the short way *}
{$title|default:' '}
See also default modifier and default
variable handling.
Default Variable Handling
If a variable is used frequently throughout your templates, applying the
default modifier every time it is
mentioned can get a bit ugly. You can remedy this by assigning the
variable its default value with the
{assign} function.
{* do this somewhere at the top of your template *}
{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 modifier and 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} them. But what if the header
needs to have a different title, depending on what page you are coming
from? You can pass the title to the header as an
attribute when it is included.
mainpage.tpl - When the main page is drawn, the title of "Main Page"
is passed to the header.tpl, and will subsequently be used as the
title.
{include file='header.tpl' title='Main Page'}
{* 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.
{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
variable modifier.
<html>
<head>
<title>{$title|default:'Smarty News'}</title>
</head>
<body>
footer.tpl
</body>
</html>
Dates
As a rule of thumb, always pass dates to Smarty as
timestamps. This allows template designers to
use the date_format modifier for
full control over date formatting, and also makes it easy to compare
dates if necessary.
{$startDate|date_format}
This will output:
Jan 4, 2009
{$startDate|date_format:"%Y/%m/%d"}
This will output:
2009/01/04
Dates can be compared in the template by timestamps with:
{if $order_date < $invoice_date}
...do something..
{/if}
When using {html_select_date}
in a template, the programmer will most likely want to convert the
output from the form back into timestamp format. Here is a function to
help you with that.
<?php
// 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},
{html_select_time},
date_format and
$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() the variables and
display() the template. So lets say for example we
have a stock ticker on our template. We would collect the stock data in
our application, then assign these variables in the template and display
it. Now wouldn't it be nice if you could add this stock ticker to any
application by merely including the template, and not worry about
fetching the data up front?
You can do this by writing a custom plugin for fetching the content and assigning it to a template variable.
function.load_ticker.php
<?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
{load_ticker symbol='SMARTY' assign='ticker'}
Stock Name: {$ticker.name} Stock Price: {$ticker.price}
See also: {include}.
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} plugin.
<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 :-?.