diff options
225 files changed, 13843 insertions, 0 deletions
diff --git a/vendor/smarty/smarty/.github/workflows/ci.yml b/vendor/smarty/smarty/.github/workflows/ci.yml new file mode 100644 index 000000000..e27b60bfc --- /dev/null +++ b/vendor/smarty/smarty/.github/workflows/ci.yml @@ -0,0 +1,77 @@ +# https://help.github.com/en/categories/automating-your-workflow-with-github-actions + +on: + - pull_request + - push + +name: CI + +jobs: + tests: + name: Tests + + runs-on: ${{ matrix.os }} + + env: + PHP_EXTENSIONS: dom, json, libxml, mbstring, pdo_sqlite, soap, xml, xmlwriter + PHP_INI_VALUES: assert.exception=1, zend.assertions=1 + + strategy: + fail-fast: false + matrix: + os: + - ubuntu-latest + + php-version: + - "7.1" + - "7.2" + - "7.3" + - "7.4" + - "8.0" + - "8.1" + + compiler: + - default + + include: + - os: ubuntu-latest + php-version: "8.0" + compiler: jit + - os: ubuntu-latest + php-version: "8.1" + compiler: jit + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Override PHP ini values for JIT compiler + if: matrix.compiler == 'jit' + run: echo "PHP_INI_VALUES::assert.exception=1, zend.assertions=1, opcache.enable=1, opcache.enable_cli=1, opcache.optimization_level=-1, opcache.jit=1255, opcache.jit_buffer_size=32M" >> $GITHUB_ENV + + - name: Install PHP with extensions + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php-version }} + coverage: pcov + extensions: ${{ env.PHP_EXTENSIONS }} + ini-values: ${{ env.PHP_INI_VALUES }} + + - name: Validate composer.json and composer.lock + run: composer validate + + - name: Cache Composer packages + id: composer-cache + uses: actions/cache@v2 + with: + path: vendor + key: ${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-php-${{ matrix.php-version }}- + + - name: Install dependencies + if: steps.composer-cache.outputs.cache-hit != 'true' + run: composer install --prefer-dist --no-progress --no-suggest + + - name: Run tests with phpunit + run: ./phpunit.sh diff --git a/vendor/smarty/smarty/SECURITY.md b/vendor/smarty/smarty/SECURITY.md new file mode 100644 index 000000000..d98ea0189 --- /dev/null +++ b/vendor/smarty/smarty/SECURITY.md @@ -0,0 +1,19 @@ +# Security Policy + +## Supported Versions + +Smarty currently supports the latest minor version of Smarty 3 and Smarty 4. (Smarty 4 has not been released yet.) + +| Version | Supported | +| ------- | ------------------ | +| 4.0.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. + +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/vendor/smarty/smarty/docs/_config.yml b/vendor/smarty/smarty/docs/_config.yml new file mode 100644 index 000000000..2f7efbeab --- /dev/null +++ b/vendor/smarty/smarty/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal
\ No newline at end of file diff --git a/vendor/smarty/smarty/docs/appendixes/tips.md b/vendor/smarty/smarty/docs/appendixes/tips.md new file mode 100644 index 000000000..b0ea40cc7 --- /dev/null +++ b/vendor/smarty/smarty/docs/appendixes/tips.md @@ -0,0 +1,332 @@ +Tips & Tricks {#tips} +============= + +Blank Variable Handling {#tips.blank.var.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}`](#language.function.if) statement to handle this, but there is a +shorthand way with Smarty, using the +[`default`](#language.modifier.default) variable modifier. + +> **Note** +> +> "Undefined variable" errors will show an E\_NOTICE if not disabled in +> PHP\'s [`error_reporting()`](&url.php-manual;error_reporting) level or +> Smarty\'s [`$error_reporting`](#variable.error.reporting) property and +> a variable had not been assigned to Smarty. + + + {* the long way *} + {if $title eq ''} + + {else} + {$title} + {/if} + + {* the short way *} + {$title|default:' '} + + + +See also [`default`](#language.modifier.default) modifier and [default +variable handling](#tips.default.var.handling). + +Default Variable Handling {#tips.default.var.handling} +========================= + +If a variable is used frequently throughout your templates, applying the +[`default`](#language.modifier.default) modifier every time it is +mentioned can get a bit ugly. You can remedy this by assigning the +variable its default value with the +[`{assign}`](#language.function.assign) function. + + + {* do this somewhere at the top of your template *} + {assign var='title' value=$title|default:'no title'} + + {* if $title was empty, it now contains the value "no title" when you use it *} + {$title} + + + +See also [`default`](#language.modifier.default) modifier and [blank +variable handling](#tips.blank.var.handling). + +Passing variable title to header template {#tips.passing.vars} +========================================= + +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}`](#language.function.include) them. But what if the header +needs to have a different title, depending on what page you are coming +from? You can pass the title to the header as an +[attribute](#language.syntax.attributes) when it is included. + +`mainpage.tpl` - When the main page is drawn, the title of "Main Page" +is passed to the `header.tpl`, and will subsequently be used as the +title. + + + {include file='header.tpl' title='Main Page'} + {* template body goes here *} + {include file='footer.tpl'} + + + +`archives.tpl` - When the archives page is drawn, the title will be +"Archives". Notice in the archive example, we are using a variable from +the `archives_page.conf` file instead of a hard coded variable. + + + {config_load file='archive_page.conf'} + + {include file='header.tpl' title=#archivePageTitle#} + {* template body goes here *} + {include file='footer.tpl'} + + + +`header.tpl` - Notice that "Smarty News" is printed if the `$title` +variable is not set, using the [`default`](#language.modifier.default) +variable modifier. + + + <html> + <head> + <title>{$title|default:'Smarty News'}</title> + </head> + <body> + + + +`footer.tpl` + + + </body> + </html> + + + +Dates {#tips.dates} +===== + +As a rule of thumb, always pass dates to Smarty as +[timestamps](&url.php-manual;time). This allows template designers to +use the [`date_format`](#language.modifier.date.format) modifier for +full control over date formatting, and also makes it easy to compare +dates if necessary. + + + {$startDate|date_format} + + + +This will output: + + + Jan 4, 2009 + + + + + {$startDate|date_format:"%Y/%m/%d"} + + + +This will output: + + + 2009/01/04 + + + +Dates can be compared in the template by timestamps with: + + + {if $order_date < $invoice_date} + ...do something.. + {/if} + + + +When using [`{html_select_date}`](#language.function.html.select.date) +in a template, the programmer will most likely want to convert the +output from the form back into timestamp format. Here is a function to +help you with that. + + + <?php + + // this assumes your form elements are named + // startDate_Day, startDate_Month, startDate_Year + + $startDate = makeTimeStamp($startDate_Year, $startDate_Month, $startDate_Day); + + function makeTimeStamp($year='', $month='', $day='') + { + if(empty($year)) { + $year = strftime('%Y'); + } + if(empty($month)) { + $month = strftime('%m'); + } + if(empty($day)) { + $day = strftime('%d'); + } + + return mktime(0, 0, 0, $month, $day, $year); + } + ?> + + + +See also [`{html_select_date}`](#language.function.html.select.date), +[`{html_select_time}`](#language.function.html.select.time), +[`date_format`](#language.modifier.date.format) and +[`$smarty.now`](#language.variables.smarty.now), + +WAP/WML {#tips.wap} +======= + +WAP/WML templates require a php [Content-Type +header](&url.php-manual;header) to be passed along with the template. +The easist way to do this would be to write a custom function that +prints the header. If you are using [caching](#caching), that won\'t +work so we\'ll do it using the [`{insert}`](#language.function.insert) +tag; remember `{insert}` tags are not cached! Be sure that there is +nothing output to the browser before the template, or else the header +may fail. + + + <?php + + // be sure apache is configure for the .wml extensions! + // put this function somewhere in your application, or in Smarty.addons.php + function insert_header($params) + { + // this function expects $content argument + if (empty($params['content'])) { + return; + } + header($params['content']); + return; + } + + ?> + + + +your Smarty template *must* begin with the insert tag : + + + {insert name=header content="Content-Type: text/vnd.wap.wml"} + + <?xml version="1.0"?> + <!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.1//EN" "http://www.wapforum.org/DTD/wml_1.1.xml"> + + <!-- begin new wml deck --> + <wml> + <!-- begin first card --> + <card> + <do type="accept"> + <go href="#two"/> + </do> + <p> + Welcome to WAP with Smarty! + Press OK to continue... + </p> + </card> + <!-- begin second card --> + <card id="two"> + <p> + Pretty easy isn't it? + </p> + </card> + </wml> + + + +Componentized Templates {#tips.componentized.templates} +======================= + +Traditionally, programming templates into your applications goes as +follows: First, you accumulate your variables within your PHP +application, (maybe with database queries.) Then, you instantiate your +Smarty object, [`assign()`](#api.assign) the variables and +[`display()`](#api.display) the template. So lets say for example we +have a stock ticker on our template. We would collect the stock data in +our application, then assign these variables in the template and display +it. Now wouldn\'t it be nice if you could add this stock ticker to any +application by merely including the template, and not worry about +fetching the data up front? + +You can do this by writing a custom plugin for fetching the content and +assigning it to a template variable. + +`function.load_ticker.php` - drop file in +[`$plugins directory`](#variable.plugins.dir) + + + <?php + + // setup our function for fetching stock data + function fetch_ticker($symbol) + { + // put logic here that fetches $ticker_info + // from some ticker resource + return $ticker_info; + } + + function smarty_function_load_ticker($params, $smarty) + { + // call the function + $ticker_info = fetch_ticker($params['symbol']); + + // assign template variable + $smarty->assign($params['assign'], $ticker_info); + } + ?> + + + +`index.tpl` + + + {load_ticker symbol='SMARTY' assign='ticker'} + + Stock Name: {$ticker.name} Stock Price: {$ticker.price} + + + +See also [`{include_php}`](#language.function.include.php), +[`{include}`](#language.function.include) and +[`{php}`](#language.function.php). + +Obfuscating E-mail Addresses {#tips.obfuscating.email} +============================ + +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}`](#language.function.mailto) plugin. + + + <div id="contact">Send inquiries to + {mailto address=$EmailAddress encode='javascript' subject='Hello'} + </div> + + + +> **Note** +> +> This method isn\'t 100% foolproof. A spammer could conceivably program +> his e-mail collector to decode these values, but not likely\.... +> hopefully..yet \... wheres that quantum computer :-?. + +See also [`escape`](#language.modifier.escape) modifier and +[`{mailto}`](#language.function.mailto). diff --git a/vendor/smarty/smarty/docs/appendixes/troubleshooting.md b/vendor/smarty/smarty/docs/appendixes/troubleshooting.md new file mode 100644 index 000000000..fe012c12c --- /dev/null +++ b/vendor/smarty/smarty/docs/appendixes/troubleshooting.md @@ -0,0 +1,120 @@ +Troubleshooting +=============== + +Smarty/PHP errors {#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}`](#language.function.if) or +[`{section}{/section}`](#language.function.if), 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`](#variable.template.dir) is incorrect, doesn\'t + exist or the file `index.tpl` is not in the `templates/` directory + +- A [`{config_load}`](#language.function.config.load) function is + within a template (or [`configLoad()`](#api.config.load) has been + called) and either [`$config_dir`](#variable.config.dir) 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`](#variable.compile.dir)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`](#variable.compile.dir) is not writable by the + web server. See the bottom of the [installing + smarty](#installing.smarty.basic) 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`](#variable.caching) is enabled and + either; the [`$cache_dir`](#variable.cache.dir) 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`](#variable.caching) is enabled and the + [`$cache_dir`](#variable.cache.dir) is not writable by the web + server. See the bottom of the [installing + smarty](#installing.smarty.basic) 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 hander + (using [set\_error\_handler()](&url.php-manual;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()`](#api.mute.expected.errors) after you\'ve + registered your custom error handler. + +See also [debugging](#chapter.debugging.console). diff --git a/vendor/smarty/smarty/docs/designers/chapter-debugging-console.md b/vendor/smarty/smarty/docs/designers/chapter-debugging-console.md new file mode 100644 index 000000000..6429b4876 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/chapter-debugging-console.md @@ -0,0 +1,41 @@ +Debugging Console {#chapter.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/vendor/smarty/smarty/docs/designers/config-files.md b/vendor/smarty/smarty/docs/designers/config-files.md new file mode 100644 index 000000000..c840e3a67 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/config-files.md @@ -0,0 +1,77 @@ +Config Files {#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. + + + # 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/vendor/smarty/smarty/docs/designers/language-basic-syntax.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax.md new file mode 100644 index 000000000..2509857c3 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax.md @@ -0,0 +1,33 @@ +Basic Syntax +============ + +A simple Smarty template could look like this: +```html +<h1>{$title|escape}</h1> +<ul> + {foreach $cities as $city} + <li>{$city.name|escape} ({$city.population})</li> + {foreachelse} + <li>no cities found</li> + {/foreach} +</ul> +``` + +All Smarty template tags are enclosed within delimiters. By default +these are `{` and `}`, but they can be +[changed](../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-basic-syntax/language-syntax-comments.md) +- [Variables](./language-basic-syntax/language-syntax-variables.md) +- [Functions](./language-basic-syntax/language-syntax-functions.md) +- [Attributes](./language-basic-syntax/language-syntax-attributes.md) +- [Quotes](./language-basic-syntax/language-syntax-quotes.md) +- [Math](./language-basic-syntax/language-math.md) +- [Escaping](./language-basic-syntax/language-escaping.md) diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md new file mode 100644 index 000000000..a62e7de89 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md @@ -0,0 +1,84 @@ +Escaping Smarty Parsing {#language.escaping} +======================= + +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.function.ldelim) 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`](#variable.auto.literal) to +false. + + + <script> + // the following braces are ignored by Smarty + // since they are surrounded by whitespace + function foobar { + alert('foobar!'); + } + // this one will need literal escapement + {literal} + function bazzy {alert('foobar!');} + {/literal} + </script> + + + +[`{literal}..{/literal}`](#language.function.literal) blocks are used +for escaping blocks of template logic. You can also escape the braces +individually with +[`{ldelim}`](#language.function.ldelim),[`{rdelim}`](#language.function.ldelim) +tags or +[`{$smarty.ldelim}`,`{$smarty.rdelim}`](#language.variables.smarty.ldelim) +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`](#variable.left.delimiter) and +[`$right_delimiter`](#variable.right.delimiter) 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 + + $smarty->left_delimiter = '<!--{'; + $smarty->right_delimiter = '}-->'; + + $smarty->assign('foo', 'bar'); + $smarty->assign('name', 'Albert'); + $smarty->display('example.tpl'); + + ?> + + + +Where the template is: + + + Welcome <!--{$name}--> to Smarty + <script language="javascript"> + var foo = <!--{$foo}-->; + function dosomething() { + alert("foo is " + foo); + } + dosomething(); + </script> + + diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-math.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-math.md new file mode 100644 index 000000000..dc78a3512 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-math.md @@ -0,0 +1,29 @@ +Math {#language.math} +==== + +Math can be applied directly to variable values. + + + {$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/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md new file mode 100644 index 000000000..0fa7c7734 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-attributes.md @@ -0,0 +1,50 @@ +Attributes {#language.syntax.attributes} +========== + +Most of the [functions](#language.syntax.functions) 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. + + + {include file="header.tpl"} + + {include file="header.tpl" nocache} // is equivalent to nocache=true + + {include file="header.tpl" attrib_name="attrib value"} + + {include file=$includeFile} + + {include file=#includeFile# title="My Title"} + + {assign var=foo value={counter}} // plugin result + + {assign var=foo value=substr($bar,2,5)} // PHP function result + + {assign var=foo value=$bar|strlen} // using modifier + + {assign var=foo value=$buh+$bar|strlen} // more complex expression + + {html_select_date display_days=true} + + {mailto address="smarty@example.com"} + + <select name="company_id"> + {html_options options=$companies selected=$company_id} + </select> + + + +> **Note** +> +> Although Smarty can handle some very complex expressions and syntax, +> it is a good rule of thumb to keep the template syntax minimal and +> focused on presentation. If you find your template syntax getting too +> complex, it may be a good idea to move the bits that do not deal +> explicitly with presentation to PHP by way of plugins or modifiers. diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md new file mode 100644 index 000000000..43104dbb6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md @@ -0,0 +1,71 @@ +Comments {#language.syntax.comments} +======== + +Template comments are surrounded by asterisks, and that is surrounded by +the [delimiter](#variable.left.delimiter) tags like so: + +::: {.informalexample} + + {* this is a comment *} + + +::: + +Smarty comments are NOT displayed in the final output of the template, +unlike `<!-- HTML comments -->`. These are useful for making internal +notes in the templates which no one will see ;-) + + + {* I am a Smarty comment, I don't exist in the compiled output *} + <html> + <head> + <title>{$title}</title> + </head> + <body> + + {* another single line smarty comment *} + <!-- HTML comment that is sent to the browser --> + + {* this multiline smarty + comment is + not sent to browser + *} + + {********************************************************* + Multi line comment block with credits block + @ author: bg@example.com + @ maintainer: support@example.com + @ para: var that sets block style + @ css: the style output + **********************************************************} + + {* The header file with the main logo and stuff *} + {include file='header.tpl'} + + + {* Dev note: the $includeFile var is assigned in foo.php script *} + <!-- Displays main content block --> + {include file=$includeFile} + + {* this <select> block is redundant *} + {* + <select name="company"> + {html_options options=$vals selected=$selected_id} + </select> + *} + + <!-- Show header from affiliate is disabled --> + {* $affiliate|upper *} + + {* you cannot nest comments *} + {* + <select name="company"> + {* <option value="0">-- none -- </option> *} + {html_options options=$vals selected=$selected_id} + </select> + *} + + </body> + </html> + + diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md new file mode 100644 index 000000000..9c8c94049 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-functions.md @@ -0,0 +1,40 @@ +Functions {#language.syntax.functions} +========= + +Every Smarty tag either prints a [variable](#language.variables) or +invokes some sort of function. These are processed and displayed by +enclosing the function and its [attributes](#language.syntax.attributes) +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> + {else} + hi, {$name} + {/if} + + {include file="footer.tpl"} + + + +- Both [built-in functions](#language.builtin.functions) and [custom + functions](#language.custom.functions) have the same syntax within + templates. + +- Built-in functions are the **inner** workings of Smarty, such as + [`{if}`](#language.function.if), + [`{section}`](#language.function.section) and + [`{strip}`](#language.function.strip). There should be no need to + change or modify them. + +- Custom functions are **additional** functions implemented via + [plugins](#plugins). They can be modified to your liking, or you can + create new ones. [`{html_options}`](#language.function.html.options) + is an example of a custom function. + +See also [`registerPlugin()`](#api.register.plugin) diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md new file mode 100644 index 000000000..6fe185c97 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-quotes.md @@ -0,0 +1,61 @@ +Embedding Vars in Double Quotes {#language.syntax.quotes} +=============================== + +- Smarty will recognize [assigned](#api.assign) + [variables](#language.syntax.variables) embedded in \"double + quotes\" so long as the variable name contains only numbers, letters + and under\_scores. See [naming](&url.php-manual;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 Smarty3 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. + +<!-- --> + + + {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.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md new file mode 100644 index 000000000..671ad8bb8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-variables.md @@ -0,0 +1,111 @@ +Variables {#language.syntax.variables} +========= + +Template variables start with the \$dollar sign. They can contain +numbers, letters and underscores, much like a [PHP +variable](&url.php-manual;language.variables). You can reference arrays +by index numerically or non-numerically. Also reference object +properties and methods. + +[Config file variables](#language.config.variables) are an exception to +the \$dollar syntax and are instead referenced with surrounding +\#hashmarks\#, or via the +[`$smarty.config`](#language.variables.smarty.config) variable. + + + {$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.smarty) variable. + +See also [`$smarty`](#language.variables.smarty), [config +variables](#language.config.variables) +[`{assign}`](#language.function.assign) and [`assign()`](#api.assign). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions.md new file mode 100644 index 000000000..6c0879d6c --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions.md @@ -0,0 +1,39 @@ +Built-in Functions {#language.builtin.functions} +================== + +## Table of contents +- [{$var=...}](./language-builtin-functions/language-function-shortform-assign.md) +- [{append}](./language-builtin-functions/language-function-append.md) +- [{assign}](./language-builtin-functions/language-function-assign.md) +- [{block}](./language-builtin-functions/language-function-block.md) +- [{call}](./language-builtin-functions/language-function-call.md) +- [{capture}](./language-builtin-functions/language-function-capture.md) +- [{config_load}](./language-builtin-functions/language-function-config.load) +- [{debug}](./language-builtin-functions/language-function-debug.md) +- [{extends}](./language-builtin-functions/language-function-extends.md) +- [{for}](./language-builtin-functions/language-function-for.md) +- [{foreach},{foreachelse}](./language-builtin-functions/language-function-foreach.md) +- [{function}](./language-builtin-functions/language-function-function.md) +- [{if},{elseif},{else}](./language-builtin-functions/language-function-if.md) +- [{include}](./language-builtin-functions/language-function-include.md) +- [{include_php}](./language-builtin-functions/language-function-include.php) +- [{insert}](./language-builtin-functions/language-function-insert.md) +- [{ldelim},{rdelim}](./language-builtin-functions/language-function-ldelim.md) +- [{literal}](./language-builtin-functions/language-function-literal.md) +- [{nocache}](./language-builtin-functions/language-function-nocache.md) +- [{section},{sectionelse}](./language-builtin-functions/language-function-section.md) +- [{setfilter}](./language-builtin-functions/language-function-setfilter.md) +- [{strip}](./language-builtin-functions/language-function-strip.md) +- [{while}](./language-builtin-functions/language-function-while.md) + +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.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-builtin-functions/language-function-assign.md) function. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-append.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-append.md new file mode 100644 index 000000000..62f2c7e19 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-append.md @@ -0,0 +1,49 @@ +{append} {#language.function.append} +======== + +`{append}` is used for creating or appending template variable arrays +**during the execution of a template**. + +> **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. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ---------------------------------------------------------------------------------------------------- + var string Yes *n/a* The name of the variable being assigned + value string Yes *n/a* The value being assigned + index string No *n/a* The index for the new array element. If not specified the value is append to the end of the array. + scope string No *n/a* The scope of the assigned variable: \'parent\',\'root\' or \'global\' + +**Option Flags:** + + Name Description + --------- ----------------------------------------------------- + nocache Assigns the variable with the \'nocache\' attribute + + + {append var='name' value='Bob' index='first'} + {append var='name' value='Meyer' index='last'} + // or + {append 'name' 'Bob' index='first'} {* short-hand *} + {append 'name' 'Meyer' index='last'} {* short-hand *} + + The first name is {$name.first}.<br> + The last name is {$name.last}. + + + +The above example will output: + + + The first name is Bob. + The last name is Meyer. + + + +See also [`append()`](#api.append) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-assign.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-assign.md new file mode 100644 index 000000000..3d3615bff --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-assign.md @@ -0,0 +1,149 @@ +{assign} {#language.function.assign} +======== + +`{assign}` is used for assigning template variables **during the +execution of a template**. + +> **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. + +> **Note** +> +> See also the [`short-form`](#language.function.shortform.assign) +> method of assigning template vars. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ----------------------------------------------------------------------- + var string Yes *n/a* The name of the variable being assigned + value string Yes *n/a* The value being assigned + scope string No *n/a* The scope of the assigned variable: \'parent\',\'root\' or \'global\' + +**Option Flags:** + + Name Description + --------- ----------------------------------------------------- + nocache Assigns the variable with the \'nocache\' attribute + + + {assign var="name" value="Bob"} + {assign "name" "Bob"} {* short-hand *} + + The value of $name is {$name}. + + + +The above example will output: + + + The value of $name is Bob. + + + + + {assign var="name" value="Bob" nocache} + {assign "name" "Bob" nocache} {* short-hand *} + + The value of $name is {$name}. + + + +The above example will output: + + + The value of $name is Bob. + + + + + {assign var=running_total value=$running_total+$some_array[$row].some_value} + + + +Variables assigned in the included template will be seen in the +including template. + + + {include file="sub_template.tpl"} + ... + {* display variable assigned in sub_template *} + {$foo}<br> + ... + + + +The template above includes the example `sub_template.tpl` below + + + ... + {* foo will be known also in the including template *} + {assign var="foo" value="something" scope=parent} + {* bar is assigned only local in the including template *} + {assign var="bar" value="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. + + + {assign var=foo value="bar" scope="root"} + + + +A global variable is seen by all templates. + + + {assign var=foo value="bar" scope="global"} + {assign "foo" "bar" scope="global"} {* short-hand *} + + + +To access `{assign}` variables from a php script use +[`getTemplateVars()`](#api.get.template.vars). Here\'s the template that +creates the variable `$foo`. + + + {assign var="foo" value="Smarty"} + +The template variables are only available after/during template +execution as in the following script. + + + <?php + + // this will output nothing as the template has not been executed + echo $smarty->getTemplateVars('foo'); + + // fetch the template to a variable + $whole_page = $smarty->fetch('index.tpl'); + + // this will output 'smarty' as the template has been executed + echo $smarty->getTemplateVars('foo'); + + $smarty->assign('foo','Even smarter'); + + // this will output 'Even smarter' + echo $smarty->getTemplateVars('foo'); + + ?> + +The following functions can also *optionally* assign template variables. + +[`{capture}`](#language.function.capture), +[`{include}`](#language.function.include), +[`{include_php}`](#language.function.include.php), +[`{insert}`](#language.function.insert), +[`{counter}`](#language.function.counter), +[`{cycle}`](#language.function.cycle), +[`{eval}`](#language.function.eval), +[`{fetch}`](#language.function.fetch), +[`{math}`](#language.function.math), +[`{textformat}`](#language.function.textformat) + +See also [`{$var=...}`](#language.function.shortform.assign), +[`assign()`](#api.assign) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-block.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-block.md new file mode 100644 index 000000000..941997a55 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-block.md @@ -0,0 +1,191 @@ +{block} {#language.function.block} +======= + +`{block}` is used to define a named area of template source for template +inheritance. For details see section of [Template +Interitance](#advanced.features.template.inheritance). + +The `{block}` template source area of a child template will replace the +correponding 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 childs `{block}` +definition. With the {\$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 Type Required Default Description + ---------------- -------- ---------- --------- --------------------------------------- + name string Yes *n/a* The name of the template source block + +**Option Flags (in child templates only):** + + Name Description + --------- ------------------------------------------------------------------------------------------- + append The `{block}` content will be 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 + +parent.tpl + + + <html> + <head> + <title>{block name="title"}Default Title{/block}</title> + <title>{block "title"}Default Title{/block}</title> {* short-hand *} + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title"} + Page Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>Page Title</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"}Title - {/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title" prepend} + Page Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>Title - Page Title</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"} is my title{/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title" append} + Page Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>Page title is my titel</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"}The {$smarty.block.child} was inserted here{/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title"} + Child Title + {/block} + + + +The result would look like + + + <html> + <head> + <title>The Child Title was inserted here</title> + </head> + </html> + +parent.tpl + + + <html> + <head> + <title>{block name="title"}Parent Title{/block}</title> + </head> + </html> + + + +child.tpl + + + {extends file="parent.tpl"} + {block name="title"} + You will see now - {$smarty.block.parent} - here + {/block} + + + +The result would look like + + + <html> + <head> + <title>You will see now - Parent Title - here</title> + </head> + </html> + +See also [Template +Inheritance](#advanced.features.template.inheritance), +[`$smarty.block.parent`](#language.variables.smarty.block.parent), +[`$smarty.block.child`](#language.variables.smarty.block.child), and +[`{extends}`](#language.function.extends) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-call.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-call.md new file mode 100644 index 000000000..786f0c10c --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-call.md @@ -0,0 +1,76 @@ +{call} {#language.function.call} +====== + +`{call}` is used to call a template function defined by the +[`{function}`](#language.function.function) tag just like a plugin +function. + +> **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. + +- The `{call}` tag must have the `name` attribute which contains the + the name of the template function. + +- Values for variables can be passed to the template function as + [attributes](#language.syntax.attributes). + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------------- ---------- --------- ------------------------------------------------------------------------------------------ + name string Yes *n/a* The name of the template function + assign string No *n/a* The name of the variable that the output of called template function will be assigned to + \[var \...\] \[var type\] No *n/a* variable to pass local to template function + +**Option Flags:** + + Name Description + --------- -------------------------------------------- + nocache Call the template function in nocache mode + + + {* define the function *} + {function name=menu level=0} + <ul class="level{$level}"> + {foreach $data as $entry} + {if is_array($entry)} + <li>{$entry@key}</li> + {call name=menu data=$entry level=$level+1} + {else} + <li>{$entry}</li> + {/if} + {/foreach} + </ul> + {/function} + + {* create an array to demonstrate *} + {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' => + ['item3-3-1','item3-3-2']],'item4']} + + {* run the array through the function *} + {call name=menu data=$menu} + {call menu data=$menu} {* short-hand *} + + + +Will generate the following output + + + * item1 + * item2 + * item3 + o item3-1 + o item3-2 + o item3-3 + + item3-3-1 + + item3-3-2 + * item4 + + + +See also [`{function}`](#language.function.function) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-capture.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-capture.md new file mode 100644 index 000000000..9121b2874 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-capture.md @@ -0,0 +1,82 @@ +{capture} {#language.function.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.smarty.capture) 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 Type Required Default Description + ---------------- -------- ---------- --------- ---------------------------------------------------------------------- + name string Yes *n/a* The name of the captured block + assign string No *n/a* The variable name where to assign the captured output to + append string No *n/a* 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. + + + {* we don't want to print a div tag unless content is displayed *} + {capture name="banner"} + {capture "banner"} {* short-hand *} + {include file="get_banner.tpl"} + {/capture} + + {if $smarty.capture.banner ne ""} + <div id="banner">{$smarty.capture.banner}</div> + {/if} + + + +This example demonstrates the capture function. + + + {capture name=some_content assign=popText} + {capture some_content assign=popText} {* short-hand *} + The server is {$my_server_name|upper} at {$my_server_addr}<br> + Your ip is {$my_ip}. + {/capture} + <a href="#">{$popText}</a> + + + +This example also demonstrates how multiple calls of capture can be used +to create an array with captured content. + + + {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.smarty.capture), +[`{eval}`](#language.function.eval), +[`{fetch}`](#language.function.fetch), [`fetch()`](#api.fetch) and +[`{assign}`](#language.function.assign). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md new file mode 100644 index 000000000..750f337c4 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md @@ -0,0 +1,91 @@ +{config\_load} {#language.function.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 Type Required Default Description + ---------------- -------- ---------- --------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + file string Yes *n/a* The name of the config file to include + section string No *n/a* The name of the section to load + scope string no *local* 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. + +The `example.conf` file. + + + #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 + + + {config_load file="example.conf"} + {config_load "example.conf"} {* short-hand *} + + <html> + <title>{#pageTitle#|default:"No title"}</title> + <body bgcolor="{#bodyBgColor#}"> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +[Config Files](#config.files) may also contain sections. You can load +variables from within a section with the added attribute `section`. Note +that global config variables are always loaded along with section +variables, and same-named section variables overwrite the globals. + +> **Note** +> +> Config file *sections* and the built-in template function called +> [`{section}`](#language.function.section) have nothing to do with each +> other, they just happen to share a common naming convention. + + + {config_load file='example.conf' section='Customer'} + {config_load 'example.conf' 'Customer'} {* short-hand *} + + <html> + <title>{#pageTitle#}</title> + <body bgcolor="{#bodyBgColor#}"> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +See [`$config_overwrite`](#variable.config.overwrite) to create arrays +of config file variables. + +See also the [config files](#config.files) page, [config +variables](#language.config.variables) page, +[`$config_dir`](#variable.config.dir), +[`getConfigVars()`](#api.get.config.vars) and +[`configLoad()`](#api.config.load). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-debug.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-debug.md new file mode 100644 index 000000000..fbaae1944 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-debug.md @@ -0,0 +1,18 @@ +{debug} {#language.function.debug} +======= + +`{debug}` dumps the debug console to the page. This works regardless of +the [debug](#chapter.debugging.console) settings in the php script. +Since this gets executed at runtime, this is only able to show the +[assigned](#api.assign) 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). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-extends.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-extends.md new file mode 100644 index 000000000..9559e7c5e --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-extends.md @@ -0,0 +1,37 @@ +{extends} {#language.function.extends} +========= + +`{extends}` tags are used in child templates in template inheritance for +extending parent templates. For details see section of [Template +Interitance](#advanced.features.template.inheritance). + +- 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](#resources) to extend files + outside of the [`$template_dir`](#variable.template.dir) directory. + +> **Note** +> +> When extending a variable parent like `{extends file=$parent_file}`, +> make sure you include `$parent_file` in the +> [`$compile_id`](#variable.compile.id). Otherwise Smarty cannot +> distinguish between different `$parent_file`s. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ------------------------------------------------- + file string Yes *n/a* The name of the template file which is extended + + + {extends file='parent.tpl'} + {extends 'parent.tpl'} {* short-hand *} + + + +See also [Template Interitance](#advanced.features.template.inheritance) +and [`{block}`](#language.function.block). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-for.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-for.md new file mode 100644 index 000000000..0545c1729 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-for.md @@ -0,0 +1,97 @@ +{for} {#language.function.for} +===== + +The `{for}{forelse}` tag is used to create simple loops. The following +different formarts 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 Name Shorthand Type Required Default Description + ---------------- ----------- --------- ---------- --------- -------------------------------- + max n/a integer No *n/a* Limit the number of iterations + +**Option Flags:** + + Name Description + --------- -------------------------------------- + nocache Disables caching of the `{for}` loop + + + <ul> + {for $foo=1 to 3} + <li>{$foo}</li> + {/for} + </ul> + + + +The above example will output: + + + <ul> + <li>1</li> + <li>2</li> + <li>3</li> + </ul> + + + + + $smarty->assign('to',10); + + + + + <ul> + {for $foo=3 to $to max=3} + <li>{$foo}</li> + {/for} + </ul> + + + +The above example will output: + + + <ul> + <li>3</li> + <li>4</li> + <li>5</li> + </ul> + + + + + $smarty->assign('start',10); + $smarty->assign('to',5); + + + + + <ul> + {for $foo=$start to $to} + <li>{$foo}</li> + {forelse} + no iteration + {/for} + </ul> + + + +The above example will output: + + + no iteration + + + +See also [`{foreach}`](#language.function.foreach), +[`{section}`](#language.function.section) and +[`{while}`](#language.function.while) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-foreach.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-foreach.md new file mode 100644 index 000000000..fdd740148 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-foreach.md @@ -0,0 +1,407 @@ +{foreach},{foreachelse} {#language.function.foreach} +======================= + +`{foreach}` is used for looping over arrays of data. `{foreach}` has a +simpler and cleaner syntax than the +[`{section}`](#language.function.section) loop, and can also loop over +associative arrays. + +`{foreach $arrayvar as $itemvar}` + +`{foreach $arrayvar as $keyvar=>$itemvar}` + +> **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`](#foreach.property.index), + [`@iteration`](#foreach.property.iteration), + [`@first`](#foreach.property.first), + [`@last`](#foreach.property.last), + [`@show`](#foreach.property.show), + [`@total`](#foreach.property.total). + +- `{foreach}` constructs are [`{break}`](#foreach.construct.break), + [`{continue}`](#foreach.construct.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. + +**Option Flags:** + + Name Description + --------- ------------------------------------------ + nocache Disables caching of the `{foreach}` loop + + + <?php + $arr = array('red', 'green', 'blue'); + $smarty->assign('myColors', $arr); + ?> + + + +Template to output `$myColors` in an un-ordered list + + + <ul> + {foreach $myColors as $color} + <li>{$color}</li> + {/foreach} + </ul> + + + +The above example will output: + + + <ul> + <li>red</li> + <li>green</li> + <li>blue</li> + </ul> + + + + + <?php + $people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com'); + $smarty->assign('myPeople', $people); + ?> + + + +Template to output `$myArray` as key/value pairs. + + + <ul> + {foreach $myPeople as $value} + <li>{$value@key}: {$value}</li> + {/foreach} + </ul> + + + +The above example will output: + + + <ul> + <li>fname: John</li> + <li>lname: Doe</li> + <li>email: j.doe@example.com</li> + </ul> + + + +Assign an array to Smarty, the key contains the key for each looped +value. + + + <?php + $smarty->assign('contacts', array( + array('phone' => '555-555-1234', + 'fax' => '555-555-5678', + 'cell' => '555-555-0357'), + array('phone' => '800-555-4444', + 'fax' => '800-555-3333', + 'cell' => '800-555-2222') + )); + ?> + + + +The template to output `$contact`. + + + {* 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 + include('Smarty.class.php'); + + $smarty = new Smarty; + + $dsn = 'mysql:host=localhost;dbname=test'; + $login = 'test'; + $passwd = 'test'; + + // setting PDO to use buffered queries in mysql is + // important if you plan on using multiple result cursors + // in the template. + + $db = new PDO($dsn, $login, $passwd, array( + PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true)); + + $res = $db->prepare("select * from users"); + $res->execute(); + $res->setFetchMode(PDO::FETCH_LAZY); + + // assign to smarty + $smarty->assign('res',$res); + + $smarty->display('index.tpl');?> + ?> + + + + + {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 {#foreach.property.index} +------- + +`index` contains the current array index, starting with zero. + + + {* output empty row on the 4th iteration (when index is 3) *} + <table> + {foreach $items as $i} + {if $i@index eq 3} + {* put empty table row *} + <tr><td>nbsp;</td></tr> + {/if} + <tr><td>{$i.label}</td></tr> + {/foreach} + </table> + + + +\@iteration {#foreach.property.iteration} +----------- + +`iteration` contains the current loop iteration and always starts at +one, unlike [`index`](#foreach.property.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. + + + {foreach $myNames as $name} + {if $name@iteration is div by 4} + <b>{$name}</b> + {/if} + {$name} + {/foreach} + +The *\"is even by\"* and *\"is odd by\"* operators can be used to +alternate something every so many iterations. Choosing between even or +odd rotates which one starts. Here we switch the font color every 3rd +iteration. + + + {foreach $myNames as $name} + {if $name@iteration is even by 3} + <span style="color: #000">{$name}</span> + {else} + <span style="color: #eee">{$name}</span> + {/if} + {/foreach} + + + +This will output something similar to this: + + + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #000">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + <span style="color: #eee">...</span> + ... + + + +\@first {#foreach.property.first} +------- + +`first` is TRUE if the current `{foreach}` iteration is the initial one. +Here we display a table header row on the first iteration. + + + {* show table header at first iteration *} + <table> + {foreach $items as $i} + {if $i@first} + <tr> + <th>key</td> + <th>name</td> + </tr> + {/if} + <tr> + <td>{$i@key}</td> + <td>{$i.name}</td> + </tr> + {/foreach} + </table> + + + +\@last {#foreach.property.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. + + + {* Add horizontal rule at end of list *} + {foreach $items as $item} + <a href="#{$item.id}">{$item.name}</a>{if $item@last}<hr>{else},{/if} + {foreachelse} + ... no items to loop ... + {/foreach} + + + +\@show {#foreach.property.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. + + + <ul> + {foreach $myArray as $name} + <li>{$name}</li> + {/foreach} + </ul> + {if $name@show} do something here if the array contained data {/if} + +\@total {#foreach.property.total} +------- + +`total` contains the number of iterations that this `{foreach}` will +loop. This can be used inside or after the `{foreach}`. + + + {* show number of rows at end *} + {foreach $items as $item} + {$item.name}<hr/> + {if $item@last} + <div id="total">{$item@total} items</div> + {/if} + {foreachelse} + ... no items to loop ... + {/foreach} + +See also [`{section}`](#language.function.section), +[`{for}`](#language.function.for) and +[`{while}`](#language.function.while) + +{break} {#foreach.construct.break} +------- + +`{break}` aborts the iteration of the array + + + {$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} {#foreach.construct.continue} +---------- + +`{continue}` leaves the current iteration and begins with the next +iteration. + + + {$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/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-function.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-function.md new file mode 100644 index 000000000..647e4bfc8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-function.md @@ -0,0 +1,88 @@ +{function} {#language.function.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. + +- The `{function}` tag must have the `name` attribute which contains + the 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.syntax.attributes). 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. + +**Attributes:** + + Attribute Name Type Required Default Description + ---------------- -------------- ---------- --------- --------------------------------------------------------------- + name string Yes *n/a* The name of the template function + \[var \...\] \[var type\] No *n/a* default variable value to pass local to the template function + +> **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. + + + {* define the function *} + {function name=menu level=0} + {function menu level=0} {* short-hand *} + <ul class="level{$level}"> + {foreach $data as $entry} + {if is_array($entry)} + <li>{$entry@key}</li> + {menu data=$entry level=$level+1} + {else} + <li>{$entry}</li> + {/if} + {/foreach} + </ul> + {/function} + + {* create an array to demonstrate *} + {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' => + ['item3-3-1','item3-3-2']],'item4']} + + {* run the array through the function *} + {menu data=$menu} + + + +Will generate the following output + + + * item1 + * item2 + * item3 + o item3-1 + o item3-2 + o item3-3 + + item3-3-1 + + item3-3-2 + * item4 + + + +See also [`{call}`](#language.function.call) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-if.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-if.md new file mode 100644 index 000000000..2c1d68eea --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-if.md @@ -0,0 +1,121 @@ +{if},{elseif},{else} {#language.function.if} +==================== + +`{if}` statements in Smarty have much the same flexibility as PHP +[if](&url.php-manual;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 securty is enabled, only PHP functions from `$php_functions` property +of the securty policy are allowed. See the +[Security](#advanced.features.security) 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. + + 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 modulous \% + 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 + + + {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/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include-php.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include-php.md new file mode 100644 index 000000000..8fc074a2b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include-php.md @@ -0,0 +1,74 @@ +{include\_php} {#language.function.include.php} +============== + +> **Note** +> +> `{include_php}` is deprecated from Smarty, use registered plugins to +> properly insulate presentation from the application code. As of Smarty +> 3.1 the `{include_php}` tags are only available from [SmartyBC](#bc). + + Attribute Name Type Required Default Description + ---------------- --------- ---------- --------- ---------------------------------------------------------------------------------- + file string Yes *n/a* The name of the php file to include as absolute path + once boolean No *TRUE* whether or not to include the php file more than once if included multiple times + assign string No *n/a* The name of the variable that the output of include\_php will be assigned to + +**Option Flags:** + + Name Description + --------- ---------------------------------------- + nocache Disables caching of inluded PHP script + +`{include_php}` tags are used to include a php script in your template. +The path of the attribute `file` can be either absolute, or relative to +[`$trusted_dir`](#variable.trusted.dir). If security is enabled, then +the script must be located in the `$trusted_dir` path of the securty +policy. See the [Security](#advanced.features.security) section for +details. + +By default, php files are only included once even if called multiple +times in the template. You can specify that it should be included every +time with the `once` attribute. Setting once to FALSE will include the +php script each time it is included in the template. + +You can optionally pass the `assign` attribute, which will specify a +template variable name that the output of `{include_php}` will be +assigned to instead of displayed. + +The smarty object is available as `$_smarty_tpl->smarty` within the PHP +script that you include. + +The `load_nav.php` file: + + + <?php + + // load in variables from a mysql db and assign them to the template + require_once('database.class.php'); + $db = new Db(); + $db->query('select url, name from navigation order by name'); + $this->assign('navigation', $db->getRows()); + + ?> + + + +where the template is: + + + {* absolute path, or relative to $trusted_dir *} + {include_php file='/path/to/load_nav.php'} + {include_php '/path/to/load_nav.php'} {* short-hand *} + + {foreach item='nav' from=$navigation} + <a href="{$nav.url}">{$nav.name}</a><br /> + {/foreach} + + + +See also [`{include}`](#language.function.include), +[`$trusted_dir`](#variable.trusted.dir), +[`{php}`](#language.function.php), +[`{capture}`](#language.function.capture), [template +resources](#resources) and [componentized +templates](#tips.componentized.templates) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include.md new file mode 100644 index 000000000..956d893e6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-include.md @@ -0,0 +1,194 @@ +{include} {#language.function.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. + +- 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). + +- Variables can be passed to included templates as + [attributes](#language.syntax.attributes). 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) statement. The later + is useful to return values from the included template to the + including template. + +- Use the syntax for [template resources](#resources) to `{include}` + files outside of the [`$template_dir`](#variable.template.dir) + directory. + +**Attributes:** + + Attribute Name Type Required Default Description + ----------------- ---------------- ---------- --------- -------------------------------------------------------------------------------------------------- + file string Yes *n/a* The name of the template file to include + assign string No *n/a* The name of the variable that the output of include will be assigned to + cache\_lifetime integer No *n/a* Enable caching of this subtemplate with an individual cache lifetime + compile\_id string/integer No *n/a* Compile this subtemplate with an individual compile\_id + cache\_id string/integer No *n/a* Enable caching of this subtemplate with an individual cache\_id + scope string No *n/a* Define the scope of all in the subtemplate assigned variables: \'parent\',\'root\' or \'global\' + \[var \...\] \[var type\] No *n/a* variable to pass local to template + +**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 + + + <html> + <head> + <title>{$title}</title> + </head> + <body> + {include file='page_header.tpl'} + + {* body of template goes here, the $tpl_name variable + is replaced with a value eg 'contact.tpl' + *} + {include file="$tpl_name.tpl"} + + {* using shortform file attribute *} + {include 'page_footer.tpl'} + </body> + </html> + + + + + {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 + + + <div id="box"> + <h3>{$title}{/h3> + <ul> + {foreach from=$links item=l} + .. do stuff ... + </foreach} + </ul> + </div> + +Variables assigned in the included template will be seen in the +including template. + + + {include 'sub_template.tpl' scope=parent} + ... + {* display variables assigned in sub_template *} + {$foo}<br> + {$bar}<br> + ... + + + +The template above includes the example `sub_template.tpl` below + + + ... + {assign var=foo value='something'} + {assign var=bar value='value'} + ... + +The included template will not be cached. + + + {include 'sub_template.tpl' nocache} + ... + + + +In this example included template will be cached with an individual +cache lifetime of 500 seconds. + + + {include 'sub_template.tpl' cache_lifetime=500} + ... + + + +In this example included template will be cached independent of the +global cahing setting. + + + {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. + + + <body> + {include 'nav.tpl' assign=navbar} + {include 'header.tpl' title='Smarty is cool'} + {$navbar} + {* body of template goes here *} + {$navbar} + {include 'footer.tpl'} + </body> + + + +This example includes another template relative to the directory of the +current template. + + + {include 'template-in-a-template_dir-directory.tpl'} + {include './template-in-same-directory.tpl'} + {include '../template-in-parent-directory.tpl'} + + + + + {* 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 [`{include_php}`](#language.function.include.php), +[`{insert}`](#language.function.insert), +[`{php}`](#language.function.php), [template resources](#resources) and +[componentized templates](#tips.componentized.templates). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-insert.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-insert.md new file mode 100644 index 000000000..e37c73890 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-insert.md @@ -0,0 +1,86 @@ +{insert} {#language.function.insert} +======== + +> **Note** +> +> `{insert}` tags are deprecated from Smarty, and should not be used. +> Put your PHP logic in PHP scripts or plugin functions instead. + +> **Note** +> +> As of Smarty 3.1 the `{insert}` tags are only available from +> [SmartyBC](#bc). + +`{insert}` tags work much like [`{include}`](#language.function.include) +tags, except that `{insert}` tags are NOT cached when template +[caching](#caching) is enabled. They will be executed on every +invocation of the template. + + Attribute Name Type Required Default Description + ---------------- -------------- ---------- --------- ---------------------------------------------------------------------------------- + name string Yes *n/a* The name of the insert function (insert\_`name`) or insert plugin + assign string No *n/a* The name of the template variable the output will be assigned to + script string No *n/a* The name of the php script that is included before the insert function is called + \[var \...\] \[var type\] No *n/a* variable to pass to insert function + +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)), and needs to call a function to get the +banner contents. + + {* 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](#variable.caching) 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`](#variable.trusted.dir). If security is enabled, + then the script must be located in the `$trusted_dir` path of the + securty policy. See the [Security](#advanced.features.security) + 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](#caching) 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) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md new file mode 100644 index 000000000..2afda031a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-ldelim.md @@ -0,0 +1,55 @@ +{ldelim},{rdelim} {#language.function.ldelim} +================= + +`{ldelim}` and `{rdelim}` are used for [escaping](#language.escaping) +template delimiters, by default **{** and **}**. You can also use +[`{literal}{/literal}`](#language.function.literal) to escape blocks of +text eg Javascript or CSS. See also the complementary +[`{$smarty.ldelim}`](#language.variables.smarty.ldelim). + + + {* 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 + + + <script language="JavaScript"> + function foo() {ldelim} + ... code ... + {rdelim} + </script> + + + +will output + + + <script language="JavaScript"> + function foo() { + .... code ... + } + </script> + + + + + <script language="JavaScript" type="text/javascript"> + function myJsFunction(){ldelim} + alert("The server name\n{$smarty.server.SERVER_NAME}\n{$smarty.server.SERVER_ADDR}"); + {rdelim} + </script> + <a href="javascript:myJsFunction()">Click here for Server Info</a> + +See also [`{literal}`](#language.function.literal) and [escaping Smarty +parsing](#language.escaping). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-literal.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-literal.md new file mode 100644 index 000000000..27ebb3ff4 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-literal.md @@ -0,0 +1,36 @@ +{literal} {#language.function.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](#variable.left.delimiter) 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) 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. + + + <script> + // the following braces are ignored by Smarty + // since they are surrounded by whitespace + function myFoo { + alert('Foo!'); + } + // this one will need literal escapement + {literal} + function myBar {alert('Bar!');} + {/literal} + </script> + + + +See also [`{ldelim} {rdelim}`](#language.function.ldelim) and the +[escaping Smarty parsing](#language.escaping) page. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-nocache.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-nocache.md new file mode 100644 index 000000000..a5922f838 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-nocache.md @@ -0,0 +1,23 @@ +{nocache} {#language.function.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. + + + + 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](#caching). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-section.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-section.md new file mode 100644 index 000000000..0bab5c715 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-section.md @@ -0,0 +1,644 @@ +{section},{sectionelse} {#language.function.section} +======================= + +A `{section}` is for looping over **sequentially indexed arrays of +data**, unlike [`{foreach}`](#language.function.foreach) 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) 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) loop. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- --------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + name string Yes *n/a* The name of the section + loop mixed Yes *n/a* Value to determine the number of loop iterations + start integer No *0* 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. + step integer No *1* 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. + max integer No *n/a* Sets the maximum number of times the section will loop. + show boolean No *TRUE* Determines whether or not to show this section + +**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](&url.php-manual;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.smarty.loops) + where "name" is the attribute `name`. + +- `{section}` properties are [`index`](#section.property.index), + [`index_prev`](#section.property.index.prev), + [`index_next`](#section.property.index.next), + [`iteration`](#section.property.iteration), + [`first`](#section.property.first), + [`last`](#section.property.last), + [`rownum`](#section.property.rownum), + [`loop`](#section.property.loop), [`show`](#section.property.show), + [`total`](#section.property.total). + +[`assign()`](#api.assign) an array to Smarty + + + <?php + $data = array(1000,1001,1002); + $smarty->assign('custid',$data); + ?> + +The template that outputs the array + + + {* this example will print out all the values of the $custid array *} + {section name=customer loop=$custid} + {section customer $custid} {* short-hand *} + id: {$custid[customer]}<br /> + {/section} + <hr /> + {* print out all the values of the $custid array reversed *} + {section name=foo loop=$custid step=-1} + {section foo $custid step=-1} {* short-hand *} + {$custid[foo]}<br /> + {/section} + + + +The above example will output: + + + id: 1000<br /> + id: 1001<br /> + id: 1002<br /> + <hr /> + id: 1002<br /> + id: 1001<br /> + id: 1000<br /> + + + + + {section name=foo start=10 loop=20 step=2} + {$smarty.section.foo.index} + {/section} + <hr /> + {section name=bar loop=21 max=6 step=-2} + {$smarty.section.bar.index} + {/section} + +The above example will output: + + + 10 12 14 16 18 + <hr /> + 20 18 16 14 12 10 + + + +The `name` of the `{section}` can be anything you like, see [PHP +variables](&url.php-manual;language.variables). It is used to reference +the data within the `{section}`. + + + {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 + $data = array( + array('name' => 'John Smith', 'home' => '555-555-5555', + 'cell' => '666-555-5555', 'email' => 'john@myexample.com'), + array('name' => 'Jack Jones', 'home' => '777-555-5555', + 'cell' => '888-555-5555', 'email' => 'jack@myexample.com'), + array('name' => 'Jane Munson', 'home' => '000-555-5555', + 'cell' => '123456', 'email' => 'jane@myexample.com') + ); + $smarty->assign('contacts',$data); + ?> + + + +The template to output `$contacts` + + + {section name=customer loop=$contacts} + <p> + name: {$contacts[customer].name}<br /> + home: {$contacts[customer].home}<br /> + cell: {$contacts[customer].cell}<br /> + e-mail: {$contacts[customer].email} + </p> + {/section} + + + +The above example will output: + + + <p> + name: John Smith<br /> + home: 555-555-5555<br /> + cell: 666-555-5555<br /> + e-mail: john@myexample.com + </p> + <p> + name: Jack Jones<br /> + home phone: 777-555-5555<br /> + cell phone: 888-555-5555<br /> + e-mail: jack@myexample.com + </p> + <p> + name: Jane Munson<br /> + home phone: 000-555-5555<br /> + cell phone: 123456<br /> + e-mail: jane@myexample.com + </p> + + + +This example assumes that `$custid`, `$name` and `$address` are all +arrays containing the same number of values. First the php script that +assign\'s the arrays to Smarty. + + + <?php + + $id = array(1001,1002,1003); + $smarty->assign('custid',$id); + + $fullnames = array('John Smith','Jack Jones','Jane Munson'); + $smarty->assign('name',$fullnames); + + $addr = array('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. + + + {section name=customer loop=$custid} + <p> + id: {$custid[customer]}<br /> + name: {$name[customer]}<br /> + address: {$address[customer]} + </p> + {/section} + + + +The above example will output: + + + <p> + id: 1000<br /> + name: John Smith<br /> + address: 253 Abbey road + </p> + <p> + id: 1001<br /> + name: Jack Jones<br /> + address: 417 Mulberry ln + </p> + <p> + id: 1002<br /> + name: Jane Munson<br /> + address: 5605 apple st + </p> + + + +{section}\'s can be nested as deep as you like. With nested +{section}\'s, you can access complex data structures, such as +multi-dimensional arrays. This is an example `.php` script thats +assign\'s the arrays. + + + <?php + + $id = array(1001,1002,1003); + $smarty->assign('custid',$id); + + $fullnames = array('John Smith','Jack Jones','Jane Munson'); + $smarty->assign('name',$fullnames); + + $addr = array('253 N 45th', '417 Mulberry ln', '5605 apple st'); + $smarty->assign('address',$addr); + + $types = array( + array( 'home phone', 'cell phone', 'e-mail'), + array( 'home phone', 'web'), + array( 'cell phone') + ); + $smarty->assign('contact_type', $types); + + $info = array( + array('555-555-5555', '666-555-5555', 'john@myexample.com'), + array( '123-456-4', 'www.example.com'), + array( '0457878') + ); + $smarty->assign('contact_info', $info); + + ?> + + +In this template, *\$contact\_type\[customer\]* is an array of contact +types for the current customer. + + + {section name=customer loop=$custid} + <hr> + id: {$custid[customer]}<br /> + name: {$name[customer]}<br /> + address: {$address[customer]}<br /> + {section name=contact loop=$contact_type[customer]} + {$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br /> + {/section} + {/section} + + + +The above example will output: + + + <hr> + id: 1000<br /> + name: John Smith<br /> + address: 253 N 45th<br /> + home phone: 555-555-5555<br /> + cell phone: 666-555-5555<br /> + e-mail: john@myexample.com<br /> + <hr> + id: 1001<br /> + name: Jack Jones<br /> + address: 417 Mulberry ln<br /> + home phone: 123-456-4<br /> + web: www.example.com<br /> + <hr> + id: 1002<br /> + name: Jane Munson<br /> + address: 5605 apple st<br /> + cell phone: 0457878<br /> + + + +Results of a database search (eg ADODB or PEAR) are assigned to Smarty + + + <?php + $sql = 'select id, name, home, cell, email from contacts ' + ."where name like '$foo%' "; + $smarty->assign('contacts', $db->getAll($sql)); + ?> + +The template to output the database result in a HTML table + + + <table> + <tr><th> </th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr> + {section name=co loop=$contacts} + <tr> + <td><a href="view.php?id={$contacts[co].id}">view<a></td> + <td>{$contacts[co].name}</td> + <td>{$contacts[co].home}</td> + <td>{$contacts[co].cell}</td> + <td>{$contacts[co].email}</td> + <tr> + {sectionelse} + <tr><td colspan="5">No items found</td></tr> + {/section} + </table> + +.index {#section.property.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`](#section.property.iteration) property, +> except it starts at zero instead of one. + +> **Note** +> +> `$custid[customer.index]` and `$custid[customer]` are identical. + + + {section name=customer loop=$custid} + {$smarty.section.customer.index} id: {$custid[customer]}<br /> + {/section} + + + +The above example will output: + + + 0 id: 1000<br /> + 1 id: 1001<br /> + 2 id: 1002<br /> + + + +.index\_prev {#section.property.index.prev} +------------ + +`index_prev` is the previous loop index. On the first loop, this is set +to -1. + +.index\_next {#section.property.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 + $data = array(1001,1002,1003,1004,1005); + $smarty->assign('rows',$data); + ?> + +Template to output the above array in a table + + + {* $rows[row.index] and $rows[row] are identical in meaning *} + <table> + <tr> + <th>index</th><th>id</th> + <th>index_prev</th><th>prev_id</th> + <th>index_next</th><th>next_id</th> + </tr> + {section name=row loop=$rows} + <tr> + <td>{$smarty.section.row.index}</td><td>{$rows[row]}</td> + <td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td> + <td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td> + </tr> + {/section} + </table> + + + +The above example will output a table containing the following: + + + index id index_prev prev_id index_next next_id + 0 1001 -1 1 1002 + 1 1002 0 1001 2 1003 + 2 1003 1 1002 3 1004 + 3 1004 2 1003 4 1005 + 4 1005 3 1004 5 + + + +.iteration {#section.property.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`](#section.property.index) property. +> `iteration` also starts with one instead of zero unlike `index`. +> [`rownum`](#section.property.rownum) is an alias to `iteration`, they +> are identical. + + + <?php + // array of 3000 to 3015 + $id = range(3000,3015); + $smarty->assign('arr',$id); + ?> + +Template to output every other element of the `$arr` array as `step=2` + + + {section name=cu loop=$arr start=5 step=2} + iteration={$smarty.section.cu.iteration} + index={$smarty.section.cu.index} + id={$custid[cu]}<br /> + {/section} + + + +The above example will output: + + + iteration=1 index=5 id=3005<br /> + iteration=2 index=7 id=3007<br /> + iteration=3 index=9 id=3009<br /> + iteration=4 index=11 id=3011<br /> + iteration=5 index=13 id=3013<br /> + iteration=6 index=15 id=3015<br /> + + + +Another example that uses the `iteration` property to output a table +header block every five rows. + + + <table> + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is div by 5} + <tr><th> </th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr> + {/if} + <tr> + <td><a href="view.php?id={$contacts[co].id}">view<a></td> + <td>{$contacts[co].name}</td> + <td>{$contacts[co].home}</td> + <td>{$contacts[co].cell}</td> + <td>{$contacts[co].email}</td> + <tr> + {/section} + </table> + + + +An that uses the `iteration` property to alternate a text color every +third row. + + + <table> + {section name=co loop=$contacts} + {if $smarty.section.co.iteration is even by 3} + <span style="color: #ffffff">{$contacts[co].name}</span> + {else} + <span style="color: #dddddd">{$contacts[co].name}</span> + {/if} + {/section} + </table> + + + +> **Note** +> +> The *\"is div by\"* syntax is a simpler alternative to the PHP mod +> operator syntax. The mod operator is allowed: +> `{if $smarty.section.co.iteration % 5 == 1}` will work just the same. + +> **Note** +> +> You can also use *\"is odd by\"* to reverse the alternating. + +.first {#section.property.first} +------ + +`first` is set to TRUE if the current `{section}` iteration is the +initial one. + +.last {#section.property.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`](#section.property.total) property. + + + {section name=customer loop=$customers} + {if $smarty.section.customer.first} + <table> + <tr><th>id</th><th>customer</th></tr> + {/if} + + <tr> + <td>{$customers[customer].id}}</td> + <td>{$customers[customer].name}</td> + </tr> + + {if $smarty.section.customer.last} + <tr><td></td><td>{$smarty.section.customer.total} customers</td></tr> + </table> + {/if} + {/section} + + + +.rownum {#section.property.rownum} +------- + +`rownum` contains the current loop iteration, starting with one. It is +an alias to [`iteration`](#section.property.iteration), they work +identically. + +.loop {#section.property.loop} +----- + +`loop` contains the last index number that this {section} looped. This +can be used inside or after the `{section}`. + + + {section name=customer loop=$custid} + {$smarty.section.customer.index} id: {$custid[customer]}<br /> + {/section} + There are {$smarty.section.customer.loop} customers shown above. + + + +The above example will output: + + + 0 id: 1000<br /> + 1 id: 1001<br /> + 2 id: 1002<br /> + There are 3 customers shown above. + + + +.show {#section.property.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 or not this section shows. + + + {section name=customer loop=$customers show=$show_customer_info} + {$smarty.section.customer.rownum} id: {$customers[customer]}<br /> + {/section} + + {if $smarty.section.customer.show} + the section was shown. + {else} + the section was not shown. + {/if} + + + +The above example will output: + + + 1 id: 1000<br /> + 2 id: 1001<br /> + 3 id: 1002<br /> + + the section was shown. + + + +.total {#section.property.total} +------ + +`total` contains the number of iterations that this `{section}` will +loop. This can be used inside or after a `{section}`. + + + {section name=customer loop=$custid step=2} + {$smarty.section.customer.index} id: {$custid[customer]}<br /> + {/section} + There are {$smarty.section.customer.total} customers shown above. + + + +See also [`{foreach}`](#language.function.foreach), +[`{for}`](#language.function.for), [`{while}`](#language.function.while) +and [`$smarty.section`](#language.variables.smarty.loops). diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md new file mode 100644 index 000000000..381c191a2 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-setfilter.md @@ -0,0 +1,42 @@ +{setfilter} {#language.function.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 modidier 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. + + + <script> + {setfilter filter1} + {$foo} {* filter1 runs on output of $foo *} + {setfilter filter2|mod:true} + {$bar} {* filter2 and modifier mod runs on output of $bar *} + {/setfilter} + {$buh} {* filter1 runs on output of $buh *} + {/setfilter} + {$blar} {* no template instance filter runs on output of $blar} + </script> + + + +> **Note** +> +> The setting of template instance filters does not effect the output of +> included subtemplates. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-shortform-assign.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-shortform-assign.md new file mode 100644 index 000000000..d6a9e9798 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-shortform-assign.md @@ -0,0 +1,84 @@ +{\$var=\...} {#language.function.shortform.assign} +============ + +This is a short-hand version of the {assign} function. You can assign +values directly to the template, or assign values to array elements too. + +> **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. + +The following attributes can be added to the tag: + +**Attributes:** + + Attribute Name Shorthand Type Required Default Description + ---------------- ----------- -------- ---------- --------- ----------------------------------------------------------------------- + scope n/a string No *n/a* The scope of the assigned variable: \'parent\',\'root\' or \'global\' + +**Option Flags:** + + Name Description + --------- ----------------------------------------------------- + nocache Assigns the variable with the \'nocache\' attribute + + + {$name='Bob'} + + The value of $name is {$name}. + + + +The above example will output: + + + The value of $name is Bob. + + + + + {$running_total=$running_total+$some_array[row].some_value} + + + + + {$user.name="Bob"} + + + + + {$user.name.first="Bob"} + + + + + {$users[]="Bob"} + + + +Variables assigned in the included template will be seen in the +including template. + + + {include file="sub_template.tpl"} + ... + {* display variable assigned in sub_template *} + {$foo}<br> + ... + + + +The template above includes the example `sub_template.tpl` below + + + ... + {* foo will be known also in the including template *} + {$foo="something" scope=parent} + {* bar is assigned only local in the including template *} + {$bar="value"} + ... + +See also [`{assign}`](#language.function.assign) and +[`{append}`](#language.function.append) diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-strip.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-strip.md new file mode 100644 index 000000000..d40646e5f --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-strip.md @@ -0,0 +1,48 @@ +{strip} {#language.function.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.modifier.strip) instead. + + + {* the following will be all run into one line upon output *} + {strip} + <table border='0'> + <tr> + <td> + <a href="{$url}"> + <font color="red">This is a test</font> + </a> + </td> + </tr> + </table> + {/strip} + + + +The above example will output: + + + <table border='0'><tr><td><a href="http://. snipped...</a></td></tr></table> + + + +Notice that in the above example, all the lines begin and end with HTML +tags. Be aware that all the lines are run together. If you have plain +text at the beginning or end of any line, they will be run together, and +may not be desired results. + +See also the [`strip`](#language.modifier.strip) modifier. diff --git a/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-while.md b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-while.md new file mode 100644 index 000000000..755c091f6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-while.md @@ -0,0 +1,43 @@ +{while} {#language.function.while} +======= + +`{while}` loops in Smarty have much the same flexibility as PHP +[while](&url.php-manual;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. + + 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 modulous \% + 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 + + + + {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), +[`{for}`](#language.function.for) and +[`{section}`](#language.function.section). diff --git a/vendor/smarty/smarty/docs/designers/language-combining-modifiers.md b/vendor/smarty/smarty/docs/designers/language-combining-modifiers.md new file mode 100644 index 000000000..edf1a83ea --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-combining-modifiers.md @@ -0,0 +1,35 @@ +Combining Modifiers {#language.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 + + $smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.'); + + ?> + +where template is: + + + {$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/vendor/smarty/smarty/docs/designers/language-custom-functions.md b/vendor/smarty/smarty/docs/designers/language-custom-functions.md new file mode 100644 index 000000000..20ad54e99 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions.md @@ -0,0 +1,21 @@ +Custom Functions {#language.custom.functions} +================ + +Smarty comes with several custom plugin functions that you can use in +the templates. + +## Table of contents +- [{counter}](./language-custom-functions/language-function-counter.md) +- [{cycle}](./language-custom-functions/language-function-cycle.md) +- [{eval}](./language-custom-functions/language-function-eval.md) +- [{fetch}](./language-custom-functions/language-function-fetch.md) +- [{html_checkboxes}](./language-custom-functions/language-function-html-checkboxes.md) +- [{html_image}](./language-custom-functions/language-function-html-image.md) +- [{html_options}](./language-custom-functions/language-function-html-options.md) +- [{html_radios}](./language-custom-functions/language-function-html-radios.md) +- [{html_select_date}](./language-custom-functions/language-function-html-select-date.md) +- [{html_select_time}](./language-custom-functions/language-function-html-select-time.md) +- [{html_table}](./language-custom-functions/language-function-html-table.md) +- [{mailto}](./language-custom-functions/language-function-mailto.md) +- [{math}](./language-custom-functions/language-function-math.md) +- [{textformat}](./language-custom-functions/language-function-textformat.md) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-counter.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-counter.md new file mode 100644 index 000000000..cc1ac08f2 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-counter.md @@ -0,0 +1,41 @@ +{counter} {#language.function.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 or not 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. + +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. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ----------- ------------------------------------------------------ + name string No *default* The name of the counter + start number No *1* The initial number to start counting from + skip number No *1* The interval to count by + direction string No *up* The direction to count (up/down) + print boolean No *TRUE* Whether or not to print the value + assign string No *n/a* the template variable the output will be assigned to + + + {* initialize the count *} + {counter start=0 skip=2}<br /> + {counter}<br /> + {counter}<br /> + {counter}<br /> + + + +this will output: + + + 0<br /> + 2<br /> + 4<br /> + 6<br /> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-cycle.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-cycle.md new file mode 100644 index 000000000..5986e6322 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-cycle.md @@ -0,0 +1,57 @@ +{cycle} {#language.function.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. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ----------- ------------------------------------------------------------------------------------------------------------- + name string No *default* The name of the cycle + values mixed Yes *N/A* The values to cycle through, either a comma delimited list (see delimiter attribute), or an array of values + print boolean No *TRUE* Whether to print the value or not + advance boolean No *TRUE* Whether or not to advance to the next value + delimiter string No *,* The delimiter to use in the values attribute + assign string No *n/a* The template variable the output will be assigned to + reset boolean No *FALSE* The cycle will be set to the first value and not advanced + +- You can `{cycle}` through more than one set of values in a template + by supplying a `name` attribute. Give each `{cycle}` an 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. + +<!-- --> + + + {section name=rows loop=$data} + <tr class="{cycle values="odd,even"}"> + <td>{$data[rows]}</td> + </tr> + {/section} + + + +The above template would output: + + + <tr class="odd"> + <td>1</td> + </tr> + <tr class="even"> + <td>2</td> + </tr> + <tr class="odd"> + <td>3</td> + </tr> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-debug.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-debug.md new file mode 100644 index 000000000..79b3477c1 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-debug.md @@ -0,0 +1,15 @@ +{debug} {#language.function.debug} +======= + +`{debug}` dumps the debug console to the page. This works regardless of +the [debug](#chapter.debugging.console) settings in the php script. +Since this gets executed at runtime, this is only able to show the +[assigned](#api.assign) 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 Type Required Default Description + ---------------- -------- ---------- -------------- --------------------------------- + output string No *javascript* output type, html or javascript + +See also the [debugging console page](#chapter.debugging.console). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-eval.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-eval.md new file mode 100644 index 000000000..e11f57e3e --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-eval.md @@ -0,0 +1,84 @@ +{eval} {#language.function.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. + +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. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ------------------------------------------------------ + var mixed Yes *n/a* Variable (or string) to evaluate + assign string No *n/a* The template variable the output will be assigned to + +> **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](#caching) +> 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. +> +The contents of the config file, `setup.conf`. + + + emphstart = <strong> + emphend = </strong> + title = Welcome to {$company}'s home page! + ErrorCity = You must supply a {#emphstart#}city{#emphend#}. + ErrorState = You must supply a {#emphstart#}state{#emphend#}. + + + +Where the template is: + + + {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: + + + This is the contents of foo. + Welcome to Foobar Pub & Grill's home page! + You must supply a <strong>city</strong>. + You must supply a <strong>state</strong>. + + + +This outputs the server name (in uppercase) and IP. The assigned +variable `$str` could be from a database query. + + + <?php + $str = 'The server name is {$smarty.server.SERVER_NAME|upper} ' + .'at {$smarty.server.SERVER_ADDR}'; + $smarty->assign('foo',$str); + ?> + + + +Where the template is: + + + {eval var=$foo} + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-fetch.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-fetch.md new file mode 100644 index 000000000..2277f5056 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-fetch.md @@ -0,0 +1,59 @@ +{fetch} {#language.function.fetch} +======= + +`{fetch}` is used to retrieve files from the local file system, http, or +ftp and display the contents. + +- If the file name begins with `http://`, the web site 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 securty policy. See the + > [Security](#advanced.features.security) 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. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ------------------------------------------------------ + file string Yes *n/a* The file, http or ftp site to fetch + assign string No *n/a* The template variable the output will be assigned to + + + {* include some javascript in your template *} + {fetch file='/export/httpd/www.example.com/docs/navbar.js'} + + {* embed some weather text in your template from another web site *} + {fetch file='http://www.myweather.com/68502/'} + + {* fetch a news headline file via ftp *} + {fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'} + {* as above but with variables *} + {fetch file="ftp://`$user`:`$password`@`$server`/`$path`"} + + {* assign the fetched contents to a template variable *} + {fetch file='http://www.myweather.com/68502/' assign='weather'} + {if $weather ne ''} + <div id="weather">{$weather}</div> + {/if} + + + +See also [`{capture}`](#language.function.capture), +[`{eval}`](#language.function.eval), +[`{assign}`](#language.function.assign) and [`fetch()`](#api.fetch). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md new file mode 100644 index 000000000..23af713b7 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-checkboxes.md @@ -0,0 +1,113 @@ +{html\_checkboxes} {#language.function.html.checkboxes} +================== + +`{html_checkboxes}` is a [custom function](#language.custom.functions) +that creates an html checkbox group with provided data. It takes care of +which item(s) are selected by default as well. + + Attribute Name Type Required Default Description + ---------------- ------------------- ------------------------------------- ------------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + name string No *checkbox* Name of checkbox list + values array Yes, unless using options attribute *n/a* An array of values for checkbox buttons + output array Yes, unless using options attribute *n/a* An array of output for checkbox buttons + selected string/array No *empty* The selected checkbox element(s) + options associative array Yes, unless using values and output *n/a* An associative array of values and output + separator string No *empty* String of text to separate each checkbox item + assign string No *empty* Assign checkbox tags to an array instead of output + labels boolean No *TRUE* Add \<label\>-tags to the output + label\_ids boolean No *FALSE* Add id-attributes to \<label\> and \<input\> to the output + escape boolean No *TRUE* Escape the output / content (values are always escaped) + strict boolean No *FALSE* 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 + +- Required attributes are `values` and `output`, unless you use + `options` instead. + +- All output is XHTML compliant. + +- All parameters that are not in the list above are printed as + name/value-pairs inside each of the created \<input\>-tags. + +<!-- --> + + + <?php + + $smarty->assign('cust_ids', array(1000,1001,1002,1003)); + $smarty->assign('cust_names', array( + 'Joe Schmoe', + 'Jack Smith', + 'Jane Johnson', + 'Charlie Brown') + ); + $smarty->assign('customer_id', 1001); + + ?> + + + +where template is + + + {html_checkboxes name='id' values=$cust_ids output=$cust_names + selected=$customer_id separator='<br />'} + + + +or where PHP code is: + + + <?php + + $smarty->assign('cust_checkboxes', array( + 1000 => 'Joe Schmoe', + 1001 => 'Jack Smith', + 1002 => 'Jane Johnson', + 1003 => 'Charlie Brown') + ); + $smarty->assign('customer_id', 1001); + + ?> + + + +and the template is + + + {html_checkboxes name='id' options=$cust_checkboxes + selected=$customer_id separator='<br />'} + + + +both examples will output: + + + <label><input type="checkbox" name="id[]" value="1000" />Joe Schmoe</label><br /> + <label><input type="checkbox" name="id[]" value="1001" checked="checked" />Jack Smith</label> + <br /> + <label><input type="checkbox" name="id[]" value="1002" />Jane Johnson</label><br /> + <label><input type="checkbox" name="id[]" value="1003" />Charlie Brown</label><br /> + + + + + <?php + + $sql = 'select type_id, types from contact_types order by type'; + $smarty->assign('contact_types',$db->getAssoc($sql)); + + $sql = 'select contact_id, contact_type_id, contact ' + .'from contacts where contact_id=12'; + $smarty->assign('contact',$db->getRow($sql)); + + ?> + + + +The results of the database queries above would be output with. + + + {html_checkboxes name='contact_type_id' options=$contact_types + selected=$contact.contact_type_id separator='<br />'} + +See also [`{html_radios}`](#language.function.html.radios) and +[`{html_options}`](#language.function.html.options) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-image.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-image.md new file mode 100644 index 000000000..76740a1fe --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-image.md @@ -0,0 +1,56 @@ +{html\_image} {#language.function.html.image} +============= + +`{html_image}` is a [custom function](#language.custom.functions) that +generates an HTML `<img>` tag. The `height` and `width` are +automatically calculated from the image file if they are not supplied. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- ----------------------- --------------------------------------- + file string Yes *n/a* name/path to image + height string No *actual image height* Height to display image + width string No *actual image width* Width to display image + basedir string no *web server doc root* Directory to base relative paths from + alt string no *""* Alternative description of the image + href string no *n/a* href value to link the image to + path\_prefix string no *n/a* 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 securty policy. See the [Security](#advanced.features.security) + section for details. + +- `href` is the href value to link the image to. If link is supplied, + an `<a href="LINKVALUE"><a>` tag is placed around the image tag. + +- `path_prefix` is an optional prefix string you can give the output + path. This is useful if you want to supply a different server name + for the image. + +- All parameters that are not in the list above are printed as + name/value-pairs inside the created `<img>` tag. + +> **Note** +> +> `{html_image}` requires a hit to the disk to read the image and +> calculate the height and width. If you don\'t use template +> [caching](#caching), it is generally better to avoid `{html_image}` +> and leave image tags static for optimal performance. + + + {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: + + + <img src="pumpkin.jpg" alt="" width="44" height="68" /> + <img src="/path/from/docroot/pumpkin.jpg" alt="" width="44" height="68" /> + <img src="../path/relative/to/currdir/pumpkin.jpg" alt="" width="44" height="68" /> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-options.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-options.md new file mode 100644 index 000000000..b7c04e940 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-options.md @@ -0,0 +1,155 @@ +{html\_options} {#language.function.html.options} +=============== + +`{html_options}` is a [custom function](#language.custom.functions) that +creates the html `<select><option>` group with the assigned data. It +takes care of which item(s) are selected by default as well. + + Attribute Name Type Required Default Description + ---------------- ------------------- ------------------------------------- --------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + values array Yes, unless using options attribute *n/a* An array of values for dropdown + output array Yes, unless using options attribute *n/a* An array of output for dropdown + selected string/array No *empty* The selected option element(s) + options associative array Yes, unless using values and output *n/a* An associative array of values and output + name string No *empty* Name of select group + strict boolean No *FALSE* 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 + +- Required attributes are `values` and `output`, unless you use the + combined `options` instead. + +- If the optional `name` attribute is given, the `<select></select>` + tags are created, otherwise ONLY the `<option>` list is generated. + +- If a given value is an array, it will treat it as an html + `<optgroup>`, and display the groups. Recursion is supported with + `<optgroup>`. + +- All parameters that are not in the list above are printed as + name/value-pairs inside the `<select>` tag. They are ignored if the + optional `name` is not given. + +- All output is XHTML compliant. + +<!-- --> + + + <?php + $smarty->assign('myOptions', array( + 1800 => 'Joe Schmoe', + 9904 => 'Jack Smith', + 2003 => 'Charlie Brown') + ); + $smarty->assign('mySelect', 9904); + ?> + + + +The following template will generate a drop-down list. Note the presence +of the `name` attribute which creates the `<select>` tags. + + + {html_options name=foo options=$myOptions selected=$mySelect} + + + +Output of the above example would be: + + + <select name="foo"> + <option value="1800">Joe Schmoe</option> + <option value="9904" selected="selected">Jack Smith</option> + <option value="2003">Charlie Brown</option> + </select> + + + <?php + $smarty->assign('cust_ids', array(56,92,13)); + $smarty->assign('cust_names', array( + '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()`](&url.php-manual;function.count) function as a +modifier to set the select size). + + + <select name="customer_id" size="{$cust_names|@count}"> + {html_options values=$cust_ids output=$cust_names selected=$customer_id} + </select> + + + +The above example would output: + + + <select name="customer_id" size="3"> + <option value="56">Joe Schmoe</option> + <option value="92" selected="selected">Jane Johnson</option> + <option value="13">Charlie Brown</option> + </select> + + + + + + <?php + + $sql = 'select type_id, types from contact_types order by type'; + $smarty->assign('contact_types',$db->getAssoc($sql)); + + $sql = 'select contact_id, name, email, contact_type_id + from contacts where contact_id='.$contact_id; + $smarty->assign('contact',$db->getRow($sql)); + + ?> + +Where a template could be as follows. Note the use of the +[`truncate`](#language.modifier.truncate) modifier. + + + <select name="type_id"> + <option value='null'>-- none --</option> + {html_options options=$contact_types|truncate:20 selected=$contact.type_id} + </select> + + + + + <?php + $arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim'); + $arr['Rest'] = array(3 => 'Sauna',1 => 'Massage'); + $smarty->assign('lookups', $arr); + $smarty->assign('fav', 7); + ?> + + + +The script above and the following template + + + {html_options name=foo options=$lookups selected=$fav} + + + +would output: + + + <select name="foo"> + <optgroup label="Sport"> + <option value="6">Golf</option> + <option value="9">Cricket</option> + <option value="7" selected="selected">Swim</option> + </optgroup> + <optgroup label="Rest"> + <option value="3">Sauna</option> + <option value="1">Massage</option> + </optgroup> + </select> + +See also [`{html_checkboxes}`](#language.function.html.checkboxes) and +[`{html_radios}`](#language.function.html.radios) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-radios.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-radios.md new file mode 100644 index 000000000..992adaeaf --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-radios.md @@ -0,0 +1,112 @@ +{html\_radios} {#language.function.html.radios} +============== + +`{html_radios}` is a [custom function](#language.custom.functions) that +creates a HTML radio button group. It also takes care of which item is +selected by default as well. + + Attribute Name Type Required Default Description + ---------------- ------------------- ------------------------------------- --------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + name string No *radio* Name of radio list + values array Yes, unless using options attribute *n/a* An array of values for radio buttons + output array Yes, unless using options attribute *n/a* An array of output for radio buttons + selected string No *empty* The selected radio element + options associative array Yes, unless using values and output *n/a* An associative array of values and output + separator string No *empty* String of text to separate each radio item + assign string No *empty* Assign radio tags to an array instead of output + labels boolean No *TRUE* Add \<label\>-tags to the output + label\_ids boolean No *FALSE* Add id-attributes to \<label\> and \<input\> to the output + escape boolean No *TRUE* Escape the output / content (values are always escaped) + strict boolean No *FALSE* 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 + +- Required attributes are `values` and `output`, unless you use + `options` instead. + +- All output is XHTML compliant. + +- All parameters that are not in the list above are output as + name/value-pairs inside each of the created `<input>`-tags. + +<!-- --> + + + <?php + + $smarty->assign('cust_ids', array(1000,1001,1002,1003)); + $smarty->assign('cust_names', array( + 'Joe Schmoe', + 'Jack Smith', + 'Jane Johnson', + 'Charlie Brown') + ); + $smarty->assign('customer_id', 1001); + + ?> + + + +Where template is: + + + {html_radios name='id' values=$cust_ids output=$cust_names + selected=$customer_id separator='<br />'} + + + + + <?php + + $smarty->assign('cust_radios', array( + 1000 => 'Joe Schmoe', + 1001 => 'Jack Smith', + 1002 => 'Jane Johnson', + 1003 => 'Charlie Brown')); + $smarty->assign('customer_id', 1001); + + ?> + + + +Where template is: + + + {html_radios name='id' options=$cust_radios + selected=$customer_id separator='<br />'} + + + +Both examples will output: + + + <label><input type="radio" name="id" value="1000" />Joe Schmoe</label><br /> + <label><input type="radio" name="id" value="1001" checked="checked" />Jack Smith</label><br /> + <label><input type="radio" name="id" value="1002" />Jane Johnson</label><br /> + <label><input type="radio" name="id" value="1003" />Charlie Brown</label><br /> + + + + + <?php + + $sql = 'select type_id, types from contact_types order by type'; + $smarty->assign('contact_types',$db->getAssoc($sql)); + + $sql = 'select contact_id, name, email, contact_type_id ' + .'from contacts where contact_id='.$contact_id; + $smarty->assign('contact',$db->getRow($sql)); + + ?> + + + +The variable assigned from the database above would be output with the +template: + + + {html_radios name='contact_type_id' options=$contact_types + selected=$contact.contact_type_id separator='<br />'} + + + +See also [`{html_checkboxes}`](#language.function.html.checkboxes) and +[`{html_options}`](#language.function.html.options) diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-date.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-date.md new file mode 100644 index 000000000..b46eb0419 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-date.md @@ -0,0 +1,119 @@ +{html\_select\_date} {#language.function.html.select.date} +==================== + +`{html_select_date}` is a [custom function](#language.custom.functions) +that creates date dropdowns. It can display any or all of year, month, +and day. All parameters that are not in the list below are printed as +name/value-pairs inside the `<select>` tags of day, month and year. + + Attribute Name Type Required Default Description + ---------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---------- ---------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + prefix string No Date\_ What to prefix the var name with + time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract year, month and day from. Omitting this parameter or supplying a falsy value will select the current date. To prevent date selection, pass in NULL + start\_year string No current year The first year in the dropdown, either year number, or relative to current year (+/- N) + end\_year string No same as start\_year The last year in the dropdown, either year number, or relative to current year (+/- N) + display\_days boolean No TRUE Whether to display days or not + display\_months boolean No TRUE Whether to display months or not + display\_years boolean No TRUE Whether to display years or not + month\_names array No null List of strings to display for months. array(1 =\> \'Jan\', ..., 12 =\> \'Dec\') + month\_format string No \%B What format the month should be in (strftime) + day\_format string No \%02d What format the day output should be in (sprintf) + day\_value\_format string No \%d What format the day value should be in (sprintf) + year\_as\_text boolean No FALSE Whether or not to display the year as text + reverse\_years boolean No FALSE Display years in reverse order + field\_array string No null If a name is given, the select boxes will be drawn such that the results will be returned to PHP in the form of name\[Day\], name\[Year\], name\[Month\]. + day\_size string No null Adds size attribute to select tag if given + month\_size string No null Adds size attribute to select tag if given + year\_size string No null Adds size attribute to select tag if given + all\_extra string No null Adds extra attributes to all select/input tags if given + day\_extra string No null Adds extra attributes to select/input tags if given + month\_extra string No null Adds extra attributes to select/input tags if given + year\_extra string No null Adds extra attributes to select/input tags if given + all\_id string No null Adds id-attribute to all select/input tags if given + day\_id string No null Adds id-attribute to select/input tags if given + month\_id string No null Adds id-attribute to select/input tags if given + year\_id string No null Adds id-attribute to select/input tags if given + field\_order string No MDY The order in which to display the fields + field\_separator string No \\n String printed between different fields + month\_value\_format string No \%m strftime() format of the month values, default is %m for month numbers. + all\_empty string No null If supplied then the first element of any select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-boxes read "Please select" for example. + year\_empty string No null If supplied then the first element of the year\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select a year" for example. Note that you can use values like "-MM-DD" as time-attribute to indicate an unselected year. + month\_empty string No null If supplied then the first element of the month\'s select-box has this value as it\'s label and "" as it\'s value. . Note that you can use values like "YYYY\--DD" as time-attribute to indicate an unselected month. + day\_empty string No null If supplied then the first element of the day\'s select-box has this value as it\'s label and "" as it\'s value. Note that you can use values like "YYYY-MM-" as time-attribute to indicate an unselected day. + +> **Note** +> +> There is an useful php function on the [date tips page](#tips.dates) +> for converting `{html_select_date}` form values to a timestamp. + +Template code + + + {html_select_date} + + + +This will output: + + + <select name="Date_Month"> + <option value="1">January</option> + <option value="2">February</option> + <option value="3">March</option> + ..... snipped ..... + <option value="10">October</option> + <option value="11">November</option> + <option value="12" selected="selected">December</option> + </select> + <select name="Date_Day"> + <option value="1">01</option> + <option value="2">02</option> + <option value="3">03</option> + ..... snipped ..... + <option value="11">11</option> + <option value="12">12</option> + <option value="13" selected="selected">13</option> + <option value="14">14</option> + <option value="15">15</option> + ..... snipped ..... + <option value="29">29</option> + <option value="30">30</option> + <option value="31">31</option> + </select> + <select name="Date_Year"> + <option value="2006" selected="selected">2006</option> + </select> + + + + + {* start and end year can be relative to current year *} + {html_select_date prefix='StartDate' time=$time start_year='-5' + end_year='+1' display_days=false} + + + +With 2000 as the current year the output: + + + <select name="StartDateMonth"> + <option value="1">January</option> + <option value="2">February</option> + .... snipped .... + <option value="11">November</option> + <option value="12" selected="selected">December</option> + </select> + <select name="StartDateYear"> + <option value="1995">1995</option> + .... snipped .... + <option value="1999">1999</option> + <option value="2000" selected="selected">2000</option> + <option value="2001">2001</option> + </select> + + + +See also [`{html_select_time}`](#language.function.html.select.time), +[`date_format`](#language.modifier.date.format), +[`$smarty.now`](#language.variables.smarty.now) and the [date tips +page](#tips.dates). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-time.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-time.md new file mode 100644 index 000000000..6ccc59907 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-select-time.md @@ -0,0 +1,98 @@ +{html\_select\_time} {#language.function.html.select.time} +==================== + +`{html_select_time}` is a [custom function](#language.custom.functions) +that creates time dropdowns for you. It can display any or all of hour, +minute, second and meridian. + +The `time` attribute can have different formats. It can be a unique +timestamp, a string of the format `YYYYMMDDHHMMSS` or a string that is +parseable by PHP\'s [`strtotime()`](&url.php-manual;strtotime). + + Attribute Name Type Required Default Description + ----------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---------- ---------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + prefix string No Time\_ What to prefix the var name with + time [timestamp](&url.php-manual;function.time), [DateTime](&url.php-manual;class.DateTime), mysql timestamp or any string parsable by [`strtotime()`](&url.php-manual;strtotime), arrays as produced by this function if field\_array is set. No current [timestamp](&url.php-manual;function.time) What date/time to pre-select. If an array is given, the attributes field\_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. + display\_hours boolean No TRUE Whether or not to display hours + display\_minutes boolean No TRUE Whether or not to display minutes + display\_seconds boolean No TRUE Whether or not to display seconds + display\_meridian boolean No TRUE Whether or not to display meridian (am/pm) + use\_24\_hours boolean No TRUE Whether or not to use 24 hour clock + minute\_interval integer No 1 Number interval in minute dropdown + second\_interval integer No 1 Number interval in second dropdown + hour\_format string No \%02d What format the hour label should be in (sprintf) + hour\_value\_format string No \%20d What format the hour value should be in (sprintf) + minute\_format string No \%02d What format the minute label should be in (sprintf) + minute\_value\_format string No \%20d What format the minute value should be in (sprintf) + second\_format string No \%02d What format the second label should be in (sprintf) + second\_value\_format string No \%20d What format the second value should be in (sprintf) + field\_array string No n/a Outputs values to array of this name + all\_extra string No null Adds extra attributes to select/input tags if given + hour\_extra string No null Adds extra attributes to select/input tags if given + minute\_extra string No null Adds extra attributes to select/input tags if given + second\_extra string No null Adds extra attributes to select/input tags if given + meridian\_extra string No null Adds extra attributes to select/input tags if given + field\_separator string No \\n String printed between different fields + option\_separator string No \\n String printed between different options of a field + all\_id string No null Adds id-attribute to all select/input tags if given + hour\_id string No null Adds id-attribute to select/input tags if given + minute\_id string No null Adds id-attribute to select/input tags if given + second\_id string No null Adds id-attribute to select/input tags if given + meridian\_id string No null Adds id-attribute to select/input tags if given + all\_empty string No null If supplied then the first element of any select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-boxes read "Please select" for example. + hour\_empty string No null If supplied then the first element of the hour\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an hour" for example. + minute\_empty string No null If supplied then the first element of the minute\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an minute" for example. + second\_empty string No null If supplied then the first element of the second\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an second" for example. + meridian\_empty string No null If supplied then the first element of the meridian\'s select-box has this value as it\'s label and "" as it\'s value. This is useful to make the select-box read "Please select an meridian" for example. + + + {html_select_time use_24_hours=true} + + + +At 9:20 and 23 seconds in the morning the template above would output: + + + <select name="Time_Hour"> + <option value="00">00</option> + <option value="01">01</option> + ... snipped .... + <option value="08">08</option> + <option value="09" selected>09</option> + <option value="10">10</option> + ... snipped .... + <option value="22">22</option> + <option value="23">23</option> + </select> + <select name="Time_Minute"> + <option value="00">00</option> + <option value="01">01</option> + ... snipped .... + <option value="19">19</option> + <option value="20" selected>20</option> + <option value="21">21</option> + ... snipped .... + <option value="58">58</option> + <option value="59">59</option> + </select> + <select name="Time_Second"> + <option value="00">00</option> + <option value="01">01</option> + ... snipped .... + <option value="22">22</option> + <option value="23" selected>23</option> + <option value="24">24</option> + ... snipped .... + <option value="58">58</option> + <option value="59">59</option> + </select> + <select name="Time_Meridian"> + <option value="am" selected>AM</option> + <option value="pm">PM</option> + </select> + + + +See also [`$smarty.now`](#language.variables.smarty.now), +[`{html_select_date}`](#language.function.html.select.date) and the +[date tips page](#tips.dates). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-table.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-table.md new file mode 100644 index 000000000..fed4ae4d7 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-html-table.md @@ -0,0 +1,89 @@ +{html\_table} {#language.function.html.table} +============= + +`{html_table}` is a [custom function](#language.custom.functions) that +dumps an array of data into an HTML `<table>`. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ---------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + loop array Yes *n/a* Array of data to loop through + cols mixed No *3* Number of columns in the table or a comma-separated list of column heading names or an array of column heading names.if the cols-attribute is empty, but rows are given, then the number of cols is computed by the number of rows and the number of elements to display to be just enough cols to display all elements. If both, rows and cols, are omitted cols defaults to 3. if given as a list or array, the number of columns is computed from the number of elements in the list or array. + rows integer No *empty* Number of rows in the table. if the rows-attribute is empty, but cols are given, then the number of rows is computed by the number of cols and the number of elements to display to be just enough rows to display all elements. + inner string No *cols* Direction of consecutive elements in the loop-array to be rendered. *cols* means elements are displayed col-by-col. *rows* means elements are displayed row-by-row. + caption string No *empty* Text to be used for the `<caption>` element of the table + table\_attr string No *border=\"1\"* Attributes for `<table>` tag + th\_attr string No *empty* Attributes for `<th>` tag (arrays are cycled) + tr\_attr string No *empty* attributes for `<tr>` tag (arrays are cycled) + td\_attr string No *empty* Attributes for `<td>` tag (arrays are cycled) + trailpad string No * * Value to pad the trailing cells on last row with (if any) + hdir string No *right* Direction of each row to be rendered. possible values: *right* (left-to-right), and *left* (right-to-left) + vdir string No *down* Direction of each column to be rendered. possible values: *down* (top-to-bottom), *up* (bottom-to-top) + +- The `cols` attribute determines how many columns will be in the + table. + +- The `table_attr`, `tr_attr` and `td_attr` values determine the + attributes given to the `<table>`, `<tr>` and `<td>` tags. + +- If `tr_attr` or `td_attr` are arrays, they will be cycled through. + +- `trailpad` is the value put into the trailing cells on the last + table row if there are any present. + +<!-- --> + + + <?php + $smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) ); + $smarty->assign( 'tr', array('bgcolor="#eeeeee"','bgcolor="#dddddd"') ); + $smarty->display('index.tpl'); + ?> + + + +The variables assigned from php could be displayed as these three +examples demonstrate. Each example shows the template followed by +output. + + + {**** Example One ****} + {html_table loop=$data} + + <table border="1"> + <tbody> + <tr><td>1</td><td>2</td><td>3</td></tr> + <tr><td>4</td><td>5</td><td>6</td></tr> + <tr><td>7</td><td>8</td><td>9</td></tr> + </tbody> + </table> + + + {**** Example Two ****} + {html_table loop=$data cols=4 table_attr='border="0"'} + + <table border="0"> + <tbody> + <tr><td>1</td><td>2</td><td>3</td><td>4</td></tr> + <tr><td>5</td><td>6</td><td>7</td><td>8</td></tr> + <tr><td>9</td><td> </td><td> </td><td> </td></tr> + </tbody> + </table> + + + {**** Example Three ****} + {html_table loop=$data cols="first,second,third,fourth" tr_attr=$tr} + + <table border="1"> + <thead> + <tr> + <th>first</th><th>second</th><th>third</th><th>fourth</th> + </tr> + </thead> + <tbody> + <tr bgcolor="#eeeeee"><td>1</td><td>2</td><td>3</td><td>4</td></tr> + <tr bgcolor="#dddddd"><td>5</td><td>6</td><td>7</td><td>8</td></tr> + <tr bgcolor="#eeeeee"><td>9</td><td> </td><td> </td><td> </td></tr> + </tbody> + </table> + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-mailto.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-mailto.md new file mode 100644 index 000000000..cc5bf6968 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-mailto.md @@ -0,0 +1,56 @@ +{mailto} {#language.function.mailto} +======== + +`{mailto}` automates the creation of a `mailto:` anchor links and +optionally encodes them. Encoding emails makes it more difficult for web +spiders to lift email addresses off of a site. + +> **Note** +> +> Javascript is probably the most thorough form of encoding, although +> you can use hex encoding too. + + Attribute Name Type Required Default Description + ---------------- -------- ---------- --------- ----------------------------------------------------------------------------------------------- + address string Yes *n/a* The e-mail address + text string No *n/a* The text to display, default is the e-mail address + encode string No *none* How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`. + cc string No *n/a* Email addresses to carbon copy, separate entries by a comma. + bcc string No *n/a* Email addresses to blind carbon copy, separate entries by a comma + subject string No *n/a* Email subject + newsgroups string No *n/a* Newsgroups to post to, separate entries by a comma. + followupto string No *n/a* Addresses to follow up to, separate entries by a comma. + extra string No *n/a* Any extra information you want passed to the link, such as style sheet classes + + + {mailto address="me@example.com"} + <a href="mailto:me@example.com" >me@example.com</a> + + {mailto address="me@example.com" text="send me some mail"} + <a href="mailto:me@example.com" >send me some mail</a> + + {mailto address="me@example.com" encode="javascript"} + <script type="text/javascript" language="javascript"> + eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b')) + </script> + + {mailto address="me@example.com" encode="hex"} + <a href="mailto:%6d%65.. snipped..3%6f%6d">m&..snipped...#x6f;m</a> + + {mailto address="me@example.com" subject="Hello to you!"} + <a href="mailto:me@example.com?subject=Hello%20to%20you%21" >me@example.com</a> + + {mailto address="me@example.com" cc="you@example.com,they@example.com"} + <a href="mailto:me@example.com?cc=you@example.com,they@example.com" >me@example.com</a> + + {mailto address="me@example.com" extra='class="email"'} + <a href="mailto:me@example.com" class="email">me@example.com</a> + + {mailto address="me@example.com" encode="javascript_charcode"} + <script type="text/javascript" language="javascript"> + {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))} + </script> + +See also [`escape`](#language.modifier.escape), +[`{textformat}`](#language.function.textformat) and [obfuscating email +addresses](#tips.obfuscating.email). diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-math.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-math.md new file mode 100644 index 000000000..9adfd1c5a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-math.md @@ -0,0 +1,104 @@ +{math} {#language.function.math} +====== + +`{math}` allows the template designer to do math equations in the +template. + +- Any numeric template variables may be used in the equations, and the + result is printed in place of the tag. + +- The variables used in the equation are passed as parameters, which + can be template variables or static values. + +- +, -, /, \*, abs, ceil, cos, exp, floor, log, log10, max, min, pi, + pow, rand, round, sin, sqrt, srans and tan are all valid operators. + Check the PHP documentation for further information on these + [math](&url.php-manual;eval) functions. + +- If you supply the `assign` attribute, the output of the `{math}` + function will be assigned to this template variable instead of being + output to the template. + +> **Note** +> +> `{math}` is an expensive function in performance due to its use of the +> php [`eval()`](&url.php-manual;eval) function. Doing the math in PHP +> is much more efficient, so whenever possible do the math calculations +> in the script and [`assign()`](#api.assign) the results to the +> template. Definitely avoid repetitive `{math}` function calls, eg +> within [`{section}`](#language.function.section) loops. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- --------- -------------------------------------------------- + equation string Yes *n/a* The equation to execute + format string No *n/a* The format of the result (sprintf) + var numeric Yes *n/a* Equation variable value + assign string No *n/a* Template variable the output will be assigned to + \[var \...\] numeric Yes *n/a* Equation variable value + +**Example a:** + + + {* $height=4, $width=5 *} + + {math equation="x + y" x=$height y=$width} + + + +The above example will output: + + + 9 + + + +**Example b:** + + + {* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *} + + {math equation="height * width / division" + height=$row_height + width=$row_width + division=#col_div#} + + + +The above example will output: + + + 100 + + + +**Example c:** + + + {* you can use parenthesis *} + + {math equation="(( x + y ) / z )" x=2 y=10 z=2} + + + +The above example will output: + + + 6 + + + +**Example d:** + + + {* you can supply a format parameter in sprintf format *} + + {math equation="x + y" x=4.4444 y=5.0000 format="%.2f"} + + + +The above example will output: + + + 9.44 + + diff --git a/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-textformat.md b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-textformat.md new file mode 100644 index 000000000..d0cd4cfc8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-custom-functions/language-function-textformat.md @@ -0,0 +1,190 @@ +{textformat} {#language.function.textformat} +============ + +`{textformat}` is a [block function](#plugins.block.functions) used to +format text. It basically cleans up spaces and special characters, and +formats paragraphs by wrapping at a boundary and indenting lines. + +You can set the parameters explicitly, or use a preset style. Currently +"email" is the only available style. + + Attribute Name Type Required Default Description + ---------------- --------- ---------- ------------------ ---------------------------------------------------------------------------------------- + style string No *n/a* Preset style + indent number No *0* The number of chars to indent every line + indent\_first number No *0* The number of chars to indent the first line + indent\_char string No *(single space)* The character (or string of chars) to indent with + wrap number No *80* How many characters to wrap each line to + wrap\_char string No *\\n* The character (or string of chars) to break each line with + wrap\_cut boolean No *FALSE* If TRUE, wrap will break the line at the exact character instead of at a word boundary + assign string No *n/a* The template variable the output will be assigned to + + + {textformat wrap=40} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + + +The above example will output: + + + + This is foo. This is foo. This is foo. + This is foo. This is foo. This is foo. + + This is bar. + + bar foo bar foo foo. bar foo bar foo + foo. bar foo bar foo foo. bar foo bar + foo foo. bar foo bar foo foo. bar foo + bar foo foo. bar foo bar foo foo. + + + + + {textformat wrap=40 indent=4} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + + +The above example will output: + + + + This is foo. This is foo. This is + foo. This is foo. This is foo. This + is foo. + + This is bar. + + bar foo bar foo foo. bar foo bar foo + foo. bar foo bar foo foo. bar foo + bar foo foo. bar foo bar foo foo. + bar foo bar foo foo. bar foo bar + foo foo. + + + + + {textformat wrap=40 indent=4 indent_first=4} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + +The above example will output: + + + + This is foo. This is foo. This + is foo. This is foo. This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. bar foo bar + foo foo. bar foo bar foo foo. bar + foo bar foo foo. bar foo bar foo + foo. bar foo bar foo foo. bar foo + bar foo foo. + + + + + {textformat style="email"} + + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + This is foo. + + This is bar. + + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + bar foo bar foo foo. + + {/textformat} + + + + +The above example will output: + + + + This is foo. This is foo. This is foo. This is foo. This is foo. This is + foo. + + This is bar. + + bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo + bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo + foo. + + + + +See also [`{strip}`](#language.function.strip) and +[`wordwrap`](#language.modifier.wordwrap). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers.md b/vendor/smarty/smarty/docs/designers/language-modifiers.md new file mode 100644 index 000000000..4cb69cd1e --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers.md @@ -0,0 +1,123 @@ +Variable Modifiers {#language.modifiers} +================== + +## Table of contents +- [capitalize](./language-modifiers/language-modifier-capitalize.md) +- [cat](./language-modifiers/language-modifier-cat.md) +- [count_characters](./language-modifiers/language-modifier-count-characters.md) +- [count_paragraphs](./language-modifiers/language-modifier-count-paragraphs.md) +- [count_sentences](./language-modifiers/language-modifier-count-sentences.md) +- [count_words](./language-modifiers/language-modifier-count-words.md) +- [date_format](./language-modifiers/language-modifier-date-format.md) +- [default](./language-modifiers/language-modifier-default.md) +- [escape](./language-modifiers/language-modifier-escape.md) +- [from_charset](./language-modifiers/language-modifier-from-charset.md) +- [indent](./language-modifiers/language-modifier-indent.md) +- [lower](./language-modifiers/language-modifier-lower.md) +- [nl2br](./language-modifiers/language-modifier-nl2br.md) +- [regex_replace](./language-modifiers/language-modifier-regex-replace.md) +- [replace](./language-modifiers/language-modifier-replace.md) +- [spacify](./language-modifiers/language-modifier-spacify.md) +- [string_format](./language-modifiers/language-modifier-string-format.md) +- [strip](./language-modifiers/language-modifier-strip.md) +- [strip_tags](./language-modifiers/language-modifier-strip-tags.md) +- [to_charset](./language-modifiers/language-modifier-to-charset.md) +- [truncate](./language-modifiers/language-modifier-truncate.md) +- [unescape](./language-modifiers/language-modifier-unescape.md) +- [upper](./language-modifiers/language-modifier-upper.md) +- [wordwrap](./language-modifiers/language-modifier-wordwrap.md) + +Variable modifiers can be applied to +[variables](./language-variables.md), [custom +functions](./language-custom-functions.md) or strings. To apply a modifier, +specify the value followed by a `|` (pipe) and the modifier name. A +modifier may accept additional parameters that affect its behavior. +These parameters follow the modifier name and are separated by a `:` +(colon). Also, *all php-functions can be used as modifiers implicitly* +(more below) and modifiers can be +[combined](./language-combining-modifiers.md). + + + {* apply modifier to a variable *} + {$title|upper} + + {* modifier with parameters *} + {$title|truncate:40:"..."} + + {* apply modifier to a function parameter *} + {html_table loop=$myvar|upper} + + {* with parameters *} + {html_table loop=$myvar|truncate:40:"..."} + + {* apply modifier to literal string *} + {"foobar"|upper} + + {* using date_format to format the current date *} + {$smarty.now|date_format:"%Y/%m/%d"} + + {* apply modifier to a custom function *} + {mailto|upper address="smarty@example.com"} + + {* using php's str_repeat *} + {"="|str_repeat:80} + + {* php's count *} + {$myArray|@count} + + {* this will uppercase and truncate the whole array *} + <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. + + > **Note** + > + > The default behavior was changed with Smarty 3. In Smarty 2.x, you + > had to use an \"`@`\" symbol to apply a modifier to an array, such + > as `{$articleTitle|@count}`. With Smarty 3, the \"`@`\" is no + > longer necessary, and is ignored. + > + > If you want a modifier to apply to each individual item of an + > array, you will either need to loop the array in the template, or + > provide for this functionality inside your modifier function. + + > **Note** + > + > Second, in Smarty 2.x, modifiers were applied to the result of + > math expressions like `{8+2}`, meaning that + > `{8+2|count_characters}` would give `2`, as 8+2=10 and 10 is two + > characters long. With Smarty 3, modifiers are applied to the + > variables or atomic expressions before executing the calculations, + > so since 2 is one character long, `{8+2|count_characters}` + > 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 securty policy. See the + [Security](../programmers/advanced-features/advanced-features-security.md) section for details. + +See also [`registerPlugin()`](../programmers/api-functions/api-register-plugin.md), [combining +modifiers](./language-combining-modifiers.md). and [extending smarty with +plugins](../programmers/plugins.md) diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-capitalize.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-capitalize.md new file mode 100644 index 000000000..015bb3bc0 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-capitalize.md @@ -0,0 +1,41 @@ +capitalize {#language.modifier.capitalize} +========== + +This is used to capitalize the first letter of all words in a variable. +This is similar to the PHP [`ucwords()`](&url.php-manual;ucwords) +function. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ----------------------------------------------------------------------------------------------------------- + 1 boolean No FALSE This determines whether or not words with digits will be uppercased + 2 boolean No FALSE This determines whether or not Capital letters within words should be lowercased, e.g. \"aAa\" to \"Aaa\" + + + <?php + + $smarty->assign('articleTitle', 'next x-men film, x3, delayed.'); + + ?> + + + +Where the template is: + + + {$articleTitle} + {$articleTitle|capitalize} + {$articleTitle|capitalize:true} + + + +Will output: + + + next x-men film, x3, delayed. + Next X-Men Film, x3, Delayed. + Next X-Men Film, X3, Delayed. + + + +See also [`lower`](#language.modifier.lower) and +[`upper`](#language.modifier.upper) diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-cat.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-cat.md new file mode 100644 index 000000000..1f43ae177 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-cat.md @@ -0,0 +1,31 @@ +cat {#language.modifier.cat} +=== + +This value is concatenated to the given variable. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- ----------------------------------------------- + 1 string No *empty* This value to catenate to the given variable. + + + <?php + + $smarty->assign('articleTitle', "Psychics predict world didn't end"); + + ?> + + + +Where template is: + + + {$articleTitle|cat:' yesterday.'} + + + +Will output: + + + Psychics predict world didn't end yesterday. + + diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-characters.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-characters.md new file mode 100644 index 000000000..23bc00d51 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-characters.md @@ -0,0 +1,39 @@ +count\_characters {#language.modifier.count.characters} +================= + +This is used to count the number of characters in a variable. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ------------------------------------------------------------------------------- + 1 boolean No FALSE This determines whether or not to include whitespace characters in the count. + + + <?php + + $smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_characters} + {$articleTitle|count_characters:true} + + + +Will output: + + + Cold Wave Linked to Temperatures. + 29 + 33 + + + +See also [`count_words`](#language.modifier.count.words), +[`count_sentences`](#language.modifier.count.sentences) and +[`count_paragraphs`](#language.modifier.count.paragraphs). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-paragraphs.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-paragraphs.md new file mode 100644 index 000000000..02c474e6b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-paragraphs.md @@ -0,0 +1,38 @@ +count\_paragraphs {#language.modifier.count.paragraphs} +================= + +This is used to count the number of paragraphs in a variable. + + + <?php + + $smarty->assign('articleTitle', + "War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\n + Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation." + ); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_paragraphs} + + + +Will output: + + + War Dims Hope for Peace. Child's Death Ruins Couple's Holiday. + + Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation. + 2 + + + +See also [`count_characters`](#language.modifier.count.characters), +[`count_sentences`](#language.modifier.count.sentences) and +[`count_words`](#language.modifier.count.words). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-sentences.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-sentences.md new file mode 100644 index 000000000..0a77ab82a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-sentences.md @@ -0,0 +1,37 @@ +count\_sentences {#language.modifier.count.sentences} +================ + +This is used to count the number of sentences in a variable. A sentence +being delimited by a dot, question- or exclamation-mark (.?!). + + + <?php + + $smarty->assign('articleTitle', + 'Two Soviet Ships Collide - One Dies. + Enraged Cow Injures Farmer with Axe.' + ); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_sentences} + + + +Will output: + + + Two Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe. + 2 + + + +See also [`count_characters`](#language.modifier.count.characters), +[`count_paragraphs`](#language.modifier.count.paragraphs) and +[`count_words`](#language.modifier.count.words). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-words.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-words.md new file mode 100644 index 000000000..d25fbd5b8 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-count-words.md @@ -0,0 +1,33 @@ +count\_words {#language.modifier.count.words} +============ + +This is used to count the number of words in a variable. + + + <?php + + $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|count_words} + + + +This will output: + + + Dealers Will Hear Car Talk at Noon. + 7 + + + +See also [`count_characters`](#language.modifier.count.characters), +[`count_paragraphs`](#language.modifier.count.paragraphs) and +[`count_sentences`](#language.modifier.count.sentences). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-date-format.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-date-format.md new file mode 100644 index 000000000..edd81937b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-date-format.md @@ -0,0 +1,175 @@ +date\_format {#language.modifier.date.format} +============ + +This formats a date and time into the given +[`strftime()`](&url.php-manual;strftime) format. Dates can be passed to +Smarty as unix [timestamps](&url.php-manual;function.time), [DateTime +objects](&url.php-manual;class.DateTime), mysql timestamps or any string +made up of month day year, parsable by php\'s +[`strtotime()`](&url.php-manual;strtotime). Designers can then use +`date_format` to have complete control of the formatting of the date. If +the date passed to `date_format` is empty and a second parameter is +passed, that will be used as the date to format. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- ------------ ------------------------------------------------- + 1 string No \%b %e, %Y This is the format for the outputted date. + 2 string No n/a This is the default date if the input is empty. + +> **Note** +> +> Since Smarty-2.6.10 numeric values passed to `date_format` are +> *always* (except for mysql timestamps, see below) interpreted as a +> unix timestamp. +> +> Before Smarty-2.6.10 numeric strings that where also parsable by +> `strtotime()` in php (like `YYYYMMDD`) where sometimes (depending on +> the underlying implementation of `strtotime()`) interpreted as date +> strings and NOT as timestamps. +> +> The only exception are mysql timestamps: They are also numeric only +> and 14 characters long (`YYYYMMDDHHMMSS`), mysql timestamps have +> precedence over unix timestamps. + +> **Note** +> +> `date_format` is essentially a wrapper to PHP\'s +> [`strftime()`](&url.php-manual;strftime) function. You may have more +> or less conversion specifiers available depending on your system\'s +> [`strftime()`](&url.php-manual;strftime) function where PHP was +> compiled. Check your system\'s manpage for a full list of valid +> specifiers. However, a few of the specifiers are emulated on Windows. +> These are: %D, %e, %h, %l, %n, %r, %R, %t, %T. + + + <?php + + $config['date'] = '%I:%M %p'; + $config['time'] = '%H:%M:%S'; + $smarty->assign('config', $config); + $smarty->assign('yesterday', strtotime('-1 day')); + + ?> + + + +This template uses [`$smarty.now`](#language.variables.smarty.now) to +get the current time: + + + {$smarty.now|date_format} + {$smarty.now|date_format:"%D"} + {$smarty.now|date_format:$config.date} + {$yesterday|date_format} + {$yesterday|date_format:"%A, %B %e, %Y"} + {$yesterday|date_format:$config.time} + + + +This above will output: + + + Jan 1, 2022 + 01/01/22 + 02:33 pm + Dec 31, 2021 + Monday, December 1, 2021 + 14:33:00 + + + +`date_format` conversion specifiers: + +- \%a - abbreviated weekday name according to the current locale + +- \%A - full weekday name according to the current locale + +- \%b - abbreviated month name according to the current locale + +- \%B - full month name according to the current locale + +- \%c - preferred date and time representation for the current locale + +- \%C - century number (the year divided by 100 and truncated to an + integer, range 00 to 99) + +- \%d - day of the month as a decimal number (range 01 to 31) + +- \%D - same as %m/%d/%y + +- \%e - day of the month as a decimal number, a single digit is + preceded by a space (range 1 to 31) + +- \%g - Week-based year within century \[00,99\] + +- \%G - Week-based year, including the century \[0000,9999\] + +- \%h - same as %b + +- \%H - hour as a decimal number using a 24-hour clock (range 00 + to 23) + +- \%I - hour as a decimal number using a 12-hour clock (range 01 + to 12) + +- \%j - day of the year as a decimal number (range 001 to 366) + +- \%k - Hour (24-hour clock) single digits are preceded by a blank. + (range 0 to 23) + +- \%l - hour as a decimal number using a 12-hour clock, single digits + preceded by a space (range 1 to 12) + +- \%m - month as a decimal number (range 01 to 12) + +- \%M - minute as a decimal number + +- \%n - newline character + +- \%p - either \`am\' or \`pm\' according to the given time value, or + the corresponding strings for the current locale + +- \%r - time in a.m. and p.m. notation + +- \%R - time in 24 hour notation + +- \%S - second as a decimal number + +- \%t - tab character + +- \%T - current time, equal to %H:%M:%S + +- \%u - weekday as a decimal number \[1,7\], with 1 representing + Monday + +- \%U - week number of the current year as a decimal number, starting + with the first Sunday as the first day of the first week + +- \%V - The ISO 8601:1988 week number of the current year as a decimal + number, range 01 to 53, where week 1 is the first week that has at + least 4 days in the current year, and with Monday as the first day + of the week. + +- \%w - day of the week as a decimal, Sunday being 0 + +- \%W - week number of the current year as a decimal number, starting + with the first Monday as the first day of the first week + +- \%x - preferred date representation for the current locale without + the time + +- \%X - preferred time representation for the current locale without + the date + +- \%y - year as a decimal number without a century (range 00 to 99) + +- \%Y - year as a decimal number including the century + +- \%Z - time zone or name or abbreviation + +- \%% - a literal \`%\' character + +See also [`$smarty.now`](#language.variables.smarty.now), +[`strftime()`](&url.php-manual;strftime), +[`{html_select_date}`](#language.function.html.select.date) and the +[date tips](#tips.dates) page. diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-default.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-default.md new file mode 100644 index 000000000..ce08e96ef --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-default.md @@ -0,0 +1,41 @@ +default {#language.modifier.default} +======= + +This is used to set a default value for a variable. If the variable is +unset or an empty string, the given default value is printed instead. +Default takes the one argument. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- --------------------------------------------------------------- + 1 string No *empty* This is the default value to output if the variable is empty. + + + <?php + + $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.'); + $smarty->assign('email', ''); + + ?> + + + +Where template is: + + + {$articleTitle|default:'no title'} + {$myTitle|default:'no title'} + {$email|default:'No email address available'} + + + +Will output: + + + Dealers Will Hear Car Talk at Noon. + no title + No email address available + + + +See also the [default variable handling](#tips.default.var.handling) and +the [blank variable handling](#tips.blank.var.handling) pages. diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-escape.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-escape.md new file mode 100644 index 000000000..37c71dde9 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-escape.md @@ -0,0 +1,74 @@ +escape {#language.modifier.escape} +====== + +`escape` is used to encode or escape a variable to `html`, `url`, +`single quotes`, `hex`, `hexentity`, `javascript` and `mail`. By default +its `html`. + + Parameter Position Type Required Possible Values Default Description + -------------------- --------- ---------- ------------------------------------------------------------------------------------------------------------ --------- ------------------------------------------------------------------------------------- + 1 string No `html`, `htmlall`, `url`, `urlpathinfo`, `quotes`, `hex`, `hexentity`, `javascript`, `mail` `html` This is the escape format to use. + 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to htmlentities() et. al. + 3 boolean No FALSE TRUE Double encode entites from & to &amp; (applys to `html` and `htmlall` only) + + + <?php + + $smarty->assign('articleTitle', + "'Stiff Opposition Expected to Casketless Funeral Plan'" + ); + $smarty->assign('EmailAddress','smarty@example.com'); + + ?> + + + +These are example `escape` template lines followed by the output + + + {$articleTitle} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + {$articleTitle|escape} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + {$articleTitle|escape:'html'} {* escapes & " ' < > *} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + {$articleTitle|escape:'htmlall'} {* escapes ALL html entities *} + 'Stiff Opposition Expected to Casketless Funeral Plan' + + <a href="?title={$articleTitle|escape:'url'}">click here</a> + <a + href="?title=%27Stiff%20Opposition%20Expected%20to%20Casketless%20Funeral%20Plan%27">click here</a> + + {$articleTitle|escape:'quotes'} + \'Stiff Opposition Expected to Casketless Funeral Plan\' + + <a href="mailto:{$EmailAddress|escape:"hex"}">{$EmailAddress|escape:"hexentity"}</a> + {$EmailAddress|escape:'mail'} {* this converts to email to text *} + <a href="mailto:%62%6f%..snip..%65%74">bob..snip..et</a> + + {'mail@example.com'|escape:'mail'} + smarty [AT] example [DOT] com + + + + + {* the "rewind" parameter registers the current location *} + <a href="$my_path?page=foo&rewind=$my_uri|urlencode}">click here</a> + + + +This snippet is useful for emails, but see also +[`{mailto}`](#language.function.mailto) + + + {* email address mangled *} + <a href="mailto:{$EmailAddress|escape:'hex'}">{$EmailAddress|escape:'mail'}</a> + + + +See also [escaping smarty parsing](#language.escaping), +[`{mailto}`](#language.function.mailto) and the [obfuscating email +addresses](#tips.obfuscating.email) page. diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-from-charset.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-from-charset.md new file mode 100644 index 000000000..8b7fdd50f --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-from-charset.md @@ -0,0 +1,19 @@ +from\_charset {#language.modifier.from_charset} +============= + +`from_charset` is used to transcode a string from a given charset to the +internal charset. This is the exact opposite of the [to\_charset +modifier](#language.modifier.to_charset). + + Parameter Position Type Required Possible Values Default Description + -------------------- -------- ---------- -------------------------------------------------------------------------------------------------------------------------- -------------- --------------------------------------------------------------- + 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be decoded from + +> **Note** +> +> Charset encoding should be handled by the application itself. This +> modifier should only be used in cases where the application cannot +> anticipate that a certain string is required in another encoding. + +See also [Charset Enconding](#charset), [from\_charset +modifier](#language.modifier.from_charset). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md new file mode 100644 index 000000000..d0264dca3 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md @@ -0,0 +1,62 @@ +indent {#language.modifier.indent} +====== + +This indents a string on each line, default is 4. As an optional +parameter, you can specify the number of characters to indent. As an +optional second parameter, you can specify the character to use to +indent with eg use `"\t"` for a tab. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- ------------- --------------------------------------------------- + 1 integer No 4 This determines how many characters to indent to. + 2 string No (one space) This is the character used to indent with. + + + <?php + + $smarty->assign('articleTitle', + 'NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25.' + ); + ?> + + + +Where template is: + + + {$articleTitle} + + {$articleTitle|indent} + + {$articleTitle|indent:10} + + {$articleTitle|indent:1:"\t"} + + + +Will output: + + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + + + +See also [`strip`](#language.modifier.strip), +[`wordwrap`](#language.modifier.wordwrap) and +[`spacify`](#language.modifier.spacify). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-lower.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-lower.md new file mode 100644 index 000000000..90122e9e4 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-lower.md @@ -0,0 +1,33 @@ +lower {#language.modifier.lower} +===== + +This is used to lowercase a variable. This is equivalent to the PHP +[`strtolower()`](&url.php-manual;strtolower) function. + + + <?php + + $smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|lower} + + + +This will output: + + + Two Convicts Evade Noose, Jury Hung. + two convicts evade noose, jury hung. + + + +See also [`upper`](#language.modifier.upper) and +[`capitalize`](#language.modifier.capitalize). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-nl2br.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-nl2br.md new file mode 100644 index 000000000..541233c8b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-nl2br.md @@ -0,0 +1,35 @@ +nl2br {#language.modifier.nl2br} +===== + +All `"\n"` line breaks will be converted to html `<br />` tags in the +given variable. This is equivalent to the PHP\'s +[`nl2br()`](&url.php-manual;nl2br) function. + + + <?php + + $smarty->assign('articleTitle', + "Sun or rain expected\ntoday, dark tonight" + ); + + ?> + + + +Where the template is: + + + {$articleTitle|nl2br} + + + +Will output: + + + Sun or rain expected<br />today, dark tonight + + + +See also [`word_wrap`](#language.modifier.wordwrap), +[`count_paragraphs`](#language.modifier.count.paragraphs) and +[`count_sentences`](#language.modifier.count.sentences). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-regex-replace.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-regex-replace.md new file mode 100644 index 000000000..6fcb33fad --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-regex-replace.md @@ -0,0 +1,51 @@ +regex\_replace {#language.modifier.regex.replace} +============== + +A regular expression search and replace on a variable. Use the +[`preg_replace()`](&url.php-manual;preg_replace) syntax from the PHP +manual. + +> **Note** +> +> Although Smarty supplies this regex convenience modifier, it is +> usually better to apply regular expressions in PHP, either via custom +> functions or modifiers. Regular expressions are considered application +> code and are not part of presentation logic. + +Parameters + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- ------------------------------------------------ + 1 string Yes *n/a* This is the regular expression to be replaced. + 2 string Yes *n/a* This is the string of text to replace with. + + + <?php + + $smarty->assign('articleTitle', "Infertility unlikely to\nbe passed on, experts say."); + + ?> + + + +Where template is: + + + {* replace each carriage return, tab and new line with a space *} + + {$articleTitle} + {$articleTitle|regex_replace:"/[\r\t\n]/":" "} + + + +Will output: + + + Infertility unlikely to + be passed on, experts say. + Infertility unlikely to be passed on, experts say. + + + +See also [`replace`](#language.modifier.replace) and +[`escape`](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-replace.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-replace.md new file mode 100644 index 000000000..c7c2903ea --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-replace.md @@ -0,0 +1,40 @@ +replace {#language.modifier.replace} +======= + +A simple search and replace on a variable. This is equivalent to the +PHP\'s [`str_replace()`](&url.php-manual;str_replace) function. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- --------------------------------------------- + 1 string Yes *n/a* This is the string of text to be replaced. + 2 string Yes *n/a* This is the string of text to replace with. + + + <?php + + $smarty->assign('articleTitle', "Child's Stool Great for Use in Garden."); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|replace:'Garden':'Vineyard'} + {$articleTitle|replace:' ':' '} + + + +Will output: + + + Child's Stool Great for Use in Garden. + Child's Stool Great for Use in Vineyard. + Child's Stool Great for Use in Garden. + + + +See also [`regex_replace`](#language.modifier.regex.replace) and +[`escape`](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-spacify.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-spacify.md new file mode 100644 index 000000000..8856dab43 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-spacify.md @@ -0,0 +1,40 @@ +spacify {#language.modifier.spacify} +======= + +`spacify` is a way to insert a space between every character of a +variable. You can optionally pass a different character or string to +insert. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- ------------- ----------------------------------------------------------------- + 1 string No *one space* This what gets inserted between each character of the variable. + + + <?php + + $smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.'); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|spacify} + {$articleTitle|spacify:"^^"} + + + +Will output: + + + Something Went Wrong in Jet Crash, Experts Say. + S o m e t h i n g W .... snip .... s h , E x p e r t s S a y . + S^^o^^m^^e^^t^^h^^i^^n^^g^^ .... snip .... ^^e^^r^^t^^s^^ ^^S^^a^^y^^. + + + +See also [`wordwrap`](#language.modifier.wordwrap) and +[`nl2br`](#language.modifier.nl2br). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md new file mode 100644 index 000000000..754014e2d --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-string-format.md @@ -0,0 +1,39 @@ +string\_format {#language.modifier.string.format} +============== + +This is a way to format strings, such as decimal numbers and such. Use +the syntax for [`sprintf()`](&url.php-manual;sprintf) for the +formatting. + + Parameter Position Type Required Default Description + -------------------- -------- ---------- --------- --------------------------------------- + 1 string Yes *n/a* This is what format to use. (sprintf) + + + <?php + + $smarty->assign('number', 23.5787446); + + ?> + + + +Where template is: + + + {$number} + {$number|string_format:"%.2f"} + {$number|string_format:"%d"} + + + +Will output: + + + 23.5787446 + 23.58 + 23 + + + +See also [`date_format`](#language.modifier.date.format). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip-tags.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip-tags.md new file mode 100644 index 000000000..4a019767b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip-tags.md @@ -0,0 +1,41 @@ +strip\_tags {#language.modifier.strip.tags} +=========== + +This strips out markup tags, basically anything between `<` and `>`. + + Parameter Position Type Required Default Description + -------------------- ------ ---------- --------- ---------------------------------------------------------------- + 1 bool No TRUE This determines whether the tags are replaced by \' \' or \'\' + + + <?php + + $smarty->assign('articleTitle', + "Blind Woman Gets <font face=\"helvetica\">New + Kidney</font> from Dad she Hasn't Seen in <b>years</b>." + ); + + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *} + {$articleTitle|strip_tags:false} + + + +Will output: + + + Blind Woman Gets <font face="helvetica">New Kidney</font> from Dad she Hasn't Seen in <b>years</b>. + Blind Woman Gets New Kidney from Dad she Hasn't Seen in years . + Blind Woman Gets New Kidney from Dad she Hasn't Seen in years. + + + +See also [`replace`](#language.modifier.replace) and +[`regex_replace`](#language.modifier.regex.replace). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip.md new file mode 100644 index 000000000..7027e0313 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-strip.md @@ -0,0 +1,40 @@ +strip {#language.modifier.strip} +===== + +This replaces all spaces, newlines and tabs with a single space, or with +the supplied string. + +> **Note** +> +> If you want to strip blocks of template text, use the built-in +> [`{strip}`](#language.function.strip) function. + + + <?php + $smarty->assign('articleTitle', "Grandmother of\neight makes\t hole in one."); + $smarty->display('index.tpl'); + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|strip} + {$articleTitle|strip:' '} + + + +Will output: + + + Grandmother of + eight makes hole in one. + Grandmother of eight makes hole in one. + Grandmother of eight makes hole in one. + + + +See also [`{strip}`](#language.function.strip) and +[`truncate`](#language.modifier.truncate). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-to-charset.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-to-charset.md new file mode 100644 index 000000000..6c53232c2 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-to-charset.md @@ -0,0 +1,19 @@ +to\_charset {#language.modifier.to_charset} +=========== + +`to_charset` is used to transcode a string from the internal charset to +a given charset. This is the exact opposite of the [from\_charset +modifier](#language.modifier.from_charset). + + Parameter Position Type Required Possible Values Default Description + -------------------- -------- ---------- -------------------------------------------------------------------------------------------------------------------------- -------------- ------------------------------------------------------------- + 1 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`mb_convert_encoding()`](&url.php-manual;mb_convert_encoding) `ISO-8859-1` The charset encoding the value is supposed to be encoded to + +> **Note** +> +> Charset encoding should be handled by the application itself. This +> modifier should only be used in cases where the application cannot +> anticipate that a certain string is required in another encoding. + +See also [Charset Enconding](#charset), [from\_charset +modifier](#language.modifier.from_charset). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-truncate.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-truncate.md new file mode 100644 index 000000000..2303a5432 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-truncate.md @@ -0,0 +1,52 @@ +truncate {#language.modifier.truncate} +======== + +This truncates a variable to a character length, the default is 80. As +an optional second parameter, you can specify a string of text to +display at the end if the variable was truncated. The characters in the +string are included with the original truncation length. By default, +`truncate` will attempt to cut off at a word boundary. If you want to +cut off at the exact character length, pass the optional third parameter +of TRUE. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + 1 integer No 80 This determines how many characters to truncate to. + 2 string No \... This is a text string that replaces the truncated text. Its length is included in the truncation length setting. + 3 boolean No FALSE This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE. + 4 boolean No FALSE This determines whether the truncation happens at the end of the string with FALSE, or in the middle of the string with TRUE. Note that if this setting is TRUE, then word boundaries are ignored. + + + <?php + $smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.'); + ?> + + + +where template is: + + + {$articleTitle} + {$articleTitle|truncate} + {$articleTitle|truncate:30} + {$articleTitle|truncate:30:""} + {$articleTitle|truncate:30:"---"} + {$articleTitle|truncate:30:"":true} + {$articleTitle|truncate:30:"...":true} + {$articleTitle|truncate:30:'..':true:true} + + + +This will output: + + + Two Sisters Reunite after Eighteen Years at Checkout Counter. + Two Sisters Reunite after Eighteen Years at Checkout Counter. + Two Sisters Reunite after... + Two Sisters Reunite after + Two Sisters Reunite after--- + Two Sisters Reunite after Eigh + Two Sisters Reunite after E... + Two Sisters Re..ckout Counter. + + diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md new file mode 100644 index 000000000..58d0b3f75 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md @@ -0,0 +1,39 @@ +unescape {#language.modifier.unescape} +======== + +`unescape` is used to decode `entity`, `html` and `htmlall`. It counters +the effects of the [escape modifier](#language.modifier.escape) for the +given types. + + Parameter Position Type Required Possible Values Default Description + -------------------- -------- ---------- ------------------------------------------------------------------------------------------------------------ --------- ------------------------------------------------------------------------------------------------------------------------------ + 1 string No `html`, `htmlall`, `entity`, `html` This is the escape format to use. + 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to html\_entity\_decode() or htmlspecialchars\_decode() or mb\_convert\_encoding() et. al. + + + <?php + + $smarty->assign('articleTitle', + "Germans use "Ümlauts" and pay in €uro" + ); + + ?> + + + +These are example `unescape` template lines followed by the output + + + {$articleTitle} + Germans use "Ümlauts" and pay in €uro + + {$articleTitle|unescape:"html"} + Germans use "Ümlauts" and pay in €uro + + {$articleTitle|unescape:"htmlall"} + Germans use "Ãœmlauts" and pay in €uro + + + +See also [escaping smarty parsing](#language.escaping), [escape +modifier](#language.modifier.escape). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-upper.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-upper.md new file mode 100644 index 000000000..9240f42d6 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-upper.md @@ -0,0 +1,31 @@ +upper {#language.modifier.upper} +===== + +This is used to uppercase a variable. This is equivalent to the PHP +[`strtoupper()`](&url.php-manual;strtoupper) function. + + + <?php + $smarty->assign('articleTitle', "If Strike isn't Settled Quickly it may Last a While."); + ?> + + + +Where template is: + + + {$articleTitle} + {$articleTitle|upper} + + + +Will output: + + + If Strike isn't Settled Quickly it may Last a While. + IF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE. + + + +See also [`lower`](#language.modifier.lower) and +[`capitalize`](#language.modifier.capitalize). diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-wordwrap.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-wordwrap.md new file mode 100644 index 000000000..97cd774f7 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-wordwrap.md @@ -0,0 +1,69 @@ +wordwrap {#language.modifier.wordwrap} +======== + +Wraps a string to a column width, the default is 80. As an optional +second parameter, you can specify a string of text to wrap the text to +the next line, the default is a carriage return `"\n"`. By default, +`wordwrap` will attempt to wrap at a word boundary. If you want to cut +off at the exact character length, pass the optional third parameter as +TRUE. This is equivalent to the PHP +[`wordwrap()`](&url.php-manual;wordwrap) function. + + Parameter Position Type Required Default Description + -------------------- --------- ---------- --------- ------------------------------------------------------------------------------------------------------ + 1 integer No 80 This determines how many columns to wrap to. + 2 string No \\n This is the string used to wrap words with. + 3 boolean No FALSE This determines whether or not to wrap at a word boundary (FALSE), or at the exact character (TRUE). + + + <?php + + $smarty->assign('articleTitle', + "Blind woman gets new kidney from dad she hasn't seen in years." + ); + + ?> + + + +Where template is + + + {$articleTitle} + + {$articleTitle|wordwrap:30} + + {$articleTitle|wordwrap:20} + + {$articleTitle|wordwrap:30:"<br />\n"} + + {$articleTitle|wordwrap:26:"\n":true} + + + +Will output: + + + Blind woman gets new kidney from dad she hasn't seen in years. + + Blind woman gets new kidney + from dad she hasn't seen in + years. + + Blind woman gets new + kidney from dad she + hasn't seen in + years. + + Blind woman gets new kidney<br /> + from dad she hasn't seen in<br /> + years. + + Blind woman gets new kidn + ey from dad she hasn't se + en in years. + + + +See also [`nl2br`](#language.modifier.nl2br) and +[`{textformat}`](#language.function.textformat). diff --git a/vendor/smarty/smarty/docs/designers/language-variables.md b/vendor/smarty/smarty/docs/designers/language-variables.md new file mode 100644 index 000000000..3950d0baf --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables.md @@ -0,0 +1,37 @@ +Variables +========= + +## Table of contents +- [Variables assigned from PHP](./language-variables/language-assigned-variables.md) +- [Variable scopes](./language-variables/language-variable-scopes.md) +- [Variables loaded from config files](./language-variables/language-config-variables.md) +- [{$smarty} reserved variable](./language-variables/language-variables-smarty.md) + + +Smarty has several different types of variables. The type of the +variable depends on what symbol it is prefixed or enclosed within. + +Variables in Smarty can be either displayed directly or used as +arguments for [functions](./language-basic-syntax/language-syntax-functions.md), +[attributes](./language-basic-syntax/language-syntax-attributes.md) and +[modifiers](./language-modifiers.md), inside conditional expressions, etc. +To print a variable, simply enclose it in the +[delimiters](../programmers/api-variables/variable-left-delimiter.md) so that it is the only thing +contained between them. + + + {$Name} + + {$product.part_no} <b>{$product.description}</b> + + {$Contacts[row].Phone} + + <body bgcolor="{#bgcolor#}"> + + + +> **Note** +> +> An easy way to examine assigned Smarty variables is with the +> [debugging console](./chapter-debugging-console.md). + diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-assigned-variables.md b/vendor/smarty/smarty/docs/designers/language-variables/language-assigned-variables.md new file mode 100644 index 000000000..005dea4a9 --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-assigned-variables.md @@ -0,0 +1,142 @@ +Variables assigned from PHP {#language.assigned.variables} +=========================== + +Assigned variables that are referenced by preceding them with a dollar +(`$`) sign. + +PHP code + + + <?php + + $smarty = new Smarty(); + + $smarty->assign('firstname', 'Doug'); + $smarty->assign('lastname', 'Evans'); + $smarty->assign('meetingPlace', 'New York'); + + $smarty->display('index.tpl'); + + ?> + +`index.tpl` source: + + + Hello {$firstname} {$lastname}, glad to see you can make it. + <br /> + {* this will not work as $variables are case sensitive *} + This weeks meeting is in {$meetingplace}. + {* this will work *} + This weeks meeting is in {$meetingPlace}. + + + +This above would output: + + + Hello Doug Evans, glad to see you can make it. + <br /> + This weeks meeting is in . + This weeks meeting is in New York. + + + +Associative arrays {#language.variables.assoc.arrays} +------------------ + +You can also reference associative array variables by specifying the key +after a dot \".\" symbol. + + + <?php + $smarty->assign('Contacts', + array('fax' => '555-222-9876', + 'email' => 'zaphod@slartibartfast.example.com', + 'phone' => array('home' => '555-444-3333', + 'cell' => '555-111-1234') + ) + ); + $smarty->display('index.tpl'); + ?> + + + +`index.tpl` source: + + + {$Contacts.fax}<br /> + {$Contacts.email}<br /> + {* you can print arrays of arrays as well *} + {$Contacts.phone.home}<br /> + {$Contacts.phone.cell}<br /> + + + +this will output: + + + 555-222-9876<br /> + zaphod@slartibartfast.example.com<br /> + 555-444-3333<br /> + 555-111-1234<br /> + + + +Array indexes {#language.variables.array.indexes} +------------- + +You can reference arrays by their index, much like native PHP syntax. + + + <?php + $smarty->assign('Contacts', array( + '555-222-9876', + 'zaphod@slartibartfast.example.com', + array('555-444-3333', + '555-111-1234') + )); + $smarty->display('index.tpl'); + ?> + + + +`index.tpl` source: + + + {$Contacts[0]}<br /> + {$Contacts[1]}<br /> + {* you can print arrays of arrays as well *} + {$Contacts[2][0]}<br /> + {$Contacts[2][1]}<br /> + + + +This will output: + + + 555-222-9876<br /> + zaphod@slartibartfast.example.com<br /> + 555-444-3333<br /> + 555-111-1234<br /> + + + +Objects {#language.variables.objects} +------- + +Properties of [objects](#advanced.features.objects) assigned from PHP +can be referenced by specifying the property name after the `->` symbol. + + + name: {$person->name}<br /> + email: {$person->email}<br /> + + + +this will output: + + + name: Zaphod Beeblebrox<br /> + email: zaphod@slartibartfast.example.com<br /> + + diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-config-variables.md b/vendor/smarty/smarty/docs/designers/language-variables/language-config-variables.md new file mode 100644 index 000000000..a3683d99b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-config-variables.md @@ -0,0 +1,83 @@ +Variables loaded from config files {#language.config.variables} +================================== + +Variables that are loaded from the [config files](#config.files) are +referenced by enclosing them within `#hash_marks#`, or with the smarty +variable [`$smarty.config`](#language.variables.smarty.config). The +later syntax is useful for embedding into quoted attribute values, or +accessing variable values such as \$smarty.config.\$foo. + +Example config file - `foo.conf`: + + + pageTitle = "This is mine" + bodyBgColor = '#eeeeee' + tableBorderSize = 3 + tableBgColor = "#bbbbbb" + rowBgColor = "#cccccc" + + + +A template demonstrating the `#hash#` method: + + + {config_load file='foo.conf'} + <html> + <title>{#pageTitle#}</title> + <body bgcolor="{#bodyBgColor#}"> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +A template demonstrating the +[`$smarty.config`](#language.variables.smarty.config) method: + + + {config_load file='foo.conf'} + <html> + <title>{$smarty.config.pageTitle}</title> + <body bgcolor="{$smarty.config.bodyBgColor}"> + <table border="{$smarty.config.tableBorderSize}" bgcolor="{$smarty.config.tableBgColor}"> + <tr bgcolor="{$smarty.config.rowBgColor}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +Both examples would output: + + + <html> + <title>This is mine</title> + <body bgcolor="#eeeeee"> + <table border="3" bgcolor="#bbbbbb"> + <tr bgcolor="#cccccc"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> + </body> + </html> + + + +Config file variables cannot be used until after they are loaded in from +a config file. This procedure is explained later in this document under +[`{config_load}`](#language.function.config.load). + +See also [variables](#language.syntax.variables) and [\$smarty reserved +variables](#language.variables.smarty) diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-variable-scopes.md b/vendor/smarty/smarty/docs/designers/language-variables/language-variable-scopes.md new file mode 100644 index 000000000..2ba3f026b --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-variable-scopes.md @@ -0,0 +1,61 @@ +Variable scopes {#language.variable.scopes} +=============== + +You have the choice to assign variables to the scope of the main Smarty +object, data objects created with [`createData()`](#api.create.data), +and template objects created with +[`createTemplate()`](#api.create.template). These objects can be +chained. A template sees all the variables of its own object and all +variables assigned to the objects in its chain of parent objects. + +By default templates which are rendered by +[`$smarty->display(...)`](#api.display) or +[`$smarty->fetch(...)`](#api.fetch) calls are automatically linked to +the Smarty object variable scope. + +By assigning variables to individual data or template objects you have +full control which variables can be seen by a template. + + + + // assign variable to Smarty object scope + $smarty->assign('foo','smarty'); + + // assign variables to data object scope + $data = $smarty->createData(); + $data->assign('foo','data'); + $data->assign('bar','bar-data'); + + // assign variables to other data object scope + $data2 = $smarty->createData($data); + $data2->assign('bar','bar-data2'); + + // assign variable to template object scope + $tpl = $smarty->createTemplate('index.tpl'); + $tpl->assign('bar','bar-template'); + + // assign variable to template object scope with link to Smarty object + $tpl2 = $smarty->createTemplate('index.tpl',$smarty); + $tpl2->assign('bar','bar-template2'); + + // This display() does see $foo='smarty' from the $smarty object + $smarty->display('index.tpl'); + + // This display() does see $foo='data' and $bar='bar-data' from the data object $data + $smarty->display('index.tpl',$data); + + // This display() does see $foo='data' from the data object $data + // and $bar='bar-data2' from the data object $data2 + $smarty->display('index.tpl',$data2); + + // This display() does see $bar='bar-template' from the template object $tpl + $tpl->display(); // or $smarty->display($tpl); + + // This display() does see $bar='bar-template2' from the template object $tpl2 + // and $foo='smarty' form the Smarty object $foo + $tpl2->display(); // or $smarty->display($tpl2); + + + +See also [`assign()`](#api.assign), [`createData()`](#api.create.data) +and [`createTemplate()`](#api.create.template). diff --git a/vendor/smarty/smarty/docs/designers/language-variables/language-variables-smarty.md b/vendor/smarty/smarty/docs/designers/language-variables/language-variables-smarty.md new file mode 100644 index 000000000..f9aa2330a --- /dev/null +++ b/vendor/smarty/smarty/docs/designers/language-variables/language-variables-smarty.md @@ -0,0 +1,176 @@ +{\$smarty} reserved variable {#language.variables.smarty} +============================ + +The PHP reserved `{$smarty}` variable can be used to access several +environment and request variables. The full list of them follows. + +Request variables {#language.variables.smarty.request} +----------------- + +The [request variables](&url.php-manual;reserved.variables) such as +`$_GET`, `$_POST`, `$_COOKIE`, `$_SERVER`, `$_ENV` and `$_SESSION` can +be accessed as demonstrated in the examples below: + + + {* display value of page from URL ($_GET) http://www.example.com/index.php?page=foo *} + {$smarty.get.page} + + {* display the variable "page" from a form ($_POST['page']) *} + {$smarty.post.page} + + {* display the value of the cookie "username" ($_COOKIE['username']) *} + {$smarty.cookies.username} + + {* display the server variable "SERVER_NAME" ($_SERVER['SERVER_NAME'])*} + {$smarty.server.SERVER_NAME} + + {* display the system environment variable "PATH" *} + {$smarty.env.PATH} + + {* display the php session variable "id" ($_SESSION['id']) *} + {$smarty.session.id} + + {* display the variable "username" from merged get/post/cookies/server/env *} + {$smarty.request.username} + + + +> **Note** +> +> For historical reasons `{$SCRIPT_NAME}` is short-hand for +> `{$smarty.server.SCRIPT_NAME}`. +> +> +> <a href="{$SCRIPT_NAME}?page=smarty">click me</a> +> <a href="{$smarty.server.SCRIPT_NAME}?page=smarty">click me</a> + +> **Note** +> +> Although Smarty provides direct access to PHP super globals for +> convenience, it should be used with caution. Directly accessing super +> globals mixes underlying application code structure with templates. A +> good practice is to assign specific needed values to template vars. + +{\$smarty.now} {#language.variables.smarty.now} +-------------- + +The current [timestamp](&url.php-manual;function.time) can be accessed +with `{$smarty.now}`. The value reflects the number of seconds passed +since the so-called Epoch on January 1, 1970, and can be passed directly +to the [`date_format`](#language.modifier.date.format) modifier for +display. Note that [`time()`](&url.php-manual;function.time) is called +on each invocation; eg a script that takes three seconds to execute with +a call to `$smarty.now` at start and end will show the three second +difference. + +::: {.informalexample} + + {* use the date_format modifier to show current date and time *} + {$smarty.now|date_format:'%Y-%m-%d %H:%M:%S'} + + +::: + +{\$smarty.const} {#language.variables.smarty.const} +---------------- + +You can access PHP constant values directly. See also [smarty +constants](#smarty.constants). + +::: {.informalexample} + + <?php + // the constant defined in php + define('MY_CONST_VAL','CHERRIES'); + ?> +::: + +Output the constant in a template with + +::: {.informalexample} + + {$smarty.const.MY_CONST_VAL} +::: + +> **Note** +> +> Although Smarty provides direct access to PHP constants for +> convenience, it is typically avoided as this is mixing underlying +> application code structure into the templates. A good practice is to +> assign specific needed values to template vars. + +{\$smarty.capture} {#language.variables.smarty.capture} +------------------ + +Template output captured via the built-in +[`{capture}..{/capture}`](#language.function.capture) function can be +accessed using the `{$smarty.capture}` variable. See the +[`{capture}`](#language.function.capture) page for more information. + +{\$smarty.config} {#language.variables.smarty.config} +----------------- + +`{$smarty.config}` variable can be used to refer to loaded [config +variables](#language.config.variables). `{$smarty.config.foo}` is a +synonym for `{#foo#}`. See the +[{config\_load}](#language.function.config.load) page for more info. + +{\$smarty.section} {#language.variables.smarty.loops} +------------------ + +The `{$smarty.section}` variables can be used to refer to +[`{section}`](#language.function.section) loop properties. These have +some very useful values such as `.first`, `.index`, etc. + +> **Note** +> +> The `{$smarty.foreach}` variable is no longer used with the new +> [`{foreach}`](#language.function.foreach) syntax, but is still +> supported with Smarty 2.x style foreach syntax. + +{\$smarty.template} {#language.variables.smarty.template} +------------------- + +Returns the name of the current template being processed (without the +directory). + +{\$smarty.template\_object} {#language.variables.smarty.template_object} +--------------------------- + +Returns the template object of the current template being processed. + +{\$smarty.current\_dir} {#language.variables.smarty.current_dir} +----------------------- + +Returns the name of the directory for the current template being +processed. + +{\$smarty.version} {#language.variables.smarty.version} +------------------ + +Returns the version of Smarty the template was compiled with. + + + <div id="footer">Powered by Smarty {$smarty.version}</div> + +{\$smarty.block.child} {#language.variables.smarty.block.child} +---------------------- + +Returns block text from child template. See [Template +interitance](#advanced.features.template.inheritance). + +{\$smarty.block.parent} {#language.variables.smarty.block.parent} +----------------------- + +Returns block text from parent template. See [Template +interitance](#advanced.features.template.inheritance) + +{\$smarty.ldelim}, {\$smarty.rdelim} {#language.variables.smarty.ldelim} +------------------------------------ + +These variables are used for printing the left-delimiter and +right-delimiter value literally, the same as +[`{ldelim},{rdelim}`](#language.function.ldelim). + +See also [assigned variables](#language.assigned.variables) and [config +variables](#language.config.variables) diff --git a/vendor/smarty/smarty/docs/features.md b/vendor/smarty/smarty/docs/features.md new file mode 100644 index 000000000..8405b46eb --- /dev/null +++ b/vendor/smarty/smarty/docs/features.md @@ -0,0 +1,152 @@ +Features +======= + +Some of Smarty's features: +- It is extremely fast. +- It is efficient since the PHP parser does the dirty work. +- No template parsing overhead, only compiles once. +- It is smart about [recompiling](#variable.compile.check) only the + template files that have changed. +- You can easily create your own custom + [functions](#language.custom.functions) and [variable + modifiers](#language.modifiers), so the template language is + extremely extensible. +- Configurable template [{delimiter}](#variable.left.delimiter) tag + syntax, so you can use `{$foo}`, `{{$foo}}`, `<!--{$foo}-->`, etc. +- The [`{if}..{elseif}..{else}..{/if}`](#language.function.if) + constructs are passed to the PHP parser, so the `{if...}` expression + syntax can be as simple or as complex an evaluation as you like. +- Allows unlimited nesting of + [`sections`](#language.function.section), `if's` etc. +- Built-in [caching](#caching) support +- Arbitrary [template](#resources) sources +- [Template Inheritance](#advanced.features.template.inheritance) for + easy management of template content. +- [Plugin](#plugins) architecture + +## Separation of presentation from application code +- This means templates can certainly contain logic under the condition + that it is for presentation only. Things such as + [including](./designers/language-builtin-functions/language-function-include.md) other templates, + [alternating](./designers/language-custom-functions/language-function-cycle.md) table row colors, + [upper-casing](./designers/language-modifiers/language-modifier-upper.md) a variable, + [looping](./designers/language-builtin-functions/language-function-foreach.md) over an array of data and + rendering it are examples of presentation logic. +- This does not mean however that Smarty forces a separation of + business and presentation logic. Smarty has no knowledge of which is + which, so placing business logic in the template is your own doing. +- Also, if you desire *no* logic in your templates you certainly can + do so by boiling the content down to text and variables only. + +## How does it work? + +Under the hood, Smarty "compiles" (basically copies and converts) the +templates into PHP scripts. This happens once when each template is +first invoked, and then the compiled versions are used from that point +forward. Smarty takes care of this for you, so the template designer +just edits the Smarty templates and never has to manage the compiled +versions. This approach keeps the templates easy to maintain, and yet +keeps execution times extremely fast since the compiled code is just +PHP. And of course, all PHP scripts take advantage of PHP op-code caches +such as APC. + +## Template Inheritance + +Template inheritance was introduced in Smarty 3. Before template +inheritance, we managed our templates in +pieces such as header and footer templates. This organization lends +itself to many problems that require some hoop-jumping, such as managing +content within the header/footer on a per-page basis. With template +inheritance, instead of including other templates we maintain our +templates as single pages. We can then manipulate blocks of content +within by inheriting them. This makes templates intuitive, efficient and +easy to manage. See +[Template Inheritance](./programmers/advanced-features/advanced-features-template-inheritance.md) +for more info. + +## Why not use XML/XSLT syntax? +There are a couple of good reasons. First, Smarty can be used for more +than just XML/HTML based templates, such as generating emails, +javascript, CSV, and PDF documents. Second, XML/XSLT syntax is even more +verbose and fragile than PHP code! It is perfect for computers, but +horrible for humans. Smarty is about being easy to read, understand and +maintain. + +## Template Security +Although Smarty insulates you from PHP, you still have the option to use +it in certain ways if you wish. Template security forces the restriction +of PHP (and select Smarty functions.) This is useful if you have third +parties editing templates, and you don't want to unleash the full power +of PHP or Smarty to them. + +## Integration +Sometimes Smarty gets compared to Model-View-Controller (MVC) +frameworks. Smarty is not an MVC, it is just the presentation layer, +much like the View (V) part of an MVC. As a matter of fact, Smarty can +easily be integrated as the view layer of an MVC. Many of the more +popular ones have integration instructions for Smarty, or you may find +some help here in the forums and documentation. + +## Other Template Engines +Smarty is not the only engine following the *"Separate Programming Code +from Presentation"* philosophy. For instance, Python has template +engines built around the same principles such as Django Templates and +CheetahTemplate. *Note: Languages such as Python do not mix with HTML +natively, which give them the advantage of proper programming code +separation from the outset. There are libraries available to mix Python +with HTML, but they are typically avoided.* + +## What Smarty is Not + +Smarty is not an application development framework. Smarty is not an +MVC. Smarty is not an alternative to Laravel, Symfony, CodeIgniter, +or any of the other application development frameworks for PHP. + +Smarty is a template engine, and works as the (V)iew component of your +application. Smarty can easily be coupled to any of the engines listed +above as the view component. No different than any other software, +Smarty has a learning curve. Smarty does not guarantee good application +design or proper separation of presentation, this still needs to be +addressed by a competent developer and web designer. + +## Is Smarty Right for Me? + +Smarty is not meant to be a tool for every job. The important thing is +to identify if Smarty fits your needs. There are some important +questions to ask yourself: + +### Template Syntax +Are you content with PHP tags mixed with HTML? Are your +web designers comfortable with PHP? Would your web designers prefer a +tag-based syntax designed for presentation? Some experience working with +both Smarty and PHP helps answer these questions. + +### The Business Case +Is there a requirement to insulate the templates from +PHP? Do you have untrusted parties editing templates that you do not +wish to unleash the power of PHP to? Do you need to programmatically +control what is and is not available within the templates? Smarty +supplies these capabilities by design. + +## Feature set +Does Smarty's features such as caching, template +inheritance and plugin architecture save development cycles writing code +that would be needed otherwise? Does the codebase or framework you plan +on using have the features you need for the presentation component? + +## Sites using Smarty +Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, Tiki +CMS/Groupware and X-Cart to name a few. + +## Summary +Whether you are using Smarty for a small website or massive enterprise +solution, it can accommodate your needs. There are numerous features +that make Smarty a great choice: + +- separation of PHP from HTML/CSS just makes sense +- readability for organization and management +- security for 3rd party template access +- feature completeness, and easily extendable to your own needs +- massive user base, Smarty is here to stay +- LGPL license for commercial use +- 100% free to use, open source project diff --git a/vendor/smarty/smarty/docs/getting-started.md b/vendor/smarty/smarty/docs/getting-started.md new file mode 100644 index 000000000..de55ffe8e --- /dev/null +++ b/vendor/smarty/smarty/docs/getting-started.md @@ -0,0 +1,169 @@ +What is Smarty? +============== + +## Requirements +Smarty can be run with PHP 7.1 to PHP 8.1. + +## Installation +Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/). + +To get the latest stable version of Smarty use: +```bash +composer require smarty/smarty +```` + +To get the latest, unreleased version, use: +```bash +composer require smarty/smarty:dev-master +```` + +To get the previous stable version of Smarty, Smarty 3, use: +```bash +composer require smarty/smarty:^3 +```` + +Here's how you create an instance of Smarty in your PHP scripts: +```php +<?php + +require 'vendor/autoload.php'; +$smarty = new Smarty(); +``` + +Now that the library files are in place, it's time to setup the Smarty +directories for your application. + +Smarty requires four directories which are by default named + [`templates`](./programmers/api-variables/variable-template-dir.md), + [`configs`](./programmers/api-variables/variable-config-dir.md), + [`templates_c`](./programmers/api-variables/variable-compile-dir.md) + and + [`cache`](./programmers/api-variables/variable-cache-dir.md) + relative to the current working directory. + +The defaults can be changed as follows: +```php +$smarty = new Smarty(); +$smarty->setTemplateDir('/some/template/dir'); +$smarty->setConfigDir('/some/config/dir'); +$smarty->setCompileDir('/some/compile/dir'); +$smarty->setCacheDir('/some/cache/dir'); +``` + +The compile dir and cache dir need to be writable for the user running the PHP script. + +> **Note** +> +> This is usually user "nobody" and group "nobody". For OS X users, the +> default is user "www" and group "www". If you are using Apache, you +> can look in your `httpd.conf` file to see what user and group are +> being used. + +```bash +chown nobody:nobody /web/www.example.com/guestbook/templates_c/ +chmod 770 /web/www.example.com/guestbook/templates_c/ + +chown nobody:nobody /web/www.example.com/guestbook/cache/ +chmod 770 /web/www.example.com/guestbook/cache/ +``` + +You can verify if your system has the correct access rights for + these directories with [`testInstall()`](./programmers/api-functions/api-test-install.md): + +```php +$smarty = new Smarty(); +$smarty->setTemplateDir('/some/template/dir'); +$smarty->setConfigDir('/some/config/dir'); +$smarty->setCompileDir('/some/compile/dir'); +$smarty->setCacheDir('/some/cache/dir'); +$smarty->testInstall(); +``` + +Now, let's create the `index.tpl` file that Smarty will display. This +needs to be located in the [`$template_dir`](./programmers/api-variables/variable-template-dir.md). + +```html +{* Smarty *} +Hello {$name}, welcome to Smarty! +``` + +> **Note** +> +> `{* Smarty *}` is a template [comment](./designers/language-basic-syntax/language-syntax-comments.md). It +> is not required, but it is good practice to start all your template +> files with this comment. It makes the file easy to recognize +> regardless of the file extension. For example, text editors could +> recognize the file and turn on special syntax highlighting. + +Now lets edit our php file. We'll create an instance of Smarty, +[`assign()`](./programmers/api-functions/api-assign.md) a template variable and +[`display()`](./programmers/api-functions/api-display.md) the `index.tpl` file. + +```php +<?php + +require 'vendor/autoload.php'; + +$smarty = new Smarty(); + +$smarty->setTemplateDir('/web/www.example.com/guestbook/templates/'); +$smarty->setCompileDir('/web/www.example.com/guestbook/templates_c/'); +$smarty->setConfigDir('/web/www.example.com/guestbook/configs/'); +$smarty->setCacheDir('/web/www.example.com/guestbook/cache/'); + +$smarty->assign('name', 'Ned'); +$smarty->display('index.tpl'); + +``` + +> **Note** +> +> In our example, we are setting absolute paths to all of the Smarty +> directories. If `/web/www.example.com/guestbook/` is within your PHP +> include\_path, then these settings are not necessary. However, it is +> more efficient and (from experience) less error-prone to set them to +> absolute paths. This ensures that Smarty is getting files from the +> directories you intended. + +Now, run your PHP file. You should see *\"Hello Ned, welcome to Smarty!\"* + +You have completed the basic setup for Smarty! + +## Extended Setup {#installing.smarty.extended} +============== + +This is a continuation of the [basic +installation](#installing.smarty.basic), please read that first! + +A slightly more flexible way to setup Smarty is to extend the Smarty +class and initialize your Smarty +environment. So instead of repeatedly setting directory paths, assigning +the same vars, etc., we can do that in one place. + +```php +<?php + +class Smarty_GuestBook extends Smarty { + + public function __construct() + { + parent::__construct(); + + $this->setTemplateDir('/web/www.example.com/guestbook/templates/'); + $this->setCompileDir('/web/www.example.com/guestbook/templates_c/'); + $this->setConfigDir('/web/www.example.com/guestbook/configs/'); + $this->setCacheDir('/web/www.example.com/guestbook/cache/'); + + $this->caching = Smarty::CACHING_LIFETIME_CURRENT; + $this->assign('app_name', 'Guest Book'); + } + +} +``` + +Now, we can use `Smarty_GuestBook` instead of `Smarty` in our scripts: +```php +$smarty = new Smarty_GuestBook(); +$smarty->assign('name','Ned'); +$smarty->display('index.tpl'); +``` diff --git a/vendor/smarty/smarty/docs/index.md b/vendor/smarty/smarty/docs/index.md new file mode 100644 index 000000000..cf2b2ddcd --- /dev/null +++ b/vendor/smarty/smarty/docs/index.md @@ -0,0 +1,50 @@ +# Smarty 4 Documentation +Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic. + +It allows you to write **templates**, using **variables**, **modifiers**, **functions** and **comments**, like this: +```html +<h1>{$title|escape}</h1> + +<p> + The number of pixels is: {math equation="x * y" x=$height y=$width}. +</p> +``` + +When this template is rendered, with the value "Hello world" for the variable $title, 640 for $width, +and 480 for $height, the result is: +```html +<h1>Hello world</h1> + +<p> + The number of pixels is: 307200. +</p> +``` + +## Introduction +- [Philosophy](./philosophy.md) - or "Why do I need a template engine?" +- [Features](./features.md) - or "Why do I want Smarty?" +- [Getting Started](./getting-started.md) + +## Smarty for template designers +- [Basic Syntax](./designers/language-basic-syntax.md) +- [Variables](./designers/language-variables.md) +- [Variable Modifiers](./designers/language-modifiers.md) +- [Combining Modifiers](./designers/language-combining-modifiers.md) +- [Built-in Functions](./designers/language-builtin-functions.md) +- [Custom Functions](./designers/language-custom-functions.md) +- [Config Files](./designers/config-files.md) +- [Debugging Console](./designers/chapter-debugging-console.md) + +## Smarty for php developers +- [Charset Encoding](./programmers/charset.md) +- [Constants](./programmers/smarty-constants.md) +- [Smarty Class Variables](./programmers/api-variables.md) +- [Smarty Class Methods](./programmers/api-functions.md) +- [Caching](./programmers/caching.md) +- [Resources](./programmers/resources.md) +- [Advanced Features](./programmers/advanced-features.md) +- [Extending Smarty With Plugins](./programmers/plugins.md) + +## Other +- [Some random tips & tricks](./appendixes/tips.md) +- [Troubleshooting](./appendixes/troubleshooting.md) diff --git a/vendor/smarty/smarty/docs/philosophy.md b/vendor/smarty/smarty/docs/philosophy.md new file mode 100644 index 000000000..86f6c46ed --- /dev/null +++ b/vendor/smarty/smarty/docs/philosophy.md @@ -0,0 +1,108 @@ +Philosophy +======= + +## What is Smarty? + +Smarty is a template engine for PHP. More specifically, it facilitates a +manageable way to separate application logic and content from its +presentation. This is best described in a situation where the +application programmer and the template designer play different roles, +or in most cases are not the same person. + +For example, let\'s say you are creating a web page that is displaying a +newspaper article. + +- The article `$headline`, `$tagline`, `$author` and `$body` are + content elements, they contain no information about how they will be + presented. They are [passed](#api.assign) into Smarty by the + application. + +- Then the template designer edits the templates and uses a + combination of HTML tags and [template tags](#language.basic.syntax) + to format the presentation of these + [variables](#language.syntax.variables) with elements such as + tables, div\'s, background colors, font sizes, style sheets, svg + etc. + +- One day the programmer needs to change the way the article content + is retrieved, ie a change in application logic. This change does not + affect the template designer, the content will still arrive in the + template exactly the same. + +- Likewise, if the template designer wants to completely redesign the + templates, this would require no change to the application logic. + +- Therefore, the programmer can make changes to the application logic + without the need to restructure templates, and the template designer + can make changes to templates without breaking application logic. + +## Goals + +The Smarty design was largely driven by these goals: +- clean separation of presentation from application code +- PHP backend, Smarty template frontend +- complement PHP, not replace it +- fast development/deployment for programmers and designers +- quick and easy to maintain +- syntax easy to understand, no PHP knowledge necessary +- flexibility for custom development +- security: insulation from PHP +- free, open source + + + +## Two camps of thought + +When it comes to templating in PHP, there are basically two camps of +thought. The first camp exclaims that \"PHP is a template engine\". This +approach simply mixes PHP code with HTML. Although this approach is +fastest from a pure script-execution point of view, many would argue +that the PHP syntax is messy and complicated when mixed with tagged +markup such as HTML. + +The second camp exclaims that presentation should be void of all +programming code, and instead use simple tags to indicate where +application content is revealed. This approach is common with other +template engines (even in other programming languages), and is also the +approach that Smarty takes. The idea is to keep the templates focused +squarely on presentation, void of application code, and with as little +overhead as possible. + +## Why is separating PHP from templates important? + +Two major benefits: + +- SYNTAX: Templates typically consist of semantic markup such as HTML. + PHP syntax works well for application code, but quickly degenerates + when mixed with HTML. Smarty\'s simple {tag} syntax is designed + specifically to express presentation. Smarty focuses your templates + on presentation and less on \"code\". This lends to quicker template + deployment and easier maintenance. Smarty syntax requires no working + knowledge of PHP, and is intuitive for programmers and + non-programmers alike. + +- INSULATION: When PHP is mixed with templates, there are no + restrictions on what type of logic can be injected into a template. + Smarty insulates the templates from PHP, creating a controlled + separation of presentation from business logic. Smarty also has + security features that can further enforce restrictions on + templates. + +## Web designers and PHP + +A common question: "Web designers have to learn a syntax anyway, why +not PHP?" Of course web designers can learn PHP, and they may already +be familiar with it. The issue isn't their ability to learn PHP, it is +about the consequences of mixing PHP with HTML. If designers use PHP, it +is too easy to add code into templates that doesn't belong there (you +just handed them a swiss-army knife when they just needed a knife.) You +can teach them the rules of application design, but this is probably +something they don't really need to learn (now they are developers!) +The PHP manual is also an overwhelming pile of information to sift +through. It is like handing the owner of a car the factory assembly +manual when all they need is the owners manual. Smarty gives web +designers exactly the tools they need, and gives developers fine-grained +control over those tools. The simplicity of the tag-based syntax is also +a huge welcome for designers, it helps them streamline the organization +and management of templates. + diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features.md b/vendor/smarty/smarty/docs/programmers/advanced-features.md new file mode 100644 index 000000000..60d4416b5 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features.md @@ -0,0 +1,14 @@ +Advanced Features {#advanced.features} +================= + +## Table of contents + +- [Security](./advanced-features/advanced-features-security.md) +- [Changing settings by template](./advanced-features/advanced-features-template-settings.md) +- [Template Inheritance](./advanced-features/advanced-features-template-inheritance.md) +- [Streams](./advanced-features/advanced-features-streams.md) +- [Objects](./advanced-features/advanced-features-objects.md) +- [Static Classes](./advanced-features/advanced-features-static-classes.md) +- [Prefilters](./advanced-features/advanced-features-prefilters.md) +- [Postfilters](./advanced-features/advanced-features-postfilters.md) +- [Output Filters](./advanced-features/advanced-features-outputfilters.md) diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-objects.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-objects.md new file mode 100644 index 000000000..6b4870b51 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-objects.md @@ -0,0 +1,99 @@ +Objects {#advanced.features.objects} +======= + +Smarty allows access to PHP [objects](&url.php-manual;object) through +the templates. + +> **Note** +> +> When you assign/register objects to templates, be sure that all +> properties and methods accessed from the template are for presentation +> purposes only. It is very easy to inject application logic through +> objects, and this leads to poor designs that are difficult to manage. +> See the Best Practices section of the Smarty website. + +There are two ways to access them. + +- One way is to [register objects](#api.register.object) to the + template, then use access them via syntax similar to [custom + functions](#language.custom.functions). + +- The other way is to [`assign()`](#api.assign) objects to the + templates and access them much like any other assigned variable. + +The first method has a much nicer template syntax. It is also more +secure, as a registered object can be restricted to certain methods or +properties. However, **a registered object cannot be looped over or +assigned in arrays of objects**, etc. The method you choose will be +determined by your needs, but use the first method whenever possible to +keep template syntax to a minimum. + +If security is enabled, no private methods or functions can be accessed +(beginningwith \'\_\'). If a method and property of the same name exist, +the method will be used. + +You can restrict the methods and properties that can be accessed by +listing them in an array as the third registration parameter. + +By default, parameters passed to objects through the templates are +passed the same way [custom functions](#language.custom.functions) get +them. An associative array is passed as the first parameter, and the +smarty object as the second. If you want the parameters passed one at a +time for each argument like traditional object parameter passing, set +the fourth registration parameter to FALSE. + +The optional fifth parameter has only effect with `format` being TRUE +and contains a list of methods that should be treated as blocks. That +means these methods have a closing tag in the template +(`{foobar->meth2}...{/foobar->meth2}`) and the parameters to the methods +have the same synopsis as the parameters for +[`block-function-plugins`](#plugins.block.functions): They get the four +parameters `$params`, `$content`, `$smarty` and `&$repeat` and they also +behave like block-function-plugins. + + + <?php + // the object + + class My_Object { + function meth1($params, $smarty_obj) { + return 'this is my meth1'; + } + } + + $myobj = new My_Object; + + // registering the object (will be by reference) + $smarty->registerObject('foobar',$myobj); + + // if we want to restrict access to certain methods or properties, list them + $smarty->registerObject('foobar',$myobj,array('meth1','meth2','prop1')); + + // if you want to use the traditional object parameter format, pass a boolean of false + $smarty->registerObject('foobar',$myobj,null,false); + + // We can also assign objects. assign_by_ref when possible. + $smarty->assign_by_ref('myobj', $myobj); + + $smarty->display('index.tpl'); + ?> + + + +And here\'s how to access your objects in `index.tpl`: + + + {* access our registered object *} + {foobar->meth1 p1='foo' p2=$bar} + + {* you can also assign the output *} + {foobar->meth1 p1='foo' p2=$bar assign='output'} + the output was {$output} + + {* access our assigned object *} + {$myobj->meth1('foo',$bar)} + + + +See also [`registerObject()`](#api.register.object) and +[`assign()`](#api.assign). diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-outputfilters.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-outputfilters.md new file mode 100644 index 000000000..393d7da23 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-outputfilters.md @@ -0,0 +1,43 @@ +Output Filters {#advanced.features.outputfilters} +============== + +When the template is invoked via [`display()`](#api.display) or +[`fetch()`](#api.fetch), its output can be sent through one or more +output filters. This differs from +[`postfilters`](#advanced.features.postfilters) because postfilters +operate on compiled templates before they are saved to the disk, whereas +output filters operate on the template output when it is executed. + +Output filters can be either [registered](#api.register.filter) or +loaded from the [plugins directory](#variable.plugins.dir) by using the +[`loadFilter()`](#api.load.filter) method or by setting the +[`$autoload_filters`](#variable.autoload.filters) variable. Smarty will +pass the template output as the first argument, and expect the function +to return the result of the processing. + + + <?php + // put this in your application + function protect_email($tpl_output, Smarty_Internal_Template $template) + { + $tpl_output = + preg_replace('!(\S+)@([a-zA-Z0-9\.\-]+\.([a-zA-Z]{2,3}|[0-9]{1,3}))!', + '$1%40$2', $tpl_output); + return $tpl_output; + } + + // register the outputfilter + $smarty->registerFilter("output","protect_email"); + $smarty->display("index.tpl'); + + // now any occurrence of an email address in the template output will have + // a simple protection against spambots + ?> + + + +See also [`registerFilter()`](#api.register.filter), +[`loadFilter()`](#api.load.filter), +[`$autoload_filters`](#variable.autoload.filters), +[postfilters](#advanced.features.postfilters) and +[`$plugins_dir`](#variable.plugins.dir). diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-postfilters.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-postfilters.md new file mode 100644 index 000000000..d3bad546a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-postfilters.md @@ -0,0 +1,40 @@ +Postfilters {#advanced.features.postfilters} +=========== + +Template postfilters are PHP functions that your templates are ran +through *after they are compiled*. Postfilters can be either +[registered](#api.register.filter) or loaded from the [plugins +directory](#variable.plugins.dir) by using the +[`loadFilter()`](#api.load.filter) function or by setting the +[`$autoload_filters`](#variable.autoload.filters) variable. Smarty will +pass the compiled template code as the first argument, and expect the +function to return the result of the processing. + + + <?php + // put this in your application + function add_header_comment($tpl_source, Smarty_Internal_Template $template) + { + return "<?php echo \"<!-- Created by Smarty! -->\n\"; ?>\n".$tpl_source; + } + + // register the postfilter + $smarty->registerFilter('post','add_header_comment'); + $smarty->display('index.tpl'); + ?> + + + +The postfilter above will make the compiled Smarty template `index.tpl` +look like: + + + <!-- Created by Smarty! --> + {* rest of template content... *} + + + +See also [`registerFilter()`](#api.register.filter), +[prefilters](#advanced.features.prefilters), +[outputfilters](#advanced.features.outputfilters), and +[`loadFilter()`](#api.load.filter). diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-prefilters.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-prefilters.md new file mode 100644 index 000000000..76229e633 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-prefilters.md @@ -0,0 +1,36 @@ +Prefilters {#advanced.features.prefilters} +========== + +Template prefilters are PHP functions that your templates are ran +through *before they are compiled*. This is good for preprocessing your +templates to remove unwanted comments, keeping an eye on what people are +putting in their templates, etc. + +Prefilters can be either [registered](#api.register.filter) or loaded +from the [plugins directory](#variable.plugins.dir) by using +[`loadFilter()`](#api.load.filter) function or by setting the +[`$autoload_filters`](#variable.autoload.filters) variable. + +Smarty will pass the template source code as the first argument, and +expect the function to return the resulting template source code. + +This will remove all the html comments in the template source. + + + <?php + // put this in your application + function remove_dw_comments($tpl_source, Smarty_Internal_Template $template) + { + return preg_replace("/<!--#.*-->/U",'',$tpl_source); + } + + // register the prefilter + $smarty->registerFilter('pre','remove_dw_comments'); + $smarty->display('index.tpl'); + ?> + + + +See also [`registerFilter()`](#api.register.filter), +[postfilters](#advanced.features.postfilters) and +[`loadFilter()`](#api.load.filter). diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-security.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-security.md new file mode 100644 index 000000000..98817a433 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-security.md @@ -0,0 +1,168 @@ +Security {#advanced.features.security} +======== + +Security is good for situations when you have untrusted parties editing +the templates eg via ftp, and you want to reduce the risk of system +security compromises through the template language. + +The settings of the security policy are defined by properties of an +instance of the Smarty\_Security class. These are the possible settings: + +- `$php_handling` determines how Smarty to handle PHP code embedded in + templates. Possible values are: + + - Smarty::PHP\_PASSTHRU -\> echo PHP tags as they are + + - Smarty::PHP\_QUOTE -\> escape tags as entities + + - Smarty::PHP\_REMOVE -\> remove php tags + + - Smarty::PHP\_ALLOW -\> execute php tags + + The default value is Smarty::PHP\_PASSTHRU. + + If security is enabled the [`$php_handling`](#variable.php.handling) + setting of the Smarty object is not checked for security. + +- `$secure_dir` is an array of template directories that are + considered secure. [`$template_dir`](#variable.template.dir) + concidered secure implicitly. The default is an empty array. + +- `$trusted_dir` is an array of all directories that are considered + trusted. Trusted directories are where you keep php scripts that are + executed directly from the templates with + [`{include_php}`](#language.function.include.php). The default is an + empty array. + +- `$trusted_uri` is an array of regular expressions matching URIs that + are considered trusted. This security directive used by + [`{fetch}`](#language.function.fetch) and + [`{html_image}`](#language.function.html.image). URIs passed to + these functions are reduced to `{$PROTOCOL}://{$HOSTNAME}` to allow + simple regular expressions (without having to deal with edge cases + like authentication-tokens). + + The expression `'#https?://.*smarty.net$#i'` would allow accessing + the follwing URIs: + + - `http://smarty.net/foo` + + - `http://smarty.net/foo` + + - `http://www.smarty.net/foo` + + - `http://smarty.net/foo` + + - `https://foo.bar.www.smarty.net/foo/bla?blubb=1` + + but deny access to these URIs: + + - `http://smarty.com/foo` (not matching top-level domain \"com\") + + - `ftp://www.smarty.net/foo` (not matching protocol \"ftp\") + + - `http://www.smarty.net.otherdomain.com/foo` (not matching end of + domain \"smarty.net\") + +- `$static_classes` is an array of classes that are considered + trusted. The default is an empty array which allows access to all + static classes. To disable access to all static classes set + \$static\_classes = null. + +- `$php_functions` is an array of PHP functions that are considered + trusted and can be used from within template. To disable access to + all PHP functions set \$php\_functions = null. An empty array ( + \$php\_functions = array() ) will allow all PHP functions. The + default is array(\'isset\', \'empty\', \'count\', \'sizeof\', + \'in\_array\', \'is\_array\',\'time\',\'nl2br\'). + +- `$php_modifiers` is an array of PHP functions that are considered + trusted and can be used from within template as modifier. To disable + access to all PHP modifier set \$php\_modifier = null. An empty + array ( \$php\_modifier = array() ) will allow all PHP functions. + The default is array(\'escape\',\'count\'). + +- `$streams` is an array of streams that are considered trusted and + can be used from within template. To disable access to all streams + set \$streams = null. An empty array ( \$streams = array() ) will + allow all streams. The default is array(\'file\'). + +- `$allowed_modifiers` is an array of (registered / autoloaded) + modifiers that should be accessible to the template. If this array + is non-empty, only the herein listed modifiers may be used. This is + a whitelist. + +- `$disabled_modifiers` is an array of (registered / autoloaded) + modifiers that may not be accessible to the template. + +- `$allowed_tags` is a boolean flag which controls if constants can + function-, block and filter plugins that should be accessible to the + template. If this array is non-empty, only the herein listed + modifiers may be used. This is a whitelist. + +- `$disabled_tags` is an array of (registered / autoloaded) function-, + block and filter plugins that may not be accessible to the template. + +- `$allow_constants` is a boolean flag which controls if constants can + be accessed by the template. The default is \"true\". + +- `$allow_super_globals` is a boolean flag which controls if the PHP + super globals can be accessed by the template. The default is + \"true\". + +- `$allow_php_tag` is a boolean flag which controls if {php} and + {include\_php} tags can be used by the template. The default is + \"false\". + +If security is enabled, no private methods, functions or properties of +static classes or assigned objects can be accessed (beginningwith +\'\_\') by the template. + +To customize the security policy settings you can extend the +Smarty\_Security class or create an instance of it. + + + <?php + require 'Smarty.class.php'; + + class My_Security_Policy extends Smarty_Security { + // disable all PHP functions + public $php_functions = null; + // remove PHP tags + public $php_handling = Smarty::PHP_REMOVE; + // allow everthing as modifier + public $php_modifiers = array(); + } + $smarty = new Smarty(); + // enable security + $smarty->enableSecurity('My_Security_Policy'); + ?> + + + <?php + require 'Smarty.class.php'; + $smarty = new Smarty(); + $my_security_policy = new Smarty_Security($smarty); + // disable all PHP functions + $my_security_policy->php_functions = null; + // remove PHP tags + $my_security_policy->php_handling = Smarty::PHP_REMOVE; + // allow everthing as modifier + $my_security_policy->php_modifiers = array(); + // enable security + $smarty->enableSecurity($my_security_policy); + ?> + + + <?php + require 'Smarty.class.php'; + $smarty = new Smarty(); + // enable default security + $smarty->enableSecurity(); + ?> + +> **Note** +> +> Most security policy settings are only checked when the template gets +> compiled. For that reasion you should delete all cached and compiled +> template files when you change your security settings. diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-static-classes.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-static-classes.md new file mode 100644 index 000000000..8ef79113c --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-static-classes.md @@ -0,0 +1,27 @@ +Static Classes {#advanced.features.static.classes} +============== + +You can directly access static classes. The syntax is the same as in +PHP. + +> **Note** +> +> Direct access to PHP classes is not recommended. This ties the +> underlying application code structure directly to the presentation, +> and also complicates template syntax. It is recommended to register +> plugins which insulate templates from PHP classes/objects. Use at your +> own discretion. See the Best Practices section of the Smarty website. + + + {assign var=foo value=myclass::BAR} <--- class constant BAR + + {assign var=foo value=myclass::method()} <--- method result + + {assign var=foo value=myclass::method1()->method2} <--- method chaining + + {assign var=foo value=myclass::$bar} <--- property bar of class myclass + + {assign var=foo value=$bar::method} <--- using Smarty variable bar as class name + + + diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-streams.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-streams.md new file mode 100644 index 000000000..d6f7a0de5 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-streams.md @@ -0,0 +1,15 @@ +Streams {#advanced.features.streams} +======= + +You can also use streams to call variables. *{\$foo:bar}* will use the +*foo://bar* stream to get the template variable. + +Using a PHP stream for a template variable resource from within a +template. + + + {$foo:bar} + + + +See also [`Template Resources`](#resources) diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-template-inheritance.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-template-inheritance.md new file mode 100644 index 000000000..25295c38d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-template-inheritance.md @@ -0,0 +1,128 @@ +Template Inheritance {#advanced.features.template.inheritance} +==================== + +Inheritance brings the concept of Object Oriented Programming to +templates, allowing you to define one (or more) base templates that can +be extended by child templates. Extending means that the child template +can override all or some of the parent named block areas. + +- The inheritance tree can be as deep as you want, meaning you can + extend a file that extends another one that extends another one and + so on. + +- The child templates can not define any content besides what\'s + inside [`{block}`](#language.function.block) tags they override. + Anything outside of [`{block}`](#language.function.block) tags will + be removed. + +- The content of [`{block}`](#language.function.block) tags from child + and parent templates can be merged by the `append` or `prepend` + [`{block}`](#language.function.block) tag option flags and + `{$smarty.block.parent}` or `{$smarty.block.child}` placeholders. + +- Template inheritance is a compile time process which creates a + single compiled template file. Compared to corresponding solutions + based on subtemplates included with the + [`{include}`](#language.function.include) tag it does have much + better performance when rendering. + +- The child template extends its parent defined with the + [`{extends}`](#language.function.extends) tag, which must be the + first line in the child template. Instead of using the + [`{extends}`](#language.function.extends) tags in the template files + you can define the whole template inheritance tree in the PHP script + when you are calling [`fetch()`](#api.fetch) or + [`display()`](#api.display) with the `extends:` template resource + type. The later provides even more flexibillity. + +> **Note** +> +> When `$compile_check` is enabled, all files in the inheritance tree +> are checked for modifications upon each invocation. You may want to +> disable `$compile_check` on production servers for this reason. + +> **Note** +> +> If you have a subtemplate which is included with +> [`{include}`](#language.function.include) and it contains +> [`{block}`](#language.function.block) areas it works only if the +> [`{include}`](#language.function.include) itself is called from within +> a surrounding [`{block}`](#language.function.block). In the final +> parent template you may need a dummy +> [`{block}`](#language.function.block) for it. + +layout.tpl (parent) + + + <html> + <head> + <title>{block name=title}Default Page Title{/block}</title> + {block name=head}{/block} + </head> + <body> + {block name=body}{/block} + </body> + </html> + + + +myproject.tpl (child) + + + {extends file='layout.tpl'} + {block name=head} + <link href="/css/mypage.css" rel="stylesheet" type="text/css"/> + <script src="/js/mypage.js"></script> + {/block} + + + + +mypage.tpl (grandchild) + + + {extends file='myproject.tpl'} + {block name=title}My Page Title{/block} + {block name=head} + <link href="/css/mypage.css" rel="stylesheet" type="text/css"/> + <script src="/js/mypage.js"></script> + {/block} + {block name=body}My HTML Page Body goes here{/block} + + + +To render the above use + + + $smarty->display('mypage.tpl'); + +The resulting output is + + + <html> + <head> + <title>My Page Title</title> + <link href="/css/mypage.css" rel="stylesheet" type="text/css"/> + <script src="/js/mypage.js"></script> + </head> + <body> + My HTML Page Body goes here + </body> + </html> + +Instead of using [`{extends}`](#language.function.extends) tags in the +template files you can define the inheritance tree in your PHP script by +using the [`extends:` resource](#resources.extends) type. + +The code below will return same result as the example above. + + + <?php + $smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); + ?> + + + +See also [`{block}`](#language.function.block), +[`{extends}`](#language.function.extends) and [`extends:` +resource](#resources.extends) diff --git a/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-template-settings.md b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-template-settings.md new file mode 100644 index 000000000..df1f86a8c --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/advanced-features/advanced-features-template-settings.md @@ -0,0 +1,32 @@ +Changing settings by template {#advanced.features.template.settings} +============================= + +Normally you configure the Smarty settings by modifying the +[`Smarty class variables`](#api.variables). Furthermore you can register +plugins, filters etc. with [`Smarty functions`](#api.functions). +Modifications done to the Smarty object will be global for all +templates. + +However the Smarty class variables and functions can be accessed or +called by induvidual template objects. Modification done to a template +object will apply only for that template and its included subtemplates. + + + <?php + $tpl = $smarty->createTemplate('index.tpl); + $tpl->cache_lifetime = 600; + //or + $tpl->setCacheLifetime(600); + $smarty->display($tpl); + ?> + + + + + <?php + $tpl = $smarty->createTemplate('index.tpl); + $tpl->registerPlugin('modifier','mymodifier'); + $smarty->display($tpl); + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-functions.md b/vendor/smarty/smarty/docs/programmers/api-functions.md new file mode 100644 index 000000000..6f120fa9a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions.md @@ -0,0 +1,64 @@ +Smarty Class Methods {#api.functions} +==================== + +## Table of contents + +- [addConfigDir()](./api-functions/api-add-config-dir.md) — add a directory to the list of directories where config files are stored +- [addPluginsDir()](./api-functions/api-add-plugins-dir.md) — add a directory to the list of directories where plugins are stored +- [addTemplateDir()](./api-functions/api-add-template-dir.md) — add a directory to the list of directories where templates are stored +- [append()](./api-functions/api-append.md) — append an element to an assigned array +- [appendByRef()](./api-functions/api-append-by-ref.md) — append values by reference +- [assign()](./api-functions/api-assign.md) — assign variables/objects to the templates +- [assignByRef()](./api-functions/api-assign-by-ref.md) — assign values by reference +- [clearAllAssign()](./api-functions/api-clear-all-assign.md) — clears the values of all assigned variables +- [clearAllCache()](./api-functions/api-clear-all-cache.md) — clears the entire template cache +- [clearAssign()](./api-functions/api-clear-assign.md) — clears the value of an assigned variable +- [clearCache()](./api-functions/api-clear-cache.md) — clears the cache for a specific template +- [clearCompiledTemplate()](./api-functions/api-clear-compiled-tpl.md) — clears the compiled version of the specified template resource +- [clearConfig()](./api-functions/api-clear-config.md) — clears assigned config variables +- [compileAllConfig()](./api-functions/api-compile-all-config.md) — compiles all known config files +- [compileAllTemplates()](./api-functions/api-compile-all-templates.md) — compiles all known templates +- [configLoad()](./api-functions/api-config-load.md) — loads config file data and assigns it to the template +- [createData()](./api-functions/api-create-data.md) — creates a data object +- [createTemplate()](./api-functions/api-create-template.md) — returns a template object +- [disableSecurity()](./api-functions/api-disable-security.md) — disables template security +- [display()](./api-functions/api-display.md) — displays the template +- [enableSecurity()](./api-functions/api-enable-security.md) — enables template security +- [fetch()](./api-functions/api-fetch.md) — returns the template output +- [getCacheDir()](./api-functions/api-get-cache-dir.md) — return the directory where the rendered template's output is stored +- [getCompileDir()](./api-functions/api-get-compile-dir.md) — returns the directory where compiled templates are stored +- [getConfigDir()](./api-functions/api-get-config-dir.md) — return the directory where config files are stored +- [getConfigVars()](./api-functions/api-get-config-vars.md) — returns the given loaded config variable value +- [getPluginsDir()](./api-functions/api-get-plugins-dir.md) — return the directory where plugins are stored +- [getRegisteredObject()](./api-functions/api-get-registered-object.md) — returns a reference to a registered object +- [getTags()](./api-functions/api-get-tags.md) — return tags used by template +- [getTemplateDir()](./api-functions/api-get-template-dir.md) — return the directory where templates are stored +- [getTemplateVars()](./api-functions/api-get-template-vars.md) — returns assigned variable value(s) +- [isCached()](./api-functions/api-is-cached.md) — returns true if there is a valid cache for this template +- [loadFilter()](./api-functions/api-load-filter.md) — load a filter plugin +- [muteExpectedErrors()](./api-functions/api-mute-expected-errors.md) — mutes expected warnings and notices deliberately generated by Smarty +- [registerCacheResource()](./api-functions/api-register-cacheresource.md) — dynamically register CacheResources +- [registerClass()](./api-functions/api-register-class.md) — register a class for use in the templates +- [registerDefaultPluginHandler()](./api-functions/api-register-default-plugin-handler.md) — register a function which gets called on undefined tags +- [registerFilter()](./api-functions/api-register-filter.md) — dynamically register filters +- [registerPlugin()](./api-functions/api-register-plugin.md) — dynamically register plugins +- [registerObject()](./api-functions/api-register-object.md) — register an object for use in the templates +- [registerResource()](./api-functions/api-register-resource.md) — dynamically register resources +- [setCacheDir()](./api-functions/api-set-cache-dir.md) — set the directory where the rendered template's output is stored +- [setCompileDir()](./api-functions/api-set-compile-dir.md) — set the directory where compiled templates are stored +- [setConfigDir()](./api-functions/api-set-config-dir.md) — set the directories where config files are stored +- [setPluginsDir()](./api-functions/api-set-plugins-dir.md) — set the directories where plugins are stored +- [setTemplateDir()](./api-functions/api-set-template-dir.md) — set the directories where templates are stored +- [templateExists()](./api-functions/api-template-exists.md) — checks whether the specified template exists +- [unregisterCacheResource()](./api-functions/api-unregister-cacheresource.md) — dynamically unregister a CacheResource plugin +- [unregisterFilter()](./api-functions/api-unregister-filter.md) — dynamically unregister a filter +- [unregisterPlugin()](./api-functions/api-unregister-plugin.md) — dynamically unregister plugins +- [unregisterObject()](./api-functions/api-unregister-object.md) — dynamically unregister an object +- [unregisterResource()](./api-functions/api-unregister-resource.md) — dynamically unregister a resource plugin +- [testInstall()](./api-functions/api-test-install.md) — checks Smarty installation + +> **Note** +> +> See +> [`Changing settings by template`](./advanced-features/advanced-features-template-settings.md) +> section for how to use the functions for individual templates. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-add-config-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-add-config-dir.md new file mode 100644 index 000000000..6c8b54e41 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-add-config-dir.md @@ -0,0 +1,49 @@ +addConfigDir() + +add a directory to the list of directories where config files are stored + +Description +=========== + +Smarty + +addConfigDir + +string\|array + +config\_dir + +string + +key + + + <?php + + // add directory where config files are stored + $smarty->addConigDir('./config_1'); + + // add directory where config files are stored and specify array-key + $smarty->addConfigDir('./config_1', 'one'); + + // add multiple directories where config files are stored and specify array-keys + $smarty->addTemplateDir(array( + 'two' => './config_2', + 'three' => './config_3', + )); + + // view the template dir chain + var_dump($smarty->getConfigDir()); + + // chaining of method calls + $smarty->setConfigDir('./config') + ->addConfigDir('./config_1', 'one') + ->addConfigDir('./config_2', 'two'); + + ?> + + + +See also [`getConfigDir()`](#api.get.config.dir), +[`setConfigDir()`](#api.set.config.dir) and +[`$config_dir`](#variable.config.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-add-plugins-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-add-plugins-dir.md new file mode 100644 index 000000000..ec9741b6e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-add-plugins-dir.md @@ -0,0 +1,42 @@ +addPluginsDir() + +add a directory to the list of directories where plugins are stored + +Description +=========== + +Smarty + +addPluginsDir + +string\|array + +plugins\_dir + + + <?php + + // add directory where plugins are stored + $smarty->addPluginsDir('./plugins_1'); + + // add multiple directories where plugins are stored + $smarty->setPluginsDir(array( + './plugins_2', + './plugins_3', + )); + + // view the plugins dir chain + var_dump($smarty->getPluginsDir()); + + // chaining of method calls + $smarty->setPluginsDir('./plugins') + ->addPluginsDir('./plugins_1') + ->addPluginsDir('./plugins_2'); + + ?> + + + +See also [`getPluginsDir()`](#api.get.plugins.dir), +[`setPluginsDir()`](#api.set.plugins.dir) and +[`$plugins_dir`](#variable.plugins.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-add-template-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-add-template-dir.md new file mode 100644 index 000000000..e0d24564c --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-add-template-dir.md @@ -0,0 +1,49 @@ +addTemplateDir() + +add a directory to the list of directories where templates are stored + +Description +=========== + +Smarty + +addTemplateDir + +string\|array + +template\_dir + +string + +key + + + <?php + + // add directory where templates are stored + $smarty->addTemplateDir('./templates_1'); + + // add directory where templates are stored and specify array-key + $smarty->addTemplateDir('./templates_1', 'one'); + + // add multiple directories where templates are stored and specify array-keys + $smarty->addTemplateDir(array( + 'two' => './templates_2', + 'three' => './templates_3', + )); + + // view the template dir chain + var_dump($smarty->getTemplateDir()); + + // chaining of method calls + $smarty->setTemplateDir('./templates') + ->addTemplateDir('./templates_1', 'one') + ->addTemplateDir('./templates_2', 'two'); + + ?> + + + +See also [`getTemplateDir()`](#api.get.template.dir), +[`setTemplateDir()`](#api.set.template.dir) and +[`$template_dir`](#variable.template.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-append-by-ref.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-append-by-ref.md new file mode 100644 index 000000000..cd396d9cc --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-append-by-ref.md @@ -0,0 +1,46 @@ +appendByRef() + +append values by reference + +Description +=========== + +void + +appendByRef + +string + +varname + +mixed + +var + +bool + +merge + +This is used to [`append()`](#api.append) values to the templates by +reference. + +> **Note** +> +> With the introduction of PHP5, `appendByRef()` is not necessary for +> most intents and purposes. `appendByRef()` is useful if you want a PHP +> array index value to be affected by its reassignment from a template. +> Assigned object properties behave this way by default. + +NOTE.PARAMETER.MERGE + + + <?php + // appending name/value pairs + $smarty->appendByRef('Name', $myname); + $smarty->appendByRef('Address', $address); + ?> + + + +See also [`append()`](#api.append), [`assign()`](#api.assign) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-append.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-append.md new file mode 100644 index 000000000..b94586417 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-append.md @@ -0,0 +1,61 @@ +append() + +append an element to an assigned array + +Description +=========== + +void + +append + +mixed + +var + +void + +append + +string + +varname + +mixed + +var + +bool + +merge + +If you append to a string value, it is converted to an array value and +then appended to. You can explicitly pass name/value pairs, or +associative arrays containing the name/value pairs. If you pass the +optional third parameter of TRUE, the value will be merged with the +current array instead of appended. + +NOTE.PARAMETER.MERGE + + + <?php + // This is effectively the same as assign() + $smarty->append('foo', 'Fred'); + // After this line, foo will now be seen as an array in the template + $smarty->append('foo', 'Albert'); + + $array = array(1 => 'one', 2 => 'two'); + $smarty->append('X', $array); + $array2 = array(3 => 'three', 4 => 'four'); + // The following line will add a second element to the X array + $smarty->append('X', $array2); + + // passing an associative array + $smarty->append(array('city' => 'Lincoln', 'state' => 'Nebraska')); + ?> + + + +See also [`appendByRef()`](#api.append.by.ref), +[`assign()`](#api.assign) and +[`getTemplateVars()`](#api.get.template.vars) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-assign-by-ref.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-assign-by-ref.md new file mode 100644 index 000000000..7c42b4836 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-assign-by-ref.md @@ -0,0 +1,42 @@ +assignByRef() + +assign values by reference + +Description +=========== + +void + +assignByRef + +string + +varname + +mixed + +var + +This is used to [`assign()`](#api.assign) values to the templates by +reference. + +> **Note** +> +> With the introduction of PHP5, `assignByRef()` is not necessary for +> most intents and purposes. `assignByRef()` is useful if you want a PHP +> array index value to be affected by its reassignment from a template. +> Assigned object properties behave this way by default. + + + <?php + // passing name/value pairs + $smarty->assignByRef('Name', $myname); + $smarty->assignByRef('Address', $address); + ?> + + + +See also [`assign()`](#api.assign), +[`clearAllAssign()`](#api.clear.all.assign), [`append()`](#api.append), +[`{assign}`](#language.function.assign) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-assign.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-assign.md new file mode 100644 index 000000000..c3b9985d4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-assign.md @@ -0,0 +1,84 @@ +assign() + +assign variables/objects to the templates + +Description +=========== + +void + +assign + +mixed + +var + +void + +assign + +string + +varname + +mixed + +var + +bool + +nocache + +You can explicitly pass name/value pairs, or associative arrays +containing the name/value pairs. + +If you pass the optional third `nocache` parameter of TRUE, the variable +is assigned as nocache variable. See +[`Cacheability of Variables`](#cacheability.variables) for details. + +> **Note** +> +> When you assign/register objects to templates, be sure that all +> properties and methods accessed from the template are for presentation +> purposes only. It is very easy to inject application logic through +> objects, and this leads to poor designs that are difficult to manage. +> See the Best Practices section of the Smarty website. + + + <?php + // passing name/value pairs + $smarty->assign('Name', 'Fred'); + $smarty->assign('Address', $address); + + // passing an associative array + $smarty->assign(array('city' => 'Lincoln', 'state' => 'Nebraska')); + + // passing an array + $myArray = array('no' => 10, 'label' => 'Peanuts'); + $smarty->assign('foo',$myArray); + + // passing a row from a database (eg adodb) + $sql = 'select id, name, email from contacts where contact ='.$id; + $smarty->assign('contact', $db->getRow($sql)); + ?> + +These are accessed in the template with + + + {* note the vars are case sensitive like php *} + {$Name} + {$Address} + {$city} + {$state} + + {$foo.no}, {$foo.label} + {$contact.id}, {$contact.name},{$contact.email} + +To access more complex array assignments see +[`{foreach}`](#language.function.foreach) and +[`{section}`](#language.function.section) + +See also [`assignByRef()`](#api.assign.by.ref), +[`getTemplateVars()`](#api.get.template.vars), +[`clearAssign()`](#api.clear.assign), [`append()`](#api.append) and +[`{assign}`](#language.function.assign) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-all-assign.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-all-assign.md new file mode 100644 index 000000000..cc75fad0f --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-all-assign.md @@ -0,0 +1,34 @@ +clearAllAssign() + +clears the values of all assigned variables + +Description +=========== + +void + +clearAllAssign + + + <?php + // passing name/value pairs + $smarty->assign('Name', 'Fred'); + $smarty->assign('Address', $address); + + // will output above + print_r( $smarty->getTemplateVars() ); + + // clear all assigned variables + $smarty->clearAllAssign(); + + // will output nothing + print_r( $smarty->getTemplateVars() ); + + ?> + + + +See also [`clearAssign()`](#api.clear.assign), +[`clearConfig()`](#api.clear.config), +[`getTemplateVars()`](#api.get.template.vars), [`assign()`](#api.assign) +and [`append()`](#api.append) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-all-cache.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-all-cache.md new file mode 100644 index 000000000..55cbe5795 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-all-cache.md @@ -0,0 +1,37 @@ +clearAllCache() + +clears the entire template cache + +Description +=========== + +void + +clearAllCache + +int + +expire\_time + +As an optional parameter, you can supply a minimum age in seconds the +cache files must be before they will get cleared. + +> **Note** +> +> Since Smarty version 3.1.14 it is possible to delete cache files by +> their individual expiration time at creation by passing constant +> SMARTY::CLEAR\_EXPIRED as `expire_time` parameter. + + + <?php + // clear the entire cache + $smarty->clearAllCache(); + + // clears all files over one hour old + $smarty->clearAllCache(3600); + ?> + + + +See also [`clearCache()`](#api.clear.cache), +[`isCached()`](#api.is.cached) and the [caching](#caching) page. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-assign.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-assign.md new file mode 100644 index 000000000..ac0731e86 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-assign.md @@ -0,0 +1,32 @@ +clearAssign() + +clears the value of an assigned variable + +Description +=========== + +void + +clearAssign + +mixed + +var + +This can be a single value, or an array of values. + + + <?php + // clear a single variable + $smarty->clearAssign('Name'); + + // clears multiple variables + $smarty->clearAssign(array('Name', 'Address', 'Zip')); + ?> + + + +See also [`clearAllAssign()`](#api.clear.all.assign), +[`clearConfig()`](#api.clear.config), +[`getTemplateVars()`](#api.get.template.vars), [`assign()`](#api.assign) +and [`append()`](#api.append) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md new file mode 100644 index 000000000..3e17d80c8 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md @@ -0,0 +1,60 @@ +clearCache() + +clears the cache for a specific template + +Description +=========== + +void + +clearCache + +string + +template + +string + +cache\_id + +string + +compile\_id + +int + +expire\_time + +- If you have [multiple caches](#caching.multiple.caches) for a + template, you can clear a specific cache by supplying the `cache_id` + as the second parameter. + +- You can also pass a [`$compile_id`](#variable.compile.id) as a third + parameter. You can [group templates together](#caching.groups) so + they can be removed as a group, see the [caching section](#caching) + for more information. + +- As an optional fourth parameter, you can supply a minimum age in + seconds the cache file must be before it will get cleared. + + > **Note** + > + > Since Smarty version 3.1.14 it is possible to delete cache files + > by their individual expiration time at creation by passing + > constant SMARTY::CLEAR\_EXPIRED as fourth parameter. + +<!-- --> + + + <?php + // clear the cache for a template + $smarty->clearCache('index.tpl'); + + // clear the cache for a particular cache id in an multiple-cache template + $smarty->clearCache('index.tpl', 'MY_CACHE_ID'); + ?> + + + +See also [`clearAllCache()`](#api.clear.all.cache) and +[`caching`](#caching) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-compiled-tpl.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-compiled-tpl.md new file mode 100644 index 000000000..dfa688eb6 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-compiled-tpl.md @@ -0,0 +1,44 @@ +clearCompiledTemplate() + +clears the compiled version of the specified template resource + +Description +=========== + +void + +clearCompiledTemplate + +string + +tpl\_file + +string + +compile\_id + +int + +exp\_time + +This clears the compiled version of the specified template resource, or +all compiled template files if one is not specified. If you pass a +[`$compile_id`](#variable.compile.id) only the compiled template for +this specific [`$compile_id`](#variable.compile.id) is cleared. If you +pass an exp\_time, then only compiled templates older than `exp_time` +seconds are cleared, by default all compiled templates are cleared +regardless of their age. This function is for advanced use only, not +normally needed. + + + <?php + // clear a specific template resource + $smarty->clearCompiledTemplate('index.tpl'); + + // clear entire compile directory + $smarty->clearCompiledTemplate(); + ?> + + + +See also [`clearCache()`](#api.clear.cache). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-config.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-config.md new file mode 100644 index 000000000..43e86be17 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-config.md @@ -0,0 +1,35 @@ +clearConfig() + +clears assigned config variables + +Description +=========== + +void + +clearConfig + +string + +var + +This clears all assigned [config variables](#language.config.variables). +If a variable name is supplied, only that variable is cleared. + + + <?php + // clear all assigned config variables. + $smarty->clearConfig(); + + // clear one variable + $smarty->clearConfig('foobar'); + ?> + + + +See also [`getConfigVars()`](#api.get.config.vars), +[`config variables`](#language.config.variables), +[`config files`](#config.files), +[`{config_load}`](#language.function.config.load), +[`configLoad()`](#api.config.load) and +[`clearAssign()`](#api.clear.assign). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-compile-all-config.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-compile-all-config.md new file mode 100644 index 000000000..a102fc97e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-compile-all-config.md @@ -0,0 +1,61 @@ +compileAllConfig() + +compiles all known config files + +Description +=========== + +string + +compileAllConfig + +string + +extension + +boolean + +force + +integer + +timelimit + +integer + +maxerror + +This function compiles config files found in the +[`$config_dir`](#variable.config.dir) folder. It uses the following +parameters: + +- `extension` is an optional string which defines the file extension + for the config files. The default is \".conf\". + +- `force` is an optional boolean which controls if only modified + (false) or all (true) config files shall be compiled. The default is + \"false\". + +- `timelimit` is an optional integer to set a runtime limit in seconds + for the compilation process. The default is no limit. + +- `maxerror` is an optional integer to set an error limit. If more + config files failed to compile the function will be aborted. The + default is no limit. + +> **Note** +> +> This function may not create desired results in all configurations. +> Use is on own risk. + + + <?php + include('Smarty.class.php'); + $smarty = new Smarty; + + // force compilation of all config files + $smarty->compileAllConfig('.config',true); + + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-compile-all-templates.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-compile-all-templates.md new file mode 100644 index 000000000..53a021da8 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-compile-all-templates.md @@ -0,0 +1,71 @@ +compileAllTemplates() + +compiles all known templates + +Description +=========== + +string + +compileAllTemplates + +string + +extension + +boolean + +force + +integer + +timelimit + +integer + +maxerror + +This function compiles template files found in the +[`$template_dir`](#variable.template.dir) folder. It uses the following +parameters: + +- `extension` is an optional string which defines the file extension + for the template files. The default is \".tpl\". + +- `force` is an optional boolean which controls if only modified + (false) or all (true) templates shall be compiled. The default is + \"false\". + +- `timelimit` is an optional integer to set a runtime limit in seconds + for the compilation process. The default is no limit. + +- `maxerror` is an optional integer to set an error limit. If more + templates failed to compile the function will be aborted. The + default is no limit. + +> **Note** +> +> This function may not create desired results in all configurations. +> Use is on own risk. + +> **Note** +> +> If any template requires registered plugins, filters or objects you +> must register all of them before running this function. + +> **Note** +> +> If you are using template inheritance this function will create +> compiled files of parent templates which will never be used. + + + <?php + include('Smarty.class.php'); + $smarty = new Smarty; + + // force compilation of all template files + $smarty->compileAllTemplates('.tpl',true); + + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-config-load.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-config-load.md new file mode 100644 index 000000000..bf6001fa4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-config-load.md @@ -0,0 +1,47 @@ +configLoad() + +loads config file data and assigns it to the template + +Description +=========== + +void + +configLoad + +string + +file + +string + +section + +This loads [config file](#config.files) data and assigns it to the +template. This works identically to the template +[`{config_load}`](#language.function.config.load) function. + +> **Note** +> +> As of Smarty 2.4.0, assigned template variables are kept across +> invocations of [`fetch()`](#api.fetch) and +> [`display()`](#api.display). Config vars loaded from `configLoad()` +> are always global in scope. Config files are also compiled for faster +> execution, and respect the [`$force_compile`](#variable.force.compile) +> and [`$compile_check`](#variable.compile.check) settings. + + + <?php + // load config variables and assign them + $smarty->configLoad('my.conf'); + + // load a section + $smarty->configLoad('my.conf', 'foobar'); + ?> + + + +See also [`{config_load}`](#language.function.config.load), +[`getConfigVars()`](#api.get.config.vars), +[`clearConfig()`](#api.clear.config), and +[`config variables`](#language.config.variables) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-create-data.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-create-data.md new file mode 100644 index 000000000..2d9f281b3 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-create-data.md @@ -0,0 +1,52 @@ +createData() + +creates a data object + +Description +=========== + +string + +createData + +object + +parent + +string + +createData + +This creates a data object which will hold assigned variables. It uses +the following parameters: + +- `parent` is an optional parameter. It is an uplink to the main + Smarty object, a another user-created data object or to user-created + template object. These objects can be chained. Templates can access + variables assigned to any of the objects in it\'s parent chain. + +Data objects are used to create scopes for assigned variables. They can +be used to have controll which variables are seen by which templates. + + + <?php + include('Smarty.class.php'); + $smarty = new Smarty; + + // create data object with its private variable scope + $data = $smarty->createData(); + + // assign variable to data scope + $data->assign('foo','bar'); + + // create template object which will use variables from data object + $tpl = $smarty->createTemplate('index.tpl',$data); + + // display the template + $tpl->display(); + ?> + + + +See also [`display()`](#api.display), and +[`createTemplate()`](#api.create.template), diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-create-template.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-create-template.md new file mode 100644 index 000000000..5129406d4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-create-template.md @@ -0,0 +1,99 @@ +createTemplate() + +returns a template object + +Description +=========== + +Smarty\_Internal\_Template + +createTemplate + +string + +template + +object + +parent + +Smarty\_Internal\_Template + +createTemplate + +string + +template + +array + +data + +Smarty\_Internal\_Template + +createTemplate + +string + +template + +string + +cache\_id + +string + +compile\_id + +object + +parent + +Smarty\_Internal\_Template + +createTemplate + +string + +template + +string + +cache\_id + +string + +compile\_id + +array + +data + +This creates a template object which later can be rendered by the +[display](#api.display) or [fetch](#api.fetch) method. It uses the +following parameters: + +- `template` must be a valid [template resource](#resources) type and + path. + +<!-- --> + + + <?php + include('Smarty.class.php'); + $smarty = new Smarty; + + // create template object with its private variable scope + $tpl = $smarty->createTemplate('index.tpl'); + + // assign variable to template scope + $tpl->assign('foo','bar'); + + // display the template + $tpl->display(); + ?> + + + +See also [`display()`](#api.display), and +[`templateExists()`](#api.template.exists). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-disable-security.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-disable-security.md new file mode 100644 index 000000000..efbaa3559 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-disable-security.md @@ -0,0 +1,15 @@ +disableSecurity() + +disables template security + +Description +=========== + +string + +disableSecurity + +This disables securty checking on templates. + +See also [`enableSecurity()`](#api.enable.security), and +[Security](#advanced.features.security). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-display.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-display.md new file mode 100644 index 000000000..59726195e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-display.md @@ -0,0 +1,82 @@ +display() + +displays the template + +Description +=========== + +void + +display + +string + +template + +string + +cache\_id + +string + +compile\_id + +This displays the contents of a template. To return the contents of a +template into a variable, use [`fetch()`](#api.fetch). Supply a valid +[template resource](#resources) type and path. As an optional second +parameter, you can pass a `$cache_id`, see the [caching +section](#caching) for more information. + +PARAMETER.COMPILEID + + + <?php + include(SMARTY_DIR.'Smarty.class.php'); + $smarty = new Smarty(); + $smarty->setCaching(true); + + // only do db calls if cache doesn't exist + if(!$smarty->isCached('index.tpl')) { + + // dummy up some data + $address = '245 N 50th'; + $db_data = array( + 'City' => 'Lincoln', + 'State' => 'Nebraska', + 'Zip' => '68502' + ); + + $smarty->assign('Name', 'Fred'); + $smarty->assign('Address', $address); + $smarty->assign('data', $db_data); + + } + + // display the output + $smarty->display('index.tpl'); + ?> + + + +Use the syntax for [template resources](#resources) to display files +outside of the [`$template_dir`](#variable.template.dir) directory. + + + <?php + // absolute filepath + $smarty->display('/usr/local/include/templates/header.tpl'); + + // absolute filepath (same thing) + $smarty->display('file:/usr/local/include/templates/header.tpl'); + + // windows absolute filepath (MUST use "file:" prefix) + $smarty->display('file:C:/www/pub/templates/header.tpl'); + + // include from template resource named "db" + $smarty->display('db:header.tpl'); + ?> + + + +See also [`fetch()`](#api.fetch) and +[`templateExists()`](#api.template.exists). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-enable-security.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-enable-security.md new file mode 100644 index 000000000..3326900d5 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-enable-security.md @@ -0,0 +1,41 @@ +enableSecurity() + +enables template security + +Description +=========== + +string + +enableSecurity + +string + +securityclass + +string + +enableSecurity + +object + +securityobject + +string + +enableSecurity + +This enables securty checking on templates. It uses the following +parameters: + +- `securityclass` is an optional parameter. It\'s the name of the + class with defines the security policy parameters. + +- `securityobject` is an optional parameter. It\'s the object with + defines the security policy parameters. + +For the details how to setup a security policy see the +[Security](#advanced.features.security) section. + +See also [`disableSecurity()`](#api.disable.security), and +[Security](#advanced.features.security). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-fetch.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-fetch.md new file mode 100644 index 000000000..a0c1676aa --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-fetch.md @@ -0,0 +1,91 @@ +fetch() + +returns the template output + +Description +=========== + +string + +fetch + +string + +template + +string + +cache\_id + +string + +compile\_id + +This returns the template output instead of [displaying](#api.display) +it. Supply a valid [template resource](#resources) type and path. As an +optional second parameter, you can pass a `$cache id`, see the [caching +section](#caching) for more information. + +PARAMETER.COMPILEID + + + <?php + include('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(true); + + // set a separate cache_id for each unique URL + $cache_id = md5($_SERVER['REQUEST_URI']); + + // capture the output + $output = $smarty->fetch('index.tpl', $cache_id); + + // do something with $output here + echo $output; + ?> + + + +The `email_body.tpl` template + + + Dear {$contact_info.name}, + + Welcome and thank you for signing up as a member of our user group. + + Click on the link below to login with your user name + of '{$contact_info.username}' so you can post in our forums. + + {$login_url} + + List master + + {textformat wrap=40} + This is some long-winded disclaimer text that would automatically get wrapped + at 40 characters. This helps make the text easier to read in mail programs that + do not wrap sentences for you. + {/textformat} + + + +The php script using the PHP [`mail()`](&url.php-manual;function.mail) +function + + + <?php + + // get $contact_info from db or other resource here + + $smarty->assign('contact_info',$contact_info); + $smarty->assign('login_url',"http://{$_SERVER['SERVER_NAME']}/login"); + + mail($contact_info['email'], 'Thank You', $smarty->fetch('email_body.tpl')); + + ?> + + + +See also [`{fetch}`](#language.function.fetch) +[`display()`](#api.display), [`{eval}`](#language.function.eval), and +[`templateExists()`](#api.template.exists). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-cache-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-cache-dir.md new file mode 100644 index 000000000..9e55d8d0b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-cache-dir.md @@ -0,0 +1,23 @@ +getCacheDir() + +return the directory where the rendered template\'s output is stored + +Description +=========== + +string + +getCacheDir + + + <?php + + // get directory where compiled templates are stored + $cacheDir = $smarty->getCacheDir(); + + ?> + + + +See also [`setCacheDir()`](#api.set.cache.dir) and +[`$cache_dir`](#variable.cache.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-compile-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-compile-dir.md new file mode 100644 index 000000000..3bfae7306 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-compile-dir.md @@ -0,0 +1,23 @@ +getCompileDir() + +returns the directory where compiled templates are stored + +Description +=========== + +string + +getCompileDir + + + <?php + + // get directory where compiled templates are stored + $compileDir = $smarty->getCompileDir(); + + ?> + + + +See also [`setCompileDir()`](#api.set.compile.dir) and +[`$compile_dir`](#variable.compile.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-config-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-config-dir.md new file mode 100644 index 000000000..f41472ca4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-config-dir.md @@ -0,0 +1,40 @@ +getConfigDir() + +return the directory where config files are stored + +Description +=========== + +string\|array + +getConfigDir + +string + +key + + + <?php + + // set some config directories + $smarty->setConfigDir(array( + 'one' => './config', + 'two' => './config_2', + 'three' => './config_3', + )); + + // get all directories where config files are stored + $config_dir = $smarty->getConfigDir(); + var_dump($config_dir); // array + + // get directory identified by key + $config_dir = $smarty->getConfigDir('one'); + var_dump($config_dir); // string + + ?> + + + +See also [`setConfigDir()`](#api.set.config.dir), +[`addConfigDir()`](#api.add.config.dir) and +[`$config_dir`](#variable.config.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-config-vars.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-config-vars.md new file mode 100644 index 000000000..f252e8674 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-config-vars.md @@ -0,0 +1,37 @@ +getConfigVars() + +returns the given loaded config variable value + +Description +=========== + +array + +getConfigVars + +string + +varname + +If no parameter is given, an array of all loaded [config +variables](#language.config.variables) is returned. + + + <?php + + // get loaded config template var #foo# + $myVar = $smarty->getConfigVars('foo'); + + // get all loaded config template vars + $all_config_vars = $smarty->getConfigVars(); + + // take a look at them + print_r($all_config_vars); + ?> + + + +See also [`clearConfig()`](#api.clear.config), +[`{config_load}`](#language.function.config.load), +[`configLoad()`](#api.config.load) and +[`getTemplateVars()`](#api.get.template.vars). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-plugins-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-plugins-dir.md new file mode 100644 index 000000000..aa6035549 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-plugins-dir.md @@ -0,0 +1,31 @@ +getPluginsDir() + +return the directory where plugins are stored + +Description +=========== + +array + +getPluginsDir + + + <?php + + // set some plugins directories + $smarty->setPluginsDir(array( + './plugins', + './plugins_2', + )); + + // get all directories where plugins are stored + $config_dir = $smarty->getPluginsDir(); + var_dump($config_dir); // array + + ?> + + + +See also [`setPluginsDir()`](#api.set.plugins.dir), +[`addPluginsDir()`](#api.add.plugins.dir) and +[`$plugins_dir`](#variable.plugins.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md new file mode 100644 index 000000000..a7c920e14 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md @@ -0,0 +1,36 @@ +getRegisteredObject() + +returns a reference to a registered object + +Description +=========== + +array + +getRegisteredObject + +string + +object\_name + +This is useful from within a custom function when you need direct access +to a [registered object](#api.register.object). See the +[objects](#advanced.features.objects) page for more info. + + + <?php + function smarty_block_foo($params, $smarty) + { + if (isset($params['object'])) { + // get reference to registered object + $obj_ref = $smarty->getRegisteredObject($params['object']); + // use $obj_ref is now a reference to the object + } + } + ?> + + + +See also [`registerObject()`](#api.register.object), +[`unregisterObject()`](#api.unregister.object) and [objects +page](#advanced.features.objects) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-tags.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-tags.md new file mode 100644 index 000000000..7729b468b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-tags.md @@ -0,0 +1,40 @@ +getTags() + +return tags used by template + +Description +=========== + +string + +getTags + +object + +template + +This function returns an array of tagname/attribute pairs for all tags +used by the template. It uses the following parameters: + +- `template` is the template object. + +> **Note** +> +> This function is experimental. + + + <?php + include('Smarty.class.php'); + $smarty = new Smarty; + + // create template object + $tpl = $smarty->createTemplate('index.tpl'); + + // get tags + $tags = $smarty->getTags($tpl); + + print_r($tags); + + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-template-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-template-dir.md new file mode 100644 index 000000000..42c75908b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-template-dir.md @@ -0,0 +1,40 @@ +getTemplateDir() + +return the directory where templates are stored + +Description +=========== + +string\|array + +getTemplateDir + +string + +key + + + <?php + + // set some template directories + $smarty->setTemplateDir(array( + 'one' => './templates', + 'two' => './templates_2', + 'three' => './templates_3', + )); + + // get all directories where templates are stored + $template_dir = $smarty->getTemplateDir(); + var_dump($template_dir); // array + + // get directory identified by key + $template_dir = $smarty->getTemplateDir('one'); + var_dump($template_dir); // string + + ?> + + + +See also [`setTemplateDir()`](#api.set.template.dir), +[`addTemplateDir()`](#api.add.template.dir) and +[`$template_dir`](#variable.template.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-template-vars.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-template-vars.md new file mode 100644 index 000000000..27882eef4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-template-vars.md @@ -0,0 +1,37 @@ +getTemplateVars() + +returns assigned variable value(s) + +Description +=========== + +array + +getTemplateVars + +string + +varname + +If no parameter is given, an array of all [assigned](#api.assign) +variables are returned. + + + <?php + // get assigned template var 'foo' + $myVar = $smarty->getTemplateVars('foo'); + + // get all assigned template vars + $all_tpl_vars = $smarty->getTemplateVars(); + + // take a look at them + print_r($all_tpl_vars); + ?> + + + +See also [`assign()`](#api.assign), +[`{assign}`](#language.function.assign), [`append()`](#api.append), +[`clearAssign()`](#api.clear.assign), +[`clearAllAssign()`](#api.clear.all.assign) and +[`getConfigVars()`](#api.get.config.vars) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-is-cached.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-is-cached.md new file mode 100644 index 000000000..0c41bf04a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-is-cached.md @@ -0,0 +1,81 @@ +isCached() + +returns true if there is a valid cache for this template + +Description +=========== + +bool + +isCached + +string + +template + +string + +cache\_id + +string + +compile\_id + +- This only works if [`$caching`](#variable.caching) is set to one of + `Smarty::CACHING_LIFETIME_CURRENT` or + `Smarty::CACHING_LIFETIME_SAVED` to enable caching. See the [caching + section](#caching) for more info. + +- You can also pass a `$cache_id` as an optional second parameter in + case you want [multiple caches](#caching.multiple.caches) for the + given template. + +- You can supply a [`$compile id`](#variable.compile.id) as an + optional third parameter. If you omit that parameter the persistent + [`$compile_id`](#variable.compile.id) is used if its set. + +- If you do not want to pass a `$cache_id` but want to pass a + [`$compile_id`](#variable.compile.id) you have to pass NULL as a + `$cache_id`. + +> **Note** +> +> If `isCached()` returns TRUE it actually loads the cached output and +> stores it internally. Any subsequent call to +> [`display()`](#api.display) or [`fetch()`](#api.fetch) will return +> this internally stored output and does not try to reload the cache +> file. This prevents a race condition that may occur when a second +> process clears the cache between the calls to `isCached()` and to +> [`display()`](#api.display) in the example above. This also means +> calls to [`clearCache()`](#api.clear.cache) and other changes of the +> cache-settings may have no effect after `isCached()` returned TRUE. + + + <?php + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + if(!$smarty->isCached('index.tpl')) { + // do database calls, assign vars here + } + + $smarty->display('index.tpl'); + ?> + + + + + <?php + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + if(!$smarty->isCached('index.tpl', 'FrontPage')) { + // do database calls, assign vars here + } + + $smarty->display('index.tpl', 'FrontPage'); + ?> + + + +See also [`clearCache()`](#api.clear.cache), +[`clearAllCache()`](#api.clear.all.cache), and [caching +section](#caching). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-load-filter.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-load-filter.md new file mode 100644 index 000000000..19286ee33 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-load-filter.md @@ -0,0 +1,42 @@ +loadFilter() + +load a filter plugin + +Description +=========== + +void + +loadFilter + +string + +type + +string + +name + +The first argument specifies the type of the filter to load and can be +one of the following: `pre`, `post` or `output`. The second argument +specifies the `name` of the filter plugin. + + + <?php + + // load prefilter named 'trim' + $smarty->loadFilter('pre', 'trim'); + + // load another prefilter named 'datefooter' + $smarty->loadFilter('pre', 'datefooter'); + + // load output filter named 'compress' + $smarty->loadFilter('output', 'compress'); + + ?> + + + +See also [`registerFilter()`](#api.register.filter), +[`$autoload_filters`](#variable.autoload.filters) and [advanced +features](#advanced.features). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-mute-expected-errors.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-mute-expected-errors.md new file mode 100644 index 000000000..1ce45d493 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-mute-expected-errors.md @@ -0,0 +1,21 @@ +Smarty::muteExpectedErrors() + +mutes expected warnings and notices deliberately generated by Smarty + +Description +=========== + +string + +muteExpectedErrors + +muteExpectedErrors() registers a custom error handler using +[set\_error\_handler()](&url.php-manual;set_error_handler). The error +handler merely inspects `$errno` and `$errfile` to determine if the +given error was produced deliberately and must be ignored, or should be +passed on to the next error handler. + +`Smarty::unmuteExpectedErrors()` removes the current error handler. +Please note, that if you\'ve registerd any custom error handlers after +the muteExpectedErrors() call, the unmute will not remove Smarty\'s +muting error handler, but the one registered last. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-cacheresource.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-cacheresource.md new file mode 100644 index 000000000..60ae60308 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-cacheresource.md @@ -0,0 +1,40 @@ +registerCacheResource() + +dynamically register CacheResources + +Description +=========== + +void + +registerCacheResource + +string + +name + +Smarty\_CacheResource + +resource\_handler + +Use this to dynamically register a [CacheResource +plugin](#caching.custom) with Smarty. Pass in the `name` of the +CacheResource and the object extending Smarty\_CacheResource. See +[Custom Cache Implementation](#caching.custom) for more information on +how to create custom CacheResources. + +> **Note** +> +> In Smarty2 this used to be a callback function called +> `$cache_handler_func`. Smarty3 replaced this callback by the +> `Smarty_CacheResource` module. + + + <?php + $smarty->registerCacheResource('mysql', new Smarty_CacheResource_Mysql()); + ?> + + + +See also [`unregisterCacheResource()`](#api.unregister.cacheresource) +and the [Custom CacheResource Implementation](#caching.custom) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-class.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-class.md new file mode 100644 index 000000000..ee339cadb --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-class.md @@ -0,0 +1,65 @@ +registerClass() + +register a class for use in the templates + +Description +=========== + +void + +registerClass + +string + +class\_name + +string + +class\_impl + +Smarty allows you to access static classes from templates as long as the +[Security Policy](#advanced.features.security) does not tell it +otherwise. If security is enabled, classes registered with +`registerClass()` are accessible to templates. + + + <?php + + class Bar { + $property = "hello world"; + } + + $smarty = new Smarty(); + $smarty->registerClass("Foo", "Bar"); + + + + + {* Smarty will access this class as long as it's not prohibited by security *} + {Bar::$property} + {* Foo translates to the real class Bar *} + {Foo::$property} + + + + + <?php + namespace my\php\application { + class Bar { + $property = "hello world"; + } + } + + $smarty = new Smarty(); + $smarty->registerClass("Foo", "\my\php\application\Bar"); + + + + + {* Foo translates to the real class \my\php\application\Bar *} + {Foo::$property} + + + +See also [`registerObject()`](#api.register.object), and +[Security](#advanced.features.security). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-default-plugin-handler.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-default-plugin-handler.md new file mode 100644 index 000000000..9447d9620 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-default-plugin-handler.md @@ -0,0 +1,93 @@ +registerDefaultPluginHandler() + +register a function which gets called on undefined tags + +Description +=========== + +void + +registerDefaultPluginHandler + +mixed + +callback + +Register a default plugin handler which gets called if the compiler can +not find a definition for a tag otherwise. It uses the following +parameters: + +If during compilation Smarty encounters tag which is not defined +internal, registered or loacted in the plugins folder it tries to +resolve it by calling the registered default plugin handler. The handler +may be called several times for same undefined tag looping over valid +plugin types. + + + <?php + + $smarty = new Smarty(); + $smarty->registerDefaultPluginHandler('my_plugin_handler'); + + /** + * Default Plugin Handler + * + * called when Smarty encounters an undefined tag during compilation + * + * @param string $name name of the undefined tag + * @param string $type tag type (e.g. Smarty::PLUGIN_FUNCTION, Smarty::PLUGIN_BLOCK, + Smarty::PLUGIN_COMPILER, Smarty::PLUGIN_MODIFIER, Smarty::PLUGIN_MODIFIERCOMPILER) + * @param Smarty_Internal_Template $template template object + * @param string &$callback returned function name + * @param string &$script optional returned script filepath if function is external + * @param bool &$cacheable true by default, set to false if plugin is not cachable (Smarty >= 3.1.8) + * @return bool true if successfull + */ + function my_plugin_handler ($name, $type, $template, &$callback, &$script, &$cacheable) + { + switch ($type) { + case Smarty::PLUGIN_FUNCTION: + switch ($name) { + case 'scriptfunction': + $script = './scripts/script_function_tag.php'; + $callback = 'default_script_function_tag'; + return true; + case 'localfunction': + $callback = 'default_local_function_tag'; + return true; + default: + return false; + } + case Smarty::PLUGIN_COMPILER: + switch ($name) { + case 'scriptcompilerfunction': + $script = './scripts/script_compiler_function_tag.php'; + $callback = 'default_script_compiler_function_tag'; + return true; + default: + return false; + } + case Smarty::PLUGIN_BLOCK: + switch ($name) { + case 'scriptblock': + $script = './scripts/script_block_tag.php'; + $callback = 'default_script_block_tag'; + return true; + default: + return false; + } + default: + return false; + } + } + + ?> + + + +> **Note** +> +> The return callback must be static; a function name or an array of +> class and method name. +> +> Dynamic callbacks like objects methods are not supported. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-filter.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-filter.md new file mode 100644 index 000000000..fd91d2661 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-filter.md @@ -0,0 +1,45 @@ +registerFilter() + +dynamically register filters + +Description +=========== + +void + +registerFilter + +string + +type + +mixed + +callback + +Use this to dynamically register filters to operate on a templates. It +uses the following parameters: + +NOTE.PARAMETER.FUNCTION + +A [prefilter](#plugins.prefilters.postfilters) runs through the template +source before it gets compiled. See [template +prefilters](#advanced.features.prefilters) for more information on how +to setup a prefiltering function. + +A [postfilter](#plugins.prefilters.postfilters) runs through the +template code after it was compiled to PHP. See [template +postfilters](#advanced.features.postfilters) for more information on how +to setup a postfiltering function. + +A [outputfilter](#plugins.outputfilters) operates on a template\'s +output before it is [displayed](#api.display). See [template output +filters](#advanced.features.outputfilters) for more information on how +to set up an output filter function. + +See also [`unregisterFilter()`](#api.unregister.filter), +[`loadFilter()`](#api.load.filter), +[`$autoload_filters`](#variable.autoload.filters), [template pre +filters](#advanced.features.prefilters) [template post +filters](#advanced.features.postfilters) [template output +filters](#advanced.features.outputfilters) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-object.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-object.md new file mode 100644 index 000000000..c310e8c2a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-object.md @@ -0,0 +1,44 @@ +registerObject() + +register an object for use in the templates + +Description +=========== + +void + +registerObject + +string + +object\_name + +object + +object + +array + +allowed\_methods\_properties + +boolean + +format + +array + +block\_methods + +> **Note** +> +> When you register/assign objects to templates, be sure that all +> properties and methods accessed from the template are for presentation +> purposes only. It is very easy to inject application logic through +> objects, and this leads to poor designs that are difficult to manage. +> See the Best Practices section of the Smarty website. + +See the [objects section](#advanced.features.objects) for more +information. + +See also [`getRegisteredObject()`](#api.get.registered.object), and +[`unregisterObject()`](#api.unregister.object). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-plugin.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-plugin.md new file mode 100644 index 000000000..6eb433810 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-plugin.md @@ -0,0 +1,110 @@ +registerPlugin() + +dynamically register plugins + +Description +=========== + +void + +registerPlugin + +string + +type + +string + +name + +mixed + +callback + +bool + +cacheable + +mixed + +cache\_attrs + +This method registers functions or methods defined in your script as +plugin. It uses the following parameters: + +- `cacheable` and `cache_attrs` can be omitted in most cases. See + [controlling cacheability of plugins output](#caching.cacheable) on + how to use them properly. + +<!-- --> + + + <?php + $smarty->registerPlugin("function","date_now", "print_current_date"); + + function print_current_date($params, $smarty) + { + if(empty($params["format"])) { + $format = "%b %e, %Y"; + } else { + $format = $params["format"]; + } + return strftime($format,time()); + } + ?> + + + +And in the template + + + {date_now} + + {* or to format differently *} + {date_now format="%Y/%m/%d"} + + + <?php + // function declaration + function do_translation ($params, $content, $smarty, &$repeat, $template) + { + if (isset($content)) { + $lang = $params["lang"]; + // do some translation with $content + return $translation; + } + } + + // register with smarty + $smarty->registerPlugin("block","translate", "do_translation"); + ?> + + + +Where the template is: + + + {translate lang="br"}Hello, world!{/translate} + + + + + <?php + + // let's map PHP's stripslashes function to a Smarty modifier. + $smarty->registerPlugin("modifier","ss", "stripslashes"); + + ?> + +In the template, use `ss` to strip slashes. + + + <?php + {$var|ss} + ?> + +See also [`unregisterPlugin()`](#api.unregister.plugin), [plugin +functions](#plugins.functions), [plugin block +functions](#plugins.block.functions), [plugin compiler +functions](#plugins.compiler.functions), and the [creating plugin +modifiers](#plugins.modifiers) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-register-resource.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-resource.md new file mode 100644 index 000000000..ca4005460 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-register-resource.md @@ -0,0 +1,46 @@ +registerResource() + +dynamically register resources + +Description +=========== + +void + +registerResource + +string + +name + +Smarty\_resource + +resource\_handler + +Use this to dynamically register a [Resource plugin](#resources) with +Smarty. Pass in the `name` of the Resource and the object extending +Smarty\_Resource. See [template resources](#resources) for more +information on how to setup a function for fetching templates. + +> **Note** +> +> A resource name must be at least two characters in length. One +> character resource names will be ignored and used as part of the file +> path, such as `$smarty->display('c:/path/to/index.tpl');` + +> **Note** +> +> Prior to Smarty 3.1 `registerResource()` accepted an array of callback +> functions. While this is still possible for backward compatibility +> reasons, it is strongly discouraged as callback functions have been +> deprecated as of Smarty 3.1. + + + <?php + $smarty->registerResource('mysql', new Smarty_Resource_Mysql()); + ?> + + + +See also [`unregisterResource()`](#api.unregister.resource) and the +[template resources](#resources) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-set-cache-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-cache-dir.md new file mode 100644 index 000000000..7f7c4b60d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-cache-dir.md @@ -0,0 +1,32 @@ +setCacheDir() + +set the directory where the rendered template\'s output is stored + +Description +=========== + +Smarty + +setCacheDir + +string + +cache\_dir + + + <?php + + // set directory where rendered template's output is stored + $smarty->setCacheDir('./cache'); + + // chaining of method calls + $smarty->setTemplateDir('./templates') + ->setCompileDir('./templates_c') + ->setCacheDir('./cache'); + + ?> + + + +See also [`getCacheDir()`](#api.get.cache.dir) and +[`$cache_dir`](#variable.cache.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-set-compile-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-compile-dir.md new file mode 100644 index 000000000..bfeb55a53 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-compile-dir.md @@ -0,0 +1,32 @@ +setCompileDir() + +set the directory where compiled templates are stored + +Description +=========== + +Smarty + +setCompileDir + +string + +compile\_dir + + + <?php + + // set directory where compiled templates are stored + $smarty->setCompileDir('./templates_c'); + + // chaining of method calls + $smarty->setTemplateDir('./templates') + ->setCompileDir('./templates_c') + ->setCacheDir('./cache'); + + ?> + + + +See also [`getCompileDir()`](#api.get.compile.dir) and +[`$compile_dir`](#variable.compile.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-set-config-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-config-dir.md new file mode 100644 index 000000000..97a6ae977 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-config-dir.md @@ -0,0 +1,47 @@ +setConfigDir() + +set the directories where config files are stored + +Description +=========== + +Smarty + +setConfigDir + +string\|array + +config\_dir + + + <?php + + // set a single directory where the config files are stored + $smarty->setConfigDir('./config'); + + // view the config dir chain + var_dump($smarty->getConfigDir()); + + // set multiple directorÃes where config files are stored + $smarty->setConfigDir(array( + 'one' => './config', + 'two' => './config_2', + 'three' => './config_3', + )); + + // view the config dir chain + var_dump($smarty->getConfigDir()); + + // chaining of method calls + $smarty->setTemplateDir('./templates') + ->setConfigDir('./config') + ->setCompileDir('./templates_c') + ->setCacheDir('./cache'); + + ?> + + + +See also [`getConfigDir()`](#api.get.config.dir), +[`addConfigDir()`](#api.add.config.dir) and +[`$config_dir`](#variable.config.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-set-plugins-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-plugins-dir.md new file mode 100644 index 000000000..25b0567b1 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-plugins-dir.md @@ -0,0 +1,46 @@ +setPluginsDir() + +set the directories where plugins are stored + +Description +=========== + +Smarty + +setPluginsDir + +string\|array + +plugins\_dir + + + <?php + + // set a single directory where the plugins are stored + $smarty->setPluginsDir('./plugins'); + + // view the plugins dir chain + var_dump($smarty->getPluginsDir()); + + // set multiple directorÃes where plugins are stored + $smarty->setPluginsDir(array( + './plugins', + './plugins_2', + )); + + // view the plugins dir chain + var_dump($smarty->getPluginsDir()); + + // chaining of method calls + $smarty->setTemplateDir('./templates') + ->setPluginsDir('./plugins') + ->setCompileDir('./templates_c') + ->setCacheDir('./cache'); + + ?> + + + +See also [`getPluginsDir()`](#api.get.plugins.dir), +[`addPluginsDir()`](#api.add.plugins.dir) and +[`$plugins_dir`](#variable.plugins.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-set-template-dir.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-template-dir.md new file mode 100644 index 000000000..2de23309b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-set-template-dir.md @@ -0,0 +1,46 @@ +setTemplateDir() + +set the directories where templates are stored + +Description +=========== + +Smarty + +setTemplateDir + +string\|array + +template\_dir + + + <?php + + // set a single directory where the templates are stored + $smarty->setTemplateDir('./cache'); + + // view the template dir chain + var_dump($smarty->getTemplateDir()); + + // set multiple directorÃes where templates are stored + $smarty->setTemplateDir(array( + 'one' => './templates', + 'two' => './templates_2', + 'three' => './templates_3', + )); + + // view the template dir chain + var_dump($smarty->getTemplateDir()); + + // chaining of method calls + $smarty->setTemplateDir('./templates') + ->setCompileDir('./templates_c') + ->setCacheDir('./cache'); + + ?> + + + +See also [`getTemplateDir()`](#api.get.template.dir), +[`addTemplateDir()`](#api.add.template.dir) and +[`$template_dir`](#variable.template.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-template-exists.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-template-exists.md new file mode 100644 index 000000000..07f61b12e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-template-exists.md @@ -0,0 +1,59 @@ +templateExists() + +checks whether the specified template exists + +Description +=========== + +bool + +templateExists + +string + +template + +It can accept either a path to the template on the filesystem or a +resource string specifying the template. + +This example uses `$_GET['page']` to +[`{include}`](#language.function.include) a content template. If the +template does not exist then an error page is displayed instead. First +the `page_container.tpl` + + + <html> + <head><title>{$title}</title></head> + <body> + {include file='page_top.tpl'} + + {* include middle content page *} + {include file=$content_template} + + {include file='page_footer.tpl'} + </body> + + + +And the php script + + + <?php + + // set the filename eg index.inc.tpl + $mid_template = $_GET['page'].'.inc.tpl'; + + if( !$smarty->templateExists($mid_template) ){ + $mid_template = 'page_not_found.tpl'; + } + $smarty->assign('content_template', $mid_template); + + $smarty->display('page_container.tpl'); + + ?> + + + +See also [`display()`](#api.display), [`fetch()`](#api.fetch), +[`{include}`](#language.function.include) and +[`{insert}`](#language.function.insert) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-test-install.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-test-install.md new file mode 100644 index 000000000..3afe5ec1d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-test-install.md @@ -0,0 +1,22 @@ +testInstall() + +checks Smarty installation + +Description +=========== + +void + +testInstall + +This function verifies that all required working folders of the Smarty +installation can be accessed. It does output a corresponding protocoll. + + + <?php + require_once('Smarty.class.php'); + $smarty = new Smarty(); + $smarty->testInstall(); + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-cacheresource.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-cacheresource.md new file mode 100644 index 000000000..d097519db --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-cacheresource.md @@ -0,0 +1,28 @@ +unregisterCacheResource() + +dynamically unregister a CacheResource plugin + +Description +=========== + +void + +unregisterCacheResource + +string + +name + +Pass in the `name` of the CacheResource. + + + <?php + + $smarty->unregisterCacheResource('mysql'); + + ?> + + + +See also [`registerCacheResource()`](#api.register.cacheresource) and +the [Custom CacheResource Implementation](#caching.custom) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-filter.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-filter.md new file mode 100644 index 000000000..44020eb40 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-filter.md @@ -0,0 +1,23 @@ +unregisterFilter() + +dynamically unregister a filter + +Description +=========== + +void + +unregisterFilter + +string + +type + +string\|array + +callback + +Use this to dynamically unregister filters. It uses the following +parameters: + +See also [`registerFilter()`](#api.register.filter). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-object.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-object.md new file mode 100644 index 000000000..c012581f9 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-object.md @@ -0,0 +1,17 @@ +unregisterObject() + +dynamically unregister an object + +Description +=========== + +void + +unregisterObject + +string + +object\_name + +See also [`registerObject()`](#api.register.object) and [objects +section](#advanced.features.objects) diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-plugin.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-plugin.md new file mode 100644 index 000000000..c692ac60f --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-plugin.md @@ -0,0 +1,36 @@ +unregisterPlugin + +dynamically unregister plugins + +Description +=========== + +void + +unregisterPlugin + +string + +type + +string + +name + +This method unregisters plugins which previously have been registered by +[registerPlugin()](#api.register.plugin), It uses the following +parameters: + +<!-- --> + + + <?php + + // we don't want template designers to have access to function plugin "date_now" + $smarty->unregisterPlugin("function","date_now"); + + ?> + + + +See also [`registerPlugin()`](#api.register.plugin). diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-resource.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-resource.md new file mode 100644 index 000000000..1a6067bd2 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-unregister-resource.md @@ -0,0 +1,28 @@ +unregisterResource() + +dynamically unregister a resource plugin + +Description +=========== + +void + +unregisterResource + +string + +name + +Pass in the `name` of the resource. + + + <?php + + $smarty->unregisterResource('db'); + + ?> + + + +See also [`registerResource()`](#api.register.resource) and [template +resources](#resources) diff --git a/vendor/smarty/smarty/docs/programmers/api-variables.md b/vendor/smarty/smarty/docs/programmers/api-variables.md new file mode 100644 index 000000000..2fcf6e217 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables.md @@ -0,0 +1,64 @@ +Smarty Class Variables {#api.variables} +====================== + +These are all of the available Smarty class variables. You can access +them directly, or use the corresponding setter/getter methods. + +- [$allow_php_templates](./api-variables/variable-allow-php-templates.md) +- [$auto_literal](./api-variables/variable-auto-literal.md) +- [$autoload_filters](./api-variables/variable-autoload-filters.md) +- [$cache_dir](./api-variables/variable-cache-dir.md) +- [$cache_id](./api-variables/variable-cache-id.md) +- [$cache_lifetime](./api-variables/variable-cache-lifetime.md) +- [$cache_locking](./api-variables/variable-cache-locking.md) +- [$cache_modified_check](./api-variables/variable-cache-modified-check.md) +- [$caching](./api-variables/variable-caching.md) +- [$caching_type](./api-variables/variable-caching-type.md) +- [$compile_check](./api-variables/variable-compile-check.md) +- [$compile_dir](./api-variables/variable-compile-dir.md) +- [$compile_id](./api-variables/variable-compile-id.md) +- [$compile_locking](./api-variables/variable-compile-locking.md) +- [$compiler_class](./api-variables/variable-compiler-class.md) +- [$config_booleanize](./api-variables/variable-config-booleanize.md) +- [$config_dir](./api-variables/variable-config-dir.md) +- [$config_overwrite](./api-variables/variable-config-overwrite.md) +- [$config_read_hidden](./api-variables/variable-config-read-hidden.md) +- [$debug_tpl](./api-variables/variable-debug-template.md) +- [$debugging](./api-variables/variable-debugging.md) +- [$debugging_ctrl](./api-variables/variable-debugging-ctrl.md) +- [$default_config_type](./api-variables/variable-default-config-type.md) +- [$default_modifiers](./api-variables/variable-default-modifiers.md) +- [$default_resource_type](./api-variables/variable-default-resource-type.md) +- [$default_config_handler_func](./api-variables/variable-default-config-handler-func.md) +- [$default_template_handler_func](./api-variables/variable-default-template-handler-func.md) +- [$direct_access_security](./api-variables/variable-direct-access-security.md) +- [$error_reporting](./api-variables/variable-error-reporting.md) +- [$escape_html](./api-variables/variable-escape-html.md) +- [$force_cache](./api-variables/variable-force-cache.md) +- [$force_compile](./api-variables/variable-force-compile.md) +- [$left_delimiter](./api-variables/variable-left-delimiter.md) +- [$locking_timeout](./api-variables/variable-locking-timeout.md) +- [$merge_compiled_includes](./api-variables/variable-merge-compiled-includes.md) +- [$php_handling](./api-variables/variable-php-handling.md) +- [$plugins_dir](./api-variables/variable-plugins-dir.md) +- [$right_delimiter](./api-variables/variable-right-delimiter.md) +- [$smarty_debug_id](./api-variables/variable-smarty-debug-id.md) +- [$template_dir](./api-variables/variable-template-dir.md) +- [$trusted_dir](./api-variables/variable-trusted-dir.md) +- [$use_include_path](./api-variables/variable-use-include-path.md) +- [$use_sub_dirs](./api-variables/variable-use-sub-dirs.md) + +> **Note** +> +> All class variables have magic setter/getter methods available. +> setter/getter methods are camelCaseFormat, unlike the variable itself. +> So for example, you can set and get the \$smarty-\>template\_dir +> variable with \$smarty-\>setTemplateDir(\$dir) and \$dir = +> \$smarty-\>getTemplateDir() respectively. + +> **Note** +> +> See +> [`Changing settings by template`](./advanced-features/advanced-features-template-settings.md) +> section for how to change Smarty class variables for individual +> templates. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-allow-php-templates.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-allow-php-templates.md new file mode 100644 index 000000000..e15520e2d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-allow-php-templates.md @@ -0,0 +1,18 @@ +\$allow\_php\_templates {#variable.allow.php.templates} +======================= + +By default the PHP template file resource is disabled. Setting +`$allow_php_templates` to TRUE will enable PHP template files. + +::: {.informalexample} + + <?php + $smarty->allow_php_templates = true; + ?> + + +::: + +> **Note** +> +> The PHP template file resource is an undocumented deprecated feature. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-auto-literal.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-auto-literal.md new file mode 100644 index 000000000..e5ddb34fc --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-auto-literal.md @@ -0,0 +1,17 @@ +\$auto\_literal {#variable.auto.literal} +=============== + +The Smarty delimiter tags { and } will be ignored so long as they are +surrounded by white space. This behavior can be disabled by setting +auto\_literal to false. + +::: {.informalexample} + + <?php + $smarty->auto_literal = false; + ?> + + +::: + +See also [Escaping Smarty Parsing](#language.escaping), diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-autoload-filters.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-autoload-filters.md new file mode 100644 index 000000000..8a300b065 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-autoload-filters.md @@ -0,0 +1,21 @@ +\$autoload\_filters {#variable.autoload.filters} +=================== + +If there are some filters that you wish to load on every template +invocation, you can specify them using this variable and Smarty will +automatically load them for you. The variable is an associative array +where keys are filter types and values are arrays of the filter names. +For example: + +::: {.informalexample} + + <?php + $smarty->autoload_filters = array('pre' => array('trim', 'stamp'), + 'output' => array('convert')); + ?> + + +::: + +See also [`registerFilter()`](#api.register.filter) and +[`loadFilter()`](#api.load.filter) diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-dir.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-dir.md new file mode 100644 index 000000000..6cb2b5559 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-dir.md @@ -0,0 +1,35 @@ +\$cache\_dir {#variable.cache.dir} +============ + +This is the name of the directory where template caches are stored. By +default this is `./cache`, meaning that Smarty will look for the +`cache/` directory in the same directory as the executing php script. +**This directory must be writeable by the web server**, [see +install](#installing.smarty.basic) for more info. + +You can also use your own [custom cache implementation](#caching.custom) +to control cache files, which will ignore this setting. See also +[`$use_sub_dirs`](#variable.use.sub.dirs). + +> **Note** +> +> This setting must be either a relative or absolute path. include\_path +> is not used for writing files. + +> **Note** +> +> It is not recommended to put this directory under the web server +> document root. + +> **Note** +> +> As of Smarty 3.1 the attribute \$cache\_dir is no longer accessible +> directly. Use [`getCacheDir()`](#api.get.cache.dir) and +> [`setCacheDir()`](#api.set.cache.dir) instead. + +See also [`getCacheDir()`](#api.get.cache.dir), +[`setCacheDir()`](#api.set.cache.dir), [`$caching`](#variable.caching), +[`$use_sub_dirs`](#variable.use.sub.dirs), +[`$cache_lifetime`](#variable.cache.lifetime), +[`$cache_modified_check`](#variable.cache.modified.check) and the +[caching section](#caching). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-id.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-id.md new file mode 100644 index 000000000..c27fae921 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-id.md @@ -0,0 +1,11 @@ +\$cache\_id {#variable.cache.id} +=========== + +Persistent cache\_id identifier. As an alternative to passing the same +`$cache_id` to each and every function call, you can set this +`$cache_id` and it will be used implicitly thereafter. + +With a `$cache_id` you can have multiple cache files for a single call +to [`display()`](#api.display) or [`fetch()`](#api.fetch) depending for +example from different content of the same template. See the [caching +section](#caching) for more information. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-lifetime.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-lifetime.md new file mode 100644 index 000000000..c9624b556 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-lifetime.md @@ -0,0 +1,30 @@ +\$cache\_lifetime {#variable.cache.lifetime} +================= + +This is the length of time in seconds that a template cache is valid. +Once this time has expired, the cache will be regenerated. + +- `$caching` must be turned on (either + Smarty::CACHING\_LIFETIME\_CURRENT or + Smarty::CACHING\_LIFETIME\_SAVED) for `$cache_lifetime` to have any + purpose. + +- A `$cache_lifetime` value of -1 will force the cache to never + expire. + +- A value of 0 will cause the cache to always regenerate (good for + testing only, to disable caching a more efficient method is to set + [`$caching`](#variable.caching) = Smarty::CACHING\_OFF). + +- If you want to give certain templates their own cache lifetime, you + could do this by setting [`$caching`](#variable.caching) = + Smarty::CACHING\_LIFETIME\_SAVED, then set `$cache_lifetime` to a + unique value just before calling [`display()`](#api.display) or + [`fetch()`](#api.fetch). + +If [`$force_compile`](#variable.force.compile) is enabled, the cache +files will be regenerated every time, effectively disabling caching. You +can clear all the cache files with the +[`clear_all_cache()`](#api.clear.all.cache) function, or individual +cache files (or groups) with the [`clear_cache()`](#api.clear.cache) +function. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-locking.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-locking.md new file mode 100644 index 000000000..6dca30c7b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-locking.md @@ -0,0 +1,11 @@ +\$cache\_locking {#variable.cache.locking} +================ + +Cache locking avoids concurrent cache generation. This means resource +intensive pages can be generated only once, even if they\'ve been +requested multiple times in the same moment. + +Cache locking is disabled by default. To enable it set `$cache_locking` +to TRUE. + +See also [`$locking_timeout`](#variable.locking.timeout) diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-modified-check.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-modified-check.md new file mode 100644 index 000000000..05e00bb91 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-cache-modified-check.md @@ -0,0 +1,12 @@ +\$cache\_modified\_check {#variable.cache.modified.check} +======================== + +If set to TRUE, Smarty will respect the If-Modified-Since header sent +from the client. If the cached file timestamp has not changed since the +last visit, then a `'304: Not Modified'` header will be sent instead of +the content. This works only on cached content without +[`{insert}`](#language.function.insert) tags. + +See also [`$caching`](#variable.caching), +[`$cache_lifetime`](#variable.cache.lifetime), and the [caching +section](#caching). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-caching-type.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-caching-type.md new file mode 100644 index 000000000..22b88cf6a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-caching-type.md @@ -0,0 +1,9 @@ +\$caching\_type {#variable.caching.type} +=============== + +This property specifies the name of the caching handler to use. It +defaults to `file`, enabling the internal filesystem based cache +handler. + +See [Custom Cache Implementation](#caching.custom) for pointers on +setting up your own cache handler. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-caching.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-caching.md new file mode 100644 index 000000000..9377e3b6d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-caching.md @@ -0,0 +1,38 @@ +\$caching {#variable.caching} +========= + +This tells Smarty whether or not to cache the output of the templates to +the [`$cache_dir`](#variable.cache.dir). By default this is set to the +constant Smarty::CACHING\_OFF. If your templates consistently generate +the same content, it is advisable to turn on `$caching`, as this may +result in significant performance gains. + +You can also have [multiple](#caching.multiple.caches) caches for the +same template. + +- A constant value of Smarty::CACHING\_LIFETIME\_CURRENT or + Smarty::CACHING\_LIFETIME\_SAVED enables caching. + +- A value of Smarty::CACHING\_LIFETIME\_CURRENT tells Smarty to use + the current [`$cache_lifetime`](#variable.cache.lifetime) variable + to determine if the cache has expired. + +- A value of Smarty::CACHING\_LIFETIME\_SAVED tells Smarty to use the + [`$cache_lifetime`](#variable.cache.lifetime) value at the time the + cache was generated. This way you can set the + [`$cache_lifetime`](#variable.cache.lifetime) just before + [fetching](#api.fetch) the template to have granular control over + when that particular cache expires. See also + [`isCached()`](#api.is.cached). + +- If [`$compile_check`](#variable.compile.check) is enabled, the + cached content will be regenerated if any of the templates or config + files that are part of this cache are changed. + +- If [`$force_compile`](#variable.force.compile) is enabled, the + cached content will always be regenerated. + +See also [`$cache_dir`](#variable.cache.dir), +[`$cache_lifetime`](#variable.cache.lifetime), +[`$cache_modified_check`](#variable.cache.modified.check), +[`is_cached()`](#api.is.cached) and the [caching section](#caching). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-check.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-check.md new file mode 100644 index 000000000..c0582d4d4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-check.md @@ -0,0 +1,27 @@ +\$compile\_check {#variable.compile.check} +================ + +Upon each invocation of the PHP application, Smarty tests to see if the +current template has changed (different timestamp) since the last time +it was compiled. If it has changed, it recompiles that template. If the +template has yet not been compiled at all, it will compile regardless of +this setting. By default this variable is set to TRUE. + +Once an application is put into production (ie the templates won\'t be +changing), the compile check step is no longer needed. Be sure to set +`$compile_check` to FALSE for maximum performance. Note that if you +change this to FALSE and a template file is changed, you will \*not\* +see the change since the template will not get recompiled. + +If [`$caching`](#variable.caching) is enabled and `$compile_check` is +enabled, then the cache files will get regenerated if an involved +template file or config file was updated. + +As of Smarty 3.1 `$compile_check` can be set to the value +`Smarty::COMPILECHECK_CACHEMISS`. This enables Smarty to revalidate the +compiled template, once a cache file is regenerated. So if there was a +cached template, but it\'s expired, Smarty will run a single +compile\_check before regenerating the cache. + +See [`$force_compile`](#variable.force.compile) and +[`clearCompiledTemplate()`](#api.clear.compiled.tpl). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-dir.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-dir.md new file mode 100644 index 000000000..c18c9acba --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-dir.md @@ -0,0 +1,29 @@ +\$compile\_dir {#variable.compile.dir} +============== + +This is the name of the directory where compiled templates are located. +By default this is `./templates_c`, meaning that Smarty will look for +the `templates_c/` directory in the same directory as the executing php +script. **This directory must be writeable by the web server**, [see +install](#installing.smarty.basic) for more info. + +> **Note** +> +> This setting must be either a relative or absolute path. include\_path +> is not used for writing files. + +> **Note** +> +> It is not recommended to put this directory under the web server +> document root. + +> **Note** +> +> As of Smarty 3.1 the attribute \$compile\_dir is no longer accessible +> directly. Use [`getCompileDir()`](#api.get.compile.dir) and +> [`setCompileDir()`](#api.set.compile.dir) instead. + +See also [`getCompileDir()`](#api.get.compile.dir), +[`setCompileDir()`](#api.set.compile.dir), +[`$compile_id`](#variable.compile.id) and +[`$use_sub_dirs`](#variable.use.sub.dirs). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-id.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-id.md new file mode 100644 index 000000000..c63f75ab9 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-id.md @@ -0,0 +1,44 @@ +\$compile\_id {#variable.compile.id} +============= + +Persistant compile identifier. As an alternative to passing the same +`$compile_id` to each and every function call, you can set this +`$compile_id` and it will be used implicitly thereafter. + +If you use the same template with different [pre- and/or +post-filters](#plugins.prefilters.postfilters) you must use a unique +`$compile_id` to keep the compiled template files separated. + +For example a [prefilter](#plugins.prefilters.postfilters) that +localizes your templates (that is: translates language dependend parts) +at compile time, then you could use the current language as +`$compile_id` and you will get a set of compiled templates for each +language you use. + + + <?php + $smarty->compile_id = 'en'; + ?> + + + +Another application would be to use the same compile directory across +multiple domains / multiple virtual hosts. + + + <?php + + $smarty->compile_id = $_SERVER['SERVER_NAME']; + $smarty->compile_dir = '/path/to/shared_compile_dir'; + + ?> + + + +> **Note** +> +> In Smarty 3 a `$compile_id` is no longer required to keep templates +> with same name in different [`$template_dir` +> folders](#variable.template.dir) separated. The [`$template_dir` file +> path](#variable.template.dir) is encoded in the file name of compiled +> and cached template files. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-locking.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-locking.md new file mode 100644 index 000000000..ff7a66f3a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compile-locking.md @@ -0,0 +1,7 @@ +\$compile\_locking {#variable.compile.locking} +================== + +Compile locking avoids concurrent compilation of the same template. + +Compile locking is enabled by default. To disable it set +`$compile_locking` to FALSE. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-compiler-class.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compiler-class.md new file mode 100644 index 000000000..32ea982d6 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-compiler-class.md @@ -0,0 +1,6 @@ +\$compiler\_class {#variable.compiler.class} +================= + +Specifies the name of the compiler class that Smarty will use to compile +the templates. The default is \'Smarty\_Compiler\'. For advanced users +only. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-booleanize.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-booleanize.md new file mode 100644 index 000000000..4ba555f84 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-booleanize.md @@ -0,0 +1,8 @@ +\$config\_booleanize {#variable.config.booleanize} +==================== + +If set to TRUE, [config files](#config.files) values of `on/true/yes` +and `off/false/no` get converted to boolean values automatically. This +way you can use the values in the template like so: +`{if #foobar#}...{/if}`. If foobar was `on`, `true` or `yes`, the `{if}` +statement will execute. Defaults to TRUE. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-dir.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-dir.md new file mode 100644 index 000000000..d73f3274f --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-dir.md @@ -0,0 +1,23 @@ +\$config\_dir {#variable.config.dir} +============= + +This is the directory used to store [config files](#config.files) used +in the templates. Default is `./configs`, meaning that Smarty will look +for the `configs/` directory in the same directory as the executing php +script. + +> **Note** +> +> It is not recommended to put this directory under the web server +> document root. + +> **Note** +> +> As of Smarty 3.1 the attribute \$config\_dir is no longer accessible +> directly. Use [`getConfigDir()`](#api.get.config.dir), +> [`setConfigDir()`](#api.set.config.dir) and +> [`addConfigDir()`](#api.add.config.dir) instead. + +See also [`getConfigDir()`](#api.get.config.dir), +[`setConfigDir()`](#api.set.config.dir) and +[`addConfigDir()`](#api.add.config.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-overwrite.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-overwrite.md new file mode 100644 index 000000000..0b8968374 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-overwrite.md @@ -0,0 +1,40 @@ +\$config\_overwrite {#variable.config.overwrite} +=================== + +If set to TRUE, the default then variables read in from [config +files](#config.files) will overwrite each other. Otherwise, the +variables will be pushed onto an array. This is helpful if you want to +store arrays of data in config files, just list each element multiple +times. + +This examples uses [`{cycle}`](#language.function.cycle) to output a +table with alternating red/green/blue row colors with +`$config_overwrite` = FALSE. + +The config file. + + + # row colors + rowColors = #FF0000 + rowColors = #00FF00 + rowColors = #0000FF + + + +The template with a [`{section}`](#language.function.section) loop. + + + <table> + {section name=r loop=$rows} + <tr bgcolor="{cycle values=#rowColors#}"> + <td> ....etc.... </td> + </tr> + {/section} + </table> + + + +See also [`{config_load}`](#language.function.config.load), +[`getConfigVars()`](#api.get.config.vars), +[`clearConfig()`](#api.clear.config), [`configLoad()`](#api.config.load) +and the [config files section](#config.files). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-read-hidden.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-read-hidden.md new file mode 100644 index 000000000..19cde68bd --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-config-read-hidden.md @@ -0,0 +1,8 @@ +\$config\_read\_hidden {#variable.config.read.hidden} +====================== + +If set to TRUE, hidden sections ie section names beginning with a +period(.) in [config files](#config.files) can be read from templates. +Typically you would leave this FALSE, that way you can store sensitive +data in the config files such as database parameters and not worry about +the template loading them. FALSE by default. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-debug-template.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-debug-template.md new file mode 100644 index 000000000..faec0e171 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-debug-template.md @@ -0,0 +1,9 @@ +\$debug\_tpl {#variable.debug_template} +============ + +This is the name of the template file used for the debugging console. By +default, it is named `debug.tpl` and is located in the +[`SMARTY_DIR`](#constant.smarty.dir). + +See also [`$debugging`](#variable.debugging) and the [debugging +console](#chapter.debugging.console) section. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-debugging-ctrl.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-debugging-ctrl.md new file mode 100644 index 000000000..a9355c0a2 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-debugging-ctrl.md @@ -0,0 +1,20 @@ +\$debugging\_ctrl {#variable.debugging.ctrl} +================= + +This allows alternate ways to enable debugging. `NONE` means no +alternate methods are allowed. `URL` means when the keyword +`SMARTY_DEBUG` is found in the `QUERY_STRING`, debugging is enabled for +that invocation of the script. If [`$debugging`](#variable.debugging) is +TRUE, this value is ignored. + + + <?php + // shows debug console only on localhost ie + // http://localhost/script.php?foo=bar&SMARTY_DEBUG + $smarty->debugging = false; // the default + $smarty->debugging_ctrl = ($_SERVER['SERVER_NAME'] == 'localhost') ? 'URL' : 'NONE'; + ?> + +See also [debugging console](#chapter.debugging.console) section, +[`$debugging`](#variable.debugging) and +[`$smarty_debug_id`](#variable.smarty.debug.id). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-debugging.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-debugging.md new file mode 100644 index 000000000..4473e0c8d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-debugging.md @@ -0,0 +1,17 @@ +\$debugging {#variable.debugging} +=========== + +This enables the [debugging console](#chapter.debugging.console). The +console is a javascript popup window that informs you of the +[included](#language.function.include) templates, variables +[assigned](#api.assign) from php and [config file +variables](#language.config.variables) for the current script. It does +not show variables assigned within a template with the +[`{assign}`](#language.function.assign) function. + +The console can also be enabled from the url with +[`$debugging_ctrl`](#variable.debugging.ctrl). + +See also [`{debug}`](#language.function.debug), +[`$debug_tpl`](#variable.debug_template), and +[`$debugging_ctrl`](#variable.debugging.ctrl). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-config-handler-func.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-config-handler-func.md new file mode 100644 index 000000000..0d6ec5e0d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-config-handler-func.md @@ -0,0 +1,50 @@ +\$default\_config\_handler\_func {#variable.default.config.handler.func} +================================ + +This function is called when a config file cannot be obtained from its +resource. + +> **Note** +> +> The default handler is currently only invoked for file resources. It +> is not triggered when the resource itself cannot be found, in which +> case a SmartyException is thrown. + + + <?php + + $smarty = new Smarty(); + $smarty->default_config_handler_func = 'my_default_config_handler_func'; + + /** + * Default Config Handler + * + * called when Smarty's file: resource is unable to load a requested file + * + * @param string $type resource type (e.g. "file", "string", "eval", "resource") + * @param string $name resource name (e.g. "foo/bar.tpl") + * @param string &$content config's content + * @param integer &$modified config's modification time + * @param Smarty $smarty Smarty instance + * @return string|boolean path to file or boolean true if $content and $modified + * have been filled, boolean false if no default config + * could be loaded + */ + function my_default_config_handler_func($type, $name, &$content, &$modified, Smarty $smarty) { + if (false) { + // return corrected filepath + return "/tmp/some/foobar.tpl"; + } elseif (false) { + // return a config directly + $content = 'someVar = "the config source"'; + $modified = time(); + return true; + } else { + // tell smarty that we failed + return false; + } + } + + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-config-type.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-config-type.md new file mode 100644 index 000000000..60bf9f1ea --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-config-type.md @@ -0,0 +1,7 @@ +\$default\_config\_type {#variable.default.config.type} +======================= + +This tells smarty what resource type to use for config files. The +default value is `file`, meaning that `$smarty->configLoad('test.conf')` +and `$smarty->configLoad('file:test.conf')` are identical in meaning. +See the [resource](#resources) chapter for more details. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-modifiers.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-modifiers.md new file mode 100644 index 000000000..c6b73eb12 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-modifiers.md @@ -0,0 +1,8 @@ +\$default\_modifiers {#variable.default.modifiers} +==================== + +This is an array of modifiers to implicitly apply to every variable in a +template. For example, to HTML-escape every variable by default, use +`array('escape:"htmlall"')`. To make a variable exempt from default +modifiers, add the \'nofilter\' attribute to the output tag such as +`{$var nofilter}`. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-resource-type.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-resource-type.md new file mode 100644 index 000000000..e8a803178 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-resource-type.md @@ -0,0 +1,7 @@ +\$default\_resource\_type {#variable.default.resource.type} +========================= + +This tells smarty what resource type to use implicitly. The default +value is `file`, meaning that `$smarty->display('index.tpl')` and +`$smarty->display('file:index.tpl')` are identical in meaning. See the +[resource](#resources) chapter for more details. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-template-handler-func.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-template-handler-func.md new file mode 100644 index 000000000..d8fcbb1ad --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-default-template-handler-func.md @@ -0,0 +1,50 @@ +\$default\_template\_handler\_func {#variable.default.template.handler.func} +================================== + +This function is called when a template cannot be obtained from its +resource. + +> **Note** +> +> The default handler is currently only invoked for file resources. It +> is not triggered when the resource itself cannot be found, in which +> case a SmartyException is thrown. + + + <?php + + $smarty = new Smarty(); + $smarty->default_template_handler_func = 'my_default_template_handler_func'; + + /** + * Default Template Handler + * + * called when Smarty's file: resource is unable to load a requested file + * + * @param string $type resource type (e.g. "file", "string", "eval", "resource") + * @param string $name resource name (e.g. "foo/bar.tpl") + * @param string &$content template's content + * @param integer &$modified template's modification time + * @param Smarty $smarty Smarty instance + * @return string|boolean path to file or boolean true if $content and $modified + * have been filled, boolean false if no default template + * could be loaded + */ + function my_default_template_handler_func($type, $name, &$content, &$modified, Smarty $smarty) { + if (false) { + // return corrected filepath + return "/tmp/some/foobar.tpl"; + } elseif (false) { + // return a template directly + $content = "the template source"; + $modified = time(); + return true; + } else { + // tell smarty that we failed + return false; + } + } + + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-direct-access-security.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-direct-access-security.md new file mode 100644 index 000000000..f471f5de0 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-direct-access-security.md @@ -0,0 +1,13 @@ +\$direct\_access\_security {#variable.direct.access.security} +========================== + +Direct access security inhibits direct browser access to compiled or +cached template files. + +Direct access security is enabled by default. To disable it set +`$direct_access_security` to FALSE. + +> **Note** +> +> This is a compile time option. If you change the setting you must make +> sure that the templates get recompiled. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-error-reporting.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-error-reporting.md new file mode 100644 index 000000000..eec7894da --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-error-reporting.md @@ -0,0 +1,17 @@ +\$error\_reporting {#variable.error.reporting} +================== + +When this value is set to a non-null-value it\'s value is used as php\'s +[`error_reporting`](&url.php-manual;error_reporting) level inside of +[`display()`](#api.display) and [`fetch()`](#api.fetch). + +Smarty 3.1.2 introduced the +[`muteExpectedErrors()`](#api.mute.expected.errors) function. Calling +`Smarty::muteExpectedErrors();` after setting up custom error handling +will ensure that warnings and notices (deliberately) produced by Smarty +will not be passed to other custom error handlers. If your error logs +are filling up with warnings regarding `filemtime()` or `unlink()` +calls, please enable Smarty\'s error muting. + +See also [debugging](#chapter.debugging.console) and +[troubleshooting](#troubleshooting). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-escape-html.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-escape-html.md new file mode 100644 index 000000000..39ff28027 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-escape-html.md @@ -0,0 +1,21 @@ +\$escape\_html {#variable.escape.html} +============== + +Setting `$escape_html` to TRUE will escape all template variable output +by wrapping it in +`htmlspecialchars({$output}, ENT_QUOTES, SMARTY_RESOURCE_CHAR_SET);`, +which is the same as `{$variable|escape:"html"}`. + +Template designers can choose to selectively disable this feature by +adding the `nofilter` flag: `{$variable nofilter}`. + +Modifiers and Filters are run in the following order: modifier, +default\_modifier, \$escape\_html, registered variable filters, +autoloaded variable filters, template instance\'s variable filters. +Everything except the individual modifier can be disabled with the +`nofilter` flag. + +> **Note** +> +> This is a compile time option. If you change the setting you must make +> sure that the templates get recompiled. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-force-cache.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-force-cache.md new file mode 100644 index 000000000..de0c0c15a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-force-cache.md @@ -0,0 +1,6 @@ +\$force\_cache {#variable.force.cache} +============== + +This forces Smarty to (re)cache templates on every invocation. It does +not override the [`$caching`](#variable.caching) level, but merely +pretends the template has never been cached before. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-force-compile.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-force-compile.md new file mode 100644 index 000000000..73f1e792d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-force-compile.md @@ -0,0 +1,9 @@ +\$force\_compile {#variable.force.compile} +================ + +This forces Smarty to (re)compile templates on every invocation. This +setting overrides [`$compile_check`](#variable.compile.check). By +default this is FALSE. This is handy for development and +[debugging](#chapter.debugging.console). It should never be used in a +production environment. If [`$caching`](#variable.caching) is enabled, +the cache file(s) will be regenerated every time. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-left-delimiter.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-left-delimiter.md new file mode 100644 index 000000000..bcc13f0e5 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-left-delimiter.md @@ -0,0 +1,8 @@ +\$left\_delimiter {#variable.left.delimiter} +================= + +This is the left delimiter used by the template language. Default is +`{`. + +See also [`$right_delimiter`](#variable.right.delimiter) and [escaping +smarty parsing](#language.escaping) . diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-locking-timeout.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-locking-timeout.md new file mode 100644 index 000000000..fdfdc087e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-locking-timeout.md @@ -0,0 +1,7 @@ +\$locking\_timeout {#variable.locking.timeout} +================== + +This is maximum time in seconds a cache lock is valid to avoid dead +locks. The deafult value is 10 seconds. + +See also [`$cache_locking`](#variable.cache.locking) diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-merge-compiled-includes.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-merge-compiled-includes.md new file mode 100644 index 000000000..8220c442b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-merge-compiled-includes.md @@ -0,0 +1,27 @@ +\$merge\_compiled\_includes {#variable.merge.compiled.includes} +=========================== + +By setting `$merge_compiled_includes` to TRUE Smarty will merge the +compiled template code of subtemplates into the compiled code of the +main template. This increases rendering speed of templates using a many +different sub-templates. + +Individual sub-templates can be merged by setting the `inline` option +flag within the `{include}` tag. `$merge_compiled_includes` does not +have to be enabled for the `inline` merge. + +::: {.informalexample} + + <?php + $smarty->merge_compiled_includes = true; + ?> + + +::: + +> **Note** +> +> This is a compile time option. If you change the setting you must make +> sure that the templates get recompiled. + +See also [`{include}`](#language.function.include) tag diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-php-handling.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-php-handling.md new file mode 100644 index 000000000..574ea6d55 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-php-handling.md @@ -0,0 +1,21 @@ +\$php\_handling {#variable.php.handling} +=============== + +This tells Smarty how to handle PHP code embedded in the templates. +There are four possible settings, the default being +`Smarty::PHP_PASSTHRU`. Note that this does NOT affect php code within +[`{php}{/php}`](#language.function.php) tags in the template. + +- `Smarty::PHP_PASSTHRU` - Smarty echos tags as-is. + +- `Smarty::PHP_QUOTE` - Smarty quotes the tags as html entities. + +- `Smarty::PHP_REMOVE` - Smarty removes the tags from the templates. + +- `Smarty::PHP_ALLOW` - Smarty will execute the tags as PHP code. + +> **Note** +> +> Embedding PHP code into templates is highly discouraged. Use [custom +> functions](#plugins.functions) or [modifiers](#plugins.modifiers) +> instead. diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-plugins-dir.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-plugins-dir.md new file mode 100644 index 000000000..8a7cfcdb2 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-plugins-dir.md @@ -0,0 +1,28 @@ +\$plugins\_dir {#variable.plugins.dir} +============== + +This is the directory or directories where Smarty will look for the +plugins that it needs. Default is `plugins/` under the +[`SMARTY_DIR`](#constant.smarty.dir). If you supply a relative path, +Smarty will first look under the [`SMARTY_DIR`](#constant.smarty.dir), +then relative to the current working directory, then relative to the PHP +include\_path. If `$plugins_dir` is an array of directories, Smarty will +search for your plugin in each plugin directory **in the order they are +given**. + +> **Note** +> +> For best performance, do not setup your `$plugins_dir` to have to use +> the PHP include path. Use an absolute pathname, or a path relative to +> `SMARTY_DIR` or the current working directory. + +> **Note** +> +> As of Smarty 3.1 the attribute \$plugins\_dir is no longer accessible +> directly. Use [`getPluginsDir()`](#api.get.plugins.dir), +> [`setPluginsDir()`](#api.set.plugins.dir) and +> [`addPluginsDir()`](#api.add.plugins.dir) instead. + +See also [`getPluginsDir()`](#api.get.plugins.dir), +[`setPluginsDir()`](#api.set.plugins.dir) and +[`addPluginsDir()`](#api.add.plugins.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-right-delimiter.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-right-delimiter.md new file mode 100644 index 000000000..14a9b568e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-right-delimiter.md @@ -0,0 +1,8 @@ +\$right\_delimiter {#variable.right.delimiter} +================== + +This is the right delimiter used by the template language. Default is +`}`. + +See also [`$left_delimiter`](#variable.left.delimiter) and [escaping +smarty parsing](#language.escaping). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-smarty-debug-id.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-smarty-debug-id.md new file mode 100644 index 000000000..0733ed518 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-smarty-debug-id.md @@ -0,0 +1,9 @@ +\$smarty\_debug\_id {#variable.smarty.debug.id} +=================== + +The value of `$smarty_debug_id` defines the URL keyword to enable +debugging at browser level. The default value is `SMARTY_DEBUG`. + +See also [debugging console](#chapter.debugging.console) section, +[`$debugging`](#variable.debugging) and +[`$debugging_ctrl`](#variable.debugging.ctrl). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-template-dir.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-template-dir.md new file mode 100644 index 000000000..e49578b1b --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-template-dir.md @@ -0,0 +1,36 @@ +\$template\_dir {#variable.template.dir} +=============== + +This is the name of the default template directory. If you do not supply +a resource type when including files, they will be found here. By +default this is `./templates`, meaning that Smarty will look for the +`templates/` directory in the same directory as the executing php +script. \$template\_dir can also be an array of directory paths: Smarty +will traverse the directories and stop on the first matching template +found. + +> **Note** +> +> It is not recommended to put this directory under the web server +> document root. + +> **Note** +> +> If the directories known to `$template_dir` are relative to +> directories known to the +> [include\_path](&url.php-manual;ini.core.php#ini.include-path) you +> need to activate the [`$use_include_path`](#variable.use.include.path) +> option. + +> **Note** +> +> As of Smarty 3.1 the attribute \$template\_dir is no longer accessible +> directly. Use [`getTemplateDir()`](#api.get.template.dir), +> [`setTemplateDir()`](#api.set.template.dir) and +> [`addTemplateDir()`](#api.add.template.dir) instead. + +See also [`Template Resources`](#resources), +[`$use_include_path`](#variable.use.include.path), +[`getTemplateDir()`](#api.get.template.dir), +[`setTemplateDir()`](#api.set.template.dir) and +[`addTemplateDir()`](#api.add.template.dir). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-trusted-dir.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-trusted-dir.md new file mode 100644 index 000000000..3d1a308fa --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-trusted-dir.md @@ -0,0 +1,8 @@ +\$trusted\_dir {#variable.trusted.dir} +============== + +`$trusted_dir` is only for use when security is enabled. This is an +array of all directories that are considered trusted. Trusted +directories are where you keep php scripts that are executed directly +from the templates with +[`{include_php}`](#language.function.include.php). diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-use-include-path.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-use-include-path.md new file mode 100644 index 000000000..103a9767d --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-use-include-path.md @@ -0,0 +1,49 @@ +\$use\_include\_path {#variable.use.include.path} +==================== + +This tells smarty to respect the +[include\_path](&url.php-manual;ini.core.php#ini.include-path) within +the [`File Template Resource`](#resources.file) handler and the plugin +loader to resolve the directories known to +[`$template_dir`](#variable.template.dir). The flag also makes the +plugin loader check the include\_path for +[`$plugins_dir`](#variable.plugins.dir). + +> **Note** +> +> You should not design your applications to rely on the include\_path, +> as this may - depending on your implementation - slow down your system +> (and Smarty) considerably. + +If use\_include\_path is enabled, file discovery for +[`$template_dir`](#variable.template.dir) and +[`$plugins_dir`](#variable.plugins.dir) work as follows. + +- For each element `$directory` in array (\$template\_dir or + \$plugins\_dir) do + +- Test if requested file is in `$directory` relative to the [current + working directory](&url.php-manual;function.getcwd.php). If file + found, return it. + +- For each `$path` in include\_path do + +- Test if requested file is in `$directory` relative to the `$path` + (possibly relative to the [current working + directory](&url.php-manual;function.getcwd.php)). If file found, + return it. + +- Try default\_handler or fail. + +This means that whenever a directory/file relative to the current +working directory is encountered, it is preferred over anything +potentially accessible through the include\_path. + +> **Note** +> +> Smarty does not filter elements of the include\_path. That means a +> \".:\" within your include path will trigger the current working +> directory lookup twice. + +See also [`Template Resources`](#resources) and +[`$template_dir`](#variable.template.dir) diff --git a/vendor/smarty/smarty/docs/programmers/api-variables/variable-use-sub-dirs.md b/vendor/smarty/smarty/docs/programmers/api-variables/variable-use-sub-dirs.md new file mode 100644 index 000000000..a95ac4159 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-variables/variable-use-sub-dirs.md @@ -0,0 +1,31 @@ +\$use\_sub\_dirs {#variable.use.sub.dirs} +================ + +Smarty will create subdirectories under the [compiled +templates](#variable.compile.dir) and [cache](#variable.cache.dir) +directories if `$use_sub_dirs` is set to TRUE, default is FALSE. In an +environment where there are potentially tens of thousands of files +created, this may help the filesystem speed. On the other hand, some +environments do not allow PHP processes to create directories, so this +must be disabled which is the default. + +Sub directories are more efficient, so use them if you can. +Theoretically you get much better perfomance on a filesystem with 10 +directories each having 100 files, than with 1 directory having 1000 +files. This was certainly the case with Solaris 7 (UFS)\... with newer +filesystems such as ext3 and especially reiserfs, the difference is +almost nothing. + +> **Note** +> +> - `$use_sub_dirs=true` doesn\'t work with +> [safe\_mode=On](&url.php-manual;features.safe-mode), that\'s why +> it\'s switchable and why it\'s off by default. +> +> - `$use_sub_dirs=true` on Windows can cause problems. +> +> - Safe\_mode is being deprecated in PHP6. +> +See also [`$compile_id`](#variable.compile.id), +[`$cache_dir`](#variable.cache.dir), and +[`$compile_dir`](#variable.compile.dir). diff --git a/vendor/smarty/smarty/docs/programmers/caching.md b/vendor/smarty/smarty/docs/programmers/caching.md new file mode 100644 index 000000000..5656b71b5 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/caching.md @@ -0,0 +1,24 @@ +Caching +======= + +Caching is used to speed up a call to [`display()`](./api-functions/api-display.md) or +[`fetch()`](./api-functions/api-fetch.md) by saving its output to a file. If a cached +version of the call is available, that is displayed instead of +regenerating the output. Caching can speed things up tremendously, +especially templates with longer computation times. Since the output of +[`display()`](./api-functions/api-display.md) or [`fetch()`](./api-functions/api-fetch.md) is cached, one +cache file could conceivably be made up of several template files, +config files, etc. + +Since templates are dynamic, it is important to be careful what you are +caching and for how long. For instance, if you are displaying the front +page of your website that does not change its content very often, it +might work well to cache this page for an hour or more. On the other +hand, if you are displaying a page with a timetable containing new +information by the minute, it would not make sense to cache this page. + +## Table of contents +- [Setting Up Caching](./caching/caching-setting-up.md) +- [Multiple Caches Per Page](./caching/caching-multiple-caches.md) +- [Controlling Cacheability of Output](./caching/caching-groups.md) +- [Custom Cache Implementation](./caching/caching-custom.md) diff --git a/vendor/smarty/smarty/docs/programmers/caching/caching-cacheable.md b/vendor/smarty/smarty/docs/programmers/caching/caching-cacheable.md new file mode 100644 index 000000000..ee9b60090 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/caching/caching-cacheable.md @@ -0,0 +1,176 @@ +Controlling Cacheability of Output {#caching.cacheable} +================================== + +If caching is enabled normally the whole final output of the page gets +cached. However Smarty3 offers several options how to exclude sections +of your output from caching. + +> **Note** +> +> Be sure any variables used within a non-cached section are also +> assigned from PHP when the page is loaded from the cache. + +Cacheability of Template Section {#cacheability.sections} +-------------------------------- + +A larger section of your template can easily excluded from caching by +using the [`{nocache}`](#language.function.nocache) and +[`{/nocache}`](#language.function.nocache) tags. + + + + Today's date is + {nocache} + {$smarty.now|date_format} + {/nocache} + + + +The above code will output the current date on a cached page. + +Cacheability of Tags {#cacheability.tags} +-------------------- + +Caching for an individual tag can be disabled by adding the \"nocache\" +option flag to the tag. + + + Today's date is + {$smarty.now|date_format nocache} + + + +Cacheability of Variables {#cacheability.variables} +------------------------- + +You can [`assign()`](#api.assign) variables as not cachable. Any tag +which uses such variable will be automatically executed in nocache mode. + +> **Note** +> +> If a tag is executed in nocache mode you must make sure that all other +> variables used by that tag are also assigned from PHP when the page is +> loaded from the cache. + +> **Note** +> +> The nocache status of an assigned variable will effect the compiled +> template code. If you change the status you must manually delete +> existing compiled and cached template files to force a recompile. + + + // assign $foo as nocahe variable + $smarty->assign('foo',time(),true); + + + Dynamic time value is {$foo} + + + +Cacheability of Plugins {#cacheability.plugins} +----------------------- + +The cacheability of plugins can be declared when registering them. The +third parameter to [`registerPlugin()`](#api.register.plugin) is called +`$cacheable` and defaults to TRUE. + +When registering a plugin with `$cacheable=false` the plugin is called +everytime the page is displayed, even if the page comes from the cache. +The plugin function behaves a little like an +[`{insert}`](#plugins.inserts) function. + +> **Note** +> +> The `$cacheable` status will effect the compiled template code. If you +> change the status you must manually delete existing compiled and +> cached template files to force a recompile. + +In contrast to [`{insert}`](#plugins.inserts) the attributes to the +plugins are not cached by default. They can be declared to be cached +with the fourth parameter `$cache_attrs`. `$cache_attrs` is an array of +attribute-names that should be cached, so the plugin-function get value +as it was the time the page was written to cache everytime it is fetched +from the cache. + + + <?php + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + function remaining_seconds($params, $smarty) { + $remain = $params['endtime'] - time(); + if($remain >= 0){ + return $remain . ' second(s)'; + }else{ + return 'done'; + } + } + + $smarty->registerPlugin('function','remaining', 'remaining_seconds', false, array('endtime')); + + if (!$smarty->isCached('index.tpl')) { + // fetch $obj from db and assign... + $smarty->assignByRef('obj', $obj); + } + + $smarty->display('index.tpl'); + ?> + + + +where `index.tpl` is: + + + Time Remaining: {remaining endtime=$obj->endtime} + + + +The number of seconds till the endtime of `$obj` is reached changes on +each display of the page, even if the page is cached. Since the endtime +attribute is cached the object only has to be pulled from the database +when page is written to the cache but not on subsequent requests of the +page. + + + index.php: + + <?php + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + function smarty_block_dynamic($param, $content, $smarty) { + return $content; + } + $smarty->registerPlugin('block','dynamic', 'smarty_block_dynamic', false); + + $smarty->display('index.tpl'); + ?> + + + +where `index.tpl` is: + + + Page created: {'0'|date_format:'%D %H:%M:%S'} + + {dynamic} + + Now is: {'0'|date_format:'%D %H:%M:%S'} + + ... do other stuff ... + + {/dynamic} + + + +When reloading the page you will notice that both dates differ. One is +"dynamic" one is "static". You can do everything between +`{dynamic}...{/dynamic}` and be sure it will not be cached like the rest +of the page. + +> **Note** +> +> The above example shall just demonstrate how a dynamic block plugins +> works. See +> [`Cacheability of Template Section`](#cacheability.sections) on how to +> disable caching of a template section by the built-in +> [`{nocache}`](#language.function.nocache) and +> [`{/nocache}`](#language.function.nocache) tags. diff --git a/vendor/smarty/smarty/docs/programmers/caching/caching-custom.md b/vendor/smarty/smarty/docs/programmers/caching/caching-custom.md new file mode 100644 index 000000000..77d2ce7b3 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/caching/caching-custom.md @@ -0,0 +1,296 @@ +Custom Cache Implementation {#caching.custom} +=========================== + +As an alternative to using the default file-based caching mechanism, you +can specify a custom cache implementation that will be used to read, +write and clear cached files. + +> **Note** +> +> In Smarty2 this used to be a callback function called +> `$cache_handler_func`. Smarty3 replaced this callback by the +> `Smarty_CacheResource` module. + +With a custom cache implementation you\'re likely trying to achieve at +least one of the following goals: replace the slow filesystem by a +faster storage engine, centralize the cache to be accessible to multiple +servers. + +Smarty allows CacheResource implementations to use one of the APIs +`Smarty_CacheResource_Custom` or `Smarty_CacheResource_KeyValueStore`. +`Smarty_CacheResource_Custom` is a simple API directing all read, write, +clear calls to your implementation. This API allows you to store +wherever and however you deem fit. The +`Smarty_CacheResource_KeyValueStore` API allows you to turn any \"dumb\" +KeyValue-Store (like APC, Memcache, ...) into a full-featured +CacheResource implementation. That is, everything around deep +cache-groups like \"a\|b\|c\" is being handled for you in way that +allows clearing the cache-group \"a\" and all nested groups are cleared +as well - even though KeyValue-Stores don\'t allow this kind of +hierarchy by nature. + +Custom CacheResources may be put in a file `cacheresource.foobarxyz.php` +within your [`$plugins_dir`](#variable.plugins.dir), or registered on +runtime with [`registerCacheResource()`](#api.register.cacheresource). +In either case you need to set [`$caching_type`](#variable.caching.type) +to invoke your custom CacheResource implementation. + + + <?php + + require_once 'libs/Smarty.class.php'; + $smarty = new Smarty(); + $smarty->caching_type = 'mysql'; + + /** + * MySQL CacheResource + * + * CacheResource Implementation based on the Custom API to use + * MySQL as the storage resource for Smarty's output caching. + * + * Table definition: + * <pre>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;</pre> + * + * @package CacheResource-examples + * @author Rodney Rehm + */ + class Smarty_CacheResource_Mysql extends Smarty_CacheResource_Custom { + // PDO instance + protected $db; + protected $fetch; + protected $fetchTimestamp; + protected $save; + + public function __construct() { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty", "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(); + } + } + + + + + <?php + + require_once 'libs/Smarty.class.php'; + $smarty = new Smarty(); + $smarty->caching_type = 'memcache'; + + /** + * Memcache CacheResource + * + * CacheResource Implementation based on the KeyValueStore API to use + * memcache as the storage resource for Smarty's output caching. + * + * Note that memcache has a limitation of 256 characters per cache-key. + * To avoid complications all cache-keys are translated to a sha1 hash. + * + * @package CacheResource-examples + * @author Rodney Rehm + */ + class Smarty_CacheResource_Memcache extends Smarty_CacheResource_KeyValueStore { + /** + * memcache instance + * @var Memcache + */ + protected $memcache = null; + + public function __construct() + { + $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) + { + $_keys = $lookup = array(); + foreach ($keys as $k) { + $_k = sha1($k); + $_keys[] = $_k; + $lookup[$_k] = $k; + } + $_res = array(); + $res = $this->memcache->get($_keys); + foreach ($res as $k => $v) { + $_res[$lookup[$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) { + $k = sha1($k); + $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/vendor/smarty/smarty/docs/programmers/caching/caching-groups.md b/vendor/smarty/smarty/docs/programmers/caching/caching-groups.md new file mode 100644 index 000000000..98e5d45c1 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/caching/caching-groups.md @@ -0,0 +1,60 @@ +Cache Groups {#caching.groups} +============ + +You can do more elaborate grouping by setting up `$cache_id` groups. +This is accomplished by separating each sub-group with a vertical bar +`|` in the `$cache_id` value. You can have as many sub-groups as you +like. + +- You can think of cache groups like a directory hierarchy. For + instance, a cache group of `'a|b|c'` could be thought of as the + directory structure `'/a/b/c/'`. + +- `clearCache(null,'a|b|c')` would be like removing the files + `'/a/b/c/*'`. `clearCache(null,'a|b')` would be like removing the + files `'/a/b/*'`. + +- If you specify a [`$compile_id`](#variable.compile.id) such as + `clearCache(null,'a|b','foo')` it is treated as an appended cache + group `'/a/b/c/foo/'`. + +- If you specify a template name such as + `clearCache('foo.tpl','a|b|c')` then Smarty will attempt to remove + `'/a/b/c/foo.tpl'`. + +- You CANNOT remove a specified template name under multiple cache + groups such as `'/a/b/*/foo.tpl'`, the cache grouping works + left-to-right ONLY. You will need to group your templates under a + single cache group heirarchy to be able to clear them as a group. + +Cache grouping should not be confused with your template directory +heirarchy, the cache grouping has no knowledge of how your templates are +structured. So for example, if you have a template structure like +`themes/blue/index.tpl` and you want to be able to clear all the cache +files for the "blue" theme, you will need to create a cache group +structure that mimics your template file structure, such as +`display('themes/blue/index.tpl','themes|blue')`, then clear them with +`clearCache(null,'themes|blue')`. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + // clear all caches with 'sports|basketball' as the first two cache_id groups + $smarty->clearCache(null,'sports|basketball'); + + // clear all caches with "sports" as the first cache_id group. This would + // include "sports|basketball", or "sports|(anything)|(anything)|(anything)|..." + $smarty->clearCache(null,'sports'); + + // clear the foo.tpl cache file with "sports|basketball" as the cache_id + $smarty->clearCache('foo.tpl','sports|basketball'); + + + $smarty->display('index.tpl','sports|basketball'); + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/caching/caching-multiple-caches.md b/vendor/smarty/smarty/docs/programmers/caching/caching-multiple-caches.md new file mode 100644 index 000000000..40fffc3d7 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/caching/caching-multiple-caches.md @@ -0,0 +1,87 @@ +Multiple Caches Per Page {#caching.multiple.caches} +======================== + +You can have multiple cache files for a single call to +[`display()`](#api.display) or [`fetch()`](#api.fetch). Let\'s say that +a call to `display('index.tpl')` may have several different output +contents depending on some condition, and you want separate caches for +each one. You can do this by passing a `$cache_id` as the second +parameter to the function call. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + $my_cache_id = $_GET['article_id']; + + $smarty->display('index.tpl', $my_cache_id); + ?> + + + +Above, we are passing the variable `$my_cache_id` to +[`display()`](#api.display) as the `$cache_id`. For each unique value of +`$my_cache_id`, a separate cache will be generated for `index.tpl`. In +this example, `article_id` was passed in the URL and is used as the +`$cache_id`. + +> **Note** +> +> Be very cautious when passing values from a client (web browser) into +> Smarty or any PHP application. Although the above example of using the +> article\_id from the URL looks handy, it could have bad consequences. +> The `$cache_id` is used to create a directory on the file system, so +> if the user decided to pass an extremely large value for article\_id, +> or write a script that sends random article\_id\'s at a rapid pace, +> this could possibly cause problems at the server level. Be sure to +> sanitize any data passed in before using it. In this instance, maybe +> you know the article\_id has a length of ten characters and is made up +> of alpha-numerics only, and must be a valid article\_id in the +> database. Check for this! + +Be sure to pass the same `$cache_id` as the second parameter to +[`isCached()`](#api.is.cached) and [`clearCache()`](#api.clear.cache). + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + $my_cache_id = $_GET['article_id']; + + if(!$smarty->isCached('index.tpl',$my_cache_id)) { + // No cache available, do variable assignments here. + $contents = get_database_contents(); + $smarty->assign($contents); + } + + $smarty->display('index.tpl',$my_cache_id); + ?> + + + +You can clear all caches for a particular `$cache_id` by passing NULL as +the first parameter to [`clearCache()`](#api.clear.cache). + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + // clear all caches with "sports" as the $cache_id + $smarty->clearCache(null,'sports'); + + $smarty->display('index.tpl','sports'); + ?> + + + +In this manner, you can "group" your caches together by giving them the +same `$cache_id`. diff --git a/vendor/smarty/smarty/docs/programmers/caching/caching-setting-up.md b/vendor/smarty/smarty/docs/programmers/caching/caching-setting-up.md new file mode 100644 index 000000000..bc9d2ad9e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/caching/caching-setting-up.md @@ -0,0 +1,153 @@ +Setting Up Caching {#caching.setting.up} +================== + +The first thing to do is enable caching by setting +[`$caching`](#variable.caching) to one of +`Smarty::CACHING_LIFETIME_CURRENT` or `Smarty::CACHING_LIFETIME_SAVED`. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + // uses the value of $smarty->cacheLifetime() to determine + // the number of seconds a cache is good for + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + $smarty->display('index.tpl'); + ?> + + + +With caching enabled, the function call to `display('index.tpl')` will +render the template as usual, but also saves a copy of its output to a +file (a cached copy) in the [`$cache_dir`](#variable.cache.dir). On the +next call to `display('index.tpl')`, the cached copy will be used +instead of rendering the template again. + +> **Note** +> +> The files in the [`$cache_dir`](#variable.cache.dir) are named similar +> to the template name. Although they end in the `.php` extension, they +> are not intended to be directly executable. Do not edit these files! + +Each cached page has a limited lifetime determined by +[`$cache_lifetime`](#variable.cache.lifetime). The default value is 3600 +seconds, or one hour. After that time expires, the cache is regenerated. +It is possible to give individual caches their own expiration time by +setting [`$caching`](#variable.caching) to +`Smarty::CACHING_LIFETIME_SAVED`. See +[`$cache_lifetime`](#variable.cache.lifetime) for more details. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + // retain current cache lifetime for each specific display call + $smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED); + + // set the cache_lifetime for index.tpl to 5 minutes + $smarty->setCacheLifetime(300); + $smarty->display('index.tpl'); + + // set the cache_lifetime for home.tpl to 1 hour + $smarty->setCacheLifetime(3600); + $smarty->display('home.tpl'); + + // NOTE: the following $cache_lifetime setting will not work when $caching + // is set to Smarty::CACHING_LIFETIME_SAVED. + // The cache lifetime for home.tpl has already been set + // to 1 hour, and will no longer respect the value of $cache_lifetime. + // The home.tpl cache will still expire after 1 hour. + $smarty->setCacheLifetime(30); // 30 seconds + $smarty->display('home.tpl'); + ?> + + + +If [`$compile_check`](#variable.compile.check) is enabled (default), +every template file and config file that is involved with the cache file +is checked for modification. If any of the files have been modified +since the cache was generated, the cache is immediately regenerated. +This is a computational overhead, so for optimum performance set +[`$compile_check`](#variable.compile.check) to FALSE. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + $smarty->setCompileCheck(false); + + $smarty->display('index.tpl'); + ?> + + + +If [`$force_compile`](#variable.force.compile) is enabled, the cache +files will always be regenerated. This effectively disables caching, +however this also seriously degrades performance. +[`$force_compile`](#variable.force.compile) is meant to be used for +[debugging](#chapter.debugging.console) purposes. The appropriate way to +disable caching is to set [`$caching`](#variable.caching) to +Smarty::CACHING\_OFF. + +The [`isCached()`](#api.is.cached) function can be used to test if a +template has a valid cache or not. If you have a cached template that +requires something like a database fetch, you can use this to skip that +process. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + if(!$smarty->isCached('index.tpl')) { + // No cache available, do variable assignments here. + $contents = get_database_contents(); + $smarty->assign($contents); + } + + $smarty->display('index.tpl'); + ?> + + + +You can keep parts of a page dynamic (disable caching) with the +[`{nocache}{/nocache}`](#language.function.nocache) block function, the +[`{insert}`](#language.function.insert) function, or by using the +`nocache` parameter for most template functions. + +Let\'s say the whole page can be cached except for a banner that is +displayed down the side of the page. By using the +[`{insert}`](#language.function.insert) function for the banner, you can +keep this element dynamic within the cached content. See the +documentation on [`{insert}`](#language.function.insert) for more +details and examples. + +You can clear all the cache files with the +[`clearAllCache()`](#api.clear.all.cache) function, or individual cache +files [and groups](#caching.groups) with the +[`clearCache()`](#api.clear.cache) function. + + + <?php + require('Smarty.class.php'); + $smarty = new Smarty; + + $smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); + + // clear only cache for index.tpl + $smarty->clearCache('index.tpl'); + + // clear out all cache files + $smarty->clearAllCache(); + + $smarty->display('index.tpl'); + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/charset.md b/vendor/smarty/smarty/docs/programmers/charset.md new file mode 100644 index 000000000..72842b3f7 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/charset.md @@ -0,0 +1,43 @@ +Charset Encoding {#charset} +================ + +Charset Encoding {#charset.encoding} +================ + +There are a variety of encodings for textual data, ISO-8859-1 (Latin1) +and UTF-8 being the most popular. Unless specified otherwise with the +`SMARTY_RESOURCE_CHAR_SET` constant, Smarty recognizes `UTF-8` as the +internal charset if [Multibyte String](https://www.php.net/mbstring) is +available, `ISO-8859-1` if not. + +> **Note** +> +> `ISO-8859-1` has been PHP\'s default internal charset since the +> beginning. Unicode has been evolving since 1991. Since then it has +> become the one charset to conquer them all, as it is capable of +> encoding most of the known characters even accross different character +> systems (latin, cyrillic, japanese, ...). `UTF-8` is unicode\'s most +> used encoding, as it allows referencing the thousands of character +> with the smallest size overhead possible. +> +> Since unicode and UTF-8 are very wide spread nowadays, their use is +> strongly encouraged. + +> **Note** +> +> Smarty\'s internals and core plugins are truly UTF-8 compatible since +> Smarty 3.1. To achieve unicode compatibility, the [Multibyte +> String](https://www.php.net/mbstring) PECL is required. Unless your PHP +> environment offers this package, Smarty will not be able to offer +> full-scale UTF-8 compatibility. + + + // use japanese character encoding + if (function_exists('mb_internal_charset')) { + mb_internal_charset('EUC-JP'); + } + define('SMARTY_RESOURCE_CHAR_SET', 'EUC-JP'); + require_once 'libs/Smarty.class.php'; + $smarty = new Smarty(); + + diff --git a/vendor/smarty/smarty/docs/programmers/plugins.md b/vendor/smarty/smarty/docs/programmers/plugins.md new file mode 100644 index 000000000..41a7ea0c4 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins.md @@ -0,0 +1,44 @@ +Extending Smarty With Plugins {#plugins} +============================= + +## Table of contents + +- [How Plugins Work](./plugins/plugins-howto.md) +- [Naming Conventions](./plugins/plugins-naming-conventions.md) +- [Writing Plugins](./plugins/plugins-writing.md) +- [Template Functions](./plugins/plugins-functions.md) +- [Modifiers](./plugins/plugins-modifiers.md) +- [Block Functions](./plugins/plugins-block-functions.md) +- [Compiler Functions](./plugins/plugins-compiler-functions.md) +- [Prefilters/Postfilters](./plugins/plugins-prefilters-postfilters.md) +- [Output Filters](./plugins/plugins-outputfilters.md) +- [Resources](./plugins/plugins-resources.md) +- [Inserts](./plugins/plugins-inserts.md) + +Version 2.0 introduced the plugin architecture that is used for almost +all the customizable functionality of Smarty. This includes: + +- functions + +- modifiers + +- block functions + +- compiler functions + +- prefilters + +- postfilters + +- outputfilters + +- resources + +- inserts + +With the exception of resources, backwards compatibility with the old +way of registering handler functions via register\_\* API is preserved. +If you did not use the API but instead modified the class variables +`$custom_funcs`, `$custom_mods`, and other ones directly, then you will +need to adjust your scripts to either use the API or convert your custom +functionality into plugins. diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-block-functions.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-block-functions.md new file mode 100644 index 000000000..47281fef5 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-block-functions.md @@ -0,0 +1,95 @@ +Block Functions {#plugins.block.functions} +=============== + +void + +smarty\_block\_ + +name + +array + +\$params + +mixed + +\$content + +object + +\$template + +boolean + +&\$repeat + +Block functions are functions of the form: `{func} .. {/func}`. In other +words, they enclose a template block and operate on the contents of this +block. Block functions take precedence over [custom +functions](#language.custom.functions) of the same name, that is, you +cannot have both custom function `{func}` and block function +`{func}..{/func}`. + +- By default your function implementation is called twice by Smarty: + once for the opening tag, and once for the closing tag. (See + `$repeat` below on how to change this.) + +- Starting with Smarty 3.1 the returned value of the opening tag call + is displayed as well. + +- Only the opening tag of the block function may have + [attributes](#language.syntax.attributes). All attributes passed to + template functions from the template are contained in the `$params` + variable as an associative array. The opening tag attributes are + also accessible to your function when processing the closing tag. + +- The value of the `$content` variable depends on whether your + function is called for the opening or closing tag. In case of the + opening tag, it will be NULL, and in case of the closing tag it will + be the contents of the template block. Note that the template block + will have already been processed by Smarty, so all you will receive + is the template output, not the template source. + +- The parameter `$repeat` is passed by reference to the function + implementation and provides a possibility for it to control how many + times the block is displayed. By default `$repeat` is TRUE at the + first call of the block-function (the opening tag) and FALSE on all + subsequent calls to the block function (the block\'s closing tag). + Each time the function implementation returns with `$repeat` being + TRUE, the contents between `{func}...{/func}` are evaluated and the + function implementation is called again with the new block contents + in the parameter `$content`. + +If you have nested block functions, it\'s possible to find out what the +parent block function is by accessing `$smarty->_tag_stack` variable. +Just do a [`var_dump()`](&url.php-manual;var_dump) on it and the +structure should be apparent. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: block.translate.php + * Type: block + * Name: translate + * Purpose: translate a block of text + * ------------------------------------------------------------- + */ + function smarty_block_translate($params, $content, Smarty_Internal_Template $template, &$repeat) + { + // only output on the closing tag + if(!$repeat){ + if (isset($content)) { + $lang = $params['lang']; + // do some intelligent translation thing here with $content + return $translation; + } + } + } + ?> + + + +See also: [`registerPlugin()`](#api.register.plugin), +[`unregisterPlugin()`](#api.unregister.plugin). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-compiler-functions.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-compiler-functions.md new file mode 100644 index 000000000..ef2454e8a --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-compiler-functions.md @@ -0,0 +1,66 @@ +Compiler Functions {#plugins.compiler.functions} +================== + +Compiler functions are called only during compilation of the template. +They are useful for injecting PHP code or time-sensitive static content +into the template. If there is both a compiler function and a [custom +function](#language.custom.functions) registered under the same name, +the compiler function has precedence. + +mixed + +smarty\_compiler\_ + +name + +array + +\$params + +object + +\$smarty + +The compiler function is passed two parameters: the params array which +contains precompiled strings for the attribute values and the Smarty +object. It\'s supposed to return the code to be injected into the +compiled template including the surrounding PHP tags. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: compiler.tplheader.php + * Type: compiler + * Name: tplheader + * Purpose: Output header containing the source file name and + * the time it was compiled. + * ------------------------------------------------------------- + */ + function smarty_compiler_tplheader($params, Smarty $smarty) + { + return "<?php\necho '" . $smarty->_current_file . " compiled at " . date('Y-m-d H:M'). "';\n?>"; + } + ?> + +This function can be called from the template as: + + + {* this function gets executed at compile time only *} + {tplheader} + + + +The resulting PHP code in the compiled template would be something like +this: + + + <?php + echo 'index.tpl compiled at 2002-02-20 20:02'; + ?> + + + +See also [`registerPlugin()`](#api.register.plugin), +[`unregisterPlugin()`](#api.unregister.plugin). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-functions.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-functions.md new file mode 100644 index 000000000..067b93826 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-functions.md @@ -0,0 +1,94 @@ +Template Functions {#plugins.functions} +================== + +void + +smarty\_function\_ + +name + +array + +\$params + +object + +\$template + +All [attributes](#language.syntax.attributes) passed to template +functions from the template are contained in the `$params` as an +associative array. + +The output (return value) of the function will be substituted in place +of the function tag in the template, eg the +[`{fetch}`](#language.function.fetch) function. Alternatively, the +function can simply perform some other task without any output, eg the +[`{assign}`](#language.function.assign) function. + +If the function needs to assign some variables to the template or use +some other Smarty-provided functionality, it can use the supplied +`$template` object to do so eg `$template->foo()`. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: function.eightball.php + * Type: function + * Name: eightball + * Purpose: outputs a random magic answer + * ------------------------------------------------------------- + */ + function smarty_function_eightball($params, Smarty_Internal_Template $template) + { + $answers = array('Yes', + 'No', + 'No way', + 'Outlook not so good', + 'Ask again soon', + 'Maybe in your reality'); + + $result = array_rand($answers); + return $answers[$result]; + } + ?> + +which can be used in the template as: + + Question: Will we ever have time travel? + Answer: {eightball}. + + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: function.assign.php + * Type: function + * Name: assign + * Purpose: assign a value to a template variable + * ------------------------------------------------------------- + */ + function smarty_function_assign($params, Smarty_Internal_Template $template) + { + if (empty($params['var'])) { + trigger_error("assign: missing 'var' parameter"); + return; + } + + if (!in_array('value', array_keys($params))) { + trigger_error("assign: missing 'value' parameter"); + return; + } + + $template->assign($params['var'], $params['value']); + + } + ?> + + + +See also: [`registerPlugin()`](#api.register.plugin), +[`unregisterPlugin()`](#api.unregister.plugin). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-howto.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-howto.md new file mode 100644 index 000000000..5738c3fcb --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-howto.md @@ -0,0 +1,18 @@ +How Plugins Work {#plugins.howto} +================ + +Plugins are always loaded on demand. Only the specific modifiers, +functions, resources, etc invoked in the templates scripts will be +loaded. Moreover, each plugin is loaded only once, even if you have +several different instances of Smarty running within the same request. + +Pre/postfilters and output filters are a bit of a special case. Since +they are not mentioned in the templates, they must be registered or +loaded explicitly via API functions before the template is processed. +The order in which multiple filters of the same type are executed +depends on the order in which they are registered or loaded. + +The [plugins directory](#variable.plugins.dir) can be a string +containing a path or an array containing multiple paths. To install a +plugin, simply place it in one of the directories and Smarty will use it +automatically. diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-inserts.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-inserts.md new file mode 100644 index 000000000..370a97bd0 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-inserts.md @@ -0,0 +1,48 @@ +Inserts {#plugins.inserts} +======= + +Insert plugins are used to implement functions that are invoked by +[`{insert}`](#language.function.insert) tags in the template. + +string + +smarty\_insert\_ + +name + +array + +\$params + +object + +\$template + +The first parameter to the function is an associative array of +attributes passed to the insert. + +The insert function is supposed to return the result which will be +substituted in place of the `{insert}` tag in the template. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: insert.time.php + * Type: time + * Name: time + * Purpose: Inserts current date/time according to format + * ------------------------------------------------------------- + */ + function smarty_insert_time($params, Smarty_Internal_Template $template) + { + if (empty($params['format'])) { + trigger_error("insert time: missing 'format' parameter"); + return; + } + return strftime($params['format']); + } + ?> + + diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-modifiers.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-modifiers.md new file mode 100644 index 000000000..b089821a6 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-modifiers.md @@ -0,0 +1,86 @@ +Modifiers {#plugins.modifiers} +========= + +[Modifiers](#language.modifiers) are little functions that are applied +to a variable in the template before it is displayed or used in some +other context. Modifiers can be chained together. + +mixed + +smarty\_modifier\_ + +name + +mixed + +\$value + +\[mixed + +\$param1 + +, \...\] + +The first parameter to the modifier plugin is the value on which the +modifier is to operate. The rest of the parameters are optional, +depending on what kind of operation is to be performed. + +The modifier has to [return](&url.php-manual;return) the result of its +processing. + +This plugin basically aliases one of the built-in PHP functions. It does +not have any additional parameters. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: modifier.capitalize.php + * Type: modifier + * Name: capitalize + * Purpose: capitalize words in the string + * ------------------------------------------------------------- + */ + function smarty_modifier_capitalize($string) + { + return ucwords($string); + } + ?> + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: modifier.truncate.php + * Type: modifier + * Name: truncate + * Purpose: Truncate a string to a certain length if necessary, + * optionally splitting in the middle of a word, and + * appending the $etc string. + * ------------------------------------------------------------- + */ + function smarty_modifier_truncate($string, $length = 80, $etc = '...', + $break_words = false) + { + if ($length == 0) + return ''; + + if (strlen($string) > $length) { + $length -= strlen($etc); + $fragment = substr($string, 0, $length+1); + if ($break_words) + $fragment = substr($fragment, 0, -1); + else + $fragment = preg_replace('/\s+(\S+)?$/', '', $fragment); + return $fragment.$etc; + } else + return $string; + } + ?> + + + +See also [`registerPlugin()`](#api.register.plugin), +[`unregisterPlugin()`](#api.unregister.plugin). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-naming-conventions.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-naming-conventions.md new file mode 100644 index 000000000..28bbcfde8 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-naming-conventions.md @@ -0,0 +1,51 @@ +Naming Conventions {#plugins.naming.conventions} +================== + +Plugin files and functions must follow a very specific naming convention +in order to be located by Smarty. + +**plugin files** must be named as follows: + +> ` +> type.name.php +> ` + +- Where `type` is one of these plugin types: + + - function + + - modifier + + - block + + - compiler + + - prefilter + + - postfilter + + - outputfilter + + - resource + + - insert + +- And `name` should be a valid identifier; letters, numbers, and + underscores only, see [php + variables](&url.php-manual;language.variables). + +- Some examples: `function.html_select_date.php`, `resource.db.php`, + `modifier.spacify.php`. + +**plugin functions** inside the PHP files must be named as follows: + +> `smarty_type_name` + +- The meanings of `type` and `name` are the same as above. + +- An example modifier name `foo` would be + `function smarty_modifier_foo()`. + +Smarty will output appropriate error messages if the plugin file it +needs is not found, or if the file or the plugin function are named +improperly. diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-outputfilters.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-outputfilters.md new file mode 100644 index 000000000..4e34ab7eb --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-outputfilters.md @@ -0,0 +1,48 @@ +Output Filters {#plugins.outputfilters} +============== + +Output filter plugins operate on a template\'s output, after the +template is loaded and executed, but before the output is displayed. + +string + +smarty\_outputfilter\_ + +name + +string + +\$template\_output + +object + +\$template + +The first parameter to the output filter function is the template output +that needs to be processed, and the second parameter is the instance of +Smarty invoking the plugin. The plugin is supposed to do the processing +and return the results. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: outputfilter.protect_email.php + * Type: outputfilter + * Name: protect_email + * Purpose: Converts @ sign in email addresses to %40 as + * a simple protection against spambots + * ------------------------------------------------------------- + */ + function smarty_outputfilter_protect_email($output, Smarty_Internal_Template $template) + { + return preg_replace('!(\S+)@([a-zA-Z0-9\.\-]+\.([a-zA-Z]{2,3}|[0-9]{1,3}))!', + '$1%40$2', $output); + } + ?> + + + +See also [`registerFilter()`](#api.register.filter), +[`unregisterFilter()`](#api.unregister.filter). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-prefilters-postfilters.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-prefilters-postfilters.md new file mode 100644 index 000000000..39467cbcb --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-prefilters-postfilters.md @@ -0,0 +1,89 @@ +Prefilters/Postfilters {#plugins.prefilters.postfilters} +====================== + +Prefilter and postfilter plugins are very similar in concept; where they +differ is in the execution \-- more precisely the time of their +execution. + +string + +smarty\_prefilter\_ + +name + +string + +\$source + +object + +\$template + +Prefilters are used to process the source of the template immediately +before compilation. The first parameter to the prefilter function is the +template source, possibly modified by some other prefilters. The plugin +is supposed to return the modified source. Note that this source is not +saved anywhere, it is only used for compilation. + +string + +smarty\_postfilter\_ + +name + +string + +\$compiled + +object + +\$template + +Postfilters are used to process the compiled output of the template (the +PHP code) immediately after the compilation is done but before the +compiled template is saved to the filesystem. The first parameter to the +postfilter function is the compiled template code, possibly modified by +other postfilters. The plugin is supposed to return the modified version +of this code. + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: prefilter.pre01.php + * Type: prefilter + * Name: pre01 + * Purpose: Convert html tags to be lowercase. + * ------------------------------------------------------------- + */ + function smarty_prefilter_pre01($source, Smarty_Internal_Template $template) + { + return preg_replace('!<(\w+)[^>]+>!e', 'strtolower("$1")', $source); + } + ?> + + + + + <?php + /* + * Smarty plugin + * ------------------------------------------------------------- + * File: postfilter.post01.php + * Type: postfilter + * Name: post01 + * Purpose: Output code that lists all current template vars. + * ------------------------------------------------------------- + */ + function smarty_postfilter_post01($compiled, Smarty_Internal_Template $template) + { + $compiled = "<pre>\n<?php print_r(\$template->getTemplateVars()); ?>\n</pre>" . $compiled; + return $compiled; + } + ?> + + + +See also [`registerFilter()`](#api.register.filter) and +[`unregisterFilter()`](#api.unregister.filter). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-resources.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-resources.md new file mode 100644 index 000000000..1b1fdf0ab --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-resources.md @@ -0,0 +1,128 @@ +Resources {#plugins.resources} +========= + +Resource plugins are meant as a generic way of providing template +sources or PHP script components to Smarty. Some examples of resources: +databases, LDAP, shared memory, sockets, and so on. + +Custom Resources may be put in a file `resource.foobarxyz.php` within +your [`$plugins_dir`](#variable.plugins.dir), or registered on runtime +with [`registerResource()`](#api.register.resource). In either case you +will be able to access that resource by prepending its name to the +template you\'re addressing: `foobarxyz:yourtemplate.tpl`. + +If a Resource\'s templates should not be run through the Smarty +compiler, the Custom Resource may extend `Smarty_Resource_Uncompiled`. +The Resource Handler must then implement the function +`renderUncompiled(Smarty_Internal_Template $_template)`. `$_template` is +a reference to the current template and contains all assigned variables +which the implementor can access via +`$_template->smarty->getTemplateVars()`. These Resources simply echo +their rendered content to the output stream. The rendered output will be +output-cached if the Smarty instance was configured accordingly. See +`libs/sysplugins/smarty_internal_resource_php.php` for an example. + +If the Resource\'s compiled templates should not be cached on disk, the +Custom Resource may extend `Smarty_Resource_Recompiled`. These Resources +are compiled every time they are accessed. This may be an expensive +overhead. See `libs/sysplugins/smarty_internal_resource_eval.php` for an +example. + + + <?php + + /** + * MySQL Resource + * + * Resource Implementation based on the Custom API to use + * MySQL as the storage resource for Smarty's templates and configs. + * + * Table definition: + * <pre>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;</pre> + * + * Demo data: + * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello world"}{$x}');</pre> + * + * @package Resource-examples + * @author Rodney Rehm + */ + class Smarty_Resource_Mysql extends Smarty_Resource_Custom { + // PDO instance + protected $db; + // prepared fetch() statement + protected $fetch; + // prepared fetchTimestamp() statement + protected $mtime; + + public function __construct() { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty", "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); + } + } + + + require_once 'libs/Smarty.class.php'; + $smarty = new Smarty(); + $smarty->registerResource('mysql', new Smarty_Resource_Mysql()); + + // using resource from php script + $smarty->display("mysql:index.tpl"); + ?> + + + +And from within Smarty template: + + + {include file='mysql:extras/navigation.tpl'} + + + +See also [`registerResource()`](#api.register.resource), +[`unregisterResource()`](#api.unregister.resource). diff --git a/vendor/smarty/smarty/docs/programmers/plugins/plugins-writing.md b/vendor/smarty/smarty/docs/programmers/plugins/plugins-writing.md new file mode 100644 index 000000000..972911d97 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/plugins/plugins-writing.md @@ -0,0 +1,36 @@ +Writing Plugins {#plugins.writing} +=============== + +Plugins can be either loaded by Smarty automatically from the filesystem +or they can be registered at runtime via one of the register\_\* API +functions. They can also be unregistered by using unregister\_\* API +functions. + +For the plugins that are registered at runtime, the name of the plugin +function(s) does not have to follow the naming convention. + +If a plugin depends on some functionality provided by another plugin (as +is the case with some plugins bundled with Smarty), then the proper way +to load the needed plugin is this: + + + <?php + function smarty_function_yourPlugin(array $params, Smarty_Internal_Template $template) + { + // load plugin depended upon + $template->smarty->loadPlugin('smarty_shared_make_timestamp'); + // plugin code + } + ?> + + + +As a general rule, the currently evaluated template\'s +Smarty\_Internal\_Template object is always passed to the plugins as the +last parameter with two exceptions: + +- modifiers do not get passed the Smarty\_Internal\_Template object at + all + +- blocks get passed `$repeat` after the Smarty\_Internal\_Template + object to keep backwards compatibility to older versions of Smarty. diff --git a/vendor/smarty/smarty/docs/programmers/resources.md b/vendor/smarty/smarty/docs/programmers/resources.md new file mode 100644 index 000000000..239690061 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources.md @@ -0,0 +1,19 @@ +Resources +========= + +The templates may come from a variety of sources. When you +[`display()`](./api-functions/api-display.md) or [`fetch()`](./api-functions/api-fetch.md) a template, or +when you include a template from within another template, you supply a +resource type, followed by the appropriate path and template name. If a +resource is not explicitly given, the value of +[`$default_resource_type`](./api-variables/variable-default-resource-type.md) (default: +\"file\") is assumed. + +## Table of contents + +- [File Template Resources](./resources/resources-file.md) +- [String Template Resources](./resources/resources-string.md) +- [Stream Template Resources](./resources/resources-streams.md) +- [Extends Template Resources](./resources/resources-extends.md) +- [Custom Template Resources](./resources/resources-custom.md) + diff --git a/vendor/smarty/smarty/docs/programmers/resources/resources-custom.md b/vendor/smarty/smarty/docs/programmers/resources/resources-custom.md new file mode 100644 index 000000000..d679afcb1 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources/resources-custom.md @@ -0,0 +1,111 @@ +Custom Template Resources {#resources.custom} +========================= + +You can retrieve templates using whatever possible source you can access +with PHP: databases, sockets, files, etc. You do this by writing +resource plugin functions and registering them with Smarty. + +See [resource plugins](#plugins.resources) section for more information +on the functions you are supposed to provide. + +> **Note** +> +> Note that you cannot override the built-in `file:` resource, but you +> can provide a resource that fetches templates from the file system in +> some other way by registering under another resource name. + + + <?php + + /** + * MySQL Resource + * + * Resource Implementation based on the Custom API to use + * MySQL as the storage resource for Smarty's templates and configs. + * + * Table definition: + * <pre>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;</pre> + * + * Demo data: + * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello world"}{$x}');</pre> + * + * @package Resource-examples + * @author Rodney Rehm + */ + class Smarty_Resource_Mysql extends Smarty_Resource_Custom { + // PDO instance + protected $db; + // prepared fetch() statement + protected $fetch; + // prepared fetchTimestamp() statement + protected $mtime; + + public function __construct() { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty", "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); + } + } + + + require_once 'libs/Smarty.class.php'; + $smarty = new Smarty(); + $smarty->registerResource('mysql', new Smarty_Resource_Mysql()); + + // using resource from php script + $smarty->display("mysql:index.tpl"); + ?> + + + +And from within Smarty template: + + + {include file='mysql:extras/navigation.tpl'} + + diff --git a/vendor/smarty/smarty/docs/programmers/resources/resources-extends.md b/vendor/smarty/smarty/docs/programmers/resources/resources-extends.md new file mode 100644 index 000000000..ad2e8f5d8 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources/resources-extends.md @@ -0,0 +1,36 @@ +Extends Template Resources {#resources.extends} +========================== + +The `extends:` resource is used to define child/parent relationships for +template inheritance from the PHP script. For details see section of +[Template Interitance](#advanced.features.template.inheritance). + +As of Smarty 3.1 the `extends:` resource may use any available [template +resource](#resources), including `string:` and `eval:`. When [templates +from strings](#resources.string) are used, make sure they are properly +(url or base64) encoded. Is an `eval:` resource found within an +inheritance chain, its \"don\'t save a compile file\" property is +superseeded by the `extends:` resource. The templates within an +inheritance chain are not compiled separately, though. Only a single +compiled template will be generated. + +> **Note** +> +> Use this when inheritance is required programatically. When inheriting +> within PHP, it is not obvious from the child template what inheritance +> took place. If you have a choice, it is normally more flexible and +> intuitive to handle inheritance chains from within the templates. + + + <?php + $smarty->display('extends:parent.tpl|child.tpl|grandchild.tpl'); + + // inheritance from multiple template sources + $smarty->display('extends:db:parent.tpl|file:child.tpl|grandchild.tpl|eval:{block name="fooBazVar_"}hello world{/block}'); + ?> + + + +See also [Template Inheritance](#advanced.features.template.inheritance) +[`{block}`](#language.function.block) and +[`{extends}`](#language.function.extends). diff --git a/vendor/smarty/smarty/docs/programmers/resources/resources-file.md b/vendor/smarty/smarty/docs/programmers/resources/resources-file.md new file mode 100644 index 000000000..986cfffca --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources/resources-file.md @@ -0,0 +1,160 @@ +File Template Resources {#resources.file} +======================= + +Smarty ships with a built-in template resource for the filesystem. The +`file:` is the default resource. The resource key `file:` must only be +specified, if the +[`$default_resource_type`](#variable.default.resource.type) has been +changed. + +If the file resource cannot find the requested template, the +[`$default_template_handler_func`](#variable.default.template.handler.func) +is invoked. + +> **Note** +> +> As of Smarty 3.1 the file resource no longer walks through the +> [include\_path](&url.php-manual;ini.core.php#ini.include-path) unless +> [`$use_include_path` is activated](#variable.use.include.path) + +Templates from \$template\_dir {#templates.from.template.dir} +------------------------------ + +The file resource pulls templates source files from the directories +specified in [`$template_dir`](#variable.template.dir). The list of +directories is traversed in the order they appear in the array. The +first template found is the one to process. + + + <?php + $smarty->display('index.tpl'); + $smarty->display('file:index.tpl'); // same as above + ?> + + + +From within a Smarty template + + + {include file='index.tpl'} + {include file='file:index.tpl'} {* same as above *} + + + +Templates from a specific \$template\_dir {#templates.from.specified.template.dir} +----------------------------------------- + +Smarty 3.1 introduced the bracket-syntax for specifying an element from +[`$template_dir`](#variable.template.dir). This allows websites +employing multiple sets of templates better control over which template +to acces. + +The bracket-syntax can be used from anywhere you can specify the `file:` +resource type. + + + <?php + + // setup template directories + $smarty->setTemplateDir(array( + './templates', // element: 0, index: 0 + './templates_2', // element: 1, index: 1 + '10' => 'templates_10', // element: 2, index: '10' + 'foo' => 'templates_foo', // element: 3, index: 'foo' + )); + + /* + assume the template structure + ./templates/foo.tpl + ./templates_2/foo.tpl + ./templates_2/bar.tpl + ./templates_10/foo.tpl + ./templates_10/bar.tpl + ./templates_foo/foo.tpl + */ + + // regular access + $smarty->display('file:foo.tpl'); + // will load ./templates/foo.tpl + + // using numeric index + $smarty->display('file:[1]foo.tpl'); + // will load ./templates_2/foo.tpl + + // using numeric string index + $smarty->display('file:[10]foo.tpl'); + // will load ./templates_10/foo.tpl + + // using string index + $smarty->display('file:[foo]foo.tpl'); + // will load ./templates_foo/foo.tpl + + // using "unknown" numeric index (using element number) + $smarty->display('file:[2]foo.tpl'); + // will load ./templates_10/foo.tpl + + ?> + + + +From within a Smarty template + + + {include file="file:foo.tpl"} + {* will load ./templates/foo.tpl *} + + {include file="file:[1]foo.tpl"} + {* will load ./templates_2/foo.tpl *} + + {include file="file:[foo]foo.tpl"} + {* will load ./templates_foo/foo.tpl *} + + + +Templates from any directory {#templates.from.any.dir} +---------------------------- + +Templates outside of the [`$template_dir`](#variable.template.dir) +require the `file:` template resource type, followed by the absolute +path to the template (with leading slash.) + +> **Note** +> +> With [`Security`](#advanced.features.security) enabled, access to +> templates outside of the [`$template_dir`](#variable.template.dir) is +> not allowed unless you list those directories in `$secure_dir`. + + + <?php + $smarty->display('file:/export/templates/index.tpl'); + $smarty->display('file:/path/to/my/templates/menu.tpl'); + ?> + + + +And from within a Smarty template: + + + {include file='file:/usr/local/share/templates/navigation.tpl'} + + + +Windows Filepaths {#templates.windows.filepath} +----------------- + +If you are using a Windows machine, filepaths usually include a drive +letter (C:) at the beginning of the pathname. Be sure to use `file:` in +the path to avoid namespace conflicts and get the desired results. + + + <?php + $smarty->display('file:C:/export/templates/index.tpl'); + $smarty->display('file:F:/path/to/my/templates/menu.tpl'); + ?> + + + +And from within Smarty template: + + + {include file='file:D:/usr/local/share/templates/navigation.tpl'} diff --git a/vendor/smarty/smarty/docs/programmers/resources/resources-streams.md b/vendor/smarty/smarty/docs/programmers/resources/resources-streams.md new file mode 100644 index 000000000..e0596f591 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources/resources-streams.md @@ -0,0 +1,27 @@ +Stream Template Resources {#resources.streams} +========================= + +Streams allow you to use PHP streams as a template resource. The syntax +is much the same a traditional template resource names. + +Smarty will first look for a registered template resource. If nothing is +found, it will check if a PHP stream is available. If a stream is +available, Smarty will use it to fetch the template. + +> **Note** +> +> You can further define allowed streams with security enabled. + +Using a PHP stream for a template resource from the display() function. + + + $smarty->display('foo:bar.tpl'); + + + +Using a PHP stream for a template resource from within a template. + + + {include file="foo:bar.tpl"} + + diff --git a/vendor/smarty/smarty/docs/programmers/resources/resources-string.md b/vendor/smarty/smarty/docs/programmers/resources/resources-string.md new file mode 100644 index 000000000..4b19d8e32 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources/resources-string.md @@ -0,0 +1,73 @@ +String Template Resources {#resources.string} +========================= + +Smarty can render templates from a string by using the `string:` or +`eval:` resource. + +- The `string:` resource behaves much the same as a template file. The + template source is compiled from a string and stores the compiled + template code for later reuse. Each unique template string will + create a new compiled template file. If your template strings are + accessed frequently, this is a good choice. If you have frequently + changing template strings (or strings with low reuse value), the + `eval:` resource may be a better choice, as it doesn\'t save + compiled templates to disk. + +- The `eval:` resource evaluates the template source every time a page + is rendered. This is a good choice for strings with low reuse value. + If the same string is accessed frequently, the `string:` resource + may be a better choice. + +> **Note** +> +> With a `string:` resource type, each unique string generates a +> compiled file. Smarty cannot detect a string that has changed, and +> therefore will generate a new compiled file for each unique string. It +> is important to choose the correct resource so that you do not fill +> your disk space with wasted compiled strings. + + + <?php + $smarty->assign('foo','value'); + $template_string = 'display {$foo} here'; + $smarty->display('string:'.$template_string); // compiles for later reuse + $smarty->display('eval:'.$template_string); // compiles every time + ?> + + + +From within a Smarty template + + + {include file="string:$template_string"} {* compiles for later reuse *} + {include file="eval:$template_string"} {* compiles every time *} + + + + +Both `string:` and `eval:` resources may be encoded with +[`urlencode()`](&url.php-manual;urlencode) or +[`base64_encode()`](&url.php-manual;urlencode). This is not necessary +for the usual use of `string:` and `eval:`, but is required when using +either of them in conjunction with +[`Extends Template Resource`](#resources.extends) + + + <?php + $smarty->assign('foo','value'); + $template_string_urlencode = urlencode('display {$foo} here'); + $template_string_base64 = base64_encode('display {$foo} here'); + $smarty->display('eval:urlencode:'.$template_string_urlencode); // will decode string using urldecode() + $smarty->display('eval:base64:'.$template_string_base64); // will decode string using base64_decode() + ?> + + + +From within a Smarty template + + + {include file="string:urlencode:$template_string_urlencode"} {* will decode string using urldecode() *} + {include file="eval:base64:$template_string_base64"} {* will decode string using base64_decode() *} + + + diff --git a/vendor/smarty/smarty/docs/programmers/resources/template-resources.md b/vendor/smarty/smarty/docs/programmers/resources/template-resources.md new file mode 100644 index 000000000..7bb5d752e --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/resources/template-resources.md @@ -0,0 +1,130 @@ +Resources {#resasdources} +========= + +The templates may come from a variety of sources. When you +[`display()`](#api.display) or [`fetch()`](#api.fetch) a template, or +when you include a template from within another template, you supply a +resource type, followed by the appropriate path and template name. If a +resource is not explicitly given, the value of +[`$default_resource_type`](#variable.default.resource.type) is assumed. + +Templates from other sources {#templates.from.elsewhere} +---------------------------- + +You can retrieve templates using whatever possible source you can access +with PHP: databases, sockets, files, etc. You do this by writing +resource plugin functions and registering them with Smarty. + +See [resource plugins](#plugins.resources) section for more information +on the functions you are supposed to provide. + +> **Note** +> +> Note that you cannot override the built-in `file:` resource, but you +> can provide a resource that fetches templates from the file system in +> some other way by registering under another resource name. + + + <?php + + /** + * MySQL Resource + * + * Resource Implementation based on the Custom API to use + * MySQL as the storage resource for Smarty's templates and configs. + * + * Table definition: + * <pre>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;</pre> + * + * Demo data: + * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello world"}{$x}');</pre> + * + * @package Resource-examples + * @author Rodney Rehm + */ + class Smarty_Resource_Mysql extends Smarty_Resource_Custom { + // PDO instance + protected $db; + // prepared fetch() statement + protected $fetch; + // prepared fetchTimestamp() statement + protected $mtime; + + public function __construct() { + try { + $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty", "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); + } + } + + + require_once 'libs/Smarty.class.php'; + $smarty = new Smarty(); + $smarty->registerResource('mysql', new Smarty_Resource_Mysql()); + + // using resource from php script + $smarty->display("mysql:index.tpl"); + ?> + + + +And from within Smarty template: + + + {include file='mysql:extras/navigation.tpl'} + + + +Default template handler function {#default.template.handler.function} +--------------------------------- + +You can specify a function that is used to retrieve template contents in +the event the template cannot be retrieved from its resource. One use of +this is to create templates that do not exist on-the-fly. + +See also [`Streams`](#advanced.features.streams) diff --git a/vendor/smarty/smarty/docs/programmers/smarty-constants.md b/vendor/smarty/smarty/docs/programmers/smarty-constants.md new file mode 100644 index 000000000..042ea5e38 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/smarty-constants.md @@ -0,0 +1,27 @@ +Constants {#smarty.constants} +========= + +SMARTY\_DIR {#constant.smarty.dir} +=========== + +This is the **full system path** to the location of the Smarty class +files. If this is not defined in your script, then Smarty will attempt +to determine the appropriate value automatically. If defined, the path +**must end with a trailing slash/**. + + + <?php + // set path to Smarty directory *nix style + define('SMARTY_DIR', '/usr/local/lib/php/Smarty-v.e.r/libs/'); + + // path to Smarty windows style + define('SMARTY_DIR', 'c:/webroot/libs/Smarty-v.e.r/libs/'); + + // include the smarty class, note 'S' is upper case + require_once(SMARTY_DIR . 'Smarty.class.php'); + ?> + + + +See also [`$smarty.const`](../designers/language-variables/language-variables-smarty.md) and +[`$php_handling constants`](./api-variables/variable-php-handling.md) |