https://github.com/paragonie/typed-arrays
Userland typed array implementation
https://github.com/paragonie/typed-arrays
Last synced: about 1 year ago
JSON representation
Userland typed array implementation
- Host: GitHub
- URL: https://github.com/paragonie/typed-arrays
- Owner: paragonie
- Created: 2024-05-14T19:46:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T21:25:05.000Z (about 2 years ago)
- Last Synced: 2025-03-30T23:31:33.617Z (about 1 year ago)
- Language: PHP
- Size: 5.86 KB
- Stars: 74
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Strictly Typed Arrays in PHP 8
[](https://github.com/paragonie/typed-arrays/actions)
[](https://packagist.org/packages/paragonie/typed-arrays)
[](https://packagist.org/packages/paragonie/typed-arrays)
[](https://packagist.org/packages/paragonie/typed-arrays)
[](https://packagist.org/packages/paragonie/typed-arrays)
**Requires PHP 8.3**. This is best described through example:
```php
foo, $x->bar);
var_dump($x->foo[1]);
```
This should output the following:
```
object(string⟦⟧)#5 (2) {
[0]=>
string(5) "apple"
[1]=>
string(3) "bee"
}
object(int⟦⟧)#6 (3) {
[0]=>
int(4)
[1]=>
int(5)
[2]=>
int(120000)
}
string(3) "bee"
```
If you try to pass an incorrect type, you'll get a `TypeError`:
```php
foo, $x->bar);
```
Should produce:
```terminal
Fatal error: Uncaught TypeError: string⟦⟧(): Argument #3 must be of type string, int given
```
## What Is This Package Doing?
We are using Unicode characters (`⟦` and `⟧`) to create a class that implements `ArrayAccess`.
All arguments to these types are then strictly typed.
In effect, we have turned a class into a typed array that your IDE will not complain about.
## Does It Support Multi-Level Types? e.g. `string⟦⟧⟦⟧`
You betcha.
```php
double);
```
This will produce:
```terminal
object(string⟦⟧⟦⟧)#7 (2) {
[0]=>
object(string⟦⟧)#5 (1) {
[0]=>
string(4) "test"
}
[1]=>
object(string⟦⟧)#6 (1) {
[0]=>
string(7) "example"
}
}
```
## Does This Support Arrays of Classes?
Of course!
```php
object(Foo⟦⟧)#5 (1) {
[0]=>
object(Foo)#6 (0) {
}
}
}
```
### How Does This Create Types for My Classes?
See: [the autoloader](global/autoloader.php).