<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/language.enumerations.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'language.enumerations.basics.php',
    1 => '枚举基础',
    2 => '枚举基础',
  ),
  'up' => 
  array (
    0 => 'language.enumerations.php',
    1 => '枚举',
  ),
  'prev' => 
  array (
    0 => 'language.enumerations.overview.php',
    1 => '枚举概览',
  ),
  'next' => 
  array (
    0 => 'language.enumerations.backed.php',
    1 => '带值（回退）枚举',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'language/enumerations.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="language.enumerations.basics" class="sect1">
  <h2 class="title">枚举基础</h2>

  <p class="para">
   Enum 类似 class，它和 class、interface、trait 共享同样的命名空间。
   也能用同样的方式自动加载。
   一个 Enum 定义了一种新的类型，它有固定、数量有限、可能的合法值。
  </p>


  <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">enum </span><span style="color: #0000BB">Suit<br /></span><span style="color: #007700">{<br />    case </span><span style="color: #0000BB">Hearts</span><span style="color: #007700">;<br />    case </span><span style="color: #0000BB">Diamonds</span><span style="color: #007700">;<br />    case </span><span style="color: #0000BB">Clubs</span><span style="color: #007700">;<br />    case </span><span style="color: #0000BB">Spades</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
  </div>


  <p class="para">
   以上声明了新的枚举类型 <code class="literal">Suit</code>，仅有四个有效的值：
   <code class="literal">Suit::Hearts</code>、<code class="literal">Suit::Diamonds</code>、
   <code class="literal">Suit::Clubs</code>、<code class="literal">Suit::Spades</code>。
   变量可以赋值为以上有效值里的其中一个。
   函数可以检测枚举类型，这种情况下只能传入类型的值。
  </p>

  <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">pick_a_card</span><span style="color: #007700">(</span><span style="color: #0000BB">Suit $suit</span><span style="color: #007700">)<br />{<br />    </span><span style="color: #FF8000">/* ... */<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">Suit</span><span style="color: #007700">::</span><span style="color: #0000BB">Diamonds</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// OK<br /></span><span style="color: #0000BB">pick_a_card</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// OK<br /></span><span style="color: #0000BB">pick_a_card</span><span style="color: #007700">(</span><span style="color: #0000BB">Suit</span><span style="color: #007700">::</span><span style="color: #0000BB">Clubs</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// TypeError: pick_a_card(): Argument #1 ($suit) must be of type Suit, string given<br /></span><span style="color: #0000BB">pick_a_card</span><span style="color: #007700">(</span><span style="color: #DD0000">'Spades'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
  </div>


  <p class="para">
   一个枚举可以定义零个或多个<code class="literal">case</code>，且没有最大数量限制。
   虽然零个 case 的 enum 没什么用处，但在语法上也是有效的。
  </p>

  <p class="para">
    枚举条目的语法规则适用于 PHP 中的任何标签，参见<a href="language.constants.php" class="link">常量</a>。
   </p>

  <p class="para">
   默认情况下，枚举的条目（case）本质上不是标量。
   就是说 <code class="literal">Suit::Hearts</code> 不等同于 <code class="literal">&quot;0&quot;</code>。
   其实，本质上每个条目是该名称对象的单例。具体来说：
  </p>

  <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$a </span><span style="color: #007700">= </span><span style="color: #0000BB">Suit</span><span style="color: #007700">::</span><span style="color: #0000BB">Spades</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$b </span><span style="color: #007700">= </span><span style="color: #0000BB">Suit</span><span style="color: #007700">::</span><span style="color: #0000BB">Spades</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$a </span><span style="color: #007700">=== </span><span style="color: #0000BB">$b</span><span style="color: #007700">; </span><span style="color: #FF8000">// true<br /><br /></span><span style="color: #0000BB">$a </span><span style="color: #007700">instanceof </span><span style="color: #0000BB">Suit</span><span style="color: #007700">;  </span><span style="color: #FF8000">// true<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
  </div>


  <p class="para">
   由于对象间的大小比较毫无意义，这也意味着 enum 值从来不会 <code class="literal">&lt;</code> 或 <code class="literal">&gt;</code>
   其他值。当 enum 的值用于比较时，总是返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>

  <p class="para">
   这类没有关联数据的条目（case），被称为“纯粹条目”（Pure Case）。
   仅包含纯粹 Case 的 Enum 被称为纯粹枚举（Pure Enum）。
  </p>

  <p class="para">
   枚举类型里所有的纯粹条目都是自身的实例。枚举类型在内部的实现形式是 class。
  </p>

  <p class="para">
   所有的 case 有个只读的属性 <code class="literal">name</code>。
   它大小写敏感，是 case 自身的名称。
  </p>

  <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">print </span><span style="color: #0000BB">Suit</span><span style="color: #007700">::</span><span style="color: #0000BB">Spades</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">name</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// 输出 "Spades"<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
  </div>


   <p class="para">
    如果名称是动态获取的，也可以使用 <span class="function"><a href="function.defined.php" class="function">defined()</a></span> 和 <span class="function"><a href="function.constant.php" class="function">constant()</a></span>
    函数来检查枚举成员是否存在或读取其值。然而，这种方法并不推荐，因为对于大多数使用场景，使用<a href="language.enumerations.backed.php" class="link">带值枚举</a>即可满足需求。
   </p>

  </div><?php manual_footer($setup); ?>