smarty/docs/en/programmers/api-functions/api-get-registered-object.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.get.registered.object">
 <refnamediv>
  <refname>get_registered_object()</refname>
  <refpurpose>returns a reference to a registered object</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>array</type><methodname>get_registered_object</methodname>
   <methodparam><type>string</type><parameter>object_name</parameter></methodparam>
  </methodsynopsis>
  <para>
   This is useful
   from within a custom function when you need direct access to a
   <link linkend="api.register.object">registered object</link>. See the
   <link linkend="advanced.features.objects">objects</link> page for more info.
  </para>
  <example>
   <title>get_registered_object()</title>
   <programlisting role="php">
<![CDATA[
<?php
function smarty_block_foo($params, &$smarty)
{
  if (isset($params['object'])) {
    // get reference to registered object
    $obj_ref = &$smarty->get_registered_object($params['object']);
    // use $obj_ref is now a reference to the object
  }
}
?>
]]>
   </programlisting>
  </example>
  <para>
  See also
  <link linkend="api.register.object"><varname>register_object()</varname></link>,
  <link linkend="api.unregister.object"><varname>unregister_object()</varname></link>
  and
  <link linkend="advanced.features.objects">objects page</link>
  </para>
 </refsect1>
</refentry>
<!-- 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
-->