README

This package provides a way to handle nullable values in your application.

Getting started

$ composer require atournayre/null

Title is from the Fixture namespace in Tests.

Before you used to have return type string and now you can use Title object.

$title = Title::create('My title');

$title->title; // 'My title'
$title->isNull(); // false
$title->isNotNull(); // true

Before you used to have return type null and now you can use Title object.

$title = Title::asNull();

$title->title; // 'Empty title'
$title->isNull(); // true
$title->isNotNull(); // false

Before you used to have return type ?string and now you can use Title object.

If you are not sure if the value is null or not, you can use orNull() method, it's a replacement of ?-> operator.

$title = Title::create('My title')
    ->orNull()
    ->title; // 'My title'

$title = Title::asNull()
    ->orNull()
    ->title; // 'Empty title'

Instead of using orNull() method, you can use orThrow() method to throw an exception if the value is null.

$title = Title::asNull()
    ->orThrow(new \RuntimeException('Title is null'));

orThrow() also accepts a callable to throw an exception with a custom message.

$title = Title::asNull()
    ->orThrow(fn () => new \RuntimeException('Title is null'));

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

After writing your fix/feature, you can run following commands to make sure that everything is still ok.

# Install dev dependencies
$ composer install

# Running tests and quality tools locally
$ make all