jdecool/optional

A PHP implementation of the Optional pattern, inspired by Java's java.util.Optional

dev-main 2024-10-20 14:25 UTC

Requires

• php: ^8.1

Requires (Dev)

• ergebnis/composer-normalize: ^2.43
• friendsofphp/php-cs-fixer: ^3.59
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^11.2

MIT

• Jérémy DECOOL

README

A PHP implementation of the Optional pattern, inspired by Java's java.util.Optional.

This library provides a container object which may or may not contain a non-null value, helping to avoid null pointer exceptions and improve code readability.

Installation

Using Composer (recommended)

You can install this library using Composer. Run the following command in your project directory:

composer require jdecool/optional

Manual Installation

If you're not using Composer, you can download the library files and include them manually in your project. Make sure to set up the appropriate autoloading for the JDecool\DataStructure namespace.

Usage

Creating an Optional

Optional::of($value)

Creates an Optional with a non-null value.

use JDecool\DataStructure\Optional;

$optional = Optional::of('Hello, World!');

Optional::ofNullable($value)

Creates an Optional that may contain a null value.

$optional = Optional::ofNullable(null);

Optional::empty()

Creates an empty Optional.

$emptyOptional = Optional::empty();

Checking the Optional's State

ifPresent(callable $action)

Performs an action if the Optional contains a non-null value;

$optional->ifPresent(static fn ($value) => echo "Optional contains a value.");

ifPresentOrElse(callable $action, callable $emptyAction)

Performs the given action with the value, otherwise performs the given empty-based action.

$optional->ifPresentOrElse(
  static fn ($value) => echo "Optional contains a value.",
  static fn () => echo "Optional doesn't contains a value.",
);

isPresent()

Checks if the Optional contains a non-null value.

if ($optional->isPresent()) {
    echo "Value is present";
}

isEmpty()

Checks if the Optional is empty (contains null).

if ($optional->isEmpty()) {
    echo "Optional is empty";
}

Retrieving the Value

get()

Retrieves the value if present, throws a NoSuchElementException if empty.

try {
    $value = $optional->get();
} catch (NoSuchElementException $e) {
    echo "No value present";
}

Transforming and Filtering

filter(callable $predicate)

Filters the Optional based on a predicate.

$filtered = $optional->filter(fn($value) => strlen($value) > 5);

map(callable $mapper)

Transforms the Optional's value using a mapping function.

$mapped = $optional->map(fn($value) => strtoupper($value));

Providing Fallback Values

or($other)

Returns the Optional if it has a value, otherwise returns the provided Optional.

$result = $optional->or(Optional::of('Default'));

orElse($other)

Returns the Optional's value if present, otherwise returns the provided value.

$value = $optional->orElse('Default');

orElseThrow(Throwable $exception)

Returns the Optional's value if present, otherwise throws the provided exception.

try {
    $value = $optional->orElseThrow(new Exception('Value not present'));
} catch (Exception $e) {
    echo $e->getMessage();
}

Comparing Optionals

equals(mixed $object)

Compares this Optional to another object for equality.

$isEqual = $optional->equals(Optional::of('Hello, World!'));

This Optional library provides a robust way to handle potentially null values in your PHP code, reducing the risk of null pointer exceptions and improving overall code quality.