https://github.com/attitude/types-php
PHP types powered by Reflections
https://github.com/attitude/types-php
Last synced: 3 months ago
JSON representation
PHP types powered by Reflections
- Host: GitHub
- URL: https://github.com/attitude/types-php
- Owner: attitude
- License: mit
- Created: 2024-04-13T19:47:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T06:40:38.000Z (about 1 year ago)
- Last Synced: 2024-04-14T12:04:55.555Z (about 1 year ago)
- Language: PHP
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Types for PHP
PHP types powered by Reflections
> [!WARNING] > **Experimental project – feedback is appreciated**
## Features:
- [x] Validation
- [x] Destructuring
- [x] `AbstractListType` methods inspired by JavaScript's `Array` class (incomplete)
- [x] Recursive types validation (needs more testing)
- [x] Primitive lists:
- [ListOfBooleansType](src/ListOfBooleansType.php)
- [ListOfFloatsType](src/ListOfFloatsType.php)
- [ListOfIntegersType](src/ListOfIntegersType.php)
- [ListOfMixedType](src/ListOfMixedType.php)
- [ListOfNumbersType](src/ListOfNumbersType.php)
- [ListOfNumericValuesType](src/ListOfNumericValuesType.php)
- [ListOfStringsType](src/ListOfStringsType.php)
## Installation
> [!IMPORTANT]
> This project is not yet published to Packagist. You need to add the repository manually or clone the repository as a submodule.
### Option 1: Add as a Git submodule
```shell
$ git submodule add [email protected]:attitude/types-php.git path/to/types-php
```
### Option 2: Add as a dependency using Composer
Update `composer.json` of your project:
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/attitude/types-php"
}
],
"require": {
"attitude/types": "dev-main"
}
}
```
```shell
$ composer install
```
### Option 3: Download the repository as a ZIP
---
## Usage
### Shape types
Define a class extending `AbstractShapeType` and define properties with types
just like you would with a regular class.
When creating an instance of the class, you can pass an associative array of
properties. The constructor will validate the properties and throw an exception
if any of the properties are missing or have the wrong type.
Unless you define const REST, the constructor will throw an exception if there
are any properties in the array that are not defined in the class.
The value of the REST constant will be used as a key for all properties that
are not defined in the class.
```php
'Title',
'extra' => 'Extra',
]);
['title' => $title, '__' => $rest] = $header;
$header; // instanceof HeaderProps::class
$title; // 'Title'
$rest; // ['extra' => 'Extra']
```
### List types
To define a list of items with a specific type, use `AbstractListType`
and provide a `parse()` method that will be used to parse each item.
```php
'Title 1'],
['title' => 'Title 2'],
]);
$items->length; // 2
$items->push(new HeaderProps(['title' => 'Title 3']));
$items->map(function ($item) {
return $item->title;
}); // ['Title 1', 'Title 2', 'Title 3']
```
---
_Enjoy!_
Created by [martin_adamko](https://www.threads.net/@martin_adamko)