v4.2.0

Second Minor Release of 4.x

Bugfixes

• #137 fixed TypeError in EnumSet::getBinaryBitsetLe()
• #134 fixed check of ambiguous values in Enum::byName()

Changes

• #136 Added PHP-7.4 in CI
• #125 PHP 7.4 serializer and wrap old Serializable methods for BC
• #132 Micro optimizations

v4.1.1

Bugfix release

Changes:

#131 fixed ordinal cache usage of Enum::getName() if ordinal=0

BC-breaks:

none

v4.1.0

First Minor Release of 4.x

Changes

• #126 Added EnumSet::isEmpty() and EnumMap::isEmpty()

v4.0.0

First stable release of new major version

We have worked a lot to make this library even more useful and also optimized the performance a lot!
To be able to do so we introduced a couple of BC breaks (please read the changes carefully) but we tried to keep them as small as possible.

Changes

• Added Immutable EnumSet and EnumMap API

  • Added with* methods which will not modify the current object but instead generate a new object
  • Now the iterable interface is using IteratorAggregate with Generator to move the iteration state into an own object and provides much better performance
  • The mutable API will stay untouched. This means that you have the choice to use either the mutable or immutable API depending on your use case.
  • #109 #110 #118

• Added methods to bulk modify an EnumSet and EnumMap and to instantiate state

  • The constructor supports an iterable second argument to instantiate the state
  • Added methods addIterable, removeIterable, withIterable, withoutIterable

• Consistent Method Namings

  • We have renamed the following methods to be consistent over all classes.
  • The old method names are marked as deprecated and will trigger a deprecation notice in the last 4.x release and get removed in 5.x
  • EnumSet::attach -> EnumSet::add
  • EnumSet::detach -> EnumSet::remove
  • EnumSet::contains -> EnumSet::has
  • EnumMap::contains -> EnumMap::has
  • #120 #121

• Added Type-Hints

  • All public methods have argument and return type-hints where possible.

• PHP-7.1

  • We have raised the required PHP version from 5.6 to 7.1 and removed HHVM support.
  • This has been done to reduce internal complexity, to improve performance and to be able to define type-hints

BC-Breaks

• As of moving from Iterator to IteratorAggregate

  • removed methods - please use foreach directly or migrate to getIterator instead
    • EnumSet::current
    • EnumSet::key
    • EnumSet::next
    • EnumSet::rewind
    • EnumSet::valid
    • EnumMap::current
    • EnumMap::key
    • EnumMap::next
    • EnumMap::rewind
    • EnumMap::valid
    • EnumMap::seek

• As of moving to Genreator

  • On iterating an EnumSet or EnumMap the iterator position can move forward only
  • Enum[Set|Map]->getIterator()->rewind() throws an exception

• Soft Deprecations

  • EnumSet::attach please use EnumSet::add instead
  • EnumSet::detach please use EnumSet::remove instead
  • EnumSet::contains please use EnumSet::has instead
  • EnumMap::contains please use EnumMap::has instead

https://github.com/marc-mabe/php-enum/issues?utf8=%E2%9C%93&q=is%3Aclosed+milestone%3A4.0.0

v4.0.0-rc1

First Release Candidate of new major version

We have worked a lot to make this library even more useful and also optimized the performance a lot!
To be able to do so we introduced a couple of BC breaks (please read the changes carefully) but we tried to keep them as small as possible.

Changes

• Added Immutable EnumSet and EnumMap API

  • Added with* methods which will not modify the current object but instead generate a new object
  • Now the iterable interface is using IteratorAggregate with Generator to move the iteration state into an own object and provides much better performance
  • The mutable API will stay untouched. This means that you have the choice to use either the mutable or immutable API depending on your use case.
  • #109 #110 #118

• Added methods to bulk modify an EnumSet and EnumMap and to instantiate state

  • The constructor supports an iterable second argument to instantiate the state
  • Added methods addIterable, removeIterable, withIterable, withoutIterable

• Consistent Method Namings

  • We have renamed the following methods to be consistent over all classes.
  • The old method names are marked as deprecated and will trigger a deprecation notice in the last 4.x release and get removed in 5.x
  • EnumSet::attach -> EnumSet::add
  • EnumSet::detach -> EnumSet::remove
  • EnumSet::contains -> EnumSet::has
  • EnumMap::contains -> EnumMap::has
  • #120 #121

• Added Type-Hints

• All public methods have argument and return type-hints where possible.

• PHP-7.1

  • We have raised the require PHP version from 5.6 to 7.1 and removed HHVM support.
  • This has been done to reduce internal complexity, to improve performance and to be able to define type-hints

BC-Breaks

• As of moving from Iterator to IteratorAggregate

  • removed methods - please use foreach directly or migrate to getIterator instead
    • EnumSet::current
    • EnumSet::key
    • EnumSet::next
    • EnumSet::rewind
    • EnumSet::valid
    • EnumMap::current
    • EnumMap::key
    • EnumMap::next
    • EnumMap::rewind
    • EnumMap::valid
    • EnumMap::seek

• As of moving to Genreator

  • On iterating an EnumSet or EnumMap the iterator position can move forward only
  • Enum[Set|Map]->getIterator()->rewind() throws an exception

• Soft Deprecations

  • EnumSet::attach please use EnumSet::add instead
  • EnumSet::detach please use EnumSet::remove instead
  • EnumSet::contains please use EnumSet::has instead
  • EnumMap::contains please use EnumMap::has instead

https://github.com/marc-mabe/php-enum/issues?utf8=%E2%9C%93&q=is%3Aclosed+milestone%3A4.0.0

v2.3.2

Bugfix release

Changes:

#98 Backported HHVM >3.18.4 & >3.20.2 reports as PHP-7.1 but does not support constant visibility

BC-breaks:

none

v3.1.1

First Patch Release of 3.1.x

Changes

• #107 fixed array to string conversion in EnumMap::offsetGet()
• copyright 2019
• \count() instead of count()
• static::class instead of get_class($this)
• more strict argument type for Enum::get()

v3.1.0

First Minor Release of 3.x

Changes

• #96 #106 Support arrays as enum values in phpDoc enhancement
• #105 added Enum::hasValue() and Enum::hasName()
• added missing phpdoc @throws
• fixed return type in phpdoc of EnumSet::getValues()
• fixed argument type in phpdoc of EnumMap::search()
• fixed first argument name in phpdoc of Enum:has()

v3.1.0-rc1

First Release Candidate of new minor version

Changes

• #96 #106 Support arrays as enum values in phpDoc enhancement
• #105 added Enum::hasValue() and Enum::hasName()

v3.0.2

Patch release of 3.0.x

Changes

• #99 : Minor phpdoc syntax fix

BC-breaks

none