aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/programmers/api-functions/api-config-load.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/smarty/smarty/docs/programmers/api-functions/api-config-load.md')
-rw-r--r--vendor/smarty/smarty/docs/programmers/api-functions/api-config-load.md47
1 files changed, 47 insertions, 0 deletions
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)