Difference between revisions of "PHP/enum"

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
< PHP
Jump to navigation Jump to search
Line 17: Line 17:
  
 
==Documentation==
 
==Documentation==
 +
Note that enums can be cast directly to arrays.
 
===official===
 
===official===
 
* Enumerations:
 
* Enumerations:
 
** [https://www.php.net/manual/en/language.types.enumerations.php variable type]
 
** [https://www.php.net/manual/en/language.types.enumerations.php variable type]
 
** [https://www.php.net/manual/en/language.enumerations.php Enumerations language reference]
 
** [https://www.php.net/manual/en/language.enumerations.php Enumerations language reference]
* Basic:
+
*** [https://www.php.net/manual/en/language.enumerations.basics.php "Basic" enums]
** [https://www.php.net/manual/en/class.unitenum.php <code>UnitEnum</code> interface]
+
*** [https://www.php.net/manual/en/language.enumerations.backed.php "Backed" enums]
** [https://www.php.net/manual/en/language.enumerations.basics.php language reference]
+
* Classoids:
* Backed:
+
** [https://www.php.net/manual/en/class.unitenum.php <code>UnitEnum</code> interface]: "Basic" enum interface
** [https://www.php.net/manual/en/class.backedenum.php <code>BackedEnum</code> interface]
+
** [https://www.php.net/manual/en/class.backedenum.php <code>BackedEnum</code> interface]: "Backed" enum interface
** [https://www.php.net/manual/en/language.enumerations.backed.php language reference]
 
 
===3rd party===
 
===3rd party===
 
* [https://stitcher.io/blog/php-enums stitcher.io]
 
* [https://stitcher.io/blog/php-enums stitcher.io]

Revision as of 19:41, 23 August 2024

PHP enum support

Methods

kind of thing name args returns defined in description
static function cases () array UnitEnum
static function final tryFrom (int|string $value) ?static BackedEnum
static function final from (int|string $value) static BackedEnum
dynamic property $name string (UnitEnum)
dynamic property $value int or string (BackedEnum) the name of the case (caps are preserved)

Documentation

Note that enums can be cast directly to arrays.

official

3rd party

Sample Code

To get a UnitEnum enum from a case name (equivalent to from()/tryFrom()):

  • constant("<enum name>::{$value}")

Tests

  • is an enum an object (is_object)? [YES]
  • is an enum seen as is_a UnitEnum? [YES]
  • is an enum an instanceof UnitEnum? [YES]
  • is an enum an instanceof enum? [no]