ramsey/collection

Fixed

• Correct the type annotation on CollectionInterface::column() to indicate the array it returns is list<mixed> (#130)

Fixed

• Correct the type annotation on CollectionInterface::column() to indicate the array it returns is list<mixed> (#130)

Added

• Add support for retrieving properties on collection items that are accessible via magic methods __get and __isset (#126)
• Certify support for PHP 8.3 and 8.4 (#127)

Fixed

• Use the correct return type annotation of list<T> instead of array<int, mixed> for CollectionInterface::column() (#124)
• If an element has a property and method of the same name, check the property visibility on the element before attempting to access it; if it is private, attempt to call the method instead (#123)
• ValueExtractorTrait expects getType(): string to exist on the using class, but it did not declare an abstract to force this requirement; now it does, and any classes using this trait must implement getType(): string
• Avoid calling contains() twice when using AbstractSet::add(), significantly improving performance for very large collections (#68)

Added

• Add support for retrieving properties on collection items that are accessible via magic methods __get and __isset (#126)
• Certify support for PHP 8.3 and 8.4 (#127)

Fixed

• Use the correct return type annotation of list<T> instead of array<int, mixed> for CollectionInterface::column() (#124)
• If an element has a property and method of the same name, check the property visibility on the element before attempting to access it; if it is private, attempt to call the method instead (#123)
• ValueExtractorTrait expects getType(): string to exist on the using class, but it did not declare an abstract to force this requirement; now it does, and any classes using this trait must implement getType(): string
• Avoid calling contains() twice when using AbstractSet::add(), significantly improving performance for very large collections (#68)

Added

• Add support for CollectionInterface::reduce() (#87)
• All exceptions now implement a base CollectionException interface
• Introduce Sort enum
• Support column(), sort(), and where() on non-object collection types

Changed

• Minimum PHP version supported is 8.1
• Every method now has parameter and return type hints; if extending classes or implementing interfaces, you may need to change method signatures to upgrade
• The second parameter of CollectionInterface::sort() now uses the new Sort enum instead of a string
• Audit all template annotations and clean up Psalm and PHPStan types for correctness; if using static analysis in projects, this may require changes to your type annotations
• ArrayInterface no longer extends \Serializable, and the serialize() and unserialize() methods have been removed from AbstractArray; however, AbstractArray still supports serialization through implementing __serialize() and __unserialize()

Added

• Add support for CollectionInterface::reduce() (#87)
• All exceptions now implement a base CollectionException interface
• Introduce Sort enum
• Support column(), sort(), and where() on non-object collection types

Changed

• Minimum PHP version supported is 8.1
• Every method now has parameter and return type hints; if extending classes or implementing interfaces, you may need to change method signatures to upgrade
• The second parameter of CollectionInterface::sort() now uses the new Sort enum instead of a string
• Audit all template annotations and clean up Psalm and PHPStan types for correctness; if using static analysis in projects, this may require changes to your type annotations
• ArrayInterface no longer extends \Serializable, and the serialize() and unserialize() methods have been removed from AbstractArray; however, AbstractArray still supports serialization through implementing __serialize() and __unserialize()

Fixed

• Make type aliases compatible in diff, intersect, and merge (#111)
• Use offsetUnset() method to remove from the collection in AbstractCollection (#104)
• Use the correct base type of array-key for template K on AbstractTypedMap

Changed

• Minimum PHP version supported is 7.4

Fixed

• Make type aliases compatible in diff, intersect, and merge (#111)
• Use offsetUnset() method to remove from the collection in AbstractCollection (#104)
• Use the correct base type of array-key for template K on AbstractTypedMap

Changed

• Minimum PHP version supported is 7.4

Fixed

• Merging of sets now excludes duplicates, since a set does not allow duplicate values.

Fixed

• Merging of sets now excludes duplicates, since a set does not allow duplicate values.

Fixed

• Standardize template annotations and fix iterable types

Fixed

• Standardize template annotations and fix iterable types

Added

• Support PHP 8.1.0

Changed

• Minimum PHP version supported is 7.3

Added

• Support PHP 8.1.0

Changed

• Minimum PHP version supported is 7.3

Fixed

• Fixed incorrect callable type annotation on CollectionInterface::map().

Fixed

• Add Traversable<T> return type to getIterator().

Fixed

• Fixed incorrect callable type annotation on CollectionInterface::map().

Fixed

• Fixed incorrect callable type annotation on CollectionInterface::map().

Fixed

• Fixed Psalm annotations causing Psalm errors in downstream projects.
• Fixed AbstractCollection::column() attempting to access a property or method on a non-object.

Fixed

• Fixed Psalm annotations causing Psalm errors in downstream projects.
• Fixed AbstractCollection::column() attempting to access a property or method on a non-object.

Fixed

• Fixed broken AbstractCollection::map() implementation.

Fixed

• Fixed AbstractCollection::diff(), AbstractCollection::intersect() and AbstractCollection::merge() when used with Generic collections.
• Fixed AbstractCollection::diff() and AbstractCollection::intersect() returning inconsistent results when used on collections containing objects.
• Removed warning about deprecated dependency when running composer install

Fixed

• Fixed AbstractCollection::offsetSet() so that it uses the provided $offset when setting $value in the array.

Added

• Added support for queue data structures to represent collections of ordered entities. Together with double-ended queues (a.k.a. deques), first-in-first-out (FIFO), last-in-first-out (LIFO), and other queue and stack behaviors may be implemented. This functionality includes interfaces QueueInterface and DoubleEndedQueueInterface and classes Queue and DoubleEndedQueue.
• Added support for set data structures, representing collections that cannot contain any duplicated elements; includes classes AbstractSet and Set.
• Added support for typed map data structures to represent maps of elements where both keys and values have specified data types; includes TypedMapInterface and the classes AbstractTypedMap and TypedMap.
• Added new manipulation and analyze methods for collections: column(), first(), last(), sort(), filter(), where(), map(), diff(), intersect(), and merge(). See CollectionInterface for more information.
• Added the following new exceptions specific to the ramsey/collection library: CollectionMismatchException, InvalidArgumentException, InvalidSortOrderException, NoSuchElementException, OutOfBoundsException, UnsupportedOperationException, and ValueExtractionException.

Changed

• Minimum PHP version supported is 7.2.
• Strict types are enforced throughout.

Removed

• Removed support for HHVM.

Security

• Fixed possible exploit using AbstractArray::unserialize() (see #47).

Added

• Added MapInterface::keys() method to return the keys from a MapInterface object. This was added to the AbstractMap class.

Removed

• Removed getType() and constructor methods from AbstractCollection. Children of AbstractCollection must now implement getType(), which should return a string value that defines the data type of items for the collection.

Fixed

• Improve error messages in exceptions when Collection and NamedParameterMap items fail type checks.

Fixed

• Allow non-strict checking of values in typed collections.

Added

• Support typed collections.

Added

• Support generic arrays and maps.