plook/type-guard

Library to ensure correctness of types with a readable interface.

1.0.0 2024-11-06 11:30 UTC

Requires

• php: ^8.2

Requires (Dev)

• brainbits/phpcs-standard: ^7.0.1
• brainbits/phpstan-rules: ^3.1.2
• ergebnis/phpstan-rules: ^2.2.0
• phpstan/phpstan: ^1.12.7
• phpstan/phpstan-phpunit: ^1.4.0
• phpstan/phpstan-strict-rules: ^1.6.1
• phpunit/phpunit: ^11.4.3
• rector/rector: ^1.2.9
• squizlabs/php_codesniffer: ^3.10.3
• thecodingmachine/phpstan-safe-rule: ^1.2.0
• thecodingmachine/phpstan-strict-rules: ^1.0.0

LGPL-2.1-or-later

• Phillip Look

README

A PHP library to ensure correctness of types providing a readable interface.

Installation

$ composer require plook/type-guard

Example

use function Plook\TypeGuard\asBool;
use function Plook\TypeGuard\asDateTimeImmutable;
use function Plook\TypeGuard\asFloat;
use function Plook\TypeGuard\asInt;
use function Plook\TypeGuard\asString;
use function Plook\TypeGuard\notNull;

$row = $this->fetchProjectRow(123);

$project = new Project(
     notNull(asInt($row['id'])),
     notNull(asString($row['name'])),
     notNull(asDateTimeImmutable($row['createdAt'])),
     notNull(asBool($row['is_assigned'])),
     asDateTimeImmutable($row['closedAt']),
     asFloat($row['rating']),
);

Provided helper functions

Ensure Types

• asBool($value) Converts input value to a boolean, but passes null.
• asFloat($value) Converts input value to a float, but passes null.
• asInt($value) Converts input value to a int, but passes null.
• asDateTimeImmutable($value) Converts input value to a DateTimeImmutable object, but passes null.
• asDateTimeString($value) Converts input value to a date string including the timezone, but passes null.
• asString($value) Converts input value to a string, but passes null.

Converters

• blankAsNull($value) Converts input value to null, if it is a blank string ''.
• falseAsNull($value) Converts input value to null, if it is a boolean false.
• falsyAsNull($value) Converts input value to null, if it is a falsy value false, '', 0, ...
• zeroAsNull($value) Converts input value to null, if it is a zero 0 or 0.0.

Assertions

• notNull($value) Throws an exception if the value is null otherwise it passes the original value.

Configuration

Setting the default target time zone of DateTimeImmutable objects

use Plook\TypeGuard\TypeGuard;

TypeGuard::instance()->timeZone('Australia/Adelaide');
TypeGuard::instance()->timeZone(new DateTimeZone('Australia/Adelaide'));

Setting the default format of date time strings

use Plook\TypeGuard\TypeGuard;

TypeGuard::instance()->dateTimeFormat(DateTimeInterface::ATOM);