Skip to content

Document ReflectionGenerator::isClosed() #3896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Document ReflectionGenerator::isClosed() #3896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a56321
Document `ReflectionGenerator::isClosed()`
TimWolla Oct 22, 2024
86f0f3f
Fix some markup issues
Girgias Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions reference/reflection/reflectiongenerator/isclosed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-->
1 change: 1 addition & 0 deletions reference/reflection/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>
Expand Down