Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeromegamez/typed-collection
Type-safe collections based on Laravel Collections
https://github.com/jeromegamez/typed-collection
collection collections laravel php type-safety typed
Last synced: 14 days ago
JSON representation
Type-safe collections based on Laravel Collections
- Host: GitHub
- URL: https://github.com/jeromegamez/typed-collection
- Owner: jeromegamez
- Created: 2017-08-31T21:18:22.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T23:53:15.000Z (8 months ago)
- Last Synced: 2024-05-02T00:41:04.951Z (8 months ago)
- Topics: collection, collections, laravel, php, type-safety, typed
- Language: PHP
- Size: 103 KB
- Stars: 37
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Type-safe PHP collections based on [Laravel Collections]
[](https://packagist.org/packages/gamez/typed-collection)
[](https://packagist.org/packages/gamez/typed-collection)
[](https://github.com/jeromegamez/typed-collection/actions/workflows/tests.yml)
[](https://github.com/sponsors/jeromegamez)
> [!NOTE]
> Laravel 11 added the `ensure()` collection method that verifies that all elements of
> a collection are of a given type or list of types. However, this verification does not
> prevent items of different types to be added at a later time.
## Installation
The package can be installed with [Composer]:
```bash
$ composer require gamez/typed-collection
```
## Usage
```php
class Person
{
public $name;
public function __construct($name)
{
$this->name = $name;
}
}
$taylor = new Person('Taylor');
$jeffrey = new Person('Jeffrey');
```
### Typed Collections
```php
use Gamez\Illuminate\Support\TypedCollection;
class People extends TypedCollection
{
protected static $allowedTypes = [Person::class];
}
$people = People::make([$taylor, $jeffrey])
->each(function (Person $person) {
printf("This is %s.\n", $person->name);
});
/* Output:
This is Taylor.
This is Jeffrey.
*/
try {
People::make('Not a person');
} catch (InvalidArgumentException $e) {
echo $e->getMessage().PHP_EOL;
}
/* Output:
Output: A People collection only accepts items of the following type(s): Person.
*/
```
### Lazy Typed Collections
```php
use Gamez\Illuminate\Support\LazyTypedCollection;
class LazyPeople extends LazyTypedCollection
{
protected static $allowedTypes = [Person::class];
}
$lazyPeople = LazyPeople::make([$taylor, $jeffrey])
->each(function (Person $person) {
printf("This is %s.\n", $person->name);
});
/* Output:
This is Lazy Taylor.
This is Lazy Jeffrey.
*/
try {
LazyPeople::make('Nope!');
} catch (InvalidArgumentException $e) {
echo $e->getMessage().PHP_EOL;
}
/* Output:
Output: A People collection only accepts objects of the following type(s): Person.
*/
```
### Supported types
Supported types are class strings, like `Person::class`, or types recognized by the
[`get_debug_type()` function](https://www.php.net/get-debug-type), `int`, `float`,
`string`, `bool`, and `array`.
### Helper functions
The `typedCollect()` helper function enables you to dynamically create typed collections
on the fly:
```php
$dateTimes = typedCollect([new DateTime(), new DateTime()], DateTimeInterface::class);
```
For further information on how to use Laravel Collections,
have a look at the [official documentation].
[Laravel Collections]: https://laravel.com/docs/collections
[official documentation]: https://laravel.com/docs/collections
[Composer]: https://getcomposer.org