Overview

Namespaces

  • Baguette
    • Mastodon
      • Config
      • Entity
      • Grant
      • Service
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
  • Psr
    • Http
      • Message
  • Teto
    • Object

Classes

  • Coroutine
  • EachPromise
  • FulfilledPromise
  • Promise
  • RejectedPromise
  • TaskQueue

Interfaces

  • PromiseInterface
  • PromisorInterface
  • TaskQueueInterface

Exceptions

  • AggregateException
  • CancellationException
  • RejectionException

Functions

  • all
  • any
  • coroutine
  • each
  • each_limit
  • each_limit_all
  • exception_for
  • inspect
  • inspect_all
  • is_fulfilled
  • is_rejected
  • is_settled
  • iter_for
  • promise_for
  • queue
  • rejection_for
  • settle
  • some
  • task
  • unwrap
  • Overview
  • Namespace
  • Class

Class Promise

Promises/A+ implementation that avoids recursion when possible.

GuzzleHttp\Promise\Promise implements GuzzleHttp\Promise\PromiseInterface
Namespace: GuzzleHttp\Promise
Link: https://promisesaplus.com/
Located at Promise.php
Methods summary
public
# __construct( callable $waitFn = null, callable $cancelFn = null )

Parameters

$waitFn
Fn that when invoked resolves the promise.
$cancelFn
Fn that when invoked cancels the promise.
public GuzzleHttp\Promise\PromiseInterface
# then( callable $onFulfilled = null, callable $onRejected = null )

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

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

Parameters

$onFulfilled
Invoked when the promise fulfills.
$onRejected
Invoked when the promise is rejected.

Returns

GuzzleHttp\Promise\PromiseInterface

Implementation of

GuzzleHttp\Promise\PromiseInterface::then()
public GuzzleHttp\Promise\PromiseInterface
# otherwise( callable $onRejected )

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.

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.

Parameters

$onRejected
Invoked when the promise is rejected.

Returns

GuzzleHttp\Promise\PromiseInterface

Implementation of

GuzzleHttp\Promise\PromiseInterface::otherwise()
public mixed
# wait( boolean $unwrap = true )

Waits until the promise completes if possible.

Waits until the promise completes if possible.

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

Returns

mixed

Throws

LogicException

if the promise has no wait function or if the promise does not settle after waiting.

Implementation of

GuzzleHttp\Promise\PromiseInterface::wait()
public string
# getState( )

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

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

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

Returns

string

Implementation of

GuzzleHttp\Promise\PromiseInterface::getState()
public
# cancel( )

Cancels the promise if possible.

Cancels the promise if possible.

Link

https://github.com/promises-aplus/cancellation-spec/issues/7

Implementation of

GuzzleHttp\Promise\PromiseInterface::cancel()
public
# resolve( mixed $value )

Resolve the promise with the given value.

Resolve the promise with the given value.

Parameters

$value

Throws

RuntimeException
if the promise is already resolved.

Implementation of

GuzzleHttp\Promise\PromiseInterface::resolve()
public
# reject( mixed $reason )

Reject the promise with the given reason.

Reject the promise with the given reason.

Parameters

$reason

Throws

RuntimeException
if the promise is already resolved.

Implementation of

GuzzleHttp\Promise\PromiseInterface::reject()
Constants inherited from GuzzleHttp\Promise\PromiseInterface
FULFILLED, PENDING, REJECTED
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by ApiGen