| PHP Version | Status |
|---|---|
| 7.4 |  |
| 8.x | in progress... |
A new way to structure your data, apply a real strict typing to your team, avoid any
- Unwanted types, such as you're expecting it to be
intwhile your FE / Client returns withstringquoted value. - This helps you to avoid using too much
isset($data['key'])or!empty(...)- The array key is always present when calling
->toArray()
- The array key is always present when calling
Inspired by Go(golang)'s struct
We do it this way in golang, where we transform a json request into a struct type automatically.
type Photo struct {
name string
url string
}
type User struct {
firstName string
age int
photos []Photo
}
var user User
jsonStr := `{...}`
json.Unmarshal([]byte(jsonStr), &user)
fmt.Print(user.firstName)
fmt.Print(user.age)
fmt.Printf("%+v", user.photos)Now if we're going to convert that into this library.
use Daison\Struct\Collection;
use Daison\Struct\Common;
use Daison\Struct\TypeException;
use Daison\Struct\Struct;
$photo = new Struct([
'name' => Common::STRING(),
'url' => Common::STRING(),
]);
$user = new Struct([
'firstName' => Common::STRING(),
'age' => Common::INTEGER(),
'photos' => fn (array $p) => new Collection($photo, $p ?? []),
]);
$user->load([
'firstName' => 'John',
'age' => '31',
'photos' => [
['url' => 'https://images.dummy.com/x.jpg'],
['url' => 'https://images.dummy.com/y.jpg'],
['url' => 'https://images.dummy.com/z.jpg'],
],
]);
try {
$user->firstName; // John
$user->photos->empty(); // false
$user->photos[0]->url; // https://images.dummy.com/x.jpg
// TypeException -> "Struct: Data type of [age] expects [int] but value is '31' typed [string]"
$user->age;
// TypeException -> "Struct: Undefined struct data [email]"
$user->email;
} catch (TypeException $e) {
// log it somewhere thru your kibana / sentry
var_dump($e);
throw $e;
}A full examples can be seen inside example.php or by running ./run-tests.sh
// imagine this is your contract structure from your frontend / clients
$load = [
'location' => ['x' => 0.111, 'y' => 0.555],
];
$location = new Struct([
'x' => Common::FLOAT(),
'y' => Common::FLOAT(),
]);
$sample = new Struct([
'location' => fn (array $d) => $location->load($d),
]);
$sample->load($load);
$sample->location->x; // 0.111
$sample->location->y; // 0.555Optional keys will still resolve the value as null, this acts the same in Golang interface{} for nil'ishable approach
// imagine this is your contract structure from your frontend / clients
$load = [
// basically this data is not required
// 'nullableKey' => 'whatever',
'requiredKey' => 1,
];
$sample = new Struct([
// if there is no return type, this library interprets it as optional or any type.
'nullableKey' => fn ($x) => $x,
// since we require it to be "string", the library can detect and throw
// TypeException if the provided data is missing or the type is wrong
'requiredKey' => Common::STRING(),
]);
$sample->load($load);
$sample->toArray(); // ['nullableKey' => null, 'requiredKey' => 1]- Struct-uring
- Thrown strict types
- Data type is different from the value returned
- Returned type is different from the value returned
- Error Bags
- Validation (in progress...)
The php-struct library is open-sourced software licensed under the MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent