Document ReflectionFunctionAbstract::hasReturnType() method

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337566 c90b9560-bf6c-de11-be94-00142212c4b1

reference/reflection/reflectionfunctionabstract/hasreturntype.xml

@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionfunctionabstract.hasreturntype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionFunctionAbstract::hasReturnType</refname>
+  <refpurpose>Checks if the function has a specified return type</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>ReflectionFunctionAbstract::hasReturnType</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Checks whether the reflected function has a return type specified.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the function is a specified return type, otherwise &false;.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>ReflectionFunctionAbstract::hasReturnType</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+function to_int($param) : float {
+    return (int) $param;
+}
+
+$reflection1 = new ReflectionFunction('to_int');
+var_dump($reflection1->hasReturnType());
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+bool(true)
+]]>
+    </screen>
+   </example>
+
+   <example>
+    <title>Usage on built-in functions</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+$reflection2 = new ReflectionFunction('array_merge');
+
+var_dump($reflection2->hasReturnType());
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+bool(false)
+]]>
+    </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::getReturnType</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
+-->

reference/reflection/versions.xml

@@ -50,6 +50,7 @@
  <function name='reflectionfunctionabstract::getstartline' from='PHP 5'/>
  <function name='reflectionfunctionabstract::getstaticvariables' from='PHP 5'/>
  <function name='reflectionfunctionabstract::returnsreference' from='PHP 5'/>
+ <function name='reflectionfunctionabstract::hasreturntype' from='PHP 7'/>
 
  <function name='reflectionfunction' from='PHP 5'/>
  <function name='reflectionfunction::__clone' from='PHP 5'/>