Files
smarty/docs/en/programmers/advanced-features/advanced-features-objects.xml

145 lines
4.5 KiB
XML
Raw Normal View History

2004-04-13 11:47:32 +00:00
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="advanced.features.objects">
<title>Objects</title>
<para>
2006-09-27 01:47:51 +00:00
Smarty allows access to PHP
<ulink url="&url.php-manual;object">objects</ulink> through the templates.
There are two ways to access them.
</para>
<itemizedlist spacing="compact">
<listitem><para>
One way is to <link linkend="api.register.object">register objects</link> to
the template, then use access them via syntax similar to
<link linkend="language.custom.functions">custom functions</link>.
</para></listitem>
<listitem><para>
The other way is to <link linkend="api.assign"><varname>assign()</varname>
</link> objects to the templates and access them much like any other
assigned variable.
</para></listitem>
</itemizedlist>
<para>
The first method has a much nicer template syntax. It
2004-04-13 11:47:32 +00:00
is also more secure, as a registered object can be restricted to certain
methods or properties. However,
<emphasis role="bold">a registered object cannot be looped over
or assigned in arrays of objects</emphasis>, etc. The method you choose will be
2004-04-13 11:47:32 +00:00
determined by your needs, but use the first method whenever possible to
keep template syntax to a minimum.
</para>
2004-04-13 11:47:32 +00:00
<para>
2006-09-27 01:47:51 +00:00
If <link linkend="variable.security"><parameter>$security</parameter></link>
is enabled, no private methods or functions can be accessed
(begininning with '_'). If a method and property of the same name exist,
the method will be used.
2004-04-13 11:47:32 +00:00
</para>
<para>
You can restrict the methods and properties that can be accessed by
listing them in an array as the third registration parameter.
2004-04-13 11:47:32 +00:00
</para>
<para>
By default, parameters passed to objects through the templates are passed
the same way
<link linkend="language.custom.functions">custom functions</link> get them.
An associative array is passed
as the first parameter, and the smarty object as the second. If you want
the parameters passed one at a time for each argument like traditional
2006-09-27 01:47:51 +00:00
object parameter passing, set the fourth registration parameter to &false;.
2004-04-13 11:47:32 +00:00
</para>
<para>
The optional fifth parameter has only effect with
2006-09-27 01:47:51 +00:00
<parameter>format</parameter> being &true;
2004-11-25 22:01:37 +00:00
and contains a list of methods that should be treated as
blocks. That means these methods have a closing tag in the
template
(<literal>{foobar->meth2}...{/foobar->meth2}</literal>) and
the parameters to the methods have the same synopsis as the
parameters for
2006-09-27 01:47:51 +00:00
<link linkend="plugins.block.functions">
<varname>block-function-plugins</varname></link>:
They get the four parameters
<parameter>$params</parameter>,
<parameter>$content</parameter>,
<parameter>&amp;$smarty</parameter> and
<parameter>&amp;$repeat</parameter> and they also behave like
block-function-plugins.
2004-04-13 11:47:32 +00:00
</para>
<example>
2006-09-27 01:47:51 +00:00
<title>Using a registered or assigned object</title>
<programlisting role="php">
2004-04-13 11:47:32 +00:00
<![CDATA[
<?php
// the object
class My_Object {
function meth1($params, &$smarty_obj) {
2005-09-13 16:42:49 +00:00
return 'this is my meth1';
2004-04-13 11:47:32 +00:00
}
}
$myobj = new My_Object;
2006-09-27 01:47:51 +00:00
2004-04-13 11:47:32 +00:00
// registering the object (will be by reference)
2005-09-13 16:42:49 +00:00
$smarty->register_object('foobar',$myobj);
2006-09-27 01:47:51 +00:00
2004-04-13 11:47:32 +00:00
// if we want to restrict access to certain methods or properties, list them
2005-09-13 16:42:49 +00:00
$smarty->register_object('foobar',$myobj,array('meth1','meth2','prop1'));
2006-09-27 01:47:51 +00:00
2004-04-13 11:47:32 +00:00
// if you want to use the traditional object parameter format, pass a boolean of false
2005-09-13 16:42:49 +00:00
$smarty->register_object('foobar',$myobj,null,false);
2004-04-13 11:47:32 +00:00
2006-09-27 01:47:51 +00:00
// We can also assign objects. assign_by_ref when possible.
2005-09-13 16:42:49 +00:00
$smarty->assign_by_ref('myobj', $myobj);
2004-04-13 11:47:32 +00:00
2005-09-13 16:42:49 +00:00
$smarty->display('index.tpl');
2004-04-13 11:47:32 +00:00
?>
]]>
</programlisting>
<para>
2006-09-27 01:47:51 +00:00
And here's how to access your objects in <filename>index.tpl</filename>:
</para>
<programlisting>
<![CDATA[
2004-04-13 11:47:32 +00:00
{* access our registered object *}
2005-09-13 16:42:49 +00:00
{foobar->meth1 p1='foo' p2=$bar}
2004-04-13 11:47:32 +00:00
{* you can also assign the output *}
2005-09-13 16:42:49 +00:00
{foobar->meth1 p1='foo' p2=$bar assign='output'}
2004-04-13 11:47:32 +00:00
the output was {$output}
{* access our assigned object *}
2005-09-13 16:42:49 +00:00
{$myobj->meth1('foo',$bar)}
2004-04-13 11:47:32 +00:00
]]>
</programlisting>
</example>
2005-09-13 16:42:49 +00:00
<para>
2005-12-13 21:33:56 +00:00
See also <link
2006-09-27 01:47:51 +00:00
linkend="api.register.object"><varname>register_object()</varname></link>
and
<link linkend="api.assign"><varname>assign()</varname></link>.
2005-09-13 16:42:49 +00:00
</para>
2004-04-13 11:47:32 +00:00
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->