Download the PHP package ryunosuke/polyfill-enum without Composer

PHP Enum Polyfill

Description

This package emulates enum feature of php8.1 and later.

Install

Demo

Spec

Inheriting a *Enum makes public const consider an enum case, and the case is obtained by a method call. All other specifications are the same as native enum.

• *Enum
  • PureEnum: compatible native PureEnum (like enum Hoge {...})
  • IntBackedEnum: compatible native IntBackedEnum (like enum Fuga: int {...})
  • StringBackedEnum: compatible native StringBackedEnum (like enum Piyo: string {...})

This package also provides ReflectionEnum*. These are fully compatible with native.

• ReflectionEnum*
  • ReflectionEnum: reflection Enum
  • ReflectionEnumUnitCase: reflection UnitCase
  • ReflectionEnumBackedCase: reflection BackedCase

Usage

See demo for details

enum

php8.1's enum is below

This package's enum is below

enum case is const that ...

• public
• value matches backed type(Pure is null)
• not EnumCase(false)
  • notice: EnumCase(true) has no effect at currently

mixin

Several traits are defined and can be conveniently used as needed.

• Methodable: provides Magic method call
  • __callStatic: returns case by name (e.g. Suit::Hearts())
  • practically required for php < 8.1
• Compatible: provides compatibility php8.1's native enum
  • disable magic method(e.g. clone, sleep, etc)
  • assert like enum(e.g. final, no properties, etc)
  • do other
• Initializable: provides initialize
  • this can be used like a java static initializer

Note

8.1 でポリフィルを使うと一部非互換となります。 具体的には enum_exists の結果が変わったり、 UnitEnum の instanceof が反応しなくなったりします。 これは組み込みゆえにどうしようもありません（組み込みの enum_exists にオレオレクラスを反応させることはできないし、UnitEnum の子クラスでもなくなるためです）。

demo の中に

• 8.0 で polyfill を使うもの
• 8.1 で polyfill を使うもの
• 8.1 で builtin を使うもの

があるので出力結果を比較してみてください。

FAQ

• Q. 8.1 のネイティブで良くない？
  • A. rhel9 の app stream に php8.0 が採用（10年サポート）されたため、8.0 縛りはしばらく続くと考えています（一応 7.4 も在命だしね）
• Q. だとして他に優秀なライブラリあるけど？
  • A. その通りです。ただ「enum が欲しい」のではなく「php8.1 の native enum 互換」が欲しかったのです（UnitEnum とか ReflectionEnum とか）
    • 例えば依存ライブラリで instanceof UnitEnum とか new ReflectionEnum() とかされていても問題なく使えるようになります
    • あと uopz の redefine で定数にオブジェクトを格納できると知ったのも大きいですね。これさえあれば使い勝手は 8.1 native とほぼ同じです
• Q. 機能少ないけど？
  • A. ポリフィルに徹してます。変に便利機能を持たせると移行がしづらくなるためです
    • あくまで enum と似た機能を提供するに留め、いざ 8.1 に移行したときに最小限の変更で済むようにする、がコンセプトです（究極的には定義部だけの変更に留めたい）
    • 確かに __toString とか name => value な配列を返す方法とかがあると便利は便利なんですけどね…

Release

Versioning follows semantic versioning.

• https://semver.org
  • major: change specifications (BC break)
  • minor: add feature (no BC break)
  • patch: fix bug (no BC break)

1.1.1

• [merge] 1.0.2

1.1.0

• [*change] php>=8.0

1.0.2

• [fixbug] trait/interface 読み込み時に多重定義エラーが出る不具合

1.0.1

• [fixbug] オートローダが無限ループする不具合を修正

1.0.0

• publish

License

MIT