README

Important

webmozarts/assert version 2.0 now finally supports return values! Use that package (again) instead. It should be a drop-in replacement (just update imports).

Assert Return Value (ARV)

This library uses webmozart/assert to assert values with the added benefit of returning the value.

Installation

Use Composer to install the package:

composer require kkevindev/assert-return-value

Versioning

This libary follows the versioning of webmozart/assert with the addition of a patch version used for patching this library on the same webmozart/assert version.

Usage

Given the follwing code:

class User {
    public function __construct(
        public string $name,
        public string $email,
        public string $role,
    ) {
    }
}

class UserDto {
    public ?string $name = null;
    public ?string $email = null;
    public ?string $role = null;
}

This library allows you to write code like this:

use Webmozart\Assert\Assert as WebmozartAssert;
use Kkevindev\AssertReturnValue\Assert;

public function create(UserDto $userDto): User
{
    return new User(
       name: Assert::stringNotEmpty($userDto->name),
       email: Assert::stringNotEmpty($userDto->email),
       role: Assert::stringNotEmpty($userDto->role),
    );
}

Instead of:

use Webmozart\Assert\Assert as WebmozartAssert;
use Kkevindev\AssertReturnValue\Assert;

public function create(UserDto $userDto): User
{
    $name = $userDto->name;
    WebmozartAssert::stringNotEmpty($name);
    
    $email = $userDto->email;
    WebmozartAssert::stringNotEmpty($email);
    
    $role = $userDto->role;
    WebmozartAssert::stringNotEmpty($role);
    
    return new User(
        name: $name,
        email: $email,
        role: $role,
    );
}