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