getfunction.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectiongenerator.getfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ReflectionGenerator::getFunction</refname>
  <refpurpose>Gets the function name of the generator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ReflectionGenerator">
   <modifier>public</modifier> <type>ReflectionFunctionAbstract</type><methodname>ReflectionGenerator::getFunction</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Enables the function name of the generator to be obtained by returning a
   class derived from <classname>ReflectionFunctionAbstract</classname>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a <classname>ReflectionFunctionAbstract</classname> class. This will
   be <classname>ReflectionFunction</classname> for functions, or
   <classname>ReflectionMethod</classname> for methods.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       <methodname>ReflectionGenerator::getFunction</methodname>
       may now be called after the generator finished executing.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

  <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><methodname>ReflectionGenerator::getFunction</methodname> example</title>
    <programlisting role="php">
<![CDATA[
<?php

function gen()
{
    yield 1;
}

$gen = gen();

$reflectionGen = new ReflectionGenerator($gen);

var_dump($reflectionGen->getFunction());
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
object(ReflectionFunction)#3 (1) {
  ["name"]=>
  string(3) "gen"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>ReflectionGenerator::getThis</methodname></member>
    <member><methodname>ReflectionGenerator::getTrace</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
-->