jrosset
/
PhpCollections
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ICollection: add "self" version of multiple functions

Browse Source 
+ Simplify/Correct template declarations
+ Fix method signatures (self → static)
master
Julien Rosset 2 years ago
parent 9e35eb1ee4
commit 1f7783090a
10 changed files with 259 additions and 196 deletions
Show Stats Download Patch File Download Diff File

75
src/Collections/Collection.php
Unescape Escape View File

@ -2,52 +2,55 @@
namespace jrosset\Collections; namespace jrosset\Collections;
use Closure;
/** /**
* A collection * A collection
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends ImmutableCollection<TKey, TValue> *
* @template-implements ICollection<TKey, TValue> * @implements ImmutableCollection<TKey, TValue>
* @implements ICollection<TKey, TValue>
*/ */
class Collection extends ImmutableCollection implements ICollection { class Collection extends ImmutableCollection implements ICollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function set (int|string $key, mixed $value): self { public function set ($key, $value): static {
return $this->_set($key, $value); return $this->_set($key, $value);
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function merge (IImmutableCollection ...$collections): ICollection { public function merge (IImmutableCollection ...$collections): static {
return $this->_merge(...$collections); return $this->_merge(...$collections);
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function add (mixed ...$values): self { public function add (...$values): static {
return $this->_add(...$values); return $this->_add(...$values);
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function addCollection (IImmutableCollection ...$collections): ICollection { public function addCollection (IImmutableCollection ...$collections): static {
return $this->_addCollection(...$collections); return $this->_addCollection(...$collections);
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function prepend (mixed ...$values): ICollection { public function prepend (...$values): static {
array_unshift($this->elements, ...$values); array_unshift($this->elements, ...$values);
return $this; return $this;
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function prependCollection (IImmutableCollection ...$collections): ICollection { public function prependCollection (IImmutableCollection ...$collections): static {
$prepend = array_merge( $prepend = array_merge(
...array_map( ...array_map(
function (IImmutableCollection $collection): array { function (IImmutableCollection $collection): array {
@ -62,21 +65,21 @@ class Collection extends ImmutableCollection implements ICollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function clear (): self { public function clear (): static {
$this->_initialize(); $this->_initialize();
return $this; return $this;
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function remove (int|string $key): self { public function remove ($key): static {
unset($this->elements[$this->_normalizeKey($key)]); unset($this->elements[$this->_normalizeKey($key)]);
return $this; return $this;
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function removeValue (mixed $value, bool $strict = false): self { public function removeValue ($value, bool $strict = false): static {
foreach ($this->elements as $currentKey => $currentValue) { foreach ($this->elements as $currentKey => $currentValue) {
if (($strict && $value === $currentValue) || (!$strict && $value == $currentValue)) { if (($strict && $value === $currentValue) || (!$strict && $value == $currentValue)) {
unset($this->elements[$currentKey]); unset($this->elements[$currentKey]);
@ -97,4 +100,50 @@ class Collection extends ImmutableCollection implements ICollection {
public function offsetUnset (mixed $offset): void { public function offsetUnset (mixed $offset): void {
$this->remove($offset); $this->remove($offset);
} }
/**
* @inheritDoc
*/
public function sliceSelf (int $offset, ?int $length = null): static {
$this->elements = array_slice($this->elements, $offset, $length, true);
return $this;
}
/**
* @inheritDoc
*/
public function filterSelf (Closure $filter): static {
$this->elements = array_filter($this->elements, $filter);
return $this;
}
/**
* @inheritDoc
*/
public function removeEmpties (): static {
return $this->filterSelf(function ($value) {
return empty($value);
});
}
/**
* @inheritDoc
*/
public function mapSelf (Closure $process): static {
$this->elements = array_map($process, $this->elements);
return $this;
}
/**
* @inheritDoc
*/
public function sortSelf (Closure|IComparator|null $sorter = null): static {
uasort($this->elements, $sorter);
return $this;
}
/**
* @inheritDoc
*/
public function sortSelfByKey (Closure|IComparator $sorter): static {
uksort($this->elements, $sorter);
return $this;
}
} }

7
src/Collections/IArrayCast.php
Unescape Escape View File

@ -5,15 +5,14 @@ namespace jrosset\Collections;
/** /**
* Interface for PHP-native array cast * Interface for PHP-native array cast
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
*/ */
interface IArrayCast { interface IArrayCast {
/** /**
* Transform to a PHP-native array * Transform to a PHP-native array
* *
* @return array The native array * @return array<TKey, TValue> The native array
* @psalm-return array<TKey, TValue>
*/ */
public function toArray (): array; public function toArray (): array;
} }

130
src/Collections/ICollection.php
Unescape Escape View File

@ -2,98 +2,156 @@
namespace jrosset\Collections; namespace jrosset\Collections;
use Closure;
use Throwable;
/** /**
* Interface for a collection * Interface for a collection
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends IImmutableCollection<TKey, TValue> *
* @implements IImmutableCollection<TKey, TValue>
*/ */
interface ICollection extends IImmutableCollection { interface ICollection extends IImmutableCollection {
/** /**
* Set a value to a key * Set a value to a key
* *
* @param array-key $key The key * @param TKey $key The key
* @param mixed $value The value * @param TValue $value The value
*
* @psalm-param TKey $key
* @psalm-param TValue $value
* *
* @return $this * @return $this
*/ */
public function set (int|string $key, mixed $value): self; public function set ($key, $value): static;
/** /**
* Merge one or multiple collections in the current one * Merge one or multiple collections into the current one
* *
* @param IImmutableCollection ...$collections The collections to merge * @param IImmutableCollection<TKey, TValue> ...$collections The collections to merge
* *
* @return $this * @return $this
*/ */
public function merge (IImmutableCollection ...$collections): self; public function merge (IImmutableCollection ...$collections): static;
/** /**
* Add one or multiple values * Add one or multiple values
* *
* @param mixed ...$values The values * @param TValue ...$values The values
*
* @psalm-param TValue ...$values
* *
* @return $this * @return $this
*/ */
public function add (mixed ...$values): self; public function add (...$values): static;
/** /**
* Add the <b>values</b> of one or multiple collections * Add the <b>values</b> of one or multiple collections
* *
* @param IImmutableCollection ...$collections The collections to add * @param IImmutableCollection<TKey, TValue> ...$collections The collections to add
* *
* @return mixed * @return $this
*/ */
public function addCollection (IImmutableCollection ...$collections): self; public function addCollection (IImmutableCollection ...$collections): static;
/** /**
* Add one or multiple values at the beginning of the current collection * Add one or multiple values at the beginning of the current collection
* *
* @param mixed ...$values The values * @param TValue ...$values The values
*
* @psalm-param TValue ...$values
* *
* @return $this * @return $this
*/ */
public function prepend (mixed ...$values): self; public function prepend (...$values): static;
/** /**
* Add the <b>values</b> of one or multiple collections at the beginning of the current collection * Add the <b>values</b> of one or multiple collections at the beginning of the current collection
* *
* @param IImmutableCollection ...$collections The collections to add * @param IImmutableCollection<TKey, TValue> ...$collections The collections to add
* *
* @return mixed * @return $this
*/ */
public function prependCollection (IImmutableCollection ...$collections): self; public function prependCollection (IImmutableCollection ...$collections): static;
/** /**
* Empties the collection * Empty the collection
* *
* @return $this * @return $this
*/ */
public function clear (): self; public function clear (): static;
/** /**
* Delete a key * Remove a value from it's key
*
* @param array-key $key The key
* *
* @psalm-param TKey $key * @param TKey $key The key
* *
* @return $this * @return $this
*/ */
public function remove (int|string $key): self; public function remove ($key): static;
/** /**
* Delete all instances of a value * Delete all instances of a value
* *
* @param mixed $value The value * @param TValue $value The value
* @param bool $strict Strict comparison ? * @param bool $strict Strict comparison ?
* *
* @psalm-param TValue $value * @return $this
*/
public function removeValue ($value, bool $strict = false): static;
/**
* Keep only a slice of the collection
*
* Preserves the keys
*
* @param int $offset The start offset
* @param int|null $length The maximum length. Null if until end of the collection
* *
* @return $this * @return $this
*/ */
public function removeValue (mixed $value, bool $strict = false): self; public function sliceSelf (int $offset, ?int $length = null): static;
/**
* Keep only elements that satisfy predicate $filter
*
* @param Closure(TKey, TValue):bool $filter The filtering predicate
*
* @return $this
*/
public function filterSelf (Closure $filter): static;
/**
* Keep only non-empty elements
*
* Use {@see https://www.php.net/manual/function.empty.php empty} to check if element is empty or not
*
* @return $this
*/
public function removeEmpties (): static;
/**
* Applied <b>$process</b> on all elements
*
* @param Closure(TKey, TValue): TValue $process The process function to apply on each element
*
* @return $this
*/
public function mapSelf (Closure $process): static;
/**
* Sort the elements (by value)
*
* @param null|IComparator|Closure(TValue, TValue):int $sorter The sorting method ; Null if values are object implementing {@see IComparable}.
* <br>Return :
* <br>&lt; 0 if value1 is before value2
* <br>= 0 if value1 equals value2
* <br>&gt; 0 if value1 is after value2
*
* @return $this
*
* @throws Throwable If an error occurs
*/
public function sortSelf (Closure|IComparator|null $sorter = null): static;
/**
* Sort the elements by key
*
* @param IComparator|Closure(TKey, TKey):int $sorter The sorting method. Return :
* <br>&lt; 0 if key1 is before key2
* <br>= 0 if key1 equals key2
* <br>&gt; 0 if key1 is after key2
*
* @return $this
*
* @throws Throwable If an error occurs
*/
public function sortSelfByKey (Closure|IComparator $sorter): static;
} }

112
src/Collections/IImmutableCollection.php
Unescape Escape View File

@ -12,11 +12,12 @@ use Throwable;
/** /**
* Interface for an immutable (read-only) collection * Interface for an immutable (read-only) collection
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends IteratorAggregate<TKey, TValue> *
* @template-extends ArrayAccess<TKey, TValue> * @implements IteratorAggregate<TKey, TValue>
* @template-extends IArrayCast<TKey, TValue> * @implements ArrayAccess<TKey, TValue>
* @implements IArrayCast<TKey, TValue>
*/ */
interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Countable, ArrayAccess, IArrayCast { interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Countable, ArrayAccess, IArrayCast {
/** /**
@ -29,48 +30,38 @@ interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Coun
/** /**
* Checks if a key exists * Checks if a key exists
* *
* @param array-key $key The key * @param TKey $key The key
*
* @psalm-param TKey $key
* *
* @return bool TRUE if the key exists, FALSE otherwise * @return bool TRUE if the key exists, FALSE otherwise
*/ */
public function exists (int|string $key): bool; public function exists ($key): bool;
/** /**
* Checks if contains a value * Checks if contains a value
* *
* @param mixed $value The value * @param TValue $value The value
* @param bool $strict Strict comparison ? * @param bool $strict Strict comparison ?
* *
* @psalm-param TValue $value
*
* @return bool TRUE if the value exists, FALSE otherwise * @return bool TRUE if the value exists, FALSE otherwise
*/ */
public function contains (mixed $value, bool $strict = false): bool; public function contains ($value, bool $strict = false): bool;
/** /**
* Get the value of a key or null if not found * Get the value of a key or null if not found
* *
* @param array-key $key The key * @param TKey $key The key
* *
* @psalm-param TKey $key * @return TValue|null The value
*
* @return mixed The value
* @psalm-return TValue|null
*/ */
public function get (int|string $key): mixed; public function get ($key): mixed;
/** /**
* Get the first key of a value or null if not found * Get the first key of a value or null if not found
* *
* @param mixed $value The value * @param TValue $value The value
* @param bool $strict Strict comparison ? * @param bool $strict Strict comparison ?
* *
* @psalm-param TValue $value * @return TKey|null
*
* @return array-key|null
* @psalm-return TKey|null
*/ */
public function key (mixed $value, bool $strict = false): int|string|null; public function key ($value, bool $strict = false);
/** /**
* Extract a slice of the collection * Extract a slice of the collection
@ -80,54 +71,39 @@ interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Coun
* @param int $offset The start offset * @param int $offset The start offset
* @param int|null $length The maximum length. Null if until end of the collection * @param int|null $length The maximum length. Null if until end of the collection
* *
* @return static * @return static<TKey, TValue> The result collection
* @psalm-return static<TKey, TValue>
*/ */
public function slice (int $offset, ?int $length = null): self; public function slice (int $offset, ?int $length = null): static;
/** /**
* Get a collection of all elements that satisfy predicate $filter * Get a collection of all elements that satisfy predicate $filter
* *
* @param Closure $filter The filtering predicate * @param Closure(TKey, TValue):bool $filter The filtering predicate
*
* @psalm-param Closure(TKey, TValue):bool $filter
* *
* @return static The result collection * @return static<TKey, TValue> The result collection
* @psalm-return static<TKey, TValue>
*/ */
public function filter (Closure $filter): self; public function filter (Closure $filter): static;
/** /**
* Get a collection of all not empty elements * Get a collection of all not empty elements
* *
* Use {@see https://www.php.net/manual/function.empty.php empty} to check if element is empty or not * Use {@see https://www.php.net/manual/function.empty.php empty} to check if element is empty or not
* *
* @return static The result collection * @return static<TKey, TValue> The result collection
*/ */
public function withoutEmpties (): self; public function withoutEmpties (): static;
/** /**
* Remove all empty elements on current collection * A new collection with <b>$process</b> applied on all elements
*
* Use {@see https://www.php.net/manual/function.empty.php empty} to check if element is empty or not
*
* @return $this
*/
public function removeEmpties (): self;
/**
* A new collection with $process applied on all elements
*
* @psalm-template TResultValue
* *
* @param Closure $process The process function to apply on each element * @template TResultValue
* *
* @psalm-param Closure(TKey, TValue): TResultValue $process * @param Closure(TKey, TValue): TResultValue $process The process function to apply on each element
* *
* @return static * @return static<TKey, TResultValue> The result collection
* @psalm-return static<TKey, TResultValue>
*/ */
public function map (Closure $process): self; public function map (Closure $process): static;
/** /**
* Sort the elements (by value) * Get a collection with the elements sorted (by value)
* *
* @param null|IComparator|Closure(TValue, TValue):int $sorter The sorting method ; Null if values are object implementing {@see IComparable}. * @param null|IComparator|Closure(TValue, TValue):int $sorter The sorting method ; Null if values are object implementing {@see IComparable}.
* <br>Return : * <br>Return :
@ -135,22 +111,20 @@ interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Coun
* <br>= 0 if value1 equals value2 * <br>= 0 if value1 equals value2
* <br>&gt; 0 if value1 is after value2 * <br>&gt; 0 if value1 is after value2
* *
* @return static The sorted collection * @return static<TKey, TValue> The result collection
* @psalm-return static<TKey, TValue>
* *
* @throws Throwable If an error occurs * @throws Throwable If an error occurs
*/ */
public function sort (Closure|IComparator|null $sorter = null): static; public function sort (Closure|IComparator|null $sorter = null): static;
/** /**
* Sort the elements by key * Get a collection with the elements sorted by key
* *
* @param IComparator|Closure(TKey, TKey):int $sorter The sorting method. Return : * @param IComparator|Closure(TKey, TKey):int $sorter The sorting method. Return :
* <br>&lt; 0 if key1 is before key2 * <br>&lt; 0 if key1 is before key2
* <br>= 0 if key1 equals key2 * <br>= 0 if key1 equals key2
* <br>&gt; 0 if key1 is after key2 * <br>&gt; 0 if key1 is after key2
* *
* @return static The sorted collection * @return static<TKey, TValue> The result collection
* @psalm-return static<TKey, TValue>
* *
* @throws Throwable If an error occurs * @throws Throwable If an error occurs
*/ */
@ -159,17 +133,15 @@ interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Coun
/** /**
* The list of all keys * The list of all keys
* *
* @return static The list of all keys * @return IImmutableCollection<int, TKey> The list of all keys
* @psalm-return static<int, TKey>
*/ */
public function keys (): self; public function keys (): IImmutableCollection;
/** /**
* The list of all values * The list of all values
* *
* @return static The list of all values * @return static<int, TValue> The list of all values
* @psalm-return static<int, TValue>
*/ */
public function values (): self; public function values (): static;
/** /**
* Join all values with a separator * Join all values with a separator
@ -185,16 +157,16 @@ interface IImmutableCollection extends IteratorAggregate, JsonSerializable, Coun
* @param string $value The value to split * @param string $value The value to split
* @param string $separator The split separator * @param string $separator The split separator
* *
* @return static * @return static<int, string> The result collection
*/ */
public static function split (string $value, string $separator): self; public static function split (string $value, string $separator): static;
/** /**
* Combine the current collection with one or multiple other collections * Merge the current collection with one or multiple collections
* *
* @param IImmutableCollection ...$collections The other collections to combine * @param IImmutableCollection<TKey, TValue> ...$collections The other collections to merge
* *
* @return static The combined collection * @return static<TKey, TValue> The result collection
*/ */
public function combineWith (IImmutableCollection ...$collections): self; public function mergeWith (IImmutableCollection ...$collections): static;
} }

84
src/Collections/ImmutableCollection.php
Unescape Escape View File

@ -10,16 +10,14 @@ use Traversable;
/** /**
* An immutable collection * An immutable collection
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-implements IImmutableCollection<TKey, TValue> *
* @implements IImmutableCollection<TKey, TValue>
*/ */
class ImmutableCollection implements IImmutableCollection { class ImmutableCollection implements IImmutableCollection {
/** /**
* @var array The internal array of elements * @var array<TKey, TValue> The internal array of elements
* @psalm-var array<TKey, TValue>
*
* @internal
*/ */
protected array $elements; protected array $elements;
@ -28,8 +26,6 @@ class ImmutableCollection implements IImmutableCollection {
* *
* @param iterable|null $other The initial values * @param iterable|null $other The initial values
* *
* @psalm-param array<TKey, TValue>|Traversable<TKey, TValue>|null $other
*
* @throws InvalidArgumentException If the initial values aren't valid * @throws InvalidArgumentException If the initial values aren't valid
*/ */
public function __construct (?iterable $other = null) { public function __construct (?iterable $other = null) {
@ -41,9 +37,8 @@ class ImmutableCollection implements IImmutableCollection {
* *
* @param iterable|null $other The initial values * @param iterable|null $other The initial values
* *
* @psalm-param array<TKey, TValue>|Traversable<TKey, TValue>|null $other
*
* @throws InvalidArgumentException If the initial values aren't valid * @throws InvalidArgumentException If the initial values aren't valid
*
* @internal * @internal
*/ */
protected function _initialize (?iterable $other = null): void { protected function _initialize (?iterable $other = null): void {
@ -61,17 +56,14 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* Internally set a value to a key * Internally set a value to a key
* *
* @param array-key $key The key * @param TKey $key The key
* @param mixed $value The value * @param TValue $value The value
*
* @psalm-param TKey $key
* @psalm-param TValue $value
* *
* @return $this * @return $this
* @internal
* *
* @internal
*/ */
protected function _set (int|string $key, mixed $value): self { protected function _set ($key, $value): static {
$this->elements[$this->_normalizeKey($key)] = $value; $this->elements[$this->_normalizeKey($key)] = $value;
return $this; return $this;
} }
@ -81,8 +73,10 @@ class ImmutableCollection implements IImmutableCollection {
* @param IImmutableCollection ...$collections The collections to merge * @param IImmutableCollection ...$collections The collections to merge
* *
* @return $this * @return $this
*
* @internal
*/ */
protected function _merge (IImmutableCollection ...$collections): self { protected function _merge (IImmutableCollection ...$collections): static {
foreach ($collections as $collection) { foreach ($collections as $collection) {
foreach ($collection as $key => $value) { foreach ($collection as $key => $value) {
$this->_set($key, $value); $this->_set($key, $value);
@ -93,15 +87,13 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* Internally add a value * Internally add a value
* *
* @param mixed ...$values The value * @param TValue ...$values The value
*
* @psalm-param TValue ...$value
* *
* @return $this * @return $this
* @internal
* *
* @internal
*/ */
protected function _add (mixed ...$values): self { protected function _add (...$values): static {
foreach ($values as $value) { foreach ($values as $value) {
$this->elements[] = $value; $this->elements[] = $value;
} }
@ -112,9 +104,9 @@ class ImmutableCollection implements IImmutableCollection {
* *
* @param IImmutableCollection ...$collections The collections to add * @param IImmutableCollection ...$collections The collections to add
* *
* @return mixed * @return $this
*/ */
protected function _addCollection (IImmutableCollection ...$collections): self { protected function _addCollection (IImmutableCollection ...$collections): static {
foreach ($collections as $collection) { foreach ($collections as $collection) {
foreach ($collection as $value) { foreach ($collection as $value) {
$this->_add($value); $this->_add($value);
@ -125,14 +117,11 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* Normalize a key * Normalize a key
* *
* @param array-key $key The key to normalize * @param TKey $key The key to normalize
*
* @psalm-param TKey $key
* *
* @return array-key The normalized key * @return TKey The normalized key
* @psalm-return TKey
*/ */
protected function _normalizeKey (int|string $key): int|string { protected function _normalizeKey ($key) {
return $key; return $key;
} }
@ -212,26 +201,26 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function exists (int|string $key): bool { public function exists ($key): bool {
return isset($this->elements[$this->_normalizeKey($key)]); return isset($this->elements[$this->_normalizeKey($key)]);
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function contains (mixed $value, bool $strict = false): bool { public function contains ($value, bool $strict = false): bool {
return in_array($value, $this->elements, $strict); return in_array($value, $this->elements, $strict);
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function get (int|string $key): mixed { public function get ($key): mixed {
return $this->elements[$this->_normalizeKey($key)] ?? null; return $this->elements[$this->_normalizeKey($key)] ?? null;
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function key (mixed $value, bool $strict = false): int|string|null { public function key ($value, bool $strict = false) {
foreach ($this->elements as $currentKey => $currentValue) { foreach ($this->elements as $currentKey => $currentValue) {
if (($strict && $value === $currentValue) || (!$strict && $value == $currentValue)) { if (($strict && $value === $currentValue) || (!$strict && $value == $currentValue)) {
return $currentKey; return $currentKey;
@ -243,7 +232,7 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function slice (int $offset, ?int $length = null): self { public function slice (int $offset, ?int $length = null): static {
$output = new static(); $output = new static();
$currentIndex = 0; $currentIndex = 0;
@ -264,7 +253,7 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function filter (Closure $filter): self { public function filter (Closure $filter): static {
$output = new static(); $output = new static();
foreach ($this->elements as $key => $value) { foreach ($this->elements as $key => $value) {
if (!$filter($key, $value)) { if (!$filter($key, $value)) {
@ -277,7 +266,7 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function withoutEmpties (): self { public function withoutEmpties (): static {
return $this->filter(function ($value) { return $this->filter(function ($value) {
return empty($value); return empty($value);
}); });
@ -285,14 +274,7 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function removeEmpties (): self { public function map (Closure $process): static {
$this->_initialize($this->withoutEmpties());
return $this;
}
/**
* @inheritDoc
*/
public function map (Closure $process): self {
$output = new static(); $output = new static();
foreach ($this->elements as $key => $value) { foreach ($this->elements as $key => $value) {
$output->_set($key, $process($key, $value)); $output->_set($key, $process($key, $value));
@ -339,13 +321,13 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function keys (): self { public function keys (): IImmutableCollection {
return new static(array_keys($this->elements)); return new static(array_keys($this->elements));
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function values (): self { public function values (): static {
return new static(array_values($this->elements)); return new static(array_values($this->elements));
} }
@ -365,14 +347,14 @@ class ImmutableCollection implements IImmutableCollection {
/** /**
* @inheritDoc * @inheritDoc
*/ */
public static function split (string $value, string $separator): self { public static function split (string $value, string $separator): static {
return new static (explode($separator, $value)); return new static (explode($separator, $value));
} }
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function combineWith (IImmutableCollection ...$collections): IImmutableCollection { public function mergeWith (IImmutableCollection ...$collections): static {
return (clone $this)->_merge(...$collections); return (clone $this)->_merge(...$collections);
} }
} }

7
src/Collections/InsensitiveCaseKeyCollection.php
Unescape Escape View File

@ -5,9 +5,10 @@ namespace jrosset\Collections;
/** /**
* A collection with insensitive case keys * A collection with insensitive case keys
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends Collection<TKey, TValue> *
* @implements Collection<TKey, TValue>
*/ */
class InsensitiveCaseKeyCollection extends Collection { class InsensitiveCaseKeyCollection extends Collection {
use TInsensitiveCaseKey; use TInsensitiveCaseKey;

7
src/Collections/InsensitiveCaseKeyImmutableCollection.php
Unescape Escape View File

@ -5,9 +5,10 @@ namespace jrosset\Collections;
/** /**
* An immutable collection with insensitive case keys * An immutable collection with insensitive case keys
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends ImmutableCollection<TKey, TValue> *
* @implements ImmutableCollection<TKey, TValue>
*/ */
class InsensitiveCaseKeyImmutableCollection extends ImmutableCollection implements IImmutableCollection { class InsensitiveCaseKeyImmutableCollection extends ImmutableCollection implements IImmutableCollection {
use TInsensitiveCaseKey; use TInsensitiveCaseKey;

5
src/Collections/TUniqueValues.php
Unescape Escape View File

@ -5,9 +5,8 @@ namespace jrosset\Collections;
/** /**
* Implementation for unique collection * Implementation for unique collection
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends ImmutableCollection<TKey, TValue>
*/ */
trait TUniqueValues { trait TUniqueValues {
/** /**

9
src/Collections/UniqueCollection.php
Unescape Escape View File

@ -5,10 +5,11 @@ namespace jrosset\Collections;
/** /**
* A collection with unique values * A collection with unique values
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends Collection<TKey, TValue> *
* @template-extends TUniqueValues<TKey, TValue> * @implements Collection<TKey, TValue>
* @implements TUniqueValues<TKey, TValue>
*/ */
class UniqueCollection extends Collection { class UniqueCollection extends Collection {
use TUniqueValues; use TUniqueValues;

9
src/Collections/UniqueImmutableCollection.php
Unescape Escape View File

@ -5,10 +5,11 @@ namespace jrosset\Collections;
/** /**
* An immutable collection with unique values * An immutable collection with unique values
* *
* @psalm-template TKey of array-key * @template TKey of array-key
* @template-covariant TValue * @template TValue
* @template-extends ImmutableCollection<TKey, TValue> *
* @template-extends TUniqueValues<TKey, TValue> * @implements ImmutableCollection<TKey, TValue>
* @implements TUniqueValues<TKey, TValue>
*/ */
class UniqueImmutableCollection extends ImmutableCollection { class UniqueImmutableCollection extends ImmutableCollection {
use TUniqueValues; use TUniqueValues;

Write Preview
Loading…
Cancel
Save