svn: /phpdoc/en/trunk/reference/reflection/ reflectionfunctionabstract/getreturntype.xml reflectionfunctionabstract/hasreturntype.xml versions.xml
| From: | Thomas Punt | Date: | Thu, 20 Aug 2015 14:24:18 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/reflection/ reflectionfunctionabstract/getreturntype.xml reflectionfunctionabstract/hasreturntype.xml versions.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-13633@lists.php.net to get a copy of this message | ||
tpunt Thu, 20 Aug 2015 14:24:18 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=337567
Log:
Document ReflectionFunctionAbstract::getReturnType() method
Changed paths:
A phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/getreturntype.xml
U phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml
U phpdoc/en/trunk/reference/reflection/versions.xml
Added: phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/getreturntype.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/getreturntype.xml
(rev 0)
+++ phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/getreturntype.xml 2015-08-20
14:24:18 UTC (rev 337567)
@@ -0,0 +1,116 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionfunctionabstract.getreturntype" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>ReflectionFunctionAbstract::getReturnType</refname>
+ <refpurpose>Gets the specified return type of a function</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>ReflectionType</type><methodname>ReflectionFunctionAbstract::getReturnType</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ Gets the specified return type of a reflected function.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <classname>ReflectionType</classname> object if a return type is
+ specified, &null; otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><methodname>ReflectionFunctionAbstract::getReturnType</methodname>
example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+function to_int($param) : int {
+ return (int) $param;
+}
+
+$reflection1 = new ReflectionFunction('to_int');
+echo $reflection1->getReturnType();
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+int
+]]>
+ </screen>
+ </example>
+
+ <example>
+ <title>Usage on built-in functions</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$reflection2 = new ReflectionFunction('array_merge');
+
+var_dump($reflection2->getReturnType());
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+null
+]]>
+ </screen>
+ </example>
+ </para>
+ <para>
+ This is because many internal functions do not have types specified for their
+ parameters or return values. It is therefore best to avoid using this
+ method on built-in functions.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+
<member><methodname>ReflectionFunctionAbstract::hasReturnType</methodname></member>
+ <member><methodname>ReflectionType::__toString</methodname></member>
+ </simplelist>
+ </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:"~/.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
+-->
Modified: phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml 2015-08-20
14:06:46 UTC (rev 337566)
+++ phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml 2015-08-20
14:24:18 UTC (rev 337567)
@@ -39,7 +39,7 @@
<![CDATA[
<?php
-function to_int($param) : float {
+function to_int($param) : int {
return (int) $param;
}
Modified: phpdoc/en/trunk/reference/reflection/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/versions.xml 2015-08-20 14:06:46 UTC (rev 337566)
+++ phpdoc/en/trunk/reference/reflection/versions.xml 2015-08-20 14:24:18 UTC (rev 337567)
@@ -51,6 +51,7 @@
<function name='reflectionfunctionabstract::getstaticvariables' from='PHP
5'/>
<function name='reflectionfunctionabstract::returnsreference' from='PHP
5'/>
<function name='reflectionfunctionabstract::hasreturntype' from='PHP
7'/>
+ <function name='reflectionfunctionabstract::getreturntype' from='PHP
7'/>
<function name='reflectionfunction' from='PHP 5'/>
<function name='reflectionfunction::__clone' from='PHP 5'/>