SDK for PHP V3
Promise
in package
implements
PromiseInterface
Uses
NonSerializableTrait
Promises/A+ implementation that avoids recursion when possible.
Tags
Table of Contents
Interfaces
- PromiseInterface
- A promise represents the eventual result of an asynchronous operation.
Methods
- __construct() : mixed
- cancel() : void
- Cancels the promise if possible.
- getState() : self::PENDING|self::FULFILLED|self::REJECTED
- Get the state of the promise ("pending", "rejected", or "fulfilled").
- otherwise() : PromiseInterface<TValue|TRejectedValue, TRejectedReason|Throwable>
- 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, or with null if no value is given.
- then() : PromiseInterface<mixed, mixed>
- 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.
Methods
__construct()
public
__construct([callable(bool): void|null $waitFn = null ][, callable(): void|null $cancelFn = null ]) : mixed
Parameters
- $waitFn : callable(bool): void|null = null
-
Fn that when invoked resolves the promise.
- $cancelFn : callable(): void|null = null
-
Fn that when invoked cancels the promise.
cancel()
Cancels the promise if possible.
public
cancel() : void
getState()
Get the state of the promise ("pending", "rejected", or "fulfilled").
public
getState() : self::PENDING|self::FULFILLED|self::REJECTED
The three states can be checked against the constants defined on PromiseInterface: PENDING, FULFILLED, and REJECTED.
Return values
self::PENDING|self::FULFILLED|self::REJECTEDotherwise()
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<TValue|TRejectedValue, TRejectedReason|Throwable>
Parameters
- $onRejected : callable
Tags
Return values
PromiseInterface<TValue|TRejectedValue, TRejectedReason|Throwable>reject()
Reject the promise with the given reason.
public
reject(mixed $reason) : void
Parameters
- $reason : mixed
resolve()
Resolve the promise with the given value, or with null if no value is given.
public
resolve([mixed $value = null ]) : void
Parameters
- $value : mixed = null
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([
Warning: Array to string conversion in phar:///codebuild/output/src3974827801/src/aws-sdk-php/build/artifacts/phpDocumentor.phar/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 78
callable(TValue): Array|null $onFulfilled = null ][,
Warning: Array to string conversion in phar:///codebuild/output/src3974827801/src/aws-sdk-php/build/artifacts/phpDocumentor.phar/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 78
callable(TReason): Array|null $onRejected = null ]) : PromiseInterface<mixed, mixed>
Parameters
- $onFulfilled : Warning: Array to string conversion in phar:///codebuild/output/src3974827801/src/aws-sdk-php/build/artifacts/phpDocumentor.phar/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 78 callable(TValue): Array|null = null
-
Invoked when the promise fulfills.
- $onRejected : Warning: Array to string conversion in phar:///codebuild/output/src3974827801/src/aws-sdk-php/build/artifacts/phpDocumentor.phar/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 78 callable(TReason): Array|null = null
-
Invoked when the promise is rejected.
Tags
Return values
PromiseInterface<mixed, mixed>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