prewk/option

Option object for PHP inspired by Rust

Maintainers

👁 prewk

Package info

github.com/prewk/option

pkg:composer/prewk/option

Statistics

Installs: 951 398

Dependents: 2

Suggesters: 0

Stars: 47

Open Issues: 7

4.1.0 2025-08-15 19:01 UTC

Requires

Suggests

None

Provides

None

Conflicts

None

Replaces

None

(MIT or Apache-2.0) 67420c9edd2e916fa980aebce622879e0e1d5799

  • Oskar Thornblad <oskar.thornblad.woop@gmail.com>

README

A PHP implementation of Rust's Option type with roughly the same API.

Version information

Version 4.x.x requires PHP 8.1+. Make sure you match the versions for this and the Result library if you use both.

Installation

composer require prewk/option

Usage

use Prewk\Option;
use Prewk\Option\{Some, None};

function findSomething(): Option {
 // ...
 if ($foundSomething) {
 return new Some($thing);
 } else {
 return new None;
 }
}

function findSomethingElse(): Result {
 // ...
 if ($foundSomething) {
 return new Some($thing);
 } else {
 return new None;
 }
}

// Fallback to value
$value = findSomething()->unwrapOr(null);

// Fallback to option and throw an exception if both fail
$value = findSomething()->or(findSomethingElse())->unwrap();

// Throw custom exception on missing thing (None)
$value = findSomething()->expect(new Exception("Oh noes!"));

License

MIT & Apache 2.0