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