Document ReflectionGenerator::isClosed() (#3896)

Author: TimWolla

reference/reflection/reflectiongenerator/isclosed.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="reflectiongenerator.isclosed" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionGenerator::isClosed</refname>
+  <refpurpose>Checks if execution finished</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="ReflectionGenerator">
+   <modifier>public</modifier> <type>bool</type><methodname>ReflectionGenerator::isClosed</methodname>
+   <void/>
+  </methodsynopsis>
+  <simpara>
+   Returns whether the execution reached the end of the function, a return statement or if an exception was thrown.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   Returns whether the generator finished executing.
+  </simpara>
+ </refsect1>
+
+  <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><methodname>ReflectionGenerator::isClosed</methodname> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+function gen()
+{
+    yield 'a';
+    yield 'a';
+}
+
+$gen = gen();
+$reflectionGen = new ReflectionGenerator($gen);
+
+foreach ($gen as $value) {
+    echo $value, PHP_EOL;
+    var_dump($reflectionGen->isClosed());
+}
+
+var_dump($reflectionGen->isClosed());
+
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+a
+bool(false)
+a
+bool(false)
+bool(true)
+]]>
+   </screen>
+  </example>
+ </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

@@ -375,6 +375,7 @@
  <function name="reflectiongenerator::getexecutingline" from="PHP 7, PHP 8"/>
  <function name="reflectiongenerator::getexecutingfile" from="PHP 7, PHP 8"/>
  <function name="reflectiongenerator::getexecutinggenerator" from="PHP 7, PHP 8"/>
+ <function name="reflectiongenerator::isclosed" from="PHP 8 &gt;= 8.4.0"/>
 
  <function name="reflectionreference" from="PHP 7 &gt;= 7.4.0, PHP 8"/>
  <function name="reflectionreference::fromarrayelement" from="PHP 7 &gt;= 7.4.0, PHP 8"/>