diff options
Diffstat (limited to 'vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md')
| -rw-r--r-- | vendor/smarty/smarty/docs/designers/language-builtin-functions/language-function-config-load.md | 109 |
1 files changed, 53 insertions, 56 deletions
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 index 750f337c4..e13c30836 100644 --- 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 @@ -1,56 +1,55 @@ -{config\_load} {#language.function.config.load} -============== +# {config_load} `{config_load}` is used for loading config -[`#variables#`](#language.config.variables) from a [configuration -file](#config.files) into the template. +[`#variables#`](#language.config.variables) from a [configuration file](#config.files) into the template. -**Attributes:** +## 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. +| Attribute Name | Required | Description | +|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| file | Yes | The name of the config file to include | +| section | No | The name of the section to load | +| scope | no | How the scope of the loaded variables are treated, which must be one of local, parent or global. local means variables are loaded into the local template context. parent means variables are loaded into both the local context and the parent template that called it. global means variables are available to all templates. | -The `example.conf` file. +## Examples - #this is config file comment +The `example.conf` file. - # global variables - pageTitle = "Main Menu" - bodyBgColor = #000000 - tableBgColor = #000000 - rowBgColor = #00ff00 +```ini +#this is config file comment - #customer variables section - [Customer] - pageTitle = "Customer Info" +# global variables +pageTitle = "Main Menu" +bodyBgColor = #000000 +tableBgColor = #000000 +rowBgColor = #00ff00 +#customer variables section +[Customer] +pageTitle = "Customer Info" +``` - and the template +```smarty +{config_load file="example.conf"} +{config_load "example.conf"} {* short-hand *} - {config_load file="example.conf"} - {config_load "example.conf"} {* short-hand *} - - <html> +<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> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> </body> - </html> - +</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 @@ -59,33 +58,31 @@ 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 +> [`{section}`](../language-builtin-functions/language-function-section.md) have nothing to do with each > other, they just happen to share a common naming convention. +```smarty +{config_load file='example.conf' section='Customer'} +{config_load 'example.conf' 'Customer'} {* short-hand *} - {config_load file='example.conf' section='Customer'} - {config_load 'example.conf' 'Customer'} {* short-hand *} - - <html> +<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> + <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"> + <tr bgcolor="{#rowBgColor#}"> + <td>First</td> + <td>Last</td> + <td>Address</td> + </tr> + </table> </body> - </html> - - +</html> +``` -See [`$config_overwrite`](#variable.config.overwrite) to create arrays +See [`$config_overwrite`](../../programmers/api-variables/variable-config-overwrite.md) 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). +See also the [config files](../config-files.md) page, [config variables](../language-variables/language-config-variables.md) page, +[`$config_dir`](../../programmers/api-variables/variable-config-dir.md), +[`getConfigVars()`](../../programmers/api-functions/api-get-config-vars.md) and +[`configLoad()`](../../programmers/api-functions/api-config-load.md). |