litgroup / enumerable.php Goto Github PK

Remove deprecated methods:

• Enumerable::getIndex()
• EnumerableTestCase::assertEnumIndex()
• EnumerableTestCase::assertEnumIndexs()

Allow only string and int for indexes.

Enumerable should implement Equatable interface from litgroup/equatable package to be consistent with other objects.

Remove Enumerable::getValue(), which was marked deprecated previously in #4.

This is the reminder for myself.

Implement __toString(), which will return information for debug.

Example

Let we have some enum class:

namespace Acme;

use LitGroup\Enumerable\Enumerable;

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

    public static function green()
    {
        return self::createEnum('#00FF00');
    }

    public static function blue()
    {
        return self::createEnum('#0000FF');
    }
}

If we convert enumerable value to string:

echo (string) Acme\ColorEnum::green();

Then next line should be printed:

Acme\ColorEnum::green

Next assertion should fail, because not all values were enumerable as $payload of the assertion:

$this->assertEnumIndexes([
    self::MALE => Gender::male(),
]);

Successful example:

$this->assertEnumIndexes([
    self::MALE => Gender::male(),
    self::FEMALE => Gender::female(),
]);

Mark Enumerable::getValue() as deprecated and add Enumerable::getValueOf()

Currently Enumerable::getValues() returns an associative array of enumerable with index of enum used for array's key.

Order of keys in array is predicted by order of static methods, which defines available values of enum.
It may be useful to sort values on the moment of the first initialization of enum class.

I think that it can be useful only if indexes of enum are sequence of integers.