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
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{fmt/title|PHP enum support}}
 
{{fmt/title|PHP enum support}}
 +
==Examples==
 +
{| class=wikitable
 +
! "Basic" enum || "Backed" enum
 +
|-
 +
|
 +
<syntaxhighlight lang=php>
 +
enum Suit
 +
{
 +
    case Hearts;
 +
    case Diamonds;
 +
    case Clubs;
 +
    case Spades;
 +
}
 +
</syntaxhighlight>
 +
|
 +
<syntaxhighlight lang=php>
 +
enum Suit: string
 +
{
 +
    case Hearts = 'H';
 +
    case Diamonds = 'D';
 +
    case Clubs = 'C';
 +
    case Spades = 'S';
 +
}
 +
</syntaxhighlight>
 +
|}
 
==Methods==
 
==Methods==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! kind of thing || name || args || returns || defined in
+
! kind of thing || name & args || returns || defined in || description
 
|-
 
|-
−
| static function || [https://www.php.net/manual/en/unitenum.cases.php cases] || <syntaxhighlight lang=php inline>()</syntaxhighlight> || array || UnitEnum
+
| static function || [https://www.php.net/manual/en/unitenum.cases.php cases]<syntaxhighlight lang=php inline>()</syntaxhighlight> || array || {{l/php/native|UnitEnum}}
 
|-
 
|-
−
| static function final || [https://www.php.net/manual/en/backedenum.tryfrom.php tryFrom] || <syntaxhighlight lang=php inline>(int|string $value)</syntaxhighlight> || ?static || BackedEnum
+
| static function final || [https://www.php.net/manual/en/backedenum.tryfrom.php tryFrom]<syntaxhighlight lang=php inline>(int|string $value)</syntaxhighlight> || ?static || {{l/php/native|BackedEnum}}
 
|-
 
|-
−
| static function final || [https://www.php.net/manual/en/backedenum.from.php from] || <syntaxhighlight lang=php inline>(int|string $value)</syntaxhighlight> || static || BackedEnum
+
| static function final || [https://www.php.net/manual/en/backedenum.from.php from]<syntaxhighlight lang=php inline>(int|string $value)</syntaxhighlight> || static || {{l/php/native|BackedEnum}}
 
|-
 
|-
−
| dynamic property || $name || || string || (UnitEnum)
+
| dynamic property || $name || string || ({{l/php/native|UnitEnum}})
 
|-
 
|-
−
| dynamic property || $value || || int or string || (BackedEnum)
+
| dynamic property || $value || int or string || ({{l/php/native|BackedEnum}}) || the name of the case (caps are preserved)
 
|}
 
|}
 
==Documentation==
 
==Documentation==
−
===official===
+
Note that enums can be cast directly to arrays.
 
* 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:
+
** {{l/php/native|UnitEnum}}
−
** [https://www.php.net/manual/en/class.backedenum.php <code>BackedEnum</code> interface]
+
** {{l/php/native|BackedEnum}}
−
** [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]

Latest revision as of 22:50, 23 August 2024

PHP enum support

Examples

"Basic" enum "Backed" enum 
enum Suit
{
    case Hearts;
    case Diamonds;
    case Clubs;
    case Spades;
}

enum Suit: string
{
    case Hearts = 'H';
    case Diamonds = 'D';
    case Clubs = 'C';
    case Spades = 'S';
}

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.

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]
Retrieved from "https://htyp.org/mw/index.php?title=PHP/enum&oldid=28935"