maxiviper117/dtokit-core

Framework-agnostic typed data boundaries for PHP

Maintainers

Package info

github.com/Maxiviper117/DTOkit

pkg:composer/maxiviper117/dtokit-core

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 4

v0.1.0 2026-06-28 10:09 UTC

README

Tests PHPStan Latest Version PHP Version License

DTOKit provides framework-agnostic typed data boundaries for PHP 8.4+. It maps arrays and objects into immutable data objects, serializes them safely, and explains mapping decisions and failures.

Installation

composer require maxiviper117/dtokit-core

Basic usage

use DTOKit\InputData;

final readonly class CreatePostData extends InputData
{
    public function __construct(
        public string $title,
        public string $body,
        public ?int $categoryId = null,
    ) {}
}

$post = CreatePostData::from([
    'title' => 'Hello',
    'body' => 'World',
]);

$payload = $post->toArray();

InputData rejects unknown fields by default. Data and OutputData ignore them. Use #[Strict] or #[IgnoreUnknown] to override this per class.

Mapping and serialization

  • Supported sources: associative arrays, stdClass, and public properties of plain objects.
  • Supported values: typed scalars, nullable/defaulted fields, backed enums, DateTimeInterface, nested DTOKit objects, and lists declared with #[ListOf].
  • #[MapInputName] and #[MapOutputName] define external names.
  • #[WithCast] and #[WithTransformer] invoke container-free extension classes.
  • #[Hidden], #[Sensitive], and #[Redact] control safe output.
  • Nullable accepts explicit null; only a constructor default makes a missing field optional.
use DTOKit\Attribute\ListOf;
use DTOKit\Attribute\MapInputName;

final readonly class OrderData extends InputData
{
    /** @param list<LineData> $lines */
    public function __construct(
        #[MapInputName('order_id')] public int $orderId,
        #[ListOf(LineData::class)] public array $lines,
    ) {}
}

Non-throwing and explain APIs

Data::tryFrom() returns a MappingResult. Data::explain() returns an ExplainResult with toArray(), toJson(), and toText() renderers. Diagnostics contain paths and types but never raw sensitive values.

Development

composer install
composer check

See PRD.md for product requirements, Phases.md for delivery status, and AGENTS.md for repository rules.