PHP Monad API Reference

None
in package
implements Option

Tags
implements

Table of Contents

Interfaces

Option

Cases

instance

Methods

and()  : $this
andThen()  : self
expect()  : never
filter()  : Option
getIterator()  : Traversable
inspect()  : $this
isNone()  : true
isSome()  : false
isSomeAnd()  : false
map()  : Option
mapOr()  : mixed
mapOrElse()  : mixed
okOr()  : Err<string|int, E>
okOrElse()  : Err<string|int, E>
or()  : Option
orElse()  : Option
orThrow()  : never
unwrap()  : never
unwrapOr()  : mixed
unwrapOrElse()  : mixed
unwrapOrThrow()  : never
xor()  : Option

Cases

Methods

and()

public and(Option $right) : $this
Parameters
$right : Option
Attributes
#[Override]
Return values
$this

andThen()

public andThen(Closure $right) : self
Parameters
$right : Closure
Tags
phpstan-ignore

method.childParameterType

Attributes
#[Override]
Return values
self

expect()

public expect(string $message) : never
Parameters
$message : string
Tags
throws
RuntimeException
Attributes
#[Override]
Return values
never

filter()

public filter(Closure $predicate) : Option
Parameters
$predicate : Closure
Attributes
#[Override]
Return values
Option

getIterator()

public getIterator() : Traversable
Attributes
#[Override]
Return values
Traversable

inspect()

public inspect(Closure $callback) : $this
Parameters
$callback : Closure
Attributes
#[Override]
Return values
$this

isNone()

public isNone() : true
Attributes
#[Override]
Return values
true

isSome()

public isSome() : false
Attributes
#[Override]
Return values
false

isSomeAnd()

public isSomeAnd(Closure $predicate) : false
Parameters
$predicate : Closure
Attributes
#[Override]
Return values
false

map()

public map(Closure $callback) : Option
Parameters
$callback : Closure
Attributes
#[Override]
Return values
Option

mapOr()

public mapOr(Closure $callback, mixed $default) : mixed
Parameters
$callback : Closure
$default : mixed
Attributes
#[Override]

mapOrElse()

public mapOrElse(Closure $callback, Closure $default) : mixed
Parameters
$callback : Closure
$default : Closure
Attributes
#[Override]

okOr()

public okOr(E $err) : Err<string|int, E>
Parameters
$err : E
Tags
template
Attributes
#[Override]
Return values
Err<string|int, E>

okOrElse()

public okOrElse(callable(): E $err) : Err<string|int, E>
Parameters
$err : callable(): E
Tags
template
Attributes
#[Override]
Return values
Err<string|int, E>

orElse()

public orElse(Closure $right) : Option
Parameters
$right : Closure
Attributes
#[Override]
Return values
Option

orThrow()

public orThrow(F $exception) : never
Parameters
$exception : F
Tags
template
throws
F
Attributes
#[Override]
Return values
never

unwrap()

public unwrap() : never
Tags
throws
RuntimeException
Attributes
#[Override]
Return values
never

unwrapOr()

public unwrapOr(mixed $default) : mixed
Parameters
$default : mixed
Attributes
#[NoDiscard]
#[Override]

unwrapOrElse()

public unwrapOrElse(Closure $default) : mixed
Parameters
$default : Closure
Attributes
#[NoDiscard]
#[Override]

unwrapOrThrow()

public unwrapOrThrow(E $exception) : never
Parameters
$exception : E
Tags
template
throws
E
Attributes
#[Override]
Return values
never 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results