Download the PHP package codica-studio/enum without Composer
On this page you can find all versions of the php package codica-studio/enum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codica-studio/enum
More information about codica-studio/enum
Files in codica-studio/enum
Package enum
Short Description A random Codica Studio package.
License MIT
Homepage https://github.com/codicastudio/enum
Informations about the package enum
About Enum
Simple, extensible and powerful enumeration implementation for Laravel.
- Enum key value pairs as class constants
- Full featured suite of methods
- Enum instantiation
- Flagged/Bitwise enums
- Type hinting
- Attribute casting
- Enum artisan generator
- Validation rules for passing enum key or values as input parameters
- Localization support
- Extendable via Macros
Jump To
- Guide
- Installation
- Enum Library
- Basic Usage
- Enum definition
- Instantiation
- Instance Properties
- Instance Equality
- Type Hinting
- Flagged/Bitwise Enum
- Attribute Casting
- Migrations
- Validation
- Localization
- Overriding the getDescription method
- Extending the Enum Base Class
- Laravel Nova Integration
- PHPStan Integration
- Artisan Command List
- Enum Class Reference
Installation
Requirements
- Laravel
8
or higher - PHP
7.3
or higher
Via Composer
Enum Library
Browse and download from a list of commonly used, community contributed enums.
Enum library →
Basic Usage
Enum Definition
You can use the following Artisan command to generate a new enum class:
Now, you just need to add the possible values your enum can have as constants.
That's it! Note that because the enum values are defined as plain constants, you can simple access them like any other class constant.
Instantiation
It can be useful to instantiate enums in order to pass them between functions with the benefit of type hinting.
Additionally, it's impossible to instantiate an enum with an invalid value, therefore you can be certain that the passed value is always valid.
For convenience, enums can be instantiated in multiple ways:
If you want your IDE to autocomplete the static instantiation helpers, you can generate PHPDoc annotations through an artisan command.
By default all Enums in app/Enums
will be annotated (you can change the folder by passing a path to --folder
)
You can annotate a single class by specifying the class name
Instance Properties
Once you have an enum instance, you can access the key
, value
and description
as properties.
This is particularly useful if you're passing an enum instance to a blade view.
Instance Casting
Enum instances can be cast to strings as they implement the __toString()
magic method.
This also means they can be echoed in blade views, for example.
Instance Equality
You can check the equality of an instance against any value by passing it to the is
method. For convenience, there is also an isNot
method which is the exact reverse of the is
method.
You can also check to see if the instance's value matches against an array of possible values using the in
method.
Type Hinting
One of the benefits of enum instances is that it enables you to use type hinting, as shown below.
Flagged/Bitwise Enum
Standard enums represent a single value at a time, but flagged or bitwise enums are capable of of representing multiple values simultaneously. This makes them perfect for when you want to express multiple selections of a limited set of options. A good example of this would be user permissions where there are a limited number of possible permissions but a user can have none, some or all of them.
You can create a flagged enum using the following artisan command:
php artisan make:enum UserPermissions --flagged
Defining values
When defining values you must use powers of 2, the easiest way to do this is by using the shift left <<
operator like so:
Defining shortcuts
You can use the bitwise or |
to set a shortcut value which represents a given set of values.
Instantiating a flagged enum
There are couple of ways to instantiate a flagged enum:
Attribute casting works in the same way as single value enums.
Empty flagged enums
Flagged enums can contain no value at all. Every flagged enum has a pre-defined constant of None
which is comparable to 0
.
Flagged enum methods
In addition to the standard enum methods, there are a suite of helpful methods available on flagged enums.
Note: Anywhere where a static property is passed, you can also pass an enum instance.
setFlags(array $flags): Enum
Set the flags for the enum to the given array of flags.
addFlag($flag): Enum
Add the given flag to the enum
addFlags(array $flags): Enum
Add the given flags to the enum
removeFlag($flag): Enum
Remove the given flag from the enum
removeFlags(array $flags): Enum
Remove the given flags from the enum
hasFlag($flag): bool
Check if the enum has the specified flag.
hasFlags(array $flags): bool
Check if the enum has all of the specified flags.
notHasFlag($flag): bool
Check if the enum does not have the specified flag.
notHasFlags(array $flags): bool
Check if the enum doesn't have any of the specified flags.
getFlags(): Enum[]
Return the flags as an array of instances.
hasMultipleFlags(): bool
Check if there are multiple flags set on the enum.
getBitmask(): int
Get the bitmask for the enum.
Attribute Casting
You may cast model attributes to enums using Laravel 7.x's built in custom casting. This will cast the attribute to an enum instance when getting and back to the enum value when setting.
Since Enum::class
implements the Castable
contract, you just need to specify the classname of the enum:
Now, when you access the user_type
attribute of your Example
model,
the underlying value will be returned as a UserType
enum.
Review the methods and properties available on enum instances to get the most out of attribute casting.
You can set the value by either passing the enum value or another enum instance.
Casting underlying native types
Many databases return everything as strings (for example, an integer may be returned as the string '1'
).
To reduce friction for users of the library, we use type coercion to figure out the intended value. If you'd prefer to control this, you can override the parseDatabase
static method on your enum class:
Returning null
from the parseDatabase
method will cause the attribute on the model to also be null
. This can be useful if your database stores inconsistent blank values such as empty strings instead of NULL
.
Model Annotation
If you're using Laravel 7 casting, the laravel-ide-helper package can be used to automatically generate property docblocks for your models.
Migrations
Recommended
Because enums enforce consistency at the code level it's not necessary to do so again at the database level, therefore the recommended type for database columns is string
or int
depending on your enum values. This means you can add/remove enum values in your code without worrying about your database layer.
Using enum
column type
Alternatively you may use Enum
classes in your migrations to define enum columns.
The enum values must be defined as strings.
Validation
Array Validation
Enum value
You may validate that an enum value passed to a controller is a valid value for a given enum by using the EnumValue
rule.
By default, type checking is set to strict, but you can bypass this by passing false
to the optional second parameter of the EnumValue class.
Enum key
You can also validate on keys using the EnumKey
rule. This is useful if you're taking the enum key as a URL parameter for sorting or filtering for example.
Enum instance
Additionally you can validate that a parameter is an instance of a given enum.
Pipe Validation
You can also use the 'pipe' syntax for rules.
enum_value_:enumclass,[strict]
enum_key_:enumclass
enum_:enumclass
Localization
Validation messages
Run the following command to publish the language files to your resources/lang
folder.
Enum descriptions
You can translate the strings returned by the getDescription
method using Laravel's built in localization features.
Add a new enums.php
keys file for each of your supported languages. In this example there is one for English and one for Spanish.
Now, you just need to make sure that your enum implements the LocalizedEnum
interface as demonstrated below:
The getDescription
method will now look for the value in your localization files. If a value doesn't exist for a given key, the default description is returned instead.
Overriding the getDescription method
If you'd like to return a custom value from the getDescription method, you may do so by overriding the method on your enum:
Calling UserType::getDescription(3);
now returns Super admin
instead of Super administator
.
Extending the Enum Base Class
The Enum
base class implements the Laravel Macroable
trait, meaning it's easy to extend it with your own functions. If you have a function that you often add to each of your enums, you can use a macro.
Let's say we want to be able to get a flipped version of the enum asArray
method, we can do this using:
Now, on each of my enums, I can call it using UserType::asFlippedArray()
.
It's best to register the macro inside of a service providers' boot method.
Laravel Nova Integration
Use the nova-enum-field package by Simple Squid to easily create fields for your Enums in Nova. See their readme for usage.
PHPStan integration
If you are using PHPStan for static analysis, you can enable the extension for proper recognition of the magic instantiation methods.
Add the following to your projects phpstan.neon
includes:
Artisan Command List
php artisan make:enum
Create a new enum class. Pass --flagged
as an option to create a flagged enum.
Find out more
php artisan enum:annotate
Generate DocBlock annotations for enum classes.
Find out more
Enum Class Reference
static getKeys(): array
Returns an array of the keys for an enum.
static getValues(): array
Returns an array of the values for an enum.
static getKey(mixed $value): string
Returns the key for the given enum value.
static getValue(string $key): mixed
Returns the value for the given enum key.
static hasKey(string $key): bool
Check if the enum contains a given key.
static hasValue(mixed $value, bool $strict = true): bool
Check if the enum contains a given value.
static getDescription(mixed $value): string
Returns the key in sentence case for the enum value. It's possible to override the getDescription method to return custom descriptions.
static getRandomKey(): string
Returns a random key from the enum. Useful for factories.
static getRandomValue(): mixed
Returns a random value from the enum. Useful for factories.
static getRandomInstance(): mixed
Returns a random instance of the enum. Useful for factories.
static asArray(): array
Returns the enum key value pairs as an associative array.
static asSelectArray(): array
Returns the enum for use in a select as value => description.
static fromValue(mixed $enumValue): Enum
Returns an instance of the called enum. Read more about enum instantiation.
static getInstances(): array
Returns an array of all possible instances of the called enum, keyed by the constant names.
static coerce(mixed $enumKeyOrValue): ?Enum
Attempt to instantiate a new Enum using the given key or value. Returns null if the Enum cannot be instantiated.
All versions of enum with dependencies
hanneskod/classtools Version ~1.0
illuminate/support Version ^8.0
illuminate/contracts Version ^8.0
laminas/laminas-code Version ^3.4