diff options
| author | Simon Wisselink <wisskid@users.noreply.github.com> | 2023-08-08 00:04:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-08 00:04:14 +0200 |
| commit | 8fd949ac5d073c640914f8c2ba96a3a7fc8b8474 (patch) | |
| tree | 7b78ca54d65f63991d78c4874ed255a9f6ae716b /docs/designers | |
| parent | a3cbdc46fbee148f2e0a7c2bf8f0840e5ef2dce0 (diff) | |
| download | smarty-8fd949ac5d073c640914f8c2ba96a3a7fc8b8474.tar.gz smarty-8fd949ac5d073c640914f8c2ba96a3a7fc8b8474.tar.bz2 smarty-8fd949ac5d073c640914f8c2ba96a3a7fc8b8474.zip | |
Smarty5 (#852)
* WIP converting code to PSR-4
* More PSR4 rewriting
* Removed autoload filters
* WIP making compile classes PSR-4
* WIP making compile classes PSR-4
* Replace Smarty:: with symfony/polyfill-mbstring
* WIP making compile classes PSR-4
* finished rewriting all compile classes into PSR-4
* Rewrote all Compile and Compiler classes to PSR-4
* WIP rewriting smarty_internal_method_*
* Finished moving smarty_internal_method_*
* smarty_internal_resource_* to PSR-4
* Refactored all _runtime_* by merging them into the proper classes or by transforming them into Runtime Extensions.
* src/Template/* to PSR-4
* src/sysplugins/* to PSR-4
* Entire src dir now PSR-4 compatible
* Add makefile, PSR-4 ModifierCompilers
* Rewrote all default modifiers and functions from the plugins folder to PSR-4 classes
* Rewrote remaining plugins to PSR-4, plugins dir is now gone.
* WIP moving Smarty to PSR-4.
* fixed pre/post/output filters and removed some old todo-comments
* filter tests passing
* Fixed TemplateObject test
* Fix CustomResourceAmbiguousTest
* Fixed CacheResource implementation and tests
* Fixed setfilter
* Fixed DefaultPluginHandlerTest for function plugins (blocks still break)
* move runPluginFromDefaultHandler to new Runtime class
* Introduce formatParamsArray method for recurring code fragment
* Fix code duplication in block compilers and fix (most) BlockPluginTests. Default plugin handler blocks still need fixing.
* minor fixes
* Implemented the DefaultHandlerBlockCompiler, made the dependencies of the template compiler into properties, fixed a couple of unit tests
* Removed support for PHP include path, and removed the ::loadPlugin method.
* Removed now unneeded PHPunit annotations @run(Tests)InSeparateProcess, @preserveGlobalState and @backupStaticAttributes. Made CacheResourceTestCommon abstract to prevent the base class from running tests (and always failing). Unregister a previously registered stream wrapper. Fixes a lot of tests.
* Fix scoping / global state problems in tests by using DI in Default Extension. Also removing a bunch of old fashioned phpdoc annotations that are superseded by namespaces.
* Make DefaultExtension lazy load again.
* Removed deprecated extends_recursion property and fix bug in CodeFrame compiler due to use of clone.
* Fixed BC loading of resource pluging from dir and all ResourcePluginTest tests
* Removed PHP functions and checks for the already removed php modifiers. Re-implemented functions as regular functions. Probably should compile these directly.
* Fixed stream resources
* 2 small fixes for unit tests
* Fixed modifiercompiler handling multiple/chained modifiers
* Rewrote global static global_tpl_vars to getters/setters on Smarty class, fixing several test cases. Added a ::getValue() method to Variable.
* Fixed issue related to scoping of left/right delimiter overrides
* Added strlen function, fixing some unit tests
* Fix bug in calling BC function handlers.
* WIP replacing direct access tpl_vars with proper getter/setters.
* WIP
* WIP rewriting variable scopes
* WIP fixing the complicated variables scopes architecture. Right now more tests are failing than before... :(
* Fixed minor unit tests
* Made variable scoping more sensible
* Fix configfile tests
* removed phpplugin, removed now unused uncompiled handler and all checks for this, fixed a refactorbug in InheritanceRuntime. Moved getRenderedTemplateCode method to Smarty\Template. Renamed Cache en Compiled base class to GeneratedPhpFile for more clarity and distinction from Resource classes. Inlined Cached::create into its only caller. Some other minor improvements. Removed php7.1 CI tests.
* Removed the allowUndefinedVars check from the smarty error handlers, because undefined vars no longer throw an error, unless smarty->error_unassigned is set to true.
* Replace direct access to inheritance property on Template object by proper getter.
* converted 3 public properties on Template into getters/setters. unified Template creation code. Provided a getter/setter for the has_nocache_code property. Removed the useless DataObject class. Fixed a few tests. Removed the variable-allow-php-templates property from the docs.
* Simplified the (no)caching architecture by:
- removing support for $cache_attrs for registered plugins,
- removing the undocumented {make_nocache} tag and the deprecated {insert} tag and associated code
- removing support for a compile_id property on include tags.
Fixes a bug in extends: resources by propagating the nocache-hashes between a master template and it's subtemplates in \Smarty\Template::_subTemplateRender. This might need further improvement.
* Removed unneeded magic setters/getters/destructors and the like.
* Replaced a bunch of direct property access with getters/setters.
* Update test runners: no longer support PHP7.1, add PHP8.2
* Fixed scope in variable assignments in included and extended templates, fixed dependencies for testing freshness of caches. Added some unit tests and fixed a class reference to pass some more tests.
* Fix searchParents parameter, fixing GetTemplateVarsTest
* @var integer > @var int for vsCode
* Fix function caching function name
* Fixed cacheability of block plugins.
* Moved handling of smarty.block.* to special compilers, because they aren't real tags. Organized tag-stack handling in compiler, unified nocache handling in compiler.
* Fixed block append/prepend functionality
* Fix testRegisterCompilerFunction by parsing argument correctly.
* Made exception msgs exactly the same again, fixing some unit tests
* Fix default plugin handler
* Simply the "isFresh" method by not including the first param anymore. Fix a couple of unit tests by respecting tag_nocache set by nocache vars used in a tag.
* Removed the undocumented {block_parent} and {parent} alternatives to {$smarty.block.parent}
and {block_child} and {child} alternatives to {$smarty.block.child}
* Fix inhertiance implementation for $smarty.block.child
* Fixed all inheritance issues
* Handle BC registered compilers and missed parameters for openTag and closeTag.
* Fix all foreach unit tests
* Fixed the {if} failures.
* Fix major {include} bug
* Fixed bug in {include} variable assignment and removed some unused/unrequired code
* Fix function call compilation using {functionname} syntax for in-template defined functions.
* Drop a unit tests bc we no longer support direct access to PHP-functinos such as sin()
* Fixed all scope assignment bugs
* Convert isset and empty to modifiercomilers, and smooth the error handling to fix unit tests.
* Fixed getCachedContent
* Add TODO list
* Run composer install before online test run
* Attempt to fix CI
* revise CI/CD workflows, bypass packagist for lexer
* Update ci.yml
* Update ci.yml
* fixes in source files
* Update ci.yml
* Update ci.yml
* attempt to load smarty-lexer directly from zip file
* Shouldnt need Github token now
* correct type of repository
* Updated the changelog
* Re-organized rendering (read source / compile / cache) process to avoid circular dependencies.
Deactivated merge_compiled_includes and the {include inline} attribute. They don't seem to do much in terms of performance, but we'll
have to check back.
* updated todo
* Fix smarty-lexer dependency for the time being
* Fix smarty-lexer dependency for the time being (remove direct ref to github)
* Pushed Lexers/Parsers into VCS again in order to be able to deliver using Packagist/Composer
* Re-organized rendering (read source / compile / cache) process to avoid circular dependencies.
* Run make regardless of timestamps, so we are sure unit tests run with the generated PHP code, not with accidental human made changes to Lexer/Parser.
* Update composer packages cache key
Update composer packages cache key to trigger refresh on lexer
* 4.0.2 of smarty-lexer is released, use that
* Throw compile error when using a modifier where it won't work. Fixes #526.
* verify that native PHP functions cannot be used as a modifier and verify that an easy userland workaround exists. Fixes #813.
* Add test for registering compiler plugin with positional params. Fixes #164
* move test methods because some other test methods rely on their relative positions
* Smarty no longer calls `mb_internal_encoding()` and doesn't check for deprecated `mbstring.func_overload` ini directive.
Fixes #480.
* Generated `<script>` tags lo longer have deprecated `type="text/javascript"` or `language="Javascript"` attributes.
Fixes #815.
* Fix error in docs on prepend/append. Fixes #818.
* Move all creating of templates to Smarty::createTemplate, adding a private property containing previously generated templates for speed.
* Load compiled object in template constructor so it will be cached.
* WIP for performance improvements.
Removed $smarty->_current_file and $smarty->allow_ambiguous_resources properties, both unused. Removed public Source::filepath property.
Cached an Compiled files (and Exceptions) no longer rely on the filepath being set. Removed explicit tests for cached and compiled filenames. The exact implementation is not important. Added tests for compile_check property, fixing a file_exists check that would always be done on source template files, even when compile_check was true. Remove code duplication between Source en Config classes. Added a local $_smarty_current_dir to the generated code files for backwards compatability for {$smarty.current_dir}.
* remove additional calls to getCached()
* updated todo
* Add mkdocs for docs
* add missing folder for unit tests
* Revert latest CI changes, we'll update docs by hand for now
* multiversion mkdocs config
* fixes to docs
* WIP improving the docs
* Improved another chunk of the designers docs
* Finished improving designers docs
* Update code examples to use Smarty\Smarty and autoload instead of require_once calls and new Smarty
* Further WIP improving docs
* Updated changelog and todo list
* WIP on API docs
* WIP docs (added page on config)
* Fixed markdown syntax. Fixes #879
* Added full support and documentation for ternary operator.
Fixes #881
* updated changelog
* fixed error in the mkdocs TOC
* Added support for null coalescing operator
Fixes #882
* Add docs for null coalescing
* more docs
* Improved docs on compile checking and inheritance
* Rewrote docs on filters and resources.
* Add makefile entries for generating docs
* Docs on caching
* finished docs on security and extending smarty
* Added Smarty::setExtensions(), fixed unit test for the null coalescing operator. Updated docs about registering a custom extension.
* updated todos
* fix template invalidation when migrating to 5.0
Diffstat (limited to 'docs/designers')
20 files changed, 80 insertions, 161 deletions
diff --git a/docs/designers/chapter-debugging-console.md b/docs/designers/chapter-debugging-console.md index 6704fce2..50acd195 100644 --- a/docs/designers/chapter-debugging-console.md +++ b/docs/designers/chapter-debugging-console.md @@ -10,8 +10,7 @@ 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 +path to `debug.tpl`. When you load the page, a Javascript console window will pop up and give you the names of all the included templates and assigned variables for the current page. diff --git a/docs/designers/language-basic-syntax/index.md b/docs/designers/language-basic-syntax/index.md index c0a12a9b..05c0ba69 100644 --- a/docs/designers/language-basic-syntax/index.md +++ b/docs/designers/language-basic-syntax/index.md @@ -26,8 +26,8 @@ The basis components of the Smarty syntax are: - [Comments](language-syntax-comments.md) - [Variables](language-syntax-variables.md) +- [Operators](language-syntax-operators.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/docs/designers/language-basic-syntax/language-escaping.md b/docs/designers/language-basic-syntax/language-escaping.md index 4c75e09e..58e75d58 100644 --- a/docs/designers/language-basic-syntax/language-escaping.md +++ b/docs/designers/language-basic-syntax/language-escaping.md @@ -69,7 +69,7 @@ Where the template is: ```smarty Welcome <!--{$name}--> to Smarty -<script language="javascript"> + <script> var foo = <!--{$foo}-->; function dosomething() { alert("foo is " + foo); diff --git a/docs/designers/language-basic-syntax/language-math.md b/docs/designers/language-basic-syntax/language-math.md deleted file mode 100644 index a9a43efd..00000000 --- a/docs/designers/language-basic-syntax/language-math.md +++ /dev/null @@ -1,28 +0,0 @@ -# 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/docs/designers/language-basic-syntax/language-syntax-functions.md b/docs/designers/language-basic-syntax/language-syntax-functions.md index c3c8c21c..93d94f6b 100644 --- a/docs/designers/language-basic-syntax/language-syntax-functions.md +++ b/docs/designers/language-basic-syntax/language-syntax-functions.md @@ -11,7 +11,6 @@ within delimiters like so: `{funcname attr1="val1" attr2="val2"}`. {config_load file="colors.conf"} {include file="header.tpl"} -{insert file="banner_ads.tpl" title="My Site"} {if $logged_in} Welcome, <span style="color:{#fontColor#}">{$name}!</span> diff --git a/docs/designers/language-basic-syntax/language-syntax-operators.md b/docs/designers/language-basic-syntax/language-syntax-operators.md new file mode 100644 index 00000000..98eff076 --- /dev/null +++ b/docs/designers/language-basic-syntax/language-syntax-operators.md @@ -0,0 +1,64 @@ +# Operators + +## Basic + +Various basic operators can be applied directly to variable values. + +## Examples +```smarty +{$foo + 1} + +{$foo * $bar} + +{$foo->bar - $bar[1] * $baz->foo->bar() -3 * 7} + +{if ($foo + $bar.test % $baz * 134232 + 10 + $b + 10)} + ... +{/if} + +{$foo = $foo + $bar} +``` + +> **Note** +> +> Although Smarty can handle some very complex expressions and syntax, +> it is a good rule of thumb to keep the template syntax minimal and +> focused on presentation. If you find your template syntax getting too +> complex, it may be a good idea to move the bits that do not deal +> explicitly with presentation to PHP by way of plugins or modifiers. + +## Ternary +You can use the `?:` (or ternary) operator to test one expression and present the value +of the second or third expression, based on the result of the test. + +In other words: +```smarty +{$test ? "OK" : "FAIL"} +``` +will result in OK if `$test` is set to true, and in FAIL otherwise. + +There is also a shorthand `?:` operator: +```smarty +{$myVar ?: "empty"} +``` +will result in 'empty' if `$myVar` is not set or set to something that evaluates to false, such as an empty string. +If `$myVar` is set to something that evaluates to true, the value of `$myVar` is returned. So, the following will +return 'hello': +```smarty +{$myVar="hello"} +{$myVar ?: "empty"} +``` + +## Testing for null +If "something that evaluates to false" is to broad a test for you, you can use the `??` (or null coalescing) operator +to trigger only if the tested value is undefined or set to null. +```smarty +{$myVar ?? "empty"} +``` +will result in 'empty' if `$myVar` is not set or set to null. +If `$myVar` is set to something that evaluates to anything else, the value of `$myVar` is returned. So, the following will +return an empty string (''): +```smarty +{$myVar=""} +{$myVar ?: "this is not shown"} +```
\ No newline at end of file diff --git a/docs/designers/language-builtin-functions.md b/docs/designers/language-builtin-functions.md new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/designers/language-builtin-functions.md diff --git a/docs/designers/language-builtin-functions/language-function-assign.md b/docs/designers/language-builtin-functions/language-function-assign.md index f5faa46d..518e3f7d 100644 --- a/docs/designers/language-builtin-functions/language-function-assign.md +++ b/docs/designers/language-builtin-functions/language-function-assign.md @@ -134,7 +134,6 @@ 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), diff --git a/docs/designers/language-builtin-functions/language-function-capture.md b/docs/designers/language-builtin-functions/language-function-capture.md index 657f077c..83f4d02d 100644 --- a/docs/designers/language-builtin-functions/language-function-capture.md +++ b/docs/designers/language-builtin-functions/language-function-capture.md @@ -27,12 +27,6 @@ is the value passed in the `name` attribute. If you do not supply the |---------|-----------------------------------------| | 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 diff --git a/docs/designers/language-builtin-functions/language-function-foreach.md b/docs/designers/language-builtin-functions/language-function-foreach.md index 645d6c52..a0b7b588 100644 --- a/docs/designers/language-builtin-functions/language-function-foreach.md +++ b/docs/designers/language-builtin-functions/language-function-foreach.md @@ -166,7 +166,7 @@ looping over a PHP iterator instead of an array(). ```php <?php - include('Smarty.class.php'); + use Smarty\Smarty; $smarty = new Smarty; diff --git a/docs/designers/language-builtin-functions/language-function-if.md b/docs/designers/language-builtin-functions/language-function-if.md index c7be37a2..1372ea58 100644 --- a/docs/designers/language-builtin-functions/language-function-if.md +++ b/docs/designers/language-builtin-functions/language-function-if.md @@ -7,10 +7,6 @@ template engine. Every `{if}` must be paired with a matching `{/if}`. 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. diff --git a/docs/designers/language-builtin-functions/language-function-include.md b/docs/designers/language-builtin-functions/language-function-include.md index d12a817e..54660cd5 100644 --- a/docs/designers/language-builtin-functions/language-function-include.md +++ b/docs/designers/language-builtin-functions/language-function-include.md @@ -183,5 +183,5 @@ current template. {include file="$style_dir/$module.$view.tpl"} ``` -See also [`{insert}`](./language-function-insert.md), [template resources](../../programmers/resources.md) and +See also [template resources](../../programmers/resources.md) and [componentized templates](../../appendixes/tips.md#componentized-templates). diff --git a/docs/designers/language-builtin-functions/language-function-insert.md b/docs/designers/language-builtin-functions/language-function-insert.md index 54f0729d..e69de29b 100644 --- a/docs/designers/language-builtin-functions/language-function-insert.md +++ b/docs/designers/language-builtin-functions/language-function-insert.md @@ -1,86 +0,0 @@ -# {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/docs/designers/language-builtin-functions/language-function-nocache.md b/docs/designers/language-builtin-functions/language-function-nocache.md index e6d8453f..7997ecfb 100644 --- a/docs/designers/language-builtin-functions/language-function-nocache.md +++ b/docs/designers/language-builtin-functions/language-function-nocache.md @@ -17,4 +17,4 @@ Today's date is The above code will output the current date on a cached page. -See also the [caching section](../../programmers/caching.md). +See also the [caching section](../../api/caching/basics.md). diff --git a/docs/designers/language-custom-functions/language-function-mailto.md b/docs/designers/language-custom-functions/language-function-mailto.md index bcb8b7d4..c32c2387 100644 --- a/docs/designers/language-custom-functions/language-function-mailto.md +++ b/docs/designers/language-custom-functions/language-function-mailto.md @@ -34,7 +34,7 @@ spiders to lift email addresses off of a site. <a href="mailto:me@example.com" >send me some mail</a> {mailto address="me@example.com" encode="javascript"} -<script type="text/javascript" language="javascript"> + <script> eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b')) </script> @@ -51,7 +51,7 @@ spiders to lift email addresses off of a site. <a href="mailto:me@example.com" class="email">me@example.com</a> {mailto address="me@example.com" encode="javascript_charcode"} -<script type="text/javascript" language="javascript"> + <script> {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))} </script> ``` diff --git a/docs/designers/language-modifiers/index.md b/docs/designers/language-modifiers/index.md index c9aeef88..a384c95c 100644 --- a/docs/designers/language-modifiers/index.md +++ b/docs/designers/language-modifiers/index.md @@ -69,7 +69,7 @@ These parameters follow the modifier name and are separated by a `:` <select name="name_id"> {html_options output=$my_array|upper|truncate:20} </select> -``` +``` - Modifiers can be applied to any type of variables, including arrays and objects. @@ -96,26 +96,9 @@ These parameters follow the modifier name and are separated by a `:` > gives 9. To get the old result use parentheses like > `{(8+2)|count_characters}`. -- Modifiers are autoloaded from the - [`$plugins_dir`](../../programmers/api-variables/variable-plugins-dir.md) or can be registered - explicitly with the [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md) - function. The later is useful for sharing a function between php - scripts and smarty templates. - -- All php-functions can be used as modifiers implicitly, as - demonstrated in the example above. However, using php-functions as - modifiers has two little pitfalls: - - - First - sometimes the order of the function-parameters is not - the desirable one. Formatting `$foo` with - `{"%2.f"|sprintf:$foo}` actually works, but asks for the more - intuitive, like `{$foo|string_format:"%2.f"}` that is provided - by the Smarty distribution. - - - Secondly - if security is enabled, all php-functions that are to - be used as modifiers have to be declared trusted in the - `$modifiers` property of the security policy. See the - [Security](../../programmers/advanced-features/advanced-features-security.md) section for details. +- Custom modifiers can be registered + with the [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md) + function. See also [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md), [combining modifiers](../language-combining-modifiers.md). and [extending smarty with diff --git a/docs/designers/language-modifiers/language-modifier-from-charset.md b/docs/designers/language-modifiers/language-modifier-from-charset.md index bf4b4769..25c4d2d9 100644 --- a/docs/designers/language-modifiers/language-modifier-from-charset.md +++ b/docs/designers/language-modifiers/language-modifier-from-charset.md @@ -16,5 +16,5 @@ modifier](language-modifier-to-charset.md). > modifier should only be used in cases where the application cannot > anticipate that a certain string is required in another encoding. -See also [Charset Encoding](../../programmers/charset.md), [to_charset +See also [Configuring Smarty](../../api/configuring.md), [to_charset modifier](language-modifier-to-charset.md). diff --git a/docs/designers/language-modifiers/language-modifier-to-charset.md b/docs/designers/language-modifiers/language-modifier-to-charset.md index c0b00384..aa8cfd53 100644 --- a/docs/designers/language-modifiers/language-modifier-to-charset.md +++ b/docs/designers/language-modifiers/language-modifier-to-charset.md @@ -16,5 +16,5 @@ modifier](#language.modifier.from_charset). > modifier should only be used in cases where the application cannot > anticipate that a certain string is required in another encoding. -See also [Charset Encoding](../../programmers/charset.md), [from_charset +See also [Configuring Smarty](../../api/configuring.md), [from_charset modifier](language-modifier-from-charset.md). diff --git a/docs/designers/language-variables/language-assigned-variables.md b/docs/designers/language-variables/language-assigned-variables.md index bd356a2b..a358008f 100644 --- a/docs/designers/language-variables/language-assigned-variables.md +++ b/docs/designers/language-variables/language-assigned-variables.md @@ -7,7 +7,7 @@ Variables assigned from PHP are referenced by preceding them with a dollar ```php <?php - +use Smarty\Smarty; $smarty = new Smarty(); $smarty->assign('firstname', 'Doug'); diff --git a/docs/designers/language-variables/language-variables-smarty.md b/docs/designers/language-variables/language-variables-smarty.md index da543fb6..b6dff73a 100644 --- a/docs/designers/language-variables/language-variables-smarty.md +++ b/docs/designers/language-variables/language-variables-smarty.md @@ -66,8 +66,7 @@ difference. ## {$smarty.const} -You can access PHP constant values directly. See also [smarty -constants](../../programmers/smarty-constants.md). +You can access PHP constant values directly. ```php <?php |
