From e644c4c46ea73d2c4c0f7d41b48df4cc2b97ef6d Mon Sep 17 00:00:00 2001
From: Joe Watkins <krakjoe@php.net>
Date: Tue, 6 Mar 2018 14:03:49 +0000
Subject: [PATCH] add Componere\cast to documentation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344454 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/componere/book.xml                  |   1 +
 .../componere/functions/componere.cast.xml    | 101 ++++++++++++++++++
 reference/componere/reference.xml             |  30 ++++++
 reference/componere/versions.xml              |   2 +
 4 files changed, 134 insertions(+)
 create mode 100644 reference/componere/functions/componere.cast.xml
 create mode 100644 reference/componere/reference.xml

diff --git a/reference/componere/book.xml b/reference/componere/book.xml
index 3d1840d00d..1ef0623fe3 100644
--- a/reference/componere/book.xml
+++ b/reference/componere/book.xml
@@ -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
diff --git a/reference/componere/functions/componere.cast.xml b/reference/componere/functions/componere.cast.xml
new file mode 100644
index 0000000000..c41b20dc0c
--- /dev/null
+++ b/reference/componere/functions/componere.cast.xml
@@ -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
+-->
diff --git a/reference/componere/reference.xml b/reference/componere/reference.xml
new file mode 100644
index 0000000000..ba22b4bf90
--- /dev/null
+++ b/reference/componere/reference.xml
@@ -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
+-->
diff --git a/reference/componere/versions.xml b/reference/componere/versions.xml
index 36f740eb34..1c631a4c70 100644
--- a/reference/componere/versions.xml
+++ b/reference/componere/versions.xml
@@ -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