<div id="readability-page-1" class="page"><div>
 <div>
 
 
 <h2>
 PHP 8.1 RFC를 통과한 PHP Enums
 </h2>
 
 <h3>
 2021-02-22
 </h3>
 
 </div>
 

 
 


 
 
 

 PHP에서는 기존까지 별도의 Enum class를 지원하지 않아 아래의 예시 처럼 class의 const(상수)를 선언해 사용했었습니다.

<div><pre><code>class Status
{
 const NOT_WORKING = 0;
 const WORKING = 1;
}
</code></pre></div>

하지만 며칠 전(2월 17일) 투표를 완료한 <a href="https://wiki.php.net/rfc/enumerations">PHP rfc:enumerations</a>에서 최종적으로 
Enum(열거형) 기능을 PHP 8.1에 추가되기로 결정 되었습니다.

근본 적으로 <code>enum</code>은 <code>class</code> 와 동일하게 취급되며, 상속, 인터페이스 등의 기능을 공유합니다.

몇가지 예시와 함께 enum의 기능에 대해서 알아 보겠습니다!

<blockquote>
 아래 예시는 <a href="https://stitcher.io/blog/php-enums">stitcher.io</a>와 <a href="https://php.watch/versions/8.1#enums">php.watch</a>에서 발췌 했습니다.
</blockquote>

<h2 id="php-enum">PHP Enum</h2>

사용 방법은 <code>class</code>를 선언과 비슷합니다. <code>enum</code> 키워드 옆에 enum의 이름을 쓰고, 
각각의 enum 들은 <code>case</code>로 선언 할 수 있습니다.

<div><pre><code>enum Status
{
 case DRAFT;
 case PUBLISHED;
 case ARCHIVED;
}
</code></pre></div>

이렇게 보면 기존의 <code>class</code>를 이용하는 것과 단순히 키워드만 다른 것 처럼 보지만, 
가장 큰 장점은 이를 타입처럼 사용할 수 있다는 것 입니다.

<div><pre><code>class BlogPost
{
 public function __construct(
 public Status $status,
 ) {}
}

$post = new BlogPost(Status::DRAFT);
</code></pre></div>

만약 <code>$status</code> 인자에 다른 <code>int</code>이나 <code>string</code>등이 들어가게 되면 <code>TypeError</code>를 출력하게 됩니다.

<h2 id="enum-method">Enum method</h2>

기본적으로 <code>enum</code>은 class로 취급하기에, <code>enum</code> 안에 메소드를 넣을 수 있습니다!

<div><pre><code>enum Status
{
 case DRAFT;
 case PUBLISHED;
 case ARCHIVED;

 public function color(): string
 {
 return match($this)
 {
 Status::DRAFT =&gt; 'grey',
 Status::PUBLISHED =&gt; 'green',
 Status::ARCHIVED =&gt; 'red',
 };
 }
}
</code></pre></div>

여기서 중요한 건 <code>Status::SOMETHING</code>의 값이 ‘상수’나 ‘스칼라’값이 아닌 ‘객체’입니다.

즉, 이를 이용해 아래처럼 사용할 수 있습니다.

<div><pre><code>$status = Status::ARCHIVED;

$status-&gt;color(); // 'red'
</code></pre></div>

또한, <code>enum</code> 객체는 <code>read-only</code> 속성인 <code>name</code>을 가지고 있어 이를 통해 <code>enum</code>의 이름을 가져올 수 있습니다.

<div><pre><code>echo Status::ARCHIVED-&gt;name; // print 'ARCHIVED'
</code></pre></div>

마지막으로, Enum의 이름은 반드시 고유해야 하지만 대소문자를 구분합니다.

<div><pre><code>enum Status
{
 case foo;
 case Foo;
 case fOO;
}
</code></pre></div>

<h2 id="enum-values---일명-backed-enums">Enum values - 일명 “Backed enums”</h2>

“지원되는” 열거형(?) 혹은 “유동적인” 열거형(?) 처럼 어떻게 불러야할지 애매하지만, 
<code>enum</code>의 각 <code>case</code>가 별도의 값을 가질 수 있습니다.

이와 반대로 아무런 값을 <a href="#php-enum">위의 예제</a> 처럼 값을 가지지 않는 열거형을 “Pure enums”라고 부릅니다.

<div><pre><code>enum Status: string
{
 case DRAFT = 'draft';
 case PUBLISHED = 'published';
 case ARCHIVED = 'archived';
}
// OR
enum Status: int
{
 case DRAFT = 1;
 case PUBLISHED = 2;
 case ARCHIVED = 3;
}
</code></pre></div>

다만, Enum의 타입은 <code>string</code> 혹은 <code>int</code> 만 가능하며, <code>int|string</code> 처럼 union 타입은 가질 수 없습니다.

<h2 id="backed-enums의-직렬화">“Backed enums”의 직렬화</h2>

각각의 케이스는 객체이기 때문에 위에서 이야기한 <code>name</code> 속성을 가지고 있습니다. 
하지만 “Backed Enum”은 <code>read-only</code>의 속성인 <code>value</code>도 가지고 있어, 아래와 같이 선언된 값을 가져올 수 있습니다.

<div><pre><code>$value = Status::PUBLISHED-&gt;value; // 2
</code></pre></div>

또한 기본적으로 제공되는 <code>from</code> 메소드를 이용해 값으로 부터 <code>enum</code> 객체를 가져올 수 있습니다.

<div><pre><code>$status = Status::from(2); // Status::PUBLISHED
</code></pre></div>

물론 <code>tryFrom</code> 메소드를 이용해 그 반대도 가능합니다.

<div><pre><code>$status = Status::tryFrom('PUBLISHED'); // Status::PUBLISHED
</code></pre></div>

하지만 각 메소드는 값이 없을때 다르게 반응하는데, <code>tryFrom</code> 은 <code>null</code>를 반환하지만, 
<code>from</code>은 <code>ValueError</code> 예외를 발생 시킵니다.

<div><pre><code>$status = Status::from('unknown'); // ValueError
$status = Status::tryFrom('unknown'); // null
</code></pre></div>

<h2 id="enum-값-리스트">Enum 값 리스트</h2>

<code>Enum::cases()</code> static 메소드를 이용해서 사용 가능한 <code>case</code> 들이 담긴 array을 가져올 수 있습니다.

<div><pre><code>Status::cases();

/* [
 Status::DRAFT,
 Status::PUBLISHED,
 Status::ARCHIVED
] */
</code></pre></div>

만약 “Backed Enums” 이라면 array의 키로 value를 넣어 반환 됩니다.

<div><pre><code>Status::cases();

/* [
 'draft' =&gt; Status::DRAFT,
 'published' =&gt; Status::PUBLISHED,
 'archived' =&gt; Status::ARCHIVED,
] */
</code></pre></div>

<h2 id="enum과-비교-연산자">Enum과 비교 연산자</h2>

Enum은 객체이지만, 싱글턴 처럼 동작되기에 아래처럼 비교 될 수 있습니다.

<div><pre><code>$statusA = Status::PENDING;
$statusB = Status::PENDING;
$statusC = Status::ARCHIVED;

new ObjectClass === new ObjectClass; // false
$statusA === $statusB; // true
$statusA === $statusC; // false
$statusC instanceof Status; // true
</code></pre></div>

<h2 id="array의-키로써의-enum">array의 키로써의 Enum</h2>

enum은 열거형이기 때문에 배열의 키로 사용할 수 없습니다.

<div><pre><code>$list = [
 Status::DRAFT =&gt; 'draft', // Fatal error: Uncaught TypeError ...
];
</code></pre></div>

하지만 <a href="https://wiki.php.net/rfc/object_keys_in_arrays">이 RFC</a>가 통과 된다면, 가능해질 수 도 있습니다.

<h2 id="클래스와의-차이점">클래스와의 차이점</h2>

<table>
 <thead>
 <tr>
 <th>&nbsp;</th>
 <th>Class</th>
 <th>Enum</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>문법</td>
 <td><code>class Foo {}</code></td>
 <td><code>enum Foo {}</code></td>
 </tr>
 <tr>
 <td>속성 (property)</td>
 <td>✅</td>
 <td>❌</td>
 </tr>
 <tr>
 <td>static 속성</td>
 <td>✅</td>
 <td>❌</td>
 </tr>
 <tr>
 <td>메소드</td>
 <td>✅</td>
 <td>✅</td>
 </tr>
 <tr>
 <td>static 메소드</td>
 <td>✅</td>
 <td>✅</td>
 </tr>
 <tr>
 <td>오토로딩</td>
 <td>✅</td>
 <td>✅</td>
 </tr>
 <tr>
 <td><code>new</code> 키워드</td>
 <td>✅</td>
 <td>❌</td>
 </tr>
 <tr>
 <td>인터페이스 사용</td>
 <td>✅</td>
 <td>✅</td>
 </tr>
 <tr>
 <td>상속 <code>Foo extends Bar</code></td>
 <td>✅</td>
 <td>❌</td>
 </tr>
 <tr>
 <td>마법 상수 <code>::class</code>, <code>__CLASS__</code>, etc</td>
 <td>✅</td>
 <td>✅</td>
 </tr>
 <tr>
 <td>마법 메소드 <code>__get</code>, <code>__set</code>, etc</td>
 <td>✅</td>
 <td>❌</td>
 </tr>
 <tr>
 <td>비교 <code>Foo === Foo</code></td>
 <td><code>false</code></td>
 <td><code>true</code></td>
 </tr>
 <tr>
 <td>Trait</td>
 <td>✅</td>
 <td>✅ (단, 속성 없이)</td>
 </tr>
 </tbody>
</table>

<h2 id="그-외-추가-되는-기능들">그 외 추가 되는 기능들</h2>
<h2 id="enum_exists-함수가-추가됩니다"><code>enum_exists</code> 함수가 추가됩니다.</h2>
<div><pre><code>function enum_exists(string $enum, bool $autoload = true): bool {}
</code></pre></div>

<h2 id="reflection-클래스가-추가됩니다">Reflection 클래스가 추가됩니다.</h2>

<code>ReflectionEnum</code>, <code>ReflectionEnumUnitCase</code>, <code>ReflectionEnumBackedCase</code> 등의 <a href="https://www.php.net/manual/en/book.reflection.php">Reflection 클래스</a>가 추가됩니다.

<h2 id="enum-과-관련된-unitenum-scalarenum-인터페이스가-추가됩니다">Enum 과 관련된 <code>UnitEnum</code>, <code>ScalarEnum</code> 인터페이스가 추가됩니다.</h2>

Enum은 기본적으론 클래스로 취급되기에 인터페이스를 가질 수 있습니다. 
그에 따른 Enum과 관련된 PHP 기본 인터페이스가 추가됩니다.

<div><pre><code>interface UnitEnum {
 public static function cases(): array;
}

interface ScalarEnum extends UnitEnum {
 public static function from(int|string $value): static;
 public static function tryFrom(int|string $value): ?static;
}
</code></pre></div>

<h2 id="마치며">마치며</h2>

이번 글에선 추가되는 Enum의 기능을 위주로 담았습니다만, 메직메소드를 사용하지 못한다던지 많은 제약사항들이 존재합니다.
그치만, 2021년 11월에 릴리즈 되기도하고, 아직 구현단계이기에 어떻게 진행될지는 계속 지켜봐야 할 것 같습니다. 
그리고, <a href="https://wiki.php.net/rfc/object_keys_in_arrays">오브젝트 array 키 RFC</a>와 같은 다른 RFC의 진행에따라 구현이 달라질 겁니다.

하지만 이번 기능에 대해서 들여다볼 가치는 충분하다고 생각합니다.

<h2 id="참조">참조</h2>

<ol>
 <li><a href="https://wiki.php.net/rfc/enumerations">https://wiki.php.net/rfc/enumerations</a></li>
 <li><a href="https://stitcher.io/blog/php-enums">https://stitcher.io/blog/php-enums</a></li>
 <li><a href="https://php.watch/versions/8.1#enums">https://php.watch/versions/8.1</a></li>
</ol>

 
 
 
</div></div>

PHP Enums

댓글