svn: /phpdoc/en/trunk/reference/reflection/ reflectionfunctionabstract/hasreturntype.xml versions.xml

From: Date: Thu, 20 Aug 2015 14:06:46 +0000
Subject: svn: /phpdoc/en/trunk/reference/reflection/ reflectionfunctionabstract/hasreturntype.xml versions.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-13632@lists.php.net to get a copy of this message
tpunt Thu, 20 Aug 2015 14:06:46 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=337566 Log: Document ReflectionFunctionAbstract::hasReturnType() method Changed paths: A phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml U phpdoc/en/trunk/reference/reflection/versions.xml Added: phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml =================================================================== --- phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml (rev 0) +++ phpdoc/en/trunk/reference/reflection/reflectionfunctionabstract/hasreturntype.xml 2015-08-20 14:06:46 UTC (rev 337566) @@ -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 +--> Modified: phpdoc/en/trunk/reference/reflection/versions.xml =================================================================== --- phpdoc/en/trunk/reference/reflection/versions.xml 2015-08-20 13:59:50 UTC (rev 337565) +++ phpdoc/en/trunk/reference/reflection/versions.xml 2015-08-20 14:06:46 UTC (rev 337566) @@ -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'/>

« previous php.doc.cvs (#13632) next »