[12.x] Add Http::batch

src/Illuminate/Http/Client/Batch.php

@@ -21,13 +21,6 @@
      */
     protected $factory;
 
-    /**
-     * The handler function for the Guzzle client.
-     *
-     * @var callable
-     */
-    protected $handler;
-
     /**
      * The list of requests.
      *
@@ -57,25 +50,11 @@
     public $failedRequests = 0;
 
     /**
-     * The date indicating when the batch was created.
-     *
-     * @var \Carbon\CarbonImmutable
-     */
-    public $createdAt = null;
-
-    /**
-     * The date indicating when the batch was cancelled.
-     *
-     * @var \Carbon\CarbonImmutable|null
-     */
-    public $cancelledAt = null;
-
-    /**
-     * The date indicating when the batch was finished.
+     * The handler function for the Guzzle client.
      *
-     * @var \Carbon\CarbonImmutable|null
+     * @var callable
      */
-    public $finishedAt = null;
+    protected $handler;
 
     /**
      * The callback to run before the first request from the batch runs.
@@ -105,18 +84,44 @@
      */
     protected $thenCallback = null;
 
+    /**
+     * The date when the batch was created.
+     *
+     * @var \Carbon\CarbonImmutable
+     */
+    public $createdAt = null;
+
+    /**
+     * The date when the batch was cancelled.
+     *
+     * @var \Carbon\CarbonImmutable|null
+     */
+    public $cancelledAt = null;
+
+    /**
+     * The date when the batch was finished.
+     *
+     * @var \Carbon\CarbonImmutable|null
+     */
+    public $finishedAt = null;
+
     /**
      * The callback to run after all the requests from the batch finish.
      *
      * @var \Closure|null
      */
     protected $finallyCallback = null;
 
+    /**
+     * Create a new request batch instance.
+     *
+     * @return void
+     */
     public function __construct(?Factory $factory = null)
     {
-        $this->factory = $factory ?: new Factory();
+        $this->factory = $factory ?: new Factory;
         $this->handler = Utils::chooseHandler();
-        $this->createdAt = new CarbonImmutable();
+        $this->createdAt = new CarbonImmutable;
     }
 
     /**
@@ -132,30 +137,6 @@
         return $this->requests[$key] = $this->asyncRequest();
     }
 
-    /**
-     * Retrieve the requests in the batch.
-     *
-     * @return array<array-key, \Illuminate\Http\Client\PendingRequest>
-     */
-    public function getRequests(): array
-    {
-        return $this->requests;
-    }
-
-    /**
-     * Add a request to the batch with a numeric index.
-     *
-     * @param  string  $method
-     * @param  array  $parameters
-     * @return \Illuminate\Http\Client\PendingRequest|\GuzzleHttp\Promise\Promise
-     */
-    public function __call(string $method, array $parameters)
-    {
-        $this->incrementPendingRequests();
-
-        return $this->requests[] = $this->asyncRequest()->$method(...$parameters);
-    }
-
     /**
      * Get the total number of requests that have been processed by the batch thus far.
      *
@@ -387,7 +368,7 @@
 
                     return $result;
                 },
                 'rejected' => function ($reason, $key) use (&$results, $catchCallback) {
                     $this->decrementPendingRequests();
 
                     if ($reason instanceof RequestException) {
@@ -458,4 +439,28 @@
     {
         $this->failedRequests++;
     }
+
+    /**
+     * Get the requests in the batch.
+     *
+     * @return array<array-key, \Illuminate\Http\Client\PendingRequest>
+     */
+    public function getRequests(): array
+    {
+        return $this->requests;
+    }
+
+    /**
+     * Add a request to the batch with a numeric index.
+     *
+     * @param  string  $method
+     * @param  array  $parameters
+     * @return \Illuminate\Http\Client\PendingRequest|\GuzzleHttp\Promise\Promise
+     */
+    public function __call(string $method, array $parameters)
+    {
+        $this->incrementPendingRequests();
+
+        return $this->requests[] = $this->asyncRequest()->$method(...$parameters);
+    }
 }

src/Illuminate/Http/Client/PendingRequest.php

@@ -899,6 +899,12 @@ public function pool(callable $callback)
         return $results;
     }
 
+    /**
+     * Send a pool of asynchronous requests concurrently, with callbacks for introspection.
+     *
+     * @param  callable  $callback
+     * @return \Illuminate\Http\Client\Batch
+     */
     public function batch(callable $callback): Batch
     {
         return tap(new Batch($this->factory), $callback);