PHP-enum: The Enum PHP is Missing, inspired From SplEnum

PHP Enum implementation inspired from SplEnum

Maintenance for this project is supported via Tidelift.

Why?

First, and mainly, SplEnum is not integrated to PHP, you have to install the extension separately.

Using an enum instead of class constants provides the following advantages:

  • You can use an enum as a parameter type: function setAction(Action $action) {
  • You can use an enum as a return type: function getAction() : Action {
  • You can enrich the enum with methods (e.g. format, parse, …)
  • You can extend the enum to add new values (make your enum final to prevent it)
  • You can get a list of all the possible values (see below)

This Enum class is not intended to replace class constants, but only to be used when it makes sense.

Installation

composer require myclabs/php-enum

Declaration

use MyCLabs\Enum\Enum;

/**
 * Action enum
 *
 * @extends Enum<Action::*>
 */
final class Action extends Enum
{
    private const VIEW = 'view';
    private const EDIT = 'edit';
}

Usage

$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) {
    // ...
}

Documentation

  • __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 enum
  • getKey() Returns the key of the current value on Enum
  • equals() 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 enum
  • toArray() 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 class
  • values() 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 set
  • isValidKey() Check if tested key is valid on enum set
  • assertValidValue() Assert the value is valid on enum set, throwing exception otherwise
  • search() Return key for searched value

Static methods

final 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';
}

Native enums and migration

Native enum arrived to PHP in version 8.1: https://www.php.net/enumerations
If your project is running PHP 8.1+ or your library has it as a minimum requirement you should use it instead of this library.

When migrating from myclabs/php-enum, the effort should be small if the usage was in the recommended way:

  • private constants
  • final classes
  • no method overridden

Changes for migration:

  • Class definition should be changed from ```php /**
  • @method static Action VIEW()
  • @method static Action EDIT()

*/ final class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; }

 to
```php
enum Action: string
{
    case VIEW = 'view';
    case EDIT = 'edit';
}

All places where the class was used as a type will continue to work.

Usages and the change needed:

Operationmyclabs/php-enumnative enum
Obtain an instance will change from$enumCase = Action::VIEW()$enumCase = Action::VIEW
Create an enum from a backed value$enumCase = new Action('view')$enumCase = Action::from('view')
Get the backed value of the enum instance$enumCase->getValue()$enumCase->value
Compare two enum instances$enumCase1 == $enumCase2 
or 
$enumCase1->equals($enumCase2)
$enumCase1 === $enumCase2
Get the key/name of the enum instance$enumCase->getKey()$enumCase->name
Get a list of all the possible instances of the enumAction::values()Action::cases()
Get a map of possible instances of the enum mapped by nameAction::values()array_combine(array_map(fn($case) => $case->name, Action::cases()), Action::cases()) 
or 
(new ReflectionEnum(Action::class))->getConstants()
Get a list of all possible names of the enumAction::keys()array_map(fn($case) => $case->name, Action::cases())
Get a list of all possible backed values of the enumAction::toArray()array_map(fn($case) => $case->value, Action::cases())
Get a map of possible backed values of the enum mapped by nameAction::toArray()array_combine(array_map(fn($case) => $case->name, Action::cases()), array_map(fn($case) => $case->value, Action::cases())) 
or 
array_map(fn($case) => $case->value, (new ReflectionEnum(Action::class))->getConstants()))

Related projects

Download Details:

Author: Myclabs
Source Code: https://github.com/myclabs/php-enum 
License: MIT license

#php #enums 

What is GEEK

Buddha Community

PHP-enum: The Enum PHP is Missing, inspired From SplEnum

PHP-enum: The Enum PHP is Missing, inspired From SplEnum

PHP Enum implementation inspired from SplEnum

Maintenance for this project is supported via Tidelift.

Why?

First, and mainly, SplEnum is not integrated to PHP, you have to install the extension separately.

Using an enum instead of class constants provides the following advantages:

  • You can use an enum as a parameter type: function setAction(Action $action) {
  • You can use an enum as a return type: function getAction() : Action {
  • You can enrich the enum with methods (e.g. format, parse, …)
  • You can extend the enum to add new values (make your enum final to prevent it)
  • You can get a list of all the possible values (see below)

This Enum class is not intended to replace class constants, but only to be used when it makes sense.

Installation

composer require myclabs/php-enum

Declaration

use MyCLabs\Enum\Enum;

/**
 * Action enum
 *
 * @extends Enum<Action::*>
 */
final class Action extends Enum
{
    private const VIEW = 'view';
    private const EDIT = 'edit';
}

Usage

$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) {
    // ...
}

Documentation

  • __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 enum
  • getKey() Returns the key of the current value on Enum
  • equals() 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 enum
  • toArray() 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 class
  • values() 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 set
  • isValidKey() Check if tested key is valid on enum set
  • assertValidValue() Assert the value is valid on enum set, throwing exception otherwise
  • search() Return key for searched value

Static methods

final 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';
}

Native enums and migration

Native enum arrived to PHP in version 8.1: https://www.php.net/enumerations
If your project is running PHP 8.1+ or your library has it as a minimum requirement you should use it instead of this library.

When migrating from myclabs/php-enum, the effort should be small if the usage was in the recommended way:

  • private constants
  • final classes
  • no method overridden

Changes for migration:

  • Class definition should be changed from ```php /**
  • @method static Action VIEW()
  • @method static Action EDIT()

*/ final class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; }

 to
```php
enum Action: string
{
    case VIEW = 'view';
    case EDIT = 'edit';
}

All places where the class was used as a type will continue to work.

Usages and the change needed:

Operationmyclabs/php-enumnative enum
Obtain an instance will change from$enumCase = Action::VIEW()$enumCase = Action::VIEW
Create an enum from a backed value$enumCase = new Action('view')$enumCase = Action::from('view')
Get the backed value of the enum instance$enumCase->getValue()$enumCase->value
Compare two enum instances$enumCase1 == $enumCase2 
or 
$enumCase1->equals($enumCase2)
$enumCase1 === $enumCase2
Get the key/name of the enum instance$enumCase->getKey()$enumCase->name
Get a list of all the possible instances of the enumAction::values()Action::cases()
Get a map of possible instances of the enum mapped by nameAction::values()array_combine(array_map(fn($case) => $case->name, Action::cases()), Action::cases()) 
or 
(new ReflectionEnum(Action::class))->getConstants()
Get a list of all possible names of the enumAction::keys()array_map(fn($case) => $case->name, Action::cases())
Get a list of all possible backed values of the enumAction::toArray()array_map(fn($case) => $case->value, Action::cases())
Get a map of possible backed values of the enum mapped by nameAction::toArray()array_combine(array_map(fn($case) => $case->name, Action::cases()), array_map(fn($case) => $case->value, Action::cases())) 
or 
array_map(fn($case) => $case->value, (new ReflectionEnum(Action::class))->getConstants()))

Related projects

Download Details:

Author: Myclabs
Source Code: https://github.com/myclabs/php-enum 
License: MIT license

#php #enums 

Hire PHP Developer

Looking to develop a PHP based website from scratch or revamp your existing website?

HourlyDeveloper.io has always been an industry leader for companies and business owners looking to hire PHP web developer. By choosing to Hire PHP Developer from our company, you can always expect the best results. Our PHP services and solutions are always flexible which means that no matter the nature of your project, you can always count on us for getting the best PHP expertise.

Consult with our experts: https://bit.ly/3aEGxPy

#hire php developer #php developer #php development company #php development services #php development #php

Hire PHP Developer - Best PHP Web Frameworks for Web Development

A framework that can drastically cut down the requirement to write original code to develop the web apps as per your requirement is PHP Framework. PHP frameworks offer code libraries for commonly used functions to reduce the development time.

Want to use PHP Web Frameworks for your web applications?

WebClues Infotech offers a service to hire dedicated PHP developers for all of the below-mentioned frameworks

  • Laravel Developer
  • Codeigniter Developer
  • Yii Developer
  • Zend Developer
  • Cake PHP Developer
  • Core PHP Developer

Not sure which framework to use for your PHP web application?

Contact us

Schedule Interview with PHP Developer https://bit.ly/3dsTWf0

Email: sales@webcluesinfotech.com

#hire php developer #hire php web developers #hire php developer in 2021 #hire php developers & dedicated php programmers #hire php developers india #hire and outsource freelance php developers

Hire Dedicated PHP Developer

Looking to hire affordable yet experienced PHP developers?

Hire Dedicated PHP Developer, who can convert your idea to reality, within the stipulated time frame. HourlyDeveloper.io expertise & experience as the top PHP development company put us above our competitors, in many ways. We have some of the top PHP developers in the industry, which can create anything you can imagine, that too, at the most competitive prices.

Consult with our experts:- https://bit.ly/2NpKnB8

#hire dedicated php developer #php developers #php development company #php development services #php development #php developer

Mariya James

Mariya James

1613990718

Top PHP web development company| PHP development services India

ValueCoders is a leading PHP app development company that focuses on building robust, secure & scalable web applications for start-ups, enterprises, and entrepreneurs.

We have 16+ years of experience and have delivered custom PHP web development solutions to 2500+ global clients catering industry verticals, including healthcare, adtech, eLearning, data analysis, Fintech, eCommerce, etc

Are you planning to outsource PHP development services? Or want to hire an offshore PHP development team?

#hire php developer #hire a php developer in india #hire dedicated php programmers #hire php coders #php developer in india #php developers for hire