Documentation

RejectedPromise
in package
implements PromiseInterface

A promise that has been rejected.

Thenning off of this promise will invoke the onRejected callback immediately and ignore other callbacks.

Tags
final

Table of Contents

Interfaces

PromiseInterface
A promise represents the eventual result of an asynchronous operation.

Properties

$reason  : mixed

Methods

__construct()  : mixed
cancel()  : void
Cancels the promise if possible.
getState()  : string
Get the state of the promise ("pending", "rejected", or "fulfilled").
otherwise()  : PromiseInterface
Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.
reject()  : void
Reject the promise with the given reason.
resolve()  : void
Resolve the promise with the given value.
then()  : PromiseInterface
Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.
wait()  : mixed
Waits until the promise completes if possible.

Properties

Methods

__construct()

public __construct(mixed $reason) : mixed
Parameters
$reason : mixed

getState()

Get the state of the promise ("pending", "rejected", or "fulfilled").

public getState() : string

The three states can be checked against the constants defined on PromiseInterface: PENDING, FULFILLED, and REJECTED.

Return values
string

otherwise()

Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.

public otherwise(callable $onRejected) : PromiseInterface
Parameters
$onRejected : callable

Invoked when the promise is rejected.

Return values
PromiseInterface

reject()

Reject the promise with the given reason.

public reject(mixed $reason) : void
Parameters
$reason : mixed

resolve()

Resolve the promise with the given value.

public resolve(mixed $value) : void
Parameters
$value : mixed

then()

Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.

public then([callable|null $onFulfilled = null ][, callable|null $onRejected = null ]) : PromiseInterface
Parameters
$onFulfilled : callable|null = null

Invoked when the promise fulfills.

$onRejected : callable|null = null

Invoked when the promise is rejected.

Return values
PromiseInterface

wait()

Waits until the promise completes if possible.

public wait([bool $unwrap = true ]) : mixed

Pass $unwrap as true to unwrap the result of the promise, either returning the resolved value or throwing the rejected exception.

If the promise cannot be waited on, then the promise will be rejected.

Parameters
$unwrap : bool = true 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results