Merge branch 'pr8742'

Author: taylorotwell

src/Illuminate/Bus/Batch.php

@@ -32,6 +32,13 @@ class Batch implements Arrayable, JsonSerializable
      */
     public $id;
 
+    /**
+     * The batch name.
+     *
+     * @var string
+     */
+    public $name;
+
     /**
      * The total number of jobs that belong to the batch.
      *
@@ -94,6 +101,7 @@ class Batch implements Arrayable, JsonSerializable
      * @param  \Illuminate\Contracts\Queue\Factory  $queue
      * @param  \Illuminate\Bus\BatchRepository  $repository
      * @param  string  $id
+     * @param  string  $name
      * @param  int  $totalJobs
      * @param  int  $pendingJobs
      * @param  int  $failedJobs
@@ -107,6 +115,7 @@ class Batch implements Arrayable, JsonSerializable
     public function __construct(QueueFactory $queue,
                                 BatchRepository $repository,
                                 string $id,
+                                string $name,
                                 int $totalJobs,
                                 int $pendingJobs,
                                 int $failedJobs,
@@ -119,6 +128,7 @@ public function __construct(QueueFactory $queue,
         $this->queue = $queue;
         $this->repository = $repository;
         $this->id = $id;
+        $this->name = $name;
         $this->totalJobs = $totalJobs;
         $this->pendingJobs = $pendingJobs;
         $this->failedJobs = $failedJobs;
@@ -370,6 +380,7 @@ public function toArray()
     {
         return [
             'id' => $this->id,
+            'name' => $this->name,
             'totalJobs' => $this->totalJobs,
             'pendingJobs' => $this->pendingJobs,
             'processedJobs' => $this->processedJobs(),

src/Illuminate/Bus/BatchFactory.php

@@ -30,6 +30,7 @@ public function __construct(QueueFactory $queue)
      *
      * @param  \Illuminate\Bus\BatchRepository  $repository
      * @param  string  $id
+     * @param  string  $name
      * @param  int  $totalJobs
      * @param  int  $pendingJobs
      * @param  int  $failedJobs
@@ -38,10 +39,11 @@ public function __construct(QueueFactory $queue)
      * @param  \Illuminate\Support\CarbonImmutable  $createdAt
      * @param  \Illuminate\Support\CarbonImmutable|null  $cancelledAt
      * @param  \Illuminate\Support\CarbonImmutable|null  $finishedAt
-     * @return void
+     * @return \Illuminate\Bus\Batch
      */
     public function make(BatchRepository $repository,
                          string $id,
+                         string $name,
                          int $totalJobs,
                          int $pendingJobs,
                          int $failedJobs,
@@ -51,6 +53,6 @@ public function make(BatchRepository $repository,
                          ?CarbonImmutable $cancelledAt,
                          ?CarbonImmutable $finishedAt)
     {
-        return new Batch($this->queue, $repository, $id, $totalJobs, $pendingJobs, $failedJobs, $failedJobIds, $options, $createdAt, $cancelledAt, $finishedAt);
+        return new Batch($this->queue, $repository, $id, $name, $totalJobs, $pendingJobs, $failedJobs, $failedJobIds, $options, $createdAt, $cancelledAt, $finishedAt);
     }
 }

src/Illuminate/Bus/DatabaseBatchRepository.php

@@ -96,6 +96,7 @@ public function store(PendingBatch $batch)
 
         $this->connection->table($this->table)->insert([
             'id' => $id,
+            'name' => $batch->name,
             'total_jobs' => 0,
             'pending_jobs' => 0,
             'failed_jobs' => 0,
@@ -253,6 +254,7 @@ protected function toBatch($batch)
         return $this->factory->make(
             $this,
             $batch->id,
+            $batch->name,
             (int) $batch->total_jobs,
             (int) $batch->pending_jobs,
             (int) $batch->failed_jobs,

src/Illuminate/Bus/PendingBatch.php

@@ -11,6 +11,13 @@
 
 class PendingBatch
 {
+    /**
+     * The batch name.
+     *
+     * @var string
+     */
+    public $name = '';
+
     /**
      * The jobs that belong to the batch.
      *
@@ -130,6 +137,19 @@ public function allowsFailures()
         return Arr::get($this->options, 'allowFailures', false) === true;
     }
 
+    /**
+     * Set the name for the batch.
+     *
+     * @param  string  $name
+     * @return $this
+     */
+    public function name(string $name)
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
     /**
      * Specify the queue connection that the batched jobs should run on.
      *

src/Illuminate/Queue/Console/stubs/batches.stub

@@ -15,6 +15,7 @@ class Create{{tableClassName}}Table extends Migration
     {
         Schema::create('{{table}}', function (Blueprint $table) {
             $table->string('id')->primary();
+            $table->string('name');
             $table->integer('total_jobs');
             $table->integer('pending_jobs');
             $table->integer('failed_jobs');

tests/Bus/BusBatchTest.php

@@ -46,6 +46,7 @@ public function createSchema()
     {
         $this->schema()->create('job_batches', function ($table) {
             $table->string('id')->primary();
+            $table->string('name');
             $table->integer('total_jobs');
             $table->integer('pending_jobs');
             $table->integer('failed_jobs');