PHP/enum - Revision history

Woozle at 12:31, 15 March 2026

2026-03-15T12:31:09Z

← Older revision		Revision as of 12:31, 15 March 2026
Line 41:		Line 41:
	\|}		\|}
	==Caveats==		==Caveats==
			There is no <code>is_enum()</code> function.
	<code>Enum</code>s are similar to objects in that:		<code>Enum</code>s are similar to objects in that:
	* An <code>enum</code> case will pass the [https://www.php.net/manual/en/function.is-object.php <code>is_object()</code>] test. (I think.)		* An <code>enum</code> case will pass the [https://www.php.net/manual/en/function.is-object.php <code>is_object()</code>] test. (I think.)

Woozle at 21:11, 22 December 2025

2025-12-22T21:11:51Z

← Older revision		Revision as of 21:11, 22 December 2025
Line 30:		Line 30:
	! kind of thing \|\| name & args \|\| returns \|\| defined in \|\| description		! 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 \|\| {{l/php/native\|UnitEnum}}		\| static function \|\| [https://www.php.net/manual/en/unitenum.cases.php cases]<syntaxhighlight lang=php inline>()</syntaxhighlight> \|\| array \|\| {{l/php/native\|UnitEnum}} \|\| returns a packed array of all defined cases, in order of declaration
	\|-		\|-
	\| static function \|\| [https://www.php.net/manual/en/backedenum.tryfrom.php tryFrom]<syntaxhighlight lang=php inline>(int\|string $value)</syntaxhighlight> \|\| ?static \|\| {{l/php/native\|BackedEnum}} \|\| same as <code>from()</code>, but returns NULL if not found (instead of erroring)		\| static function \|\| [https://www.php.net/manual/en/backedenum.tryfrom.php tryFrom]<syntaxhighlight lang=php inline>(int\|string $value)</syntaxhighlight> \|\| ?static \|\| {{l/php/native\|BackedEnum}} \|\| same as <code>from()</code>, but returns NULL if not found (instead of erroring)
Line 40:		Line 40:
	\| dynamic property \|\| $value \|\| int or string \|\| {{l/php/native\|BackedEnum}} \|\| the value of the case		\| dynamic property \|\| $value \|\| int or string \|\| {{l/php/native\|BackedEnum}} \|\| the value of the case
	\|}		\|}
			==Caveats==
			<code>Enum</code>s are similar to objects in that:
			* An <code>enum</code> case will pass the [https://www.php.net/manual/en/function.is-object.php <code>is_object()</code>] test. (I think.)
			* They may implement interfaces.
			* Code in their methods may use <code>self::</code> and <code>$this-></code>.
			* The <code>::class</code> magic constant works.
			<code>Enum</code>s are [https://www.php.net/manual/en/language.enumerations.object-differences.php different from objects] in that:
			* They cannot be extended, or extend other entities.
			* They can't have constructors or destructors.
			* They can't have static properties.
			* The <code>::class</code> magic constant exists on individual cases (enum instances) as well.
			* An <code>enum</code> can't be instantiated like an object; individual cases are ''similar'' to singleton objects.
			** Cases also provide the <code>::class</code> magic constant. (I don't ''think'' this works on regular objects.)

			Not sure if <code>enum</code> cases can be used as <code>switch</code> cases (to be checked).
	==Documentation==		==Documentation==
	Note that enums can be cast directly to arrays.		Note that enums can be cast directly to arrays.
Line 48:		Line 62:
	*** [https://www.php.net/manual/en/language.enumerations.basics.php "Basic" enums]		*** [https://www.php.net/manual/en/language.enumerations.basics.php "Basic" enums]
	*** [https://www.php.net/manual/en/language.enumerations.backed.php "Backed" enums]		*** [https://www.php.net/manual/en/language.enumerations.backed.php "Backed" enums]
	* ~~Classoids~~:		* Demiclasses:
	** {{l/php/native\|UnitEnum}}		** {{l/php/native\|UnitEnum}}
	** {{l/php/native\|BackedEnum}}		** {{l/php/native\|BackedEnum}}
Line 58:		Line 72:
	* constant("{{arg\|enum name}}::{$value}")		* constant("{{arg\|enum name}}::{$value}")
	==Tests==		==Tests==
	* is an <code>enum</code> an object (<code>is_object</code>)? [YES]		* is an <code>enum</code> case an object (<code>is_object</code>)? [YES]
	* is an <code>enum</code> seen as <code>is_a UnitEnum</code>? [YES]		* is an <code>enum</code> seen as <code>is_a UnitEnum</code>? [YES]
	* is an <code>enum</code> an <code>instanceof UnitEnum</code>? [YES]		* is an <code>enum</code> an <code>instanceof UnitEnum</code>? [YES]
	* is an <code>enum</code> an <code>instanceof enum</code>? [no]		* is an <code>enum</code> an <code>instanceof enum</code>? [no]

Woozle: /* Methods */

2025-05-12T13:34:00Z

Methods

← Older revision		Revision as of 13:34, 12 May 2025
Line 32:		Line 32:
	\| static function \|\| [https://www.php.net/manual/en/unitenum.cases.php cases]<syntaxhighlight lang=php inline>()</syntaxhighlight> \|\| array \|\| {{l/php/native\|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 \|\| {{l/php/native\|BackedEnum}}		\| static function \|\| [https://www.php.net/manual/en/backedenum.tryfrom.php tryFrom]<syntaxhighlight lang=php inline>(int\|string $value)</syntaxhighlight> \|\| ?static \|\| {{l/php/native\|BackedEnum}} \|\| same as <code>from()</code>, but returns NULL if not found (instead of erroring)
	\|-		\|-
	\| 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}}		\| static function \|\| [https://www.php.net/manual/en/backedenum.from.php from]<syntaxhighlight lang=php inline>(int\|string $value)</syntaxhighlight> \|\| static \|\| {{l/php/native\|BackedEnum}} \|\| same as <code>tryFrom</code>, but throws an error if not found
	\|-		\|-
	\| dynamic property \|\| $name \|\| string \|\| ({{l/php/native\|UnitEnum}})		\| dynamic property \|\| $name \|\| string \|\| {{l/php/native\|UnitEnum}} \|\| the name of the case (case-sensitive)
	\|-		\|-
	\| dynamic property \|\| $value \|\| int or string \|\| ({{l/php/native\|BackedEnum}}) \|\| the ~~name~~ of the case ~~(caps are preserved)~~		\| dynamic property \|\| $value \|\| int or string \|\| {{l/php/native\|BackedEnum}} \|\| the value of the case
	\|}		\|}

	==Documentation==		==Documentation==
	Note that enums can be cast directly to arrays.		Note that enums can be cast directly to arrays.

Woozle at 22:50, 23 August 2024

2024-08-23T22:50:07Z

@@ Line 1: / Line 1: @@
 {{fmt/title|PHP enum support}}
 ==Methods==
 {| class="wikitable sortable"
@@ Line 15: / Line 40: @@
 | dynamic property || $value || int or string || ({{l/php/native|BackedEnum}}) || the name of the case (caps are preserved)
 |}
 ==Documentation==
 Note that enums can be cast directly to arrays.
 * Enumerations:
 ** [https://www.php.net/manual/en/language.types.enumerations.php variable type]

Woozle at 20:09, 23 August 2024

2024-08-23T20:09:58Z

← Older revision		Revision as of 20:09, 23 August 2024
Line 3:		Line 3:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	\|-		\|-
	! kind of thing \|\| name \|\| args \|\| returns \|\| defined in \|\| description		! 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) \|\| the name of the case (caps are preserved)		\| dynamic property \|\| $value \|\| int or string \|\| ({{l/php/native\|BackedEnum}}) \|\| the name of the case (caps are preserved)
	\|}		\|}

Line 25:		Line 25:
	*** [https://www.php.net/manual/en/language.enumerations.backed.php "Backed" enums]		*** [https://www.php.net/manual/en/language.enumerations.backed.php "Backed" enums]
	* Classoids:		* Classoids:
	** ~~[https:~~/~~/www.~~php~~.net~~/~~manual/en/class.unitenum.php <code>~~UnitEnum~~</code> interface]: "Basic" enum interface~~		** {{l/php/native\|UnitEnum}}
	** ~~[https:/~~/~~www.~~php~~.net~~/~~manual/en/class.backedenum.php <code>~~BackedEnum~~</code> interface]: "Backed" enum interface~~		** {{l/php/native\|BackedEnum}}
	===3rd party===		===3rd party===
	* [https://stitcher.io/blog/php-enums stitcher.io]		* [https://stitcher.io/blog/php-enums stitcher.io]

Woozle: /* Documentation */

2024-08-23T19:41:39Z

Documentation

← Older revision		Revision as of 19:41, 23 August 2024
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]

Woozle: /* Methods */

2024-08-23T19:36:23Z

Methods

← Older revision		Revision as of 19:36, 23 August 2024
Line 3:		Line 3:
	{\| 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 \|\| UnitEnum
Line 13:		Line 13:
	\| dynamic property \|\| $name \|\| \|\| string \|\| (UnitEnum)		\| dynamic property \|\| $name \|\| \|\| string \|\| (UnitEnum)
	\|-		\|-
	\| dynamic property \|\| $value \|\| \|\| int or string \|\| (BackedEnum)		\| dynamic property \|\| $value \|\| \|\| int or string \|\| (BackedEnum) \|\| the name of the case (caps are preserved)
	\|}		\|}

	==Documentation==		==Documentation==
	===official===		===official===

Woozle at 14:56, 25 April 2023

2023-04-25T14:56:53Z

← Older revision		Revision as of 14:56, 25 April 2023
Line 3:		Line 3:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	\|-		\|-
	! kind of thing \|\| name \|\| returns \|\| defined in		! kind of thing \|\| name \|\| args \|\| returns \|\| defined in
	\|-		\|-
	\| static function \|\| [https://www.php.net/manual/en/unitenum.cases.php cases]() \|\| array \|\| UnitEnum		\| static function \|\| [https://www.php.net/manual/en/unitenum.cases.php cases] \|\| <syntaxhighlight lang=php inline>()</syntaxhighlight> \|\| array \|\| UnitEnum
	\|-		\|-
	\| static function final \|\| [https://www.php.net/manual/en/backedenum.tryfrom.php tryFrom](int ~~''or''~~ string $value) \|\| ?static \|\| BackedEnum		\| 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 \|\| from(int ~~''or''~~ string $value) \|\| static \|\| BackedEnum		\| static function final \|\| [https://www.php.net/manual/en/backedenum.from.php from] \|\| <syntaxhighlight lang=php inline>(int\|string $value)</syntaxhighlight> \|\| static \|\| BackedEnum
	\|-		\|-
	\| dynamic property \|\| $name \|\| string \|\| (UnitEnum)		\| dynamic property \|\| $name \|\| \|\| string \|\| (UnitEnum)
	\|-		\|-
	\| dynamic property \|\| $value \|\| int or string \|\| (BackedEnum)		\| dynamic property \|\| $value \|\| \|\| int or string \|\| (BackedEnum)
	\|}		\|}
	==Documentation==		==Documentation==

Woozle at 20:42, 11 April 2023

2023-04-11T20:42:38Z

← Older revision		Revision as of 20:42, 11 April 2023
Line 32:		Line 32:
	To get a UnitEnum enum from a case name (equivalent to from()/tryFrom()):		To get a UnitEnum enum from a case name (equivalent to from()/tryFrom()):
	* constant("{{arg\|enum name}}::{$value}")		* constant("{{arg\|enum name}}::{$value}")
			==Tests==
			* is an <code>enum</code> an object (<code>is_object</code>)? [YES]
			* is an <code>enum</code> seen as <code>is_a UnitEnum</code>? [YES]
			* is an <code>enum</code> an <code>instanceof UnitEnum</code>? [YES]
			* is an <code>enum</code> an <code>instanceof enum</code>? [no]

Woozle: /* Documentation */

2023-04-10T12:34:33Z

Documentation

← Older revision		Revision as of 12:34, 10 April 2023
Line 16:		Line 16:
	\|}		\|}
	==Documentation==		==Documentation==
			===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]
Line 25:		Line 26:
	** [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]
	** [https://www.php.net/manual/en/language.enumerations.backed.php language reference]		** [https://www.php.net/manual/en/language.enumerations.backed.php language reference]
			===3rd party===
			* [https://stitcher.io/blog/php-enums stitcher.io]

	==Sample Code==		==Sample Code==
	To get a UnitEnum enum from a case name (equivalent to from()/tryFrom()):		To get a UnitEnum enum from a case name (equivalent to from()/tryFrom()):
	* constant("{{arg\|enum name}}::{$value}")		* constant("{{arg\|enum name}}::{$value}")