PHP Monad API Reference

pipeline.php

Table of Contents

Functions

map()  : callable(Option<string|int, T>): Option<string|int, U>
Pipeline function: Maps the Some value using the callback.
andThen()  : callable(Option<string|int, T>): Option<string|int, U>
Pipeline function: Chains an Option-returning operation on Some value.
orElse()  : callable(Option<string|int, mixed>): Option<string|int, mixed|U>
Pipeline function: Handles None by calling an Option-returning function.
filter()  : callable(Option<string|int, mixed>): Option<string|int, mixed>
Pipeline function: Filters Some value by predicate, returning None if false.
inspect()  : callable(Option<string|int, mixed>): Option<string|int, mixed>
Pipeline function: Performs a side-effect on Some value, passing through the Option.
unwrapOr()  : callable(Option<string|int, mixed>): mixed
Pipeline function: Unwraps the Some value or returns the default.
unwrapOrElse()  : callable(Option<string|int, mixed>): mixed
Pipeline function: Unwraps the Some value or computes a default.
expect()  : callable(Option<string|int, mixed>): mixed
Pipeline function: Unwraps the Some value or throws RuntimeException with the message.
okOr()  : callable(Option<string|int, mixed>): Result<mixed, E>
Pipeline function: Converts Option to Result with a fixed error value.
okOrElse()  : callable(Option<string|int, mixed>): Result<mixed, E>
Pipeline function: Converts Option to Result with a lazy error value.

Functions

map()

Pipeline function: Maps the Some value using the callback.

map(callable(T): U $callback) : callable(Option<string|int, T>): Option<string|int, U>

Usage with PHP 8.5 pipeline operator: $option |> Option\map(fn($x) => $x * 2)

Parameters
$callback : callable(T): U
Tags
template
template
Return values
callable(Option<string|int, T>): Option<string|int, U>

andThen()

Pipeline function: Chains an Option-returning operation on Some value.

andThen(callable(T): Option<string|int, U> $callback) : callable(Option<string|int, T>): Option<string|int, U>

Usage with PHP 8.5 pipeline operator: $option |> Option\andThen(fn($x) => findUser($x))

Parameters
$callback : callable(T): Option<string|int, U>
Tags
template
template
Return values
callable(Option<string|int, T>): Option<string|int, U>

orElse()

Pipeline function: Handles None by calling an Option-returning function.

orElse(callable(): Option<string|int, U> $callback) : callable(Option<string|int, mixed>): Option<string|int, mixed|U>

Usage with PHP 8.5 pipeline operator: $option |> Option\orElse(fn() => getDefault())

Parameters
$callback : callable(): Option<string|int, U>
Tags
template
Return values
callable(Option<string|int, mixed>): Option<string|int, mixed|U>

filter()

Pipeline function: Filters Some value by predicate, returning None if false.

filter(callable(mixed): bool $predicate) : callable(Option<string|int, mixed>): Option<string|int, mixed>

Usage with PHP 8.5 pipeline operator: $option |> Option\filter(fn($x) => $x > 0)

Parameters
$predicate : callable(mixed): bool
Return values
callable(Option<string|int, mixed>): Option<string|int, mixed>

inspect()

Pipeline function: Performs a side-effect on Some value, passing through the Option.

inspect(callable(mixed): mixed $callback) : callable(Option<string|int, mixed>): Option<string|int, mixed>

Usage with PHP 8.5 pipeline operator: $option |> Option\inspect(fn($x) => logger()->info("Got: {$x}"))

Parameters
$callback : callable(mixed): mixed
Return values
callable(Option<string|int, mixed>): Option<string|int, mixed>

unwrapOr()

Pipeline function: Unwraps the Some value or returns the default.

unwrapOr(U $default) : callable(Option<string|int, mixed>): mixed

Usage with PHP 8.5 pipeline operator: $option |> Option\unwrapOr(0)

Parameters
$default : U
Tags
template
Return values
callable(Option<string|int, mixed>): mixed

unwrapOrElse()

Pipeline function: Unwraps the Some value or computes a default.

unwrapOrElse(callable(): mixed $callback) : callable(Option<string|int, mixed>): mixed

Usage with PHP 8.5 pipeline operator: $option |> Option\unwrapOrElse(fn() => computeDefault())

Parameters
$callback : callable(): mixed
Return values
callable(Option<string|int, mixed>): mixed

expect()

Pipeline function: Unwraps the Some value or throws RuntimeException with the message.

expect(string $message) : callable(Option<string|int, mixed>): mixed

Usage with PHP 8.5 pipeline operator: $option |> Option\expect('Value must be present')

Parameters
$message : string
Return values
callable(Option<string|int, mixed>): mixed

okOr()

Pipeline function: Converts Option to Result with a fixed error value.

okOr(E $err) : callable(Option<string|int, mixed>): Result<mixed, E>

Usage with PHP 8.5 pipeline operator: $option |> Option\okOr('not found')

Parameters
$err : E
Tags
template
Return values
callable(Option<string|int, mixed>): Result<mixed, E>

okOrElse()

Pipeline function: Converts Option to Result with a lazy error value.

okOrElse(callable(): E $err) : callable(Option<string|int, mixed>): Result<mixed, E>

Usage with PHP 8.5 pipeline operator: $option |> Option\okOrElse(fn() => new NotFoundException())

Parameters
$err : callable(): E
Tags
template
Return values
callable(Option<string|int, mixed>): Result<mixed, E> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results