Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemaur/laravel-typed-arr
Laravel Typed Array
https://github.com/lemaur/laravel-typed-arr
array laravel type typed-array
Last synced: 4 days ago
JSON representation
Laravel Typed Array
- Host: GitHub
- URL: https://github.com/lemaur/laravel-typed-arr
- Owner: leMaur
- License: mit
- Created: 2023-05-31T18:42:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T12:00:38.000Z (8 months ago)
- Last Synced: 2024-05-01T15:28:59.942Z (8 months ago)
- Topics: array, laravel, type, typed-array
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Typed Arr
[](https://packagist.org/packages/lemaur/laravel-typed-arr)
[](https://packagist.org/packages/lemaur/laravel-typed-arr)
[](https://github.com/leMaur/laravel-typed-arr/blob/main/LICENSE.md)
[](https://github.com/leMaur/laravel-typed-arr/actions/workflows/run-tests.yml)
[](https://github.com/sponsors/leMaur)
[](https://ecologi.com/lemaur?r=6012e849de97da001ddfd6c9)
This package provides an object-oriented way to retrieve the Array data with the right type.
If you are familiar with static analysis tool like phpstan, you've probably encountered `Cannot cast mixed to string` error (or similar).
This is usually happen when you try to cast a value returned from a method/function with a `mixed` return type.
With this package you can get a string value (and not only string) directly from the [Arr helper](https://laravel.com/docs/master/helpers#arrays) like:
```php
use \Illuminate\Support\Arr;
/** @var \Illuminate\Support\Stringable $myValue */
$myValue = Arr::string($data, 'my-value');
```
## Support Me
Hey folks,
Do you like this package? Do you find it useful, and it fits well in your project?
I am glad to help you, and I would be so grateful if you considered supporting my work.
You can even choose 😃:
* You can [sponsor me 😎](https://github.com/sponsors/leMaur) with a monthly subscription.
* You can [buy me a coffee ☕ or a pizza 🍕](https://github.com/sponsors/leMaur?frequency=one-time&sponsor=leMaur) just for this package.
* You can [plant trees 🌴](https://ecologi.com/lemaur?r=6012e849de97da001ddfd6c9). By using this link we will both receive 30 trees for free and the planet (and me) will thank you.
* You can "Star ⭐" this repository (it's free 😉).
## Installation
You can install the package via composer:
```bash
composer require lemaur/laravel-typed-arr
```
## Usage
### Retrieving Stringable from Arr helper
You may use the `string` method to retrieve the Arr helper item as an instance of `Illuminate\Support\Stringable`:
```php
use \Illuminate\Support\Arr;
/** @var \Illuminate\Support\Stringable $name */
$name = Arr::string($data, 'name');
```
### Retrieving Boolean from Arr helper
You may use the `boolean` method to retrieve the Arr helper item as a boolean. The `boolean` method returns `true` for 1, "1", true, "true", "on", and "yes". All other values will return `false`:
```php
use \Illuminate\Support\Arr;
/** @var bool $archived */
$archived = Arr::boolean($data, 'archived');
```
### Retrieving Integer from Arr helper
You may use the `integer` method to retrieve the Arr helper item as an integer:
```php
use \Illuminate\Support\Arr;
/** @var int $count */
$count = Arr::integer($data, 'count');
```
### Retrieving Float from Arr helper
You may use the `float` method to retrieve the Arr helper item as a float:
```php
use \Illuminate\Support\Arr;
/** @var float $amount */
$amount = Arr::float($data, 'amount');
```
### Retrieving Date from Arr helper
You may use the `date` method to retrieve the Arr helper item as a Carbon instance:
```php
use \Illuminate\Support\Arr;
/** @var \Carbon\Carbon $birthday */
$birthday = Arr::date($data, 'birthday');
```
The second and third arguments accepted by the `date` method may be used to specify the date's format and timezone, respectively:
```php
use \Illuminate\Support\Arr;
/** @var \Carbon\Carbon $elapsed */
$elapsed = Arr::date($data, 'elapsed', '!H:i', 'Europe/Madrid');
```
In case of an invalid format, an `InvalidArgumentException` will be thrown.
### Retrieving Enum from Arr helper
You may use the `enum` method to retrieve the Arr helper item as a [PHP enum](https://www.php.net/manual/en/language.types.enumerations.php) instance.
In case of an invalid value or the enum does not have a backing value that matches the input value, `null` will be returned.
The `enum` method accepts the name of the input value and the enum class as its first and second arguments:
```php
use App\Enums\Status;
use \Illuminate\Support\Arr;
/** @var Status $status */
$status = Arr::enum($data, 'status', Status::class);
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [leMaur](https://github.com/lemaur)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.