mako/dataclass

A dataclass implementation inspired by Pydantic

dev-master / 1.0.x-dev 2024-01-31 20:34 UTC

Requires

• php: >=8.2.0

Requires (Dev)

• phpstan/phpstan: ^1.10.6
• phpunit/phpunit: ^10.0

BSD-3-Clause

• Frederic G. Østby

• framework
• mako

README

Examples

Basic usage

<?php

use mako\dataclass\DataClass;

class User extends DataClass
{
	public string $username;
	public string $email;
}

// Basic instantiation

$user = new User(
	username: 'freost',
	email: '[e-mail]',
);

// Instantiation from an array

$array = [
	'username' => 'freost',
	'email' => '[e-mail]',
];

$user = new User(...$array);

// Instantiation from JSON

$json = <<<JSON
{
	"username": "freost",
	"email": "[e-mail]"
}
JSON;

$user = User::fromJSON($json);

$user = new User(...json_decode($json, associative: true));

Validation

<?php

use mako\dataclass\DataClass;
use mako\dataclass\attributes\Validator;

class User extends DataClass
{
	public string $username;
	public string $email;

	#[Validator('username')]
	protected function usernameMustNotContainSpace(string $username): string
	{
		if(str_contains($username, ' ') === true)
			throw new ValueError('username must not contain a space');

		return $username;
	}
}

// An error will now be thrown if the username property contains a space

$user = new User(
	username: 'freost',
	email: '[e-mail]',
);

Nested data classes

<?php

use mako\dataclass\DataClass;
use mako\dataclass\attributes\Validator;

class Avatar extends DataClass
{
	public string $url;
}

class User extends DataClass
{
	public string $username;
	public string $email;
	public Avatar $avatar;
}

// The avatar property will be instantiated as an Avatar instance

$user = new User(
	username: 'freost',
	email: '[e-mail]',
	avatar: ['url' => 'https://example.org/avatar.png'],
);

Arrays of nested data classes

<?php

use mako\dataclass\DataClass;
use mako\dataclass\attributes\ArrayOf;
use mako\dataclass\attributes\Validator;

class Avatar extends DataClass
{
	public string $url;
}

class User extends DataClass
{
	public string $username;
	public string $email;
	#[ArrayOf(Avatar::class)]
	public array $avatars;
}

// The elements of the avatars property will be instantiated as Avatar instances

$user = new User(
	username: 'freost',
	email: '[e-mail]',
	avatars: [['url' => 'https://example.org/avatar.png']],
);