This commit is contained in:
pete_morgan
2005-09-13 16:42:49 +00:00
parent 4d93debe1e
commit 92d8d3af4f

View File

@@ -3,11 +3,15 @@
<sect1 id="advanced.features.objects"> <sect1 id="advanced.features.objects">
<title>Objects</title> <title>Objects</title>
<para> <para>
Smarty allows access to PHP objects through the templates. There are Smarty allows access to PHP
<ulink url="&url.php-manual;object">objects</ulink> through the templates.
There are
two ways to access them. One way is to two ways to access them. One way is to
<link linkend="api.register.object">register objects</link> to the template, <link linkend="api.register.object">register objects</link> to the template,
then use access them via syntax similar to custom functions. The other way then use access them via syntax similar to
is to <link linkend="api.assign">assign objects</link> <link linkend="language.custom.functions">custom functions</link>.
The other way
is to <link linkend="api.assign">assign()</link> objects
to the templates and access them much like any other to the templates and access them much like any other
assigned variable. The first method has a much nicer template syntax. It 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 is also more secure, as a registered object can be restricted to certain
@@ -62,22 +66,22 @@
class My_Object { class My_Object {
function meth1($params, &$smarty_obj) { function meth1($params, &$smarty_obj) {
return "this is my meth1"; return 'this is my meth1';
} }
} }
$myobj = new My_Object; $myobj = new My_Object;
// registering the object (will be by reference) // registering the object (will be by reference)
$smarty->register_object("foobar",$myobj); $smarty->register_object('foobar',$myobj);
// if we want to restrict access to certain methods or properties, list them // if we want to restrict access to certain methods or properties, list them
$smarty->register_object("foobar",$myobj,array('meth1','meth2','prop1')); $smarty->register_object('foobar',$myobj,array('meth1','meth2','prop1'));
// if you want to use the traditional object parameter format, pass a boolean of false // if you want to use the traditional object parameter format, pass a boolean of false
$smarty->register_object("foobar",$myobj,null,false); $smarty->register_object('foobar',$myobj,null,false);
// We can also assign objects. Assign by ref when possible. // We can also assign objects. Assign by ref when possible.
$smarty->assign_by_ref("myobj", $myobj); $smarty->assign_by_ref('myobj', $myobj);
$smarty->display("index.tpl"); $smarty->display('index.tpl');
?> ?>
]]> ]]>
</programlisting> </programlisting>
@@ -87,17 +91,21 @@ $smarty->display("index.tpl");
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
{* access our registered object *} {* access our registered object *}
{foobar->meth1 p1="foo" p2=$bar} {foobar->meth1 p1='foo' p2=$bar}
{* you can also assign the output *} {* you can also assign the output *}
{foobar->meth1 p1="foo" p2=$bar assign="output"} {foobar->meth1 p1='foo' p2=$bar assign='output'}
the output was {$output} the output was {$output}
{* access our assigned object *} {* access our assigned object *}
{$myobj->meth1("foo",$bar)} {$myobj->meth1('foo',$bar)}
]]> ]]>
</programlisting> </programlisting>
</example> </example>
<para>
See also <link linkend="api.register.object">register_object()</link>
<link linkend="api.assign">assign()</link>
</para>
</sect1> </sect1>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
@@ -119,4 +127,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml vim: et tw=78 syn=sgml
vi: ts=1 sw=1 vi: ts=1 sw=1
--> -->