Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teodoroleckie/collection
⚡ Simple and powerful library for collections in PHP
https://github.com/teodoroleckie/collection
collection library php php-8 php-collection
Last synced: 3 days ago
JSON representation
⚡ Simple and powerful library for collections in PHP
- Host: GitHub
- URL: https://github.com/teodoroleckie/collection
- Owner: teodoroleckie
- License: mit
- Created: 2021-04-30T05:46:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-19T12:50:20.000Z (over 3 years ago)
- Last Synced: 2024-05-02T04:13:11.359Z (5 months ago)
- Topics: collection, library, php, php-8, php-collection
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Simple and powerful library for collections in PHP
[](https://packagist.org/packages/tleckie/collection)
[](https://scrutinizer-ci.com/g/teodoroleckie/collection/?branch=main)
[](https://scrutinizer-ci.com/g/teodoroleckie/collection/build-status/main)
[](https://packagist.org/packages/tleckie/collection)
[](https://scrutinizer-ci.com/code-intelligence)
### Installation
You can install the package via composer:
```bash
composer require tleckie/collection
```
## Usage
# Hash
Hash collections should be used when you need the keys to be strings.
```php
new User('John'),
'user2' => new User('Pedro'),
'user3' => new User('Mario'),
'user4' => new User('Walter'),
'user5' => new User('Mario')
];
$userCollection = new UserCollection($users);
/**
* @param HashInterface $userCollection
*/
public function addCollection(HashInterface $userCollection){ ... }
/**
* @param UserCollection $userCollection
*/
public function addCollection(UserCollection $userCollection){ ... }
```
```php
use Tleckie\Collection\Hash;
$collection = new Hash(['key' => 'value']);
$collection->append('otherKey', 'other value');
```
# Hash methods:
```php
public function current(): mixed;
public function next(): void;
public function key(): null|string;
public function valid(): bool;
public function rewind(): void;
public function count(): int;
public function sortByKey(): HashInterface;
public function sortByValue(): HashInterface;
public function sort(callable$callable): HashInterface;
public function reverse(): HashInterface;
public function filter(callable $filterFunction): HashInterface;
public function find(callable $findFunction): HashInterface;
public function empty(): HashInterface;
public function hasKey(string $key): bool;
public function hasValue(mixed $item): bool;
public function get(string $key): mixed;
public function append(string $key, mixed $item): HashInterface;
public function prepend(string $key, mixed $item): HashInterface;
public function remove(string $key): HashInterface;
public function shuffle(): HashInterface;
public function toArray(): array;
```
# Sequence:
The sequences are used when the key of the collection is not important besides being ordered. Many of its methods are immutable.
If you want you can create your own type of collection
```php
append('other value');
```
# Sequence methods:
```php
public function current(): mixed;
public function next(): void;
public function key(): null|int;
public function valid(): bool;
public function rewind(): void;
public function count(): int;
public function sortByKey(): SequenceInterface;
public function sortByValue(): SequenceInterface;
public function sort(callable$callable): SequenceInterface;
public function reverse(): SequenceInterface;
public function filter(callable $filterFunction): SequenceInterface;
public function find(callable $findFunction): SequenceInterface;
public function empty(): SequenceInterface;
public function hasKey(int $index): bool;
public function hasValue(mixed $item): bool;
public function get(int $index): mixed;
public function append(mixed $item): SequenceInterface;
public function prepend(mixed $item): SequenceInterface;
public function remove(int $index): SequenceInterface;
public function shuffle(): SequenceInterface;
public function toArray(): array;
```
# Collection:
Use the collection when you have numeric and string keys.
```php
name();
}
// count elements
$collection->count(); //5
count($collection); //5
// filter
$collection = $collection->filter(function (int $key, User $user) {
return $user->id() > 4;
}); // UserCollection( [ User(5) ] );
// filterNot
$collection = $collection->filterNot(function (int $key, User $user) {
return $user->id() > 4;
}); // UserCollection( [ User(1),User(2),User(3),User(4) ] );
// find
$collection = $collection->find(function (int $key, User $user) {
return $user->name() === 'Mario';
}); // UserCollection( [ User(3), User(5) ] );
// findIndex
$collection = $collection->find(function (int $key, User $user) {
return $key === 1;
}); // UserCollection( [ User(2) ] );
// sort
$collection = $collection->sort(function (User $current, User $next) {
if ($current->id() === $next->id()) {
return 0;
}
return ($current->id() > $next->id()) ? -1 : 1;
}); // UserCollection( [ User(5), User(4), User(3), User(2), User(1) ] );
```
## Other methods:
```php
$collection->shuffle(): CollectionInterface;
$collection->reverse(): CollectionInterface;
$collection->prepend(mixed $item): CollectionInterface;
$collection->append(mixed $item): CollectionInterface;
$collection->toArray(): array;
$collection->push(mixed $item): CollectionInterface;
$collection->pull(): mixed;
```