add Componere\cast to documentation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344454 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Joe Watkins 2018-03-06 14:03:49 +00:00
parent 461bcf6643
commit e644c4c46e
4 changed files with 134 additions and 0 deletions

View file

@ -18,6 +18,7 @@
&reference.componere.componere.patch;
&reference.componere.componere.method;
&reference.componere.componere.value;
&reference.componere.reference;
</book>
<!-- Keep this comment at the end of the file

View file

@ -0,0 +1,101 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere.cast" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Componere\cast</refname>
<refpurpose>Casting</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>Componere\cast</methodname>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam><type>object</type><parameter>instance</parameter></methodparam>
</methodsynopsis>
<para>
Shall cast <parameter>instance</parameter> to <parameter>class</parameter>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<listitem>
<para>
A user defined class name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>instance</parameter></term>
<listitem>
<para>
An object with a user defined type
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A clone of <parameter>instance</parameter>, of type <parameter>class</parameter>
</para>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if <type>instance</type> is not of a user defined standard type
</para>
</warning>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if <parameter>class</parameter> is an interface
</para>
</warning>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if <parameter>class</parameter> is a trait
</para>
</warning>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if <parameter>class</parameter> is an abstract
</para>
</warning>
<warning>
<para>
Shall throw <type>InvalidArgumentException</type> if <parameter>class</parameter> is not compatible with the type of <parameter>instance</parameter>
</para>
</warning>
</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
-->

View file

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 334047 $ -->
<reference xml:id="reference.componere" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Componere &Functions;</title>
&reference.componere.entities.functions;
</reference>
<!-- 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
-->

View file

@ -55,6 +55,8 @@
<function name='componere\value::isprivate' from='Componere 2 &gt;= 2.1.0'/>
<function name='componere\value::isstatic' from='Componere 2 &gt;= 2.1.0'/>
<function name='componere\value::hasdefault' from='Componere 2 &gt;= 2.1.0'/>
<function name='componere\cast' from='Componere 2 &gt;= 2.1.2'/>
</versions>
<!-- Keep this comment at the end of the file