diff --git a/.gitignore b/.gitignore index d255d19..366b364 100644 --- a/.gitignore +++ b/.gitignore @@ -23,6 +23,7 @@ error_log* smarty_compile # Backups / Altlasten +/libs/smarty.4.1.1.bak/ *.bak *.bak2 *.bak3 diff --git a/core/admin_role.class.php b/core/admin_role.class.php index 777fbc1..0d0ac45 100644 --- a/core/admin_role.class.php +++ b/core/admin_role.class.php @@ -10,6 +10,7 @@ include_once './core/main.class.php'; +#[\AllowDynamicProperties] class Admin_role extends Main { public $list_table_config = array ( diff --git a/core/base.class.php b/core/base.class.php index 544c075..133448a 100644 --- a/core/base.class.php +++ b/core/base.class.php @@ -16,6 +16,7 @@ include_once './core/customer.class.php'; include_once './core/customer_group.class.php'; include_once './core/admin_role.class.php'; +#[\AllowDynamicProperties] class base { public $logger; diff --git a/core/config.class.php b/core/config.class.php index cb92a87..764e73b 100644 --- a/core/config.class.php +++ b/core/config.class.php @@ -11,6 +11,7 @@ include_once './core/logger.class.php'; include_once './core/main.class.php'; +#[\AllowDynamicProperties] class Config extends Main { protected $base_object; diff --git a/core/customer.class.php b/core/customer.class.php index 74f83a5..b09ac5c 100644 --- a/core/customer.class.php +++ b/core/customer.class.php @@ -16,6 +16,7 @@ include_once './core/cs_ticket.class.php'; include_once './core/customergroups.class.php'; include_once './core/main.class.php'; +#[\AllowDynamicProperties] class Customer extends Main { protected $base_object; diff --git a/core/customer_group.class.php b/core/customer_group.class.php index ccfd68f..a49ec5b 100644 --- a/core/customer_group.class.php +++ b/core/customer_group.class.php @@ -10,6 +10,7 @@ include_once './core/main.class.php'; +#[\AllowDynamicProperties] class Customer_group extends Main { protected $base_object; diff --git a/core/customergroups.class.php b/core/customergroups.class.php index 9be1c21..b057b49 100644 --- a/core/customergroups.class.php +++ b/core/customergroups.class.php @@ -8,6 +8,7 @@ * Carteasy is a web shop system */ +#[\AllowDynamicProperties] class CustomerGroups { private $table_fields = array( diff --git a/core/item.class.php b/core/item.class.php index afc0c23..f4531fc 100644 --- a/core/item.class.php +++ b/core/item.class.php @@ -19,6 +19,7 @@ include_once './core/customer_group.class.php'; include_once './core/itemschema.class.php'; include_once './core/structure.class.php'; +#[\AllowDynamicProperties] class Item extends Main { public $list_table_config = array( diff --git a/core/structure.class.php b/core/structure.class.php index cd7ae39..0eb18a5 100644 --- a/core/structure.class.php +++ b/core/structure.class.php @@ -8,6 +8,7 @@ * Carteasy is a web shop system */ +#[\AllowDynamicProperties] class Structure extends Main { protected $base_object; diff --git a/core/website.class.php b/core/website.class.php index 71f1cf5..a98a29e 100644 --- a/core/website.class.php +++ b/core/website.class.php @@ -13,6 +13,7 @@ include_once './core/manufacturer.class.php'; include_once './core/shoppingcart.class.php'; include_once './core/memory.class.php'; +#[\AllowDynamicProperties] class website { private $db; diff --git a/libs/smarty/CHANGELOG.md b/libs/smarty/CHANGELOG.md index 784cc09..3af862d 100644 --- a/libs/smarty/CHANGELOG.md +++ b/libs/smarty/CHANGELOG.md @@ -6,10 +6,116 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [4.5.6] - 2025-08-26 +- Fixed that modifiers called like function would be compiled to modifier name instead of calling the registered callback [#1100](https://github.com/smarty-php/smarty/issues/1100) +- Replace SMARTY_VERSION constant with $smarty.version in debug.tpl [#1073](https://github.com/smarty-php/smarty/issues/1073) + + +- Fixed escaping of array/object keys in debug_print_var + +## [4.5.5] - 2024-11-21 + +- Support the deprecations introduced in PHP 8.4 and added tests for PHP 8.4 [#1084](https://github.com/smarty-php/smarty/pull/1084) + +## [4.5.4] - 2024-08-14 +- Fixed that using `count()` would trigger a deprecation notice. [#813](https://github.com/smarty-php/smarty/issues/813) + + +## [4.5.3] - 2024-05-28 +- Fixed a code injection vulnerability in extends-tag. This addresses CVE-2024-35226. + + +## [4.5.2] - 2024-04-06 +- Fixed argument must be passed by reference error introduced in v4.5.1 [#964](https://github.com/smarty-php/smarty/issues/964) + +## [4.5.1] - 2024-03-18 +- Using unregistered static class methods in expressions now also triggers a deprecation notice because we will drop support for this in the next major release [#813](https://github.com/smarty-php/smarty/issues/813) + +## [4.5.0] - 2024-03-18 +- (this release accidentally didn't contain any changes, fixed in 4.5.1) + +## [4.4.1] - 2024-02-26 +- Fixed internal release-tooling + +## [4.4.0] - 2024-02-26 +- Using the `|implode`, `|json_encode` and `|substr` modifiers does not generate a deprecation warning anymore as they will continue to be supported in v5 [#939](https://github.com/smarty-php/smarty/issues/939) + +### Added +- PHP8.3 support [#925](https://github.com/smarty-php/smarty/issues/925) + +### Fixed +- Incorrect compilation of expressions when escape_html=true [#930](https://github.com/smarty-php/smarty/pull/930) + +## [4.3.4] - 2023-09-14 + +## [4.3.3] - 2023-09-14 + +### Fixed +- `|strip_tags` does not work if the input is 0 [#890](https://github.com/smarty-php/smarty/issues/890) +- Use of negative numbers in {math} equations [#895](https://github.com/smarty-php/smarty/issues/895) + +## [4.3.2] - 2023-07-19 + +### Fixed +- `$smarty->muteUndefinedOrNullWarnings()` now also mutes PHP8 warnings for undefined properties + +## [4.3.1] - 2023-03-28 + +### Security +- Fixed Cross site scripting vulnerability in Javascript escaping. This addresses CVE-2023-28447. + +### Fixed +- `$smarty->muteUndefinedOrNullWarnings()` now also mutes PHP7 notices for undefined array indexes [#736](https://github.com/smarty-php/smarty/issues/736) +- `$smarty->muteUndefinedOrNullWarnings()` now treats undefined vars and array access of a null or false variables + equivalent across all supported PHP versions +- `$smarty->muteUndefinedOrNullWarnings()` now allows dereferencing of non-objects across all supported PHP versions [#831](https://github.com/smarty-php/smarty/issues/831) +- PHP 8.1 deprecation warnings on null strings in modifiers [#834](https://github.com/smarty-php/smarty/pull/834) + +## [4.3.0] - 2022-11-22 + +### Added +- PHP8.2 compatibility [#775](https://github.com/smarty-php/smarty/pull/775) + +### Changed +- Include docs and demo in the releases [#799](https://github.com/smarty-php/smarty/issues/799) +- Using PHP functions as modifiers now triggers a deprecation notice because we will drop support for this in the next major release [#813](https://github.com/smarty-php/smarty/issues/813) +- Dropped remaining references to removed PHP-support in Smarty 4 from docs, lexer and security class. [#816](https://github.com/smarty-php/smarty/issues/816) +- Support umask when writing (template) files and set dir permissions to 777 [#548](https://github.com/smarty-php/smarty/issues/548) [#819](https://github.com/smarty-php/smarty/issues/819) + +### Fixed +- Output buffer is now cleaned for internal PHP errors as well, not just for Exceptions [#514](https://github.com/smarty-php/smarty/issues/514) +- Fixed recursion and out of memory errors when caching in complicated template set-ups using inheritance and includes [#801](https://github.com/smarty-php/smarty/pull/801) +- Fixed PHP8.1 deprecation errors in strip_tags +- Fix Variable Usage in Exception message when unable to load subtemplate [#808](https://github.com/smarty-php/smarty/pull/808) +- Fixed PHP8.1 deprecation notices for strftime [#672](https://github.com/smarty-php/smarty/issues/672) +- Fixed PHP8.1 deprecation errors passing null to parameter in trim [#807](https://github.com/smarty-php/smarty/pull/807) +- Adapt Smarty upper/lower functions to be codesafe (e.g. for Turkish locale) [#586](https://github.com/smarty-php/smarty/pull/586) +- Bug fix for underscore and limited length in template name in custom resources [#581](https://github.com/smarty-php/smarty/pull/581) + +## [4.2.1] - 2022-09-14 + +### Security +- Applied appropriate javascript and html escaping in mailto plugin to counter injection attacks [#454](https://github.com/smarty-php/smarty/issues/454) + +### Fixed +- Fixed PHP8.1 deprecation notices in modifiers (upper, explode, number_format and replace) [#755](https://github.com/smarty-php/smarty/pull/755) and [#788](https://github.com/smarty-php/smarty/pull/788) +- Fixed PHP8.1 deprecation notices in capitalize modifier [#789](https://github.com/smarty-php/smarty/issues/789) +- Fixed use of `rand()` without a parameter in math function [#794](https://github.com/smarty-php/smarty/issues/794) +- Fixed unselected year/month/day not working in html_select_date [#395](https://github.com/smarty-php/smarty/issues/395) + +## [4.2.0] - 2022-08-01 + +### Fixed +- Fixed problems with smarty_mb_str_replace [#549](https://github.com/smarty-php/smarty/issues/549) +- Fixed second parameter of unescape modifier not working [#777](https://github.com/smarty-php/smarty/issues/777) + +### Changed +- Updated HTML of the debug template [#599](https://github.com/smarty-php/smarty/pull/599) + ## [4.1.1] - 2022-05-17 ### Security -- Prevent PHP injection through malicious block name or include file name. This addresses CVE-2022- +- Prevent PHP injection through malicious block name or include file name. This addresses CVE-2022-29221 ### Fixed - Exclude docs and demo from export and composer [#751](https://github.com/smarty-php/smarty/pull/751) diff --git a/libs/smarty/README.md b/libs/smarty/README.md index 782f0b2..b6271e6 100644 --- a/libs/smarty/README.md +++ b/libs/smarty/README.md @@ -7,7 +7,7 @@ Smarty is a template engine for PHP, facilitating the separation of presentation Read the [documentation](https://smarty-php.github.io/smarty/) to find out how to use it. ## Requirements -Smarty can be run with PHP 7.1 to PHP 8.1. +Smarty can be run with PHP 7.1 to PHP 8.4. ## Installation Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/). diff --git a/libs/smarty/SECURITY.md b/libs/smarty/SECURITY.md index d98ea01..80b5ef5 100644 --- a/libs/smarty/SECURITY.md +++ b/libs/smarty/SECURITY.md @@ -2,18 +2,19 @@ ## Supported Versions -Smarty currently supports the latest minor version of Smarty 3 and Smarty 4. (Smarty 4 has not been released yet.) +Smarty currently supports the latest minor version of Smarty 3 and Smarty 4. | Version | Supported | -| ------- | ------------------ | -| 4.0.x | :white_check_mark: | +|---------|--------------------| +| 4.3.x | :white_check_mark: | | 3.1.x | :white_check_mark: | | < 3.1 | :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 PLEASE do not file an Issue. +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. diff --git a/libs/smarty/changelog/.gitkeep b/libs/smarty/changelog/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/libs/smarty/demo/configs/test.conf b/libs/smarty/demo/configs/test.conf new file mode 100644 index 0000000..5eac748 --- /dev/null +++ b/libs/smarty/demo/configs/test.conf @@ -0,0 +1,5 @@ +title = Welcome to Smarty! +cutoff_size = 40 + +[setup] +bold = true diff --git a/libs/smarty/demo/index.php b/libs/smarty/demo/index.php new file mode 100644 index 0000000..3aed371 --- /dev/null +++ b/libs/smarty/demo/index.php @@ -0,0 +1,35 @@ +force_compile = 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("option_selected", "NE"); +$smarty->display('index.tpl'); diff --git a/libs/smarty/demo/plugins/cacheresource.apc.php b/libs/smarty/demo/plugins/cacheresource.apc.php new file mode 100644 index 0000000..7867cc5 --- /dev/null +++ b/libs/smarty/demo/plugins/cacheresource.apc.php @@ -0,0 +1,85 @@ + $v) { + $_res[ $k ] = $v; + } + return $_res; + } + + /** + * Save values for a set of keys to cache + * + * @param array $keys list of values to save + * @param int $expire expiration time + * + * @return boolean true on success, false on failure + */ + protected function write(array $keys, $expire = null) + { + foreach ($keys as $k => $v) { + apc_store($k, $v, $expire); + } + return true; + } + + /** + * Remove values from cache + * + * @param array $keys list of keys to delete + * + * @return boolean true on success, false on failure + */ + protected function delete(array $keys) + { + foreach ($keys as $k) { + apc_delete($k); + } + return true; + } + + /** + * Remove *all* values from cache + * + * @return boolean true on success, false on failure + */ + protected function purge() + { + return apc_clear_cache('user'); + } +} diff --git a/libs/smarty/demo/plugins/cacheresource.memcache.php b/libs/smarty/demo/plugins/cacheresource.memcache.php new file mode 100644 index 0000000..71fe9d3 --- /dev/null +++ b/libs/smarty/demo/plugins/cacheresource.memcache.php @@ -0,0 +1,99 @@ +memcache = new Memcached(); + } else { + $this->memcache = new Memcache(); + } + $this->memcache->addServer('127.0.0.1', 11211); + } + + /** + * Read values for a set of keys from cache + * + * @param array $keys list of keys to fetch + * + * @return array list of values with the given keys used as indexes + * @return boolean true on success, false on failure + */ + protected function read(array $keys) + { + $res = array(); + foreach ($keys as $key) { + $k = sha1($key); + $res[$key] = $this->memcache->get($k); + } + return $res; + } + + /** + * Save values for a set of keys to cache + * + * @param array $keys list of values to save + * @param int $expire expiration time + * + * @return boolean true on success, false on failure + */ + protected function write(array $keys, $expire = null) + { + foreach ($keys as $k => $v) { + $k = sha1($k); + if (class_exists('Memcached')) { + $this->memcache->set($k, $v, $expire); + } else { + $this->memcache->set($k, $v, 0, $expire); + } + } + return true; + } + + /** + * Remove values from cache + * + * @param array $keys list of keys to delete + * + * @return boolean true on success, false on failure + */ + protected function delete(array $keys) + { + foreach ($keys as $k) { + $k = sha1($k); + $this->memcache->delete($k); + } + return true; + } + + /** + * Remove *all* values from cache + * + * @return boolean true on success, false on failure + */ + protected function purge() + { + return $this->memcache->flush(); + } +} diff --git a/libs/smarty/demo/plugins/cacheresource.mysql.php b/libs/smarty/demo/plugins/cacheresource.mysql.php new file mode 100644 index 0000000..c5037eb --- /dev/null +++ b/libs/smarty/demo/plugins/cacheresource.mysql.php @@ -0,0 +1,183 @@ +CREATE TABLE IF NOT EXISTS `output_cache` ( + * `id` CHAR(40) NOT NULL COMMENT 'sha1 hash', + * `name` VARCHAR(250) NOT NULL, + * `cache_id` VARCHAR(250) NULL DEFAULT NULL, + * `compile_id` VARCHAR(250) NULL DEFAULT NULL, + * `modified` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, + * `content` LONGTEXT NOT NULL, + * PRIMARY KEY (`id`), + * INDEX(`name`), + * INDEX(`cache_id`), + * INDEX(`compile_id`), + * INDEX(`modified`) + * ) ENGINE = InnoDB; + * + * @package CacheResource-examples + * @author Rodney Rehm + */ +class Smarty_CacheResource_Mysql extends Smarty_CacheResource_Custom +{ + /** + * @var \PDO + */ + protected $db; + + /** + * @var \PDOStatement + */ + protected $fetch; + + /** + * @var \PDOStatement + */ + protected $fetchTimestamp; + + /** + * @var \PDOStatement + */ + protected $save; + + /** + * Smarty_CacheResource_Mysql constructor. + * + * @throws \SmartyException + */ + public function __construct() + { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty"); + } catch (PDOException $e) { + throw new SmartyException('Mysql Resource failed: ' . $e->getMessage()); + } + $this->fetch = $this->db->prepare('SELECT modified, content FROM output_cache WHERE id = :id'); + $this->fetchTimestamp = $this->db->prepare('SELECT modified FROM output_cache WHERE id = :id'); + $this->save = $this->db->prepare( + 'REPLACE INTO output_cache (id, name, cache_id, compile_id, content) + VALUES (:id, :name, :cache_id, :compile_id, :content)' + ); + } + + /** + * fetch cached content and its modification time from data source + * + * @param string $id unique cache content identifier + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * @param string $content cached content + * @param integer $mtime cache modification timestamp (epoch) + * + * @return void + */ + protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime) + { + $this->fetch->execute(array('id' => $id)); + $row = $this->fetch->fetch(); + $this->fetch->closeCursor(); + if ($row) { + $content = $row[ 'content' ]; + $mtime = strtotime($row[ 'modified' ]); + } else { + $content = null; + $mtime = null; + } + } + + /** + * Fetch cached content's modification timestamp from data source + * + * @note implementing this method is optional. Only implement it if modification times can be accessed faster than + * loading the complete cached content. + * + * @param string $id unique cache content identifier + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * + * @return integer|boolean timestamp (epoch) the template was modified, or false if not found + */ + protected function fetchTimestamp($id, $name, $cache_id, $compile_id) + { + $this->fetchTimestamp->execute(array('id' => $id)); + $mtime = strtotime($this->fetchTimestamp->fetchColumn()); + $this->fetchTimestamp->closeCursor(); + return $mtime; + } + + /** + * Save content to cache + * + * @param string $id unique cache content identifier + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * @param integer|null $exp_time seconds till expiration time in seconds or null + * @param string $content content to cache + * + * @return boolean success + */ + protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content) + { + $this->save->execute( + array('id' => $id, + 'name' => $name, + 'cache_id' => $cache_id, + 'compile_id' => $compile_id, + 'content' => $content,) + ); + return !!$this->save->rowCount(); + } + + /** + * Delete content from cache + * + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * @param integer|null $exp_time seconds till expiration or null + * + * @return integer number of deleted caches + */ + protected function delete($name, $cache_id, $compile_id, $exp_time) + { + // delete the whole cache + if ($name === null && $cache_id === null && $compile_id === null && $exp_time === null) { + // returning the number of deleted caches would require a second query to count them + $query = $this->db->query('TRUNCATE TABLE output_cache'); + return -1; + } + // build the filter + $where = array(); + // equal test name + if ($name !== null) { + $where[] = 'name = ' . $this->db->quote($name); + } + // equal test compile_id + if ($compile_id !== null) { + $where[] = 'compile_id = ' . $this->db->quote($compile_id); + } + // range test expiration time + if ($exp_time !== null) { + $where[] = 'modified < DATE_SUB(NOW(), INTERVAL ' . intval($exp_time) . ' SECOND)'; + } + // equal test cache_id and match sub-groups + if ($cache_id !== null) { + $where[] = + '(cache_id = ' . + $this->db->quote($cache_id) . + ' OR cache_id LIKE ' . + $this->db->quote($cache_id . '|%') . + ')'; + } + // run delete query + $query = $this->db->query('DELETE FROM output_cache WHERE ' . join(' AND ', $where)); + return $query->rowCount(); + } +} diff --git a/libs/smarty/demo/plugins/cacheresource.pdo.php b/libs/smarty/demo/plugins/cacheresource.pdo.php new file mode 100644 index 0000000..ae3ebbf --- /dev/null +++ b/libs/smarty/demo/plugins/cacheresource.pdo.php @@ -0,0 +1,346 @@ +setCachingType('pdo'); + * $smarty->loadPlugin('Smarty_CacheResource_Pdo'); + * $smarty->registerCacheResource('pdo', new Smarty_CacheResource_Pdo($cnx, 'smarty_cache')); + * + * @author Beno!t POLASZEK - 2014 + */ +class Smarty_CacheResource_Pdo extends Smarty_CacheResource_Custom +{ + /** + * @var string[] + */ + protected $fetchStatements = array('default' => 'SELECT %2$s + FROM %1$s + WHERE 1 + AND id = :id + AND cache_id IS NULL + AND compile_id IS NULL', + 'withCacheId' => 'SELECT %2$s + FROM %1$s + WHERE 1 + AND id = :id + AND cache_id = :cache_id + AND compile_id IS NULL', + 'withCompileId' => 'SELECT %2$s + FROM %1$s + WHERE 1 + AND id = :id + AND compile_id = :compile_id + AND cache_id IS NULL', + 'withCacheIdAndCompileId' => 'SELECT %2$s + FROM %1$s + WHERE 1 + AND id = :id + AND cache_id = :cache_id + AND compile_id = :compile_id'); + + /** + * @var string + */ + protected $insertStatement = 'INSERT INTO %s + + SET id = :id, + name = :name, + cache_id = :cache_id, + compile_id = :compile_id, + modified = CURRENT_TIMESTAMP, + expire = DATE_ADD(CURRENT_TIMESTAMP, INTERVAL :expire SECOND), + content = :content + + ON DUPLICATE KEY UPDATE + name = :name, + cache_id = :cache_id, + compile_id = :compile_id, + modified = CURRENT_TIMESTAMP, + expire = DATE_ADD(CURRENT_TIMESTAMP, INTERVAL :expire SECOND), + content = :content'; + + /** + * @var string + */ + protected $deleteStatement = 'DELETE FROM %1$s WHERE %2$s'; + + /** + * @var string + */ + protected $truncateStatement = 'TRUNCATE TABLE %s'; + + /** + * @var string + */ + protected $fetchColumns = 'modified, content'; + + /** + * @var string + */ + protected $fetchTimestampColumns = 'modified'; + + /** + * @var \PDO + */ + protected $pdo; + + /** + * @var + */ + protected $table; + + /** + * @var null + */ + protected $database; + + /** + * Constructor + * + * @param PDO $pdo PDO : active connection + * @param string $table : table (or view) name + * @param string $database : optional - if table is located in another db + * + * @throws \SmartyException + */ + public function __construct(PDO $pdo, $table, $database = null) + { + if (is_null($table)) { + throw new SmartyException("Table name for caching can't be null"); + } + $this->pdo = $pdo; + $this->table = $table; + $this->database = $database; + $this->fillStatementsWithTableName(); + } + + /** + * Fills the table name into the statements. + * + * @return $this Current Instance + * @access protected + */ + protected function fillStatementsWithTableName() + { + foreach ($this->fetchStatements as &$statement) { + $statement = sprintf($statement, $this->getTableName(), '%s'); + } + $this->insertStatement = sprintf($this->insertStatement, $this->getTableName()); + $this->deleteStatement = sprintf($this->deleteStatement, $this->getTableName(), '%s'); + $this->truncateStatement = sprintf($this->truncateStatement, $this->getTableName()); + return $this; + } + + /** + * Gets the fetch statement, depending on what you specify + * + * @param string $columns : the column(s) name(s) you want to retrieve from the database + * @param string $id unique cache content identifier + * @param string|null $cache_id cache id + * @param string|null $compile_id compile id + * + * @access protected + * @return \PDOStatement + */ + protected function getFetchStatement($columns, $id, $cache_id = null, $compile_id = null) + { + $args = array(); + if (!is_null($cache_id) && !is_null($compile_id)) { + $query = $this->fetchStatements[ 'withCacheIdAndCompileId' ] and + $args = array('id' => $id, 'cache_id' => $cache_id, 'compile_id' => $compile_id); + } elseif (is_null($cache_id) && !is_null($compile_id)) { + $query = $this->fetchStatements[ 'withCompileId' ] and + $args = array('id' => $id, 'compile_id' => $compile_id); + } elseif (!is_null($cache_id) && is_null($compile_id)) { + $query = $this->fetchStatements[ 'withCacheId' ] and $args = array('id' => $id, 'cache_id' => $cache_id); + } else { + $query = $this->fetchStatements[ 'default' ] and $args = array('id' => $id); + } + $query = sprintf($query, $columns); + $stmt = $this->pdo->prepare($query); + foreach ($args as $key => $value) { + $stmt->bindValue($key, $value); + } + return $stmt; + } + + /** + * fetch cached content and its modification time from data source + * + * @param string $id unique cache content identifier + * @param string $name template name + * @param string|null $cache_id cache id + * @param string|null $compile_id compile id + * @param string $content cached content + * @param integer $mtime cache modification timestamp (epoch) + * + * @return void + * @access protected + */ + protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime) + { + $stmt = $this->getFetchStatement($this->fetchColumns, $id, $cache_id, $compile_id); + $stmt->execute(); + $row = $stmt->fetch(); + $stmt->closeCursor(); + if ($row) { + $content = $this->outputContent($row[ 'content' ]); + $mtime = strtotime($row[ 'modified' ]); + } else { + $content = null; + $mtime = null; + } + } + + /** + * Fetch cached content's modification timestamp from data source + * {@internal implementing this method is optional. + * Only implement it if modification times can be accessed faster than loading the complete cached content.}} + * + * @param string $id unique cache content identifier + * @param string $name template name + * @param string|null $cache_id cache id + * @param string|null $compile_id compile id + * + * @return integer|boolean timestamp (epoch) the template was modified, or false if not found + * @access protected + */ + // protected function fetchTimestamp($id, $name, $cache_id = null, $compile_id = null) { + // $stmt = $this->getFetchStatement($this->fetchTimestampColumns, $id, $cache_id, $compile_id); + // $stmt -> execute(); + // $mtime = strtotime($stmt->fetchColumn()); + // $stmt -> closeCursor(); + // return $mtime; + // } + /** + * Save content to cache + * + * @param string $id unique cache content identifier + * @param string $name template name + * @param string|null $cache_id cache id + * @param string|null $compile_id compile id + * @param integer|null $exp_time seconds till expiration time in seconds or null + * @param string $content content to cache + * + * @return boolean success + * @access protected + */ + protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content) + { + $stmt = $this->pdo->prepare($this->insertStatement); + $stmt->bindValue('id', $id); + $stmt->bindValue('name', $name); + $stmt->bindValue('cache_id', $cache_id, (is_null($cache_id)) ? PDO::PARAM_NULL : PDO::PARAM_STR); + $stmt->bindValue('compile_id', $compile_id, (is_null($compile_id)) ? PDO::PARAM_NULL : PDO::PARAM_STR); + $stmt->bindValue('expire', (int)$exp_time, PDO::PARAM_INT); + $stmt->bindValue('content', $this->inputContent($content)); + $stmt->execute(); + return !!$stmt->rowCount(); + } + + /** + * Encodes the content before saving to database + * + * @param string $content + * + * @return string $content + * @access protected + */ + protected function inputContent($content) + { + return $content; + } + + /** + * Decodes the content before saving to database + * + * @param string $content + * + * @return string $content + * @access protected + */ + protected function outputContent($content) + { + return $content; + } + + /** + * Delete content from cache + * + * @param string|null $name template name + * @param string|null $cache_id cache id + * @param string|null $compile_id compile id + * @param integer|null|-1 $exp_time seconds till expiration or null + * + * @return integer number of deleted caches + * @access protected + */ + protected function delete($name = null, $cache_id = null, $compile_id = null, $exp_time = null) + { + // delete the whole cache + if ($name === null && $cache_id === null && $compile_id === null && $exp_time === null) { + // returning the number of deleted caches would require a second query to count them + $this->pdo->query($this->truncateStatement); + return -1; + } + // build the filter + $where = array(); + // equal test name + if ($name !== null) { + $where[] = 'name = ' . $this->pdo->quote($name); + } + // equal test cache_id and match sub-groups + if ($cache_id !== null) { + $where[] = + '(cache_id = ' . + $this->pdo->quote($cache_id) . + ' OR cache_id LIKE ' . + $this->pdo->quote($cache_id . '|%') . + ')'; + } + // equal test compile_id + if ($compile_id !== null) { + $where[] = 'compile_id = ' . $this->pdo->quote($compile_id); + } + // for clearing expired caches + if ($exp_time === Smarty::CLEAR_EXPIRED) { + $where[] = 'expire < CURRENT_TIMESTAMP'; + } // range test expiration time + elseif ($exp_time !== null) { + $where[] = 'modified < DATE_SUB(NOW(), INTERVAL ' . intval($exp_time) . ' SECOND)'; + } + // run delete query + $query = $this->pdo->query(sprintf($this->deleteStatement, join(' AND ', $where))); + return $query->rowCount(); + } + + /** + * Gets the formatted table name + * + * @return string + * @access protected + */ + protected function getTableName() + { + return (is_null($this->database)) ? "`{$this->table}`" : "`{$this->database}`.`{$this->table}`"; + } +} diff --git a/libs/smarty/demo/plugins/cacheresource.pdo_gzip.php b/libs/smarty/demo/plugins/cacheresource.pdo_gzip.php new file mode 100644 index 0000000..5560b9e --- /dev/null +++ b/libs/smarty/demo/plugins/cacheresource.pdo_gzip.php @@ -0,0 +1,42 @@ +setCachingType('pdo_gzip'); + * $smarty->loadPlugin('Smarty_CacheResource_Pdo_Gzip'); + * $smarty->registerCacheResource('pdo_gzip', new Smarty_CacheResource_Pdo_Gzip($cnx, 'smarty_cache')); + * + * @require Smarty_CacheResource_Pdo class + * @author Beno!t POLASZEK - 2014 + */ +class Smarty_CacheResource_Pdo_Gzip extends Smarty_CacheResource_Pdo +{ + /** + * Encodes the content before saving to database + * + * @param string $content + * + * @return string $content + * @access protected + */ + protected function inputContent($content) + { + return gzdeflate($content); + } + + /** + * Decodes the content before saving to database + * + * @param string $content + * + * @return string $content + * @access protected + */ + protected function outputContent($content) + { + return gzinflate($content); + } +} diff --git a/libs/smarty/demo/plugins/resource.extendsall.php b/libs/smarty/demo/plugins/resource.extendsall.php new file mode 100644 index 0000000..fba9b4f --- /dev/null +++ b/libs/smarty/demo/plugins/resource.extendsall.php @@ -0,0 +1,62 @@ +smarty->getTemplateDir() as $key => $directory) { + try { + $s = Smarty_Resource::source(null, $source->smarty, 'file:' . '[' . $key . ']' . $source->name); + if (!$s->exists) { + continue; + } + $sources[ $s->uid ] = $s; + $uid .= $s->filepath; + $timestamp = $s->timestamp > $timestamp ? $s->timestamp : $timestamp; + } catch (SmartyException $e) { + } + } + if (!$sources) { + $source->exists = false; + return; + } + $sources = array_reverse($sources, true); + reset($sources); + $s = current($sources); + $source->components = $sources; + $source->filepath = $s->filepath; + $source->uid = sha1($uid . $source->smarty->_joined_template_dir); + $source->exists = true; + $source->timestamp = $timestamp; + } + + /** + * Disable timestamp checks for extendsall resource. + * The individual source components will be checked. + * + * @return bool false + */ + public function checkTimestamps() + { + return false; + } +} diff --git a/libs/smarty/demo/plugins/resource.mysql.php b/libs/smarty/demo/plugins/resource.mysql.php new file mode 100644 index 0000000..95a3c2b --- /dev/null +++ b/libs/smarty/demo/plugins/resource.mysql.php @@ -0,0 +1,101 @@ +CREATE TABLE IF NOT EXISTS `templates` ( + * `name` varchar(100) NOT NULL, + * `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + * `source` text, + * PRIMARY KEY (`name`) + * ) ENGINE=InnoDB DEFAULT CHARSET=utf8; + * Demo data: + * 
INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello
+ * world"}{$x}');
+ * + * + * @package Resource-examples + * @author Rodney Rehm + */ +class Smarty_Resource_Mysql extends Smarty_Resource_Custom +{ + /** + * PDO instance + * + * @var \PDO + */ + protected $db; + + /** + * prepared fetch() statement + * + * @var \PDOStatement + */ + protected $fetch; + + /** + * prepared fetchTimestamp() statement + * + * @var \PDOStatement + */ + protected $mtime; + + /** + * Smarty_Resource_Mysql constructor. + * + * @throws \SmartyException + */ + public function __construct() + { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty"); + } catch (PDOException $e) { + throw new SmartyException('Mysql Resource failed: ' . $e->getMessage()); + } + $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name'); + $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name'); + } + + /** + * Fetch a template and its modification time from database + * + * @param string $name template name + * @param string $source template source + * @param integer $mtime template modification timestamp (epoch) + * + * @return void + */ + protected function fetch($name, &$source, &$mtime) + { + $this->fetch->execute(array('name' => $name)); + $row = $this->fetch->fetch(); + $this->fetch->closeCursor(); + if ($row) { + $source = $row[ 'source' ]; + $mtime = strtotime($row[ 'modified' ]); + } else { + $source = null; + $mtime = null; + } + } + + /** + * Fetch a template's modification time from database + * + * @note implementing this method is optional. Only implement it if modification times can be accessed faster than + * loading the comple template source. + * + * @param string $name template name + * + * @return integer timestamp (epoch) the template was modified + */ + protected function fetchTimestamp($name) + { + $this->mtime->execute(array('name' => $name)); + $mtime = $this->mtime->fetchColumn(); + $this->mtime->closeCursor(); + return strtotime($mtime); + } +} diff --git a/libs/smarty/demo/plugins/resource.mysqls.php b/libs/smarty/demo/plugins/resource.mysqls.php new file mode 100644 index 0000000..148a8dd --- /dev/null +++ b/libs/smarty/demo/plugins/resource.mysqls.php @@ -0,0 +1,77 @@ +CREATE TABLE IF NOT EXISTS `templates` ( + * `name` varchar(100) NOT NULL, + * `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + * `source` text, + * PRIMARY KEY (`name`) + * ) ENGINE=InnoDB DEFAULT CHARSET=utf8; + * Demo data: + * 
INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello
+ * world"}{$x}');
+ * + * + * @package Resource-examples + * @author Rodney Rehm + */ +class Smarty_Resource_Mysqls extends Smarty_Resource_Custom +{ + /** + * PDO instance + * + * @var \PDO + */ + protected $db; + + /** + * prepared fetch() statement + * + * @var \PDOStatement + */ + protected $fetch; + + /** + * Smarty_Resource_Mysqls constructor. + * + * @throws \SmartyException + */ + public function __construct() + { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty"); + } catch (PDOException $e) { + throw new SmartyException('Mysql Resource failed: ' . $e->getMessage()); + } + $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name'); + } + + /** + * Fetch a template and its modification time from database + * + * @param string $name template name + * @param string $source template source + * @param integer $mtime template modification timestamp (epoch) + * + * @return void + */ + protected function fetch($name, &$source, &$mtime) + { + $this->fetch->execute(array('name' => $name)); + $row = $this->fetch->fetch(); + $this->fetch->closeCursor(); + if ($row) { + $source = $row[ 'source' ]; + $mtime = strtotime($row[ 'modified' ]); + } else { + $source = null; + $mtime = null; + } + } +} diff --git a/libs/smarty/demo/templates/footer.tpl b/libs/smarty/demo/templates/footer.tpl new file mode 100644 index 0000000..e04310f --- /dev/null +++ b/libs/smarty/demo/templates/footer.tpl @@ -0,0 +1,2 @@ + + diff --git a/libs/smarty/demo/templates/header.tpl b/libs/smarty/demo/templates/header.tpl new file mode 100644 index 0000000..783210a --- /dev/null +++ b/libs/smarty/demo/templates/header.tpl @@ -0,0 +1,5 @@ + + +{$title} - {$Name} + + diff --git a/libs/smarty/demo/templates/index.tpl b/libs/smarty/demo/templates/index.tpl new file mode 100644 index 0000000..1fbb6d3 --- /dev/null +++ b/libs/smarty/demo/templates/index.tpl @@ -0,0 +1,87 @@ +{config_load file="test.conf" section="setup"} +{include file="header.tpl" title=foo} + +
+
+{* bold and title are read from the config file *}
+    {if #bold#}{/if}
+        {* capitalize the first letters of each word of the title *}
+        Title: {#title#|capitalize}
+        {if #bold#}{/if}
+
+    The current date and time is {$smarty.now|date_format:"%Y-%m-%d %H:%M:%S"}
+
+    The value of global assigned variable $SCRIPT_NAME is {$SCRIPT_NAME}
+
+    Example of accessing server environment variable SERVER_NAME: {$smarty.server.SERVER_NAME}
+
+    The value of {ldelim}$Name{rdelim} is {$Name}
+
+variable modifier example of {ldelim}$Name|upper{rdelim}
+
+{$Name|upper}
+
+
+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}
+
+    An example of section looped key values:
+
+    {section name=sec1 loop=$contacts}
+        phone: {$contacts[sec1].phone}
+        

+
+            fax: {$contacts[sec1].fax}
+        

+
+            cell: {$contacts[sec1].cell}
+        

+    {/section}
+    

+
+        testing strip tags
+        {strip}
+
+    
+        
+    
+

+            
+                This is a test 
+            
+        

+    {/strip}
+
+
+ +This is an example of the html_select_date function: + +
+ {html_select_date start_year=1998 end_year=2010} +
+ +This is an example of the html_select_time function: + +
+ {html_select_time use_24_hours=false} +
+ +This is an example of the html_options function: + +
+ +
+ +{include file="footer.tpl"} diff --git a/libs/smarty/docs/_config.yml b/libs/smarty/docs/_config.yml new file mode 100644 index 0000000..2f7efbe --- /dev/null +++ b/libs/smarty/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal \ No newline at end of file diff --git a/libs/smarty/docs/appendixes/tips.md b/libs/smarty/docs/appendixes/tips.md new file mode 100644 index 0000000..3c6e6b9 --- /dev/null +++ b/libs/smarty/docs/appendixes/tips.md @@ -0,0 +1,274 @@ +# 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 + + + + {$title|default:'Smarty News'} + + + +``` + + +`footer.tpl` + +```smarty + + + + +``` + + +## 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 + +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 + +
Send inquiries to +{mailto address=$EmailAddress encode='javascript' subject='Hello'} +
+ +``` + +> **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). diff --git a/libs/smarty/docs/appendixes/troubleshooting.md b/libs/smarty/docs/appendixes/troubleshooting.md new file mode 100644 index 0000000..8364534 --- /dev/null +++ b/libs/smarty/docs/appendixes/troubleshooting.md @@ -0,0 +1,104 @@ +# 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). diff --git a/libs/smarty/docs/designers/chapter-debugging-console.md b/libs/smarty/docs/designers/chapter-debugging-console.md new file mode 100644 index 0000000..6704fce --- /dev/null +++ b/libs/smarty/docs/designers/chapter-debugging-console.md @@ -0,0 +1,40 @@ +# 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` (this is in [`SMARTY_DIR`](../programmers/smarty-constants.md) by +default). When you load the page, a Javascript console window will pop +up and give you the names of all the included templates and assigned +variables for the current page. + +To see the available variables for a particular template, see the +[`{debug}`](./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). diff --git a/libs/smarty/docs/designers/config-files.md b/libs/smarty/docs/designers/config-files.md new file mode 100644 index 0000000..1e1db2d --- /dev/null +++ b/libs/smarty/docs/designers/config-files.md @@ -0,0 +1,74 @@ +# 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) diff --git a/libs/smarty/docs/designers/language-basic-syntax/index.md b/libs/smarty/docs/designers/language-basic-syntax/index.md new file mode 100644 index 0000000..c0a12a9 --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/index.md @@ -0,0 +1,33 @@ +# Basic Syntax + +A simple Smarty template could look like this: +```smarty +

{$title|escape}

+ +``` + +All Smarty template tags are enclosed within delimiters. By default +these are `{` and `}`, but they can be +[changed](../../programmers/api-variables/variable-left-delimiter.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 basis components of the Smarty syntax are: + +- [Comments](language-syntax-comments.md) +- [Variables](language-syntax-variables.md) +- [Functions](language-syntax-functions.md) +- [Attributes](language-syntax-attributes.md) +- [Quotes](language-syntax-quotes.md) +- [Math](language-math.md) +- [Escaping](language-escaping.md) diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-escaping.md b/libs/smarty/docs/designers/language-basic-syntax/language-escaping.md new file mode 100644 index 0000000..4c75e09 --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-escaping.md @@ -0,0 +1,79 @@ +# 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 + +``` + +[`{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 +[`$left_delimiter`](../../programmers/api-variables/variable-left-delimiter.md) and +[`$right_delimiter`](../../programmers/api-variables/variable-right-delimiter.md) values. + +> **Note** +> +> Changing delimiters affects ALL template syntax and escapement. Be +> sure to clear out cache and compiled files if you decide to change +> them. + +```php +left_delimiter = ''; + +$smarty->assign('foo', 'bar'); +$smarty->assign('name', 'Albert'); +$smarty->display('example.tpl'); +``` + +Where the template is: + +```smarty +Welcome to Smarty + +``` diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-math.md b/libs/smarty/docs/designers/language-basic-syntax/language-math.md new file mode 100644 index 0000000..a9a43ef --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-math.md @@ -0,0 +1,28 @@ +# Math + +Math can be applied directly to variable values. + +## Examples +```smarty +{$foo+1} + +{$foo*$bar} + +{* some more complicated examples *} + +{$foo->bar-$bar[1]*$baz->foo->bar()-3*7} + +{if ($foo+$bar.test%$baz*134232+10+$b+10)} + +{$foo|truncate:"`$fooTruncCount/$barTruncFactor-1`"} + +{assign var="foo" value="`$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. diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md new file mode 100644 index 0000000..41f6c45 --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md @@ -0,0 +1,49 @@ +# Attributes + +Most of the [functions](./language-syntax-functions.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"} + + +``` + +> **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. diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md new file mode 100644 index 0000000..7052c20 --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md @@ -0,0 +1,69 @@ +# Comments + +Template comments are surrounded by asterisks, and that is surrounded by +the [delimiter](../../programmers/api-variables/variable-left-delimiter.md) tags like so: + +## Examples + +```smarty +{* this is a comment *} +``` + +Smarty comments are NOT displayed in the final output of the template, +unlike ``. 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 *} + + + {$title} + + + + {* another single line smarty comment *} + + + {* 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 *} + + {include file=$includeFile} + + {* this + {html_options options=$vals selected=$selected_id} + + *} + + + {* $affiliate|upper *} + + {* you cannot nest comments *} + {* + + *} + + + +``` + diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md new file mode 100644 index 0000000..c3c8c21 --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md @@ -0,0 +1,40 @@ +# Functions + +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"} +{insert file="banner_ads.tpl" title="My Site"} + +{if $logged_in} + Welcome, {$name}! +{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 functions are **additional** functions implemented via + [plugins](../../programmers/plugins.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) diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md new file mode 100644 index 0000000..e04e6da --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md @@ -0,0 +1,54 @@ +# 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). diff --git a/libs/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md new file mode 100644 index 0000000..c0285d0 --- /dev/null +++ b/libs/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md @@ -0,0 +1,109 @@ +# 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)} + +Direct PHP function access: + +{time()} +``` + +> **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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/index.md b/libs/smarty/docs/designers/language-builtin-functions/index.md new file mode 100644 index 0000000..10dc3a6 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/index.md @@ -0,0 +1,35 @@ +# 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 functions](../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) + diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-append.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-append.md new file mode 100644 index 0000000..37e1b81 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-append.md @@ -0,0 +1,49 @@ +# {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}.
+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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-assign.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-assign.md new file mode 100644 index 0000000..f5faa46 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-assign.md @@ -0,0 +1,147 @@ +# {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}
+``` + +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"} +``` + +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 +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), +[`{insert}`](#language.function.insert), +[`{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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-block.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-block.md new file mode 100644 index 0000000..c2acd19 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-block.md @@ -0,0 +1,201 @@ +# {block} + +`{block}` is used to define a named area of template source for template +inheritance. For details see section of [Template +Inheritance](../../programmers/advanced-features/advanced-features-template-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 + + + {block name="title"}Default Title{/block} + {block "title"}Default Title{/block} {* short-hand *} + + +``` + + +child.tpl + +```smarty + {extends file="parent.tpl"} + {block name="title"} + Page Title + {/block} +``` + + +The result would look like + +```html + + + Page Title + + +``` + +parent.tpl + +```smarty + + + {block name="title"}Title - {/block} + + +``` + + +child.tpl + +```smarty + {extends file="parent.tpl"} + {block name="title" append} + Page Title + {/block} +``` + + +The result would look like + +```html + + + Title - Page Title + + +``` + +parent.tpl + +```smarty + + + {block name="title"} is my title{/block} + + +``` + +child.tpl + +```smarty + {extends file="parent.tpl"} + {block name="title" prepend} + Page Title + {/block} +``` + + +The result would look like + +```html + + + Page title is my titel + + +``` + +parent.tpl + +```smarty + + + {block name="title"}The {$smarty.block.child} was inserted here{/block} + + +``` + +child.tpl + +```smarty + {extends file="parent.tpl"} + {block name="title"} + Child Title + {/block} +``` + +The result would look like + +```html + + + The Child Title was inserted here + + +``` + +parent.tpl + +```smarty + + + {block name="title"}Parent Title{/block} + + +``` + + +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 + + + You will see now - Parent Title - here + + +``` + +See also [Template +Inheritance](../../programmers/advanced-features/advanced-features-template-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) diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-call.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-call.md new file mode 100644 index 0000000..c07fb49 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-call.md @@ -0,0 +1,77 @@ +# {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} + + {/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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-capture.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-capture.md new file mode 100644 index 0000000..657f077 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-capture.md @@ -0,0 +1,81 @@ +# {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 | + +> **Note** +> +> Be careful when capturing [`{insert}`](#language.function.insert) +> output. If you have [`$caching`](#caching) enabled and you have +> [`{insert}`](#language.function.insert) commands that you expect to +> run within cached content, do not capture this content. + +## 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 ""} + +{/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}
+Your ip is {$my_ip}. +{/capture} +{$popText} +``` + + +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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-config-load.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-config-load.md new file mode 100644 index 0000000..e13c308 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-config-load.md @@ -0,0 +1,88 @@ +# {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 *} + + + {#pageTitle#|default:"No title"} + + + + + + + +
FirstLastAddress
+ + +``` + +[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 *} + + + {#pageTitle#} + + + + + + + +
FirstLastAddress
+ + +``` + +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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-debug.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-debug.md new file mode 100644 index 0000000..29485d5 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-debug.md @@ -0,0 +1,17 @@ +# {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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-extends.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-extends.md new file mode 100644 index 0000000..eba17b9 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-extends.md @@ -0,0 +1,37 @@ +# {extends} + +`{extends}` tags are used in child templates in template inheritance for +extending parent templates. For details see section of [Template +Inheritance](../../programmers/advanced-features/advanced-features-template-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](../../programmers/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](../../programmers/advanced-features/advanced-features-template-inheritance.md) +and [`{block}`](./language-function-block.md). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-for.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-for.md new file mode 100644 index 0000000..619b61e --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-for.md @@ -0,0 +1,91 @@ +# {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 + +``` + +The above example will output: + +```html + +``` + +```php +assign('to',10); +``` + +```smarty + +``` + +The above example will output: + +```html + +``` + +```php +assign('start',10); +$smarty->assign('to',5); +``` + +```smarty + +``` + +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) diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-foreach.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-foreach.md new file mode 100644 index 0000000..645d6c5 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-foreach.md @@ -0,0 +1,389 @@ +# {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 +assign('myColors', $arr); +``` + +Template to output `$myColors` in an un-ordered list + +```smarty + +``` + +The above example will output: + +```html + +``` + +```php + 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com'); +$smarty->assign('myPeople', $people); +``` + +Template to output `$myArray` as key/value pairs. + +```smarty + +``` + +The above example will output: + +```html + +``` + +Assign an array to Smarty, the key contains the key for each looped +value. + +```php +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 + 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) *} + + {foreach $items as $i} + {if $i@index eq 3} + {* put empty table row *} + + {/if} + + {/foreach} +
nbsp;
{$i.label}
+``` + + +## @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} + {$name} + {/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@iteration is even by 3} + {$name} + {else} + {$name} + {/if} + {/foreach} +``` + +This will output something similar to this: + +```html +... +... +... +... +... +... +... +... +... +... +... +... +... +``` + +## @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 *} + + {foreach $items as $i} + {if $i@first} + + + {/if} + + + + + {/foreach} +
key + name +
{$i@key}{$i.name}
+``` + +## @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} + {$item.name}{if $item@last}
{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 + +{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}
+ {if $item@last} +
{$item@total} items
+ {/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 + *} +``` diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-function.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-function.md new file mode 100644 index 0000000..cee6762 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-function.md @@ -0,0 +1,89 @@ +# {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 *} + +{/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) diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-if.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-if.md new file mode 100644 index 0000000..c7be37a --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-if.md @@ -0,0 +1,120 @@ +# {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 PHP conditionals and +functions are recognized, such as *\|\|*, *or*, *&&*, *and*, +*is_array()*, etc. + +If security is enabled, only PHP functions from `$php_functions` property +of the security policy are allowed. See the +[Security](../../programmers/advanced-features/advanced-features-security.md) section for details. + +The following is a list of recognized qualifiers, which must be +separated from surrounding elements by spaces. Note that items listed in +\[brackets\] are optional. PHP equivalents are shown where applicable. + +## Qualifiers + +| Qualifier | Alternates | Syntax Example | Meaning | PHP Equivalent | +|--------------------|------------|----------------------|--------------------------------|--------------------| +| == | eq | $a eq $b | equals | == | +| != | ne, neq | $a neq $b | not equals | != | +| > | gt | $a gt $b | greater than | > | +| < | lt | $a lt $b | less than | < | +| >= | gte, ge | $a ge $b | greater than or equal | >= | +| <= | lte, le | $a le $b | less than or equal | <= | +| === | | $a === 0 | check for identity | === | +| ! | not | not $a | negation (unary) | ! | +| % | mod | $a mod $b | modulo | % | +| is \[not\] div by | | $a is not div by 4 | divisible by | $a % $b == 0 | +| is \[not\] even | | $a is not even | \[not\] an even number (unary) | $a % 2 == 0 | +| is \[not\] even by | | $a is not even by $b | grouping level \[not\] even | ($a / $b) % 2 == 0 | +| is \[not\] odd | | $a is not odd | \[not\] an odd number (unary) | $a % 2 != 0 | +| is \[not\] odd by | | $a is not odd by $b | \[not\] an odd grouping | ($a / $b) % 2 != 0 | + +## 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} +``` diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-include.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-include.md new file mode 100644 index 0000000..d12a817 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-include.md @@ -0,0 +1,187 @@ +# {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](../../programmers/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 + + + {$title} + + + {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'} + + +``` + +```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 +
+

{$title}{/h3> +

+``` +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}
+{$bar}
+... +``` + +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 + + {include 'nav.tpl' assign=navbar} + {include 'header.tpl' title='Smarty is cool'} + {$navbar} + {* body of template goes here *} + {$navbar} + {include 'footer.tpl'} + +``` + +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 [`{insert}`](./language-function-insert.md), [template resources](../../programmers/resources.md) and +[componentized templates](../../appendixes/tips.md#componentized-templates). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-insert.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-insert.md new file mode 100644 index 0000000..54f0729 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-insert.md @@ -0,0 +1,86 @@ +# {insert} + +> **Note** +> +> `{insert}` tags are deprecated from Smarty, and should not be used. +> Put your PHP logic in PHP scripts or plugin functions instead. +> As of Smarty 3.1 the `{insert}` tags are only available from +> [SmartyBC](#bc). + +`{insert}` tags work much like [`{include}`](./language-function-include.md) +tags, except that `{insert}` tags are NOT cached when template +[caching](../../programmers/caching.md) is enabled. They will be executed on every +invocation of the template. + +| Attribute Name | Required | Description | +|----------------|----------|----------------------------------------------------------------------------------| +| name | Yes | The name of the insert function (insert_`name`) or insert plugin | +| assign | No | The name of the template variable the output will be assigned to | +| script | No | The name of the php script that is included before the insert function is called | +| \[var \...\] | No | variable to pass to insert function | + +## Examples + +Let's say you have a template with a banner slot at the top of the +page. The banner can contain any mixture of HTML, images, flash, etc. so +we can't just use a static link here, and we don't want this contents +cached with the page. In comes the {insert} tag: the template knows +\#banner\_location\_id\# and \#site\_id\# values (gathered from a +[config file](../config-files.md)), and needs to call a function to get the +banner contents. + +```smarty + {* example of fetching a banner *} + {insert name="getBanner" lid=#banner_location_id# sid=#site_id#} + {insert "getBanner" lid=#banner_location_id# sid=#site_id#} {* short-hand *} +``` + +In this example, we are using the name "getBanner" and passing the +parameters \#banner\_location\_id\# and \#site\_id\#. Smarty will look +for a function named insert\_getBanner() in your PHP application, +passing the values of \#banner\_location\_id\# and \#site\_id\# as the +first argument in an associative array. All {insert} function names in +your application must be prepended with "insert_" to remedy possible +function name-space conflicts. Your insert\_getBanner() function should +do something with the passed values and return the results. These +results are then displayed in the template in place of the {insert} tag. +In this example, Smarty would call this function: +insert_getBanner(array("lid" => "12345","sid" => "67890")); +and display the returned results in place of the {insert} tag. + +- If you supply the `assign` attribute, the output of the `{insert}` + tag will be assigned to this template variable instead of being + output to the template. + + > **Note** + > + > Assigning the output to a template variable isn't too useful with + > [caching](../../programmers/api-variables/variable-caching.md) enabled. + +- If you supply the `script` attribute, this php script will be + included (only once) before the `{insert}` function is executed. + This is the case where the insert function may not exist yet, and a + php script must be included first to make it work. + + The path can be either absolute, or relative to + [`$trusted_dir`](../../programmers/api-variables/variable-trusted-dir.md). If security is enabled, + then the script must be located in the `$trusted_dir` path of the + security policy. See the [Security](../../programmers/advanced-features/advanced-features-security.md) + section for details. + +The Smarty object is passed as the second argument. This way you can +reference and modify information in the Smarty object from within the +`{insert}` function. + +If no PHP script can be found Smarty is looking for a corresponding +insert plugin. + +> **Note** +> +> It is possible to have portions of the template not cached. If you +> have [caching](../../programmers/api-variables/variable-caching.md) turned on, `{insert}` tags will not be +> cached. They will run dynamically every time the page is created, even +> within cached pages. This works good for things like banners, polls, +> live weather, search results, user feedback areas, etc. + +See also [`{include}`](./language-function-include.md) diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md new file mode 100644 index 0000000..c9f73c3 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md @@ -0,0 +1,51 @@ +# {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}`](../../programmers/api-variables/variable-left-delimiter.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 + +``` + +will output + +```html + +``` + +```smarty + +Click here for Server Info +``` + +See also [`{literal}`](./language-function-literal.md) and [escaping Smarty +parsing](../language-basic-syntax/language-escaping.md). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-literal.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-literal.md new file mode 100644 index 0000000..4bc12f9 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-literal.md @@ -0,0 +1,34 @@ +# {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](../../programmers/api-variables/variable-left-delimiter.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 + +``` + +See also [`{ldelim} {rdelim}`](./language-function-ldelim.md) and the +[escaping Smarty parsing](../language-basic-syntax/language-escaping.md) page. diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-nocache.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-nocache.md new file mode 100644 index 0000000..e6d8453 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-nocache.md @@ -0,0 +1,20 @@ +# {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](../../programmers/caching.md). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-section.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-section.md new file mode 100644 index 0000000..4279025 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-section.md @@ -0,0 +1,610 @@ +# {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 +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]}
+{/section} +
+{* 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]}
+{/section} +``` + +The above example will output: + +```html +id: 1000
+id: 1001
+id: 1002
+
+id: 1002
+id: 1001
+id: 1000
+``` + +```smarty +{section name=foo start=10 loop=20 step=2} + {$smarty.section.foo.index} +{/section} +
+{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 +
+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 + '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} +

+ name: {$contacts[customer].name}
+ home: {$contacts[customer].home}
+ cell: {$contacts[customer].cell}
+ e-mail: {$contacts[customer].email} +

+{/section} +``` + +The above example will output: + +```html +

+ name: John Smith
+ home: 555-555-5555
+ cell: 666-555-5555
+ e-mail: john@myexample.com +

+

+ name: Jack Jones
+ home: 777-555-5555
+ cell: 888-555-5555
+ e-mail: jack@myexample.com +

+

+ name: Jane Munson
+ home: 000-555-5555
+ cell: 123456
+ e-mail: jane@myexample.com +

+``` + +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 +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} +

+ id: {$custid[customer]}
+ name: {$name[customer]}
+ address: {$address[customer]} +

+{/section} +``` + +The above example will output: + +```html +

+ id: 1000
+ name: John Smith
+ address: 253 Abbey road +

+

+ id: 1001
+ name: Jack Jones
+ address: 417 Mulberry ln +

+

+ id: 1002
+ name: Jane Munson
+ address: 5605 apple st +

+``` + +{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 +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} +
+ id: {$custid[customer]}
+ name: {$name[customer]}
+ address: {$address[customer]}
+ {section name=contact loop=$contact_type[customer]} + {$contact_type[customer][contact]}: {$contact_info[customer][contact]}
+ {/section} +{/section} +``` + +The above example will output: + +```html +
+ id: 1000
+ name: John Smith
+ address: 253 N 45th
+ home phone: 555-555-5555
+ cell phone: 666-555-5555
+ e-mail: john@myexample.com
+
+ id: 1001
+ name: Jack Jones
+ address: 417 Mulberry ln
+ home phone: 123-456-4
+ web: www.example.com
+
+ id: 1002
+ name: Jane Munson
+ address: 5605 apple st
+ cell phone: 0457878
+``` + +Results of a database search (eg ADODB or PEAR) are assigned to Smarty + +```php +assign('contacts', $db->getAll($sql)); +``` + +The template to output the database result in a HTML table + +```smarty + + + {section name=co loop=$contacts} + + + + + + + + {sectionelse} + + {/section} +
 Name>HomeCellEmail
view{$contacts[co].name}{$contacts[co].home}{$contacts[co].cell}{$contacts[co].email}
No items found
+``` + +## .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]}
+{/section} +``` + +The above example will output: + +```html +0 id: 1000
+1 id: 1001
+2 id: 1002
+``` + + +## .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 +assign('rows',$data); +``` + +Template to output the above array in a table + +```smarty +{* $rows[row.index] and $rows[row] are identical in meaning *} + + + + + + +{section name=row loop=$rows} + + + + + +{/section} +
indexidindex_prevprev_idindex_nextnext_id
{$smarty.section.row.index}{$rows[row]}{$smarty.section.row.index_prev}{$rows[row.index_prev]}{$smarty.section.row.index_next}{$rows[row.index_next]}
+``` + +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 +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]}
+{/section} +``` + +The above example will output: + +```html +iteration=1 index=5 id=3005
+iteration=2 index=7 id=3007
+iteration=3 index=9 id=3009
+iteration=4 index=11 id=3011
+iteration=5 index=13 id=3013
+iteration=6 index=15 id=3015
+``` + +Another example that uses the `iteration` property to output a table +header block every five rows. + +```smarty + + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is div by 5} + + {/if} + + + + + + + + {/section} +
 Name>HomeCellEmail
view{$contacts[co].name}{$contacts[co].home}{$contacts[co].cell}{$contacts[co].email}
+``` + +An example that uses the `iteration` property to alternate a text color every +third row. + +```smarty + + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is even by 3} + {$contacts[co].name} + {else} + {$contacts[co].name} + {/if} + {/section} +
+``` + +> **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} + + + {/if} + + + + + + + {if $smarty.section.customer.last} + +
idcustomer
{$customers[customer].id}}{$customers[customer].name}
{$smarty.section.customer.total} customers
+ {/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]}
+{/section} +There are {$smarty.section.customer.loop} customers shown above. +``` + +The above example will output: + +```html +0 id: 1000
+1 id: 1001
+2 id: 1002
+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]}
+{/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
+2 id: 1001
+3 id: 1002
+ +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]}
+{/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). diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md new file mode 100644 index 0000000..eb11cbf --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md @@ -0,0 +1,43 @@ +# {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 + +``` + diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-strip.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-strip.md new file mode 100644 index 0000000..800de84 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-strip.md @@ -0,0 +1,45 @@ +# {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} + + + + +
+ + This is a test + +
+{/strip} +``` + +The above example will output: + +```html +
This is a test
+``` + +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. diff --git a/libs/smarty/docs/designers/language-builtin-functions/language-function-while.md b/libs/smarty/docs/designers/language-builtin-functions/language-function-while.md new file mode 100644 index 0000000..13eaef9 --- /dev/null +++ b/libs/smarty/docs/designers/language-builtin-functions/language-function-while.md @@ -0,0 +1,43 @@ +# {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 PHP conditionals and functions are recognized, such as +*\|\|*, *or*, *&&*, *and*, *is_array()*, etc. + +The following is a list of recognized qualifiers, which must be +separated from surrounding elements by spaces. Note that items listed in +\[brackets\] are optional. PHP equivalents are shown where applicable. + +## Qualifiers + +| Qualifier | Alternates | Syntax Example | Meaning | PHP Equivalent | +|--------------------|------------|----------------------|--------------------------------|--------------------| +| == | eq | $a eq $b | equals | == | +| != | ne, neq | $a neq $b | not equals | != | +| > | gt | $a gt $b | greater than | > | +| < | lt | $a lt $b | less than | < | +| >= | gte, ge | $a ge $b | greater than or equal | >= | +| <= | lte, le | $a le $b | less than or equal | <= | +| === | | $a === 0 | check for identity | === | +| ! | not | not $a | negation (unary) | ! | +| % | mod | $a mod $b | modulo | % | +| is \[not\] div by | | $a is not div by 4 | divisible by | $a % $b == 0 | +| is \[not\] even | | $a is not even | \[not\] an even number (unary) | $a % 2 == 0 | +| is \[not\] even by | | $a is not even by $b | grouping level \[not\] even | ($a / $b) % 2 == 0 | +| is \[not\] odd | | $a is not odd | \[not\] an odd number (unary) | $a % 2 != 0 | +| is \[not\] odd by | | $a is not odd by $b | \[not\] an odd grouping | ($a / $b) % 2 != 0 | + +## 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). diff --git a/libs/smarty/docs/designers/language-combining-modifiers.md b/libs/smarty/docs/designers/language-combining-modifiers.md new file mode 100644 index 0000000..97903c5 --- /dev/null +++ b/libs/smarty/docs/designers/language-combining-modifiers.md @@ -0,0 +1,32 @@ +# 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 +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. . . +``` diff --git a/libs/smarty/docs/designers/language-custom-functions/index.md b/libs/smarty/docs/designers/language-custom-functions/index.md new file mode 100644 index 0000000..8197965 --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/index.md @@ -0,0 +1,19 @@ +# Custom Functions + +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) diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-counter.md b/libs/smarty/docs/designers/language-custom-functions/language-function-counter.md new file mode 100644 index 0000000..de04c2f --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-counter.md @@ -0,0 +1,45 @@ +# {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}
+{counter}
+{counter}
+{counter}
+ +``` + +this will output: + +```html +0
+2
+4
+6
+``` + diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-cycle.md b/libs/smarty/docs/designers/language-custom-functions/language-function-cycle.md new file mode 100644 index 0000000..661e490 --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-cycle.md @@ -0,0 +1,55 @@ +# {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} + + {$data[rows]} + +{/section} +``` + +The above template would output: + +```html + + 1 + + + 2 + + + 3 + +``` diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-debug.md b/libs/smarty/docs/designers/language-custom-functions/language-function-debug.md new file mode 100644 index 0000000..7886145 --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-debug.md @@ -0,0 +1,14 @@ +# {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). diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-eval.md b/libs/smarty/docs/designers/language-custom-functions/language-function-eval.md new file mode 100644 index 0000000..70c7a3d --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-eval.md @@ -0,0 +1,81 @@ +# {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](../../programmers/caching.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 = +emphend = +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 city. +You must supply a state. +``` + +This outputs the server name (in uppercase) and IP. The assigned +variable `$str` could be from a database query. + +```php +assign('foo',$str); +``` + +Where the template is: + +```smarty +{eval var=$foo} +``` diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-fetch.md b/libs/smarty/docs/designers/language-custom-functions/language-function-fetch.md new file mode 100644 index 0000000..2ff494f --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-fetch.md @@ -0,0 +1,61 @@ +# {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](../../programmers/advanced-features/advanced-features-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 ''} +
{$weather}
+{/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). diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md b/libs/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md new file mode 100644 index 0000000..3ab3609 --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md @@ -0,0 +1,102 @@ +# {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 -tags to the output (defaults to true) | +| label\_ids | No | Add id-attributes to and 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 -tags. + +## Examples +```php +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='
'} +``` + +or where PHP code is: + +```php +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='
'} +``` + +both examples will output: + +```html +
+ +
+
+
+``` + + +```php +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='
'} +``` + +See also [`{html_radios}`](./language-function-html-radios.md) and +[`{html_options}`](./language-function-html-options.md) diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-html-image.md b/libs/smarty/docs/designers/language-custom-functions/language-function-html-image.md new file mode 100644 index 0000000..7ecde26 --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-html-image.md @@ -0,0 +1,58 @@ +# {html_image} + +`{html_image}` is a [custom function](index.md) that +generates an HTML `` 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](../../programmers/advanced-features/advanced-features-security.md) + section for details. + +- `href` is the href value to link the image to. If link is supplied, + an `` 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 `` 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](../../programmers/caching.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 + + + +``` + diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-html-options.md b/libs/smarty/docs/designers/language-custom-functions/language-function-html-options.md new file mode 100644 index 0000000..a63ccc5 --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-html-options.md @@ -0,0 +1,146 @@ +# {html_options} + +`{html_options}` is a [custom function](index.md) that +creates the html `` + tags are created, otherwise ONLY the ``, and display the groups. Recursion is supported with + ``. + +- All parameters that are not in the list above are printed as + name/value-pairs inside the `` tags. + +```smarty +{html_options name=foo options=$myOptions selected=$mySelect} +``` + +Output of the above example would be: + +```html + +``` + +```php +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 + +``` + +The above example would output: + +```html + +``` + +```php +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 + +``` + +```php + '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 + +``` + +See also [`{html_checkboxes}`](./language-function-html-checkboxes.md) and +[`{html_radios}`](./language-function-html-radios.md) diff --git a/libs/smarty/docs/designers/language-custom-functions/language-function-html-radios.md b/libs/smarty/docs/designers/language-custom-functions/language-function-html-radios.md new file mode 100644 index 0000000..af8ecda --- /dev/null +++ b/libs/smarty/docs/designers/language-custom-functions/language-function-html-radios.md @@ -0,0 +1,104 @@ +# {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