AWS SDK for PHP 3.x (original) (raw)

PromiseInterface

A promise represents the eventual result of an asynchronous operation.

The primary way of interacting with a promise is through its then method, which registers callbacks to receive either a promise’s eventual value or the reason why the promise cannot be fulfilled.

Tags

see

https://promisesaplus.com/

Constants

FULFILLED = 'fulfilled'

PENDING = 'pending'

REJECTED = 'rejected'

Methods

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.

FULFILLED

public mixed FULFILLED = 'fulfilled'

PENDING

public mixed PENDING = 'pending'

REJECTED

public mixed REJECTED = 'rejected'

cancel()

Cancels the promise if possible.

public cancel() : void

Tags

see

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

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()

public otherwise(callable $onRejected) : [PromiseInterface](class-GuzzleHttp.Promise.PromiseInterface.html)

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

Tags

throws

RuntimeException

if the promise is already resolved.

resolve()

Resolve the promise with the given value.

public resolve(mixed $value) : void

Parameters

$value : mixed

Tags

throws

RuntimeException

if the promise is already resolved.

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 <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>o</mi><mi>n</mi><mi>F</mi><mi>u</mi><mi>l</mi><mi>f</mi><mi>i</mi><mi>l</mi><mi>l</mi><mi>e</mi><mi>d</mi><mo>=</mo><mi>n</mi><mi>u</mi><mi>l</mi><mi>l</mi><mo stretchy="false">]</mo><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>c</mi><mi>a</mi><mi>l</mi><mi>l</mi><mi>a</mi><mi>b</mi><mi>l</mi><mi>e</mi></mrow><annotation encoding="application/x-tex">onFulfilled = null ][, callable </annotation></semantics></math>onFulfilled=null][,callableonRejected = null ]) : [PromiseInterface](class-GuzzleHttp.Promise.PromiseInterface.html)

Parameters

$onFulfilled : callable = null

Invoked when the promise fulfills.

$onRejected : callable = 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

Tags

throws

LogicException

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

AWS SDK for PHP 3.x (original) (raw)

PromiseInterface

Tags

Table of Contents

Constants

Methods

FULFILLED

PENDING

REJECTED

cancel()

Tags

getState()

Return values

otherwise()

Parameters

Return values

reject()

Parameters

Tags

resolve()

Parameters

Tags

then()

Parameters

Return values

wait()

Parameters

Tags