README

Part of BarnSuite.

Typed readers for untyped input. Decoded JSON and Symfony Console arguments/options arrive as mixed; Typed Input turns them into the types your code needs, or fails with a message that says exactly where the bad value was.

Requirements

PHP 8.5+
Symfony Console 7 (for ConsoleInput)

Installation

composer require rmb32/typed-input

Reading decoded JSON

use Rmb32\TypedInput\Api\Payload;

$file = Payload::from($fileStore->readJson($path), $path);

$file->string('id');                       // non-empty string, or InvalidValueException
$file->optionalString('reference');        // null when absent or null
$file->stringList('tokens');               // [] when absent
$file->stringMap('confirmedScenarios');    // array<string,string>

foreach ($file->payload('roles', absentIsEmpty: true)->entries() as $slug => $role) {
    $role->string('title');                // "Expected a non-empty string for '<path>.roles.admin.title'"
}

foreach ($file->items('given') as $given) {
    $given->string('subject');
}

Reading a console command's input

use Rmb32\TypedInput\Api\ConsoleInput;

$console = new ConsoleInput($input);

$area = $console->argument('area-of-business');        // required
$dir = $console->optionalOption('output-dir');         // ?string

Related Barnsuite packages

Used by Barnspec and its CLIs, and by Scenario Bridge.

Internals · History · Known issues

rmb32 / typed-input

Package info

Security

Statistics