README

This library was developed to support enum types before PHP 8.1.

Since release 0.9.0 of the library it provides API similar to current PHP 8 backed enum types. Previous API is marked as deprecated. This change was made intentionally to support migration to native enums in PHP 8.

See change log for more details about API changes.

Enumerable

Installation

Install via composer:

composer require litgroup/enumerable:^0.9.0

Example of usage

Definition

Create final class, which extends Enumerable;
For each variant of values create a static method, which will creates an instance of value. For this purpose your method must call Enumerable::case() with some backed value.

Note:

Enumerable class must be final!

Backed can be ether string or int.

Enum definition example:

namespace Acme;

use LitGroup\Enumerable\Enumerable;

final class ColorEnum extends Enumerable
{
    public static function red(): self
    {
        return self::case('red');
    }

    public static function green(): self
    {
        return self::case('green');
    }

    public static function blue(): self
    {
        return self::case('blue');
    }
}

Equality/Identity checking

You can use enumerable values in equality/identity expressions:

ColorEnum::red() == ColorEnum::red() // => true
ColorEnum::red() === ColorEnum::red() // => true

ColorEnum::red() == ColorEnum::blue() // => false
ColorEnum::red() === ColorEnum::blue() // => false

Note: Enumerables works as runtime constants. Therefore enumerable values can be checked on identity. And we recommend to use check on identity (===) instead of equality (==) if possible.

Usage in switch-case statement

$color = ColorEnum::green();

switch ($color) {
    case ColorEnum::red():
        echo "Red!\n";
        break;
    case ColorEnum::green():
        echo "Green!\n";
        break;
    case ColorEnum::blue():
        echo "Blue!\n";
        break;
}

// "Green!" will be printed

A match expression also works es expected.

Serialization and Persistence

Enumerable works as runtime-constant. Enumerable type cannot be serialized. If you need to store representation of enumerable in a database or send it via an API you can use a backed value of enumerable as its representation.

$enum->value;

To restore an instance of enumerable type by its backed value from database or from API-request you can use static method tryFrom() on the concrete enum-class.

$colorRawValue = fetchValueFromDatabase(/* something */);

$enum = ColorEnum::tryFrom($colorRawValue);

If you need to get all values of enumerable type, use static method cases() on the concrete enum-class.

ColorEnum::cases(); // => Returns a list of enum cases

Extensibility

Instances of your enumerable classes can have additional behavior if it needed. But you cannot define any public static methods with custom behavior. Public static methods used only for initialization of the enum.

Note: You cannot define any public static methods with custom behavior. Public static methods used only for initialization of the enum.

Example:

final class MergeRequestStatus extends Enumerable {

    public static function open(): self
    {
        return self::case('open');
    }

    public static function approved(): self
    {
        return self::case('approved');
    }

    public static function merged(): self
    {
        return self::case('merged');
    }

    public static function declined(): self
    {
        return self::case('declined');
    }

    /**
     * Returns true if status is final.
     */
    public function isFinal(): bool
    {
        return $this === self::merged() || $this === self::declined();
    }
}

Run tests

composer install
composer test

LICENSE

See LICENSE file.

litgroup / enumerable

Maintainers

Package info

Statistics

Security