Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
GuzzleHttp\Promise\EachPromise Class Reference
Inheritance diagram for GuzzleHttp\Promise\EachPromise:
GuzzleHttp\Promise\PromisorInterface

Public Member Functions

 __construct ($iterable, array $config=[])
 Configuration hash can include the following key value pairs:
 
 promise ()
 @psalm-suppress InvalidNullableReturnType
 

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Promise\EachPromise::__construct ( $iterable,
array $config = [] )

Configuration hash can include the following key value pairs:

  • fulfilled: (callable) Invoked when a promise fulfills. The function is invoked with three arguments: the fulfillment value, the index position from the iterable list of the promise, and the aggregate promise that manages all of the promises. The aggregate promise may be resolved from within the callback to short-circuit the promise.
  • rejected: (callable) Invoked when a promise is rejected. The function is invoked with three arguments: the rejection reason, the index position from the iterable list of the promise, and the aggregate promise that manages all of the promises. The aggregate promise may be resolved from within the callback to short-circuit the promise.
  • concurrency: (integer) Pass this configuration option to limit the allowed number of outstanding concurrently executing promises, creating a capped pool of promises. There is no limit by default.
Parameters
mixed$iterablePromises or values to iterate.
array$configConfiguration options

Member Function Documentation

◆ promise()

GuzzleHttp\Promise\EachPromise::promise ( )

@psalm-suppress InvalidNullableReturnType

Implements GuzzleHttp\Promise\PromisorInterface.


The documentation for this class was generated from the following file: