Skip to content

Document ReflectionGenerator::isClosed #152

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.

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
Changes from all commits
Commits
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
94 changes: 94 additions & 0 deletions reference/reflection/reflectiongenerator/isclosed.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 84883b6030a179c7d48bfd79b71a5767c8d2646a Maintainer: jdkfx Status: ready -->
<!-- CREDITS: jdkfx -->
<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>ジェネレータの実行が完了したかどうかを確認する</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ReflectionGenerator">
<modifier>public</modifier> <type>bool</type><methodname>ReflectionGenerator::isClosed</methodname>
<void/>
</methodsynopsis>
<simpara>
実行中のジェネレータが関数の終端やreturn文に到達したか、または例外がスローされたかを返します。
</simpara>
</refsect1>

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

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
ジェネレーターの実行が完了したかどうかを返します。
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>ReflectionGenerator::isClosed</methodname> の例</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
-->