Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Promise.php

interface Promise

Promise represents a value that may not be available yet, but will be resolved at some point in future. It acts like a proxy to the actual value.

This interface is an extension of the promises/a+ specification.

@author Joel Wurtz <joel.wurtz@gmail.com> @author Márk Sági-Kazár <mark.sagikazar@gmail.com>

Hierarchy

  • interface \Http\Promise\Promise

Expanded class hierarchy of Promise

All classes that implement Promise

See also

https://promisesaplus.com/

4 files declare their use of Promise
HttpAsyncClient.php in vendor/php-http/httplug/src/HttpAsyncClient.php
HttpFulfilledPromise.php in vendor/php-http/httplug/src/Promise/HttpFulfilledPromise.php
HttpRejectedPromise.php in vendor/php-http/httplug/src/Promise/HttpRejectedPromise.php
Promise.php in vendor/php-http/guzzle7-adapter/src/Promise.php

File

vendor/php-http/promise/src/Promise.php, line 16

Namespace

Http\Promise
View source
interface Promise {
    
    /**
     * Promise has not been fulfilled or rejected.
     */
    const PENDING = 'pending';
    
    /**
     * Promise has been fulfilled.
     */
    const FULFILLED = 'fulfilled';
    
    /**
     * Promise has been rejected.
     */
    const REJECTED = 'rejected';
    
    /**
     * Adds behavior for when the promise is resolved or rejected (response will be available, or error happens).
     *
     * If you do not care about one of the cases, you can set the corresponding callable to null
     * The callback will be called when the value arrived and never more than once.
     *
     * @param callable|null $onFulfilled called when a response will be available
     * @param callable|null $onRejected  called when an exception occurs
     *
     * @return Promise a new resolved promise with value of the executed callback (onFulfilled / onRejected)
     */
    public function then(?callable $onFulfilled = null, ?callable $onRejected = null);
    
    /**
     * Returns the state of the promise, one of PENDING, FULFILLED or REJECTED.
     *
     * @return string
     */
    public function getState();
    
    /**
     * Wait for the promise to be fulfilled or rejected.
     *
     * When this method returns, the request has been resolved and if callables have been
     * specified, the appropriate one has terminated.
     *
     * When $unwrap is true (the default), the response is returned, or the exception thrown
     * on failure. Otherwise, nothing is returned or thrown.
     *
     * @param bool $unwrap Whether to return resolved value / throw reason or not
     *
     * @return ($unwrap is true ? mixed : null) Resolved value, null if $unwrap is set to false
     *
     * @throws \Throwable the rejection reason if $unwrap is set to true and the request failed
     */
    public function wait($unwrap = true);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
Promise::FULFILLED constant Promise has been fulfilled.
Promise::getState public function Returns the state of the promise, one of PENDING, FULFILLED or REJECTED. 5
Promise::PENDING constant Promise has not been fulfilled or rejected.
Promise::REJECTED constant Promise has been rejected.
Promise::then public function Adds behavior for when the promise is resolved or rejected (response will be available, or error happens). 5
Promise::wait public function Wait for the promise to be fulfilled or rejected. 5

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal