componere.cast_by_ref.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="componere.cast_by_ref" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Componere\cast_by_ref</refname>
  <refpurpose>Casting</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>object</type><methodname>Componere\cast_by_ref</methodname>
   <methodparam><type>string</type><parameter>type</parameter></methodparam>
   <methodparam><type>object</type><parameter>object</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><exceptionname>type</exceptionname></term>
    <listitem>
     <para>
      A user defined type
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object</parameter></term>
    <listitem>
     <para>
      An object with a user defined type compatible with <exceptionname>Type</exceptionname>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An <type>object</type> of type <exceptionname>Type</exceptionname>, cast from <parameter>object</parameter>, where members are references to <parameter>object</parameter> members
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <warning>
   <para>
    Shall throw <type>InvalidArgumentException</type> if the type of <parameter>object</parameter> is or is derived from an internal class
   </para>
  </warning>
  <warning>
   <para>
    Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is an interface
   </para>
  </warning>
  <warning>
   <para>
    Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is a trait
   </para>
  </warning>
  <warning>
   <para>
    Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is an abstract
   </para>
  </warning>
  <warning>
   <para>
    Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is not compatible with the type of <parameter>object</parameter>
   </para>
  </warning>
 </refsect1>

 <refsect1 role="seealso">
   &reftitle.seealso;
   <simplelist>
    <member><xref linkend="componere.cast" /></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->