A Symfony bundle for EasyAdmin that provide basic entity traits and a enum helper
MIT License
Provide base utilities for Easyadmin.
Repository Branch | Version | Symfony Compatibility | PHP Compatibility | Status |
---|---|---|---|---|
2.x |
2.x |
5.4 , and 6.x
|
8.0.2 or higher |
New features and bug fixes |
1.x |
1.x |
4.4 , and 5.x
|
7.2.5 or higher |
No longer maintained |
Install with composer
composer require agence-adeliom/easy-common-bundle
use Adeliom\EasyCommonBundle\Helper\Enum;
/**
* Action enum
*/
final class Action extends Enum
{
private const VIEW = 'view';
private const EDIT = 'edit';
}
$action = Action::VIEW();
// or with a dynamic key:
$action = Action::$key();
// or with a dynamic value:
$action = Action::from($value);
// or
$action = new Action($value);
As you can see, static methods are automatically implemented to provide quick access to an enum value.
One advantage over using class constants is to be able to use an enum as a parameter type:
function setAction(Action $action) {
// ...
}
__construct()
The constructor checks that the value exist in the enum__toString()
You can echo $myValue
, it will display the enum value (value of the constant)getValue()
Returns the current value of the enumgetKey()
Returns the key of the current value on Enumequals()
Tests whether enum instances are equal (returns true
if enum values are equal, false
otherwise)Static methods:
from()
Creates an Enum instance, checking that the value exist in the enumtoArray()
method Returns all possible values as an array (constant name in key, constant value in value)keys()
Returns the names (keys) of all constants in the Enum classvalues()
Returns instances of the Enum class of all Enum constants (constant name in key, Enum instance in value)isValid()
Check if tested value is valid on enum setisValidKey()
Check if tested key is valid on enum setassertValidValue()
Assert the value is valid on enum set, throwing exception otherwisesearch()
Return key for searched valuefinal class Action extends Enum
{
private const VIEW = 'view';
private const EDIT = 'edit';
}
// Static method:
$action = Action::VIEW();
$action = Action::EDIT();
Static method helpers are implemented using __callStatic()
.
If you care about IDE autocompletion, you can either implement the static methods yourself:
final class Action extends Enum
{
private const VIEW = 'view';
/**
* @return Action
*/
public static function VIEW() {
return new Action(self::VIEW);
}
}
or you can use phpdoc (this is supported in PhpStorm for example):
/**
* @method static Action VIEW()
* @method static Action EDIT()
*/
final class Action extends Enum
{
private const VIEW = 'view';
private const EDIT = 'edit';
}