https://github.com/ngmy/php-typed-array
The typed array for PHP
https://github.com/ngmy/php-typed-array
array library php php-library type typed-array
Last synced: 3 months ago
JSON representation
The typed array for PHP
- Host: GitHub
- URL: https://github.com/ngmy/php-typed-array
- Owner: ngmy
- License: mit
- Created: 2021-02-15T13:54:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-10T16:35:05.000Z (about 4 years ago)
- Last Synced: 2025-03-06T20:04:24.363Z (4 months ago)
- Topics: array, library, php, php-library, type, typed-array
- Language: PHP
- Homepage:
- Size: 223 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PHP Typed Array
[](//packagist.org/packages/ngmy/typed-array)
[](//packagist.org/packages/ngmy/typed-array)
[](//packagist.org/packages/ngmy/typed-array)
[](//packagist.org/packages/ngmy/typed-array)
[](//packagist.org/packages/ngmy/typed-array)
[](https://github.com/ngmy/php-typed-array/actions/workflows/php.yml)
[](https://coveralls.io/github/ngmy/php-typed-array?branch=master)
[](https://github.com/phpstan/phpstan)
[](https://shepherd.dev/github/ngmy/php-typed-array)
[](https://shepherd.dev/github/ngmy/php-typed-array)
PHP Typed Array is the typed array for PHP.
- Can create the typed array with the specified key and value type
- Can specify the bool, float, int, object, resource, or string type, or the specified class type, or the class type that implements the specified interface, or the class type that uses the specified trait for the key type
- Can specify the array, bool, float, int, object, resource, or string type, or the specified class type, or the class type that implements the specified interface, or the class type that uses the specified trait for the value type
- Implements the `ArrayAccess`, `Countable`, and `IteratorAggregate` interfaces
- Supports the static analysis like PHPStan and Psalm. Please see [examples](docs/examples)
```php
// Returns a new instance of the typed array with the int type value
$intArray = Ngmy\TypedArray\TypedArray::new()->withIntValue(); // TypedArray
$intArray[] = 1; // Good
// $intArray[] = '2'; // No good. The InvalidArgumentException exception is thrown
// Returns a new instance of the typed array with the class type value that implements the DateTimeInterface interface
$dateTimeInterfaceArray = Ngmy\TypedArray\TypedArray::new()
->withInterfaceValue(DateTimeInterface::class); // TypedArray
$dateTimeInterfaceArray[] = new DateTime(); // Good
$dateTimeInterfaceArray[] = new DateTimeImmutable(); // Good
// $dateTimeInterfaceArray[] = new stdClass(); // No good. The InvalidArgumentException exception is thrown
foreach ($dateTimeInterfaceArray as $dateTime) {
echo $dateTime->format('Y-m-d H:i:s') . PHP_EOL;
}
// Determines if the typed array is empty or not
echo var_export($dateTimeInterfaceArray->isEmpty(), true) . PHP_EOL; // false
// Gets the typed array of items as a plain array
print_r($dateTimeInterfaceArray->toArray());
// Array
// (
// [0] => DateTime Object
// ...
// [1] => DateTimeImmutable Object
// ...
// )
// You can also specify the type of the key
$stringKeyArray = Ngmy\TypedArray\TypedArray::new()->withStringKey(); // TypedArray
$stringKeyArray['foo'] = 1; // Good
// $stringKeyArray[] = 2; // No good. The InvalidArgumentException exception is thrown
// Of course, you can also specify the type of both the key and the value
$intStringArray = Ngmy\TypedArray\TypedArray::new()->withIntKey()->withStringValue(); // TypedArray
```
## Requirements
PHP Typed Array has the following requirements:
* PHP >= 7.3
## Installation
Execute the Composer `require` command:
```console
composer require ngmy/typed-array
```
## Documentation
Please see the [API documentation](https://ngmy.github.io/php-typed-array/api/).
## License
PHP Typed Array is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).