getcases.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ec2fe9a592f794978114ef5021db9f1d00c2e05d Maintainer: mumumu Status: ready -->
<refentry xml:id="reflectionenum.getcases" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ReflectionEnum::getCases</refname>
  <refpurpose>列挙型の全ての case を返す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ReflectionEnum">
   <modifier>public</modifier> <type>array</type><methodname>ReflectionEnum::getCases</methodname>
   <void/>
  </methodsynopsis>
  <para>
   列挙型には、ひとつ以上の case を含めることができます。
   このメソッドは、定義済みの全ての case を字句解析順
   (つまり、ソースコードに現れる順) に取得します。
  </para>

 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   列挙型のリフレクションオブジェクトの配列を返します。
   ひとつひとつが、列挙型の case を表します。
   Pure Enum の場合、すべてのインスタンスが
   <classname>ReflectionEnumUnitCase</classname> になります。
   Backed Enum の場合、すべてのインスタンスが
   <classname>ReflectionEnumBackedCase</classname> になります。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><methodname>ReflectionEnum::getCases</methodname> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
enum Suit
{
    case Hearts;
    case Diamonds;
    case Clubs;
    case Spades;
}

$rEnum = new ReflectionEnum(Suit::class);

$cases = $rEnum->getCases();

foreach ($cases as $rCase) {
    var_dump($rCase->getValue());
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
enum(Suit::Hearts)
enum(Suit::Diamonds)
enum(Suit::Clubs)
enum(Suit::Spades)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="language.enumerations">列挙型(Enum)</link></member>
    <member><methodname>ReflectionEnum::getCase</methodname></member>
    <member><methodname>ReflectionEnum::isBacked</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
-->