Add AfterBatch and AfterChunk event and refactor events (SpartnerNL#3993)

* Add AfterBatch and AfterChunk event and refactor events

* Don't use reflection

* Make protected

* phpcs

Author: Tofandel

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+- AfterChunk and AfterBatch events
+
 ### Fixed
 - Bug preventing WithChunkReading from working with multiple sheets when using ToCollection or ToArray   
 - Row::toArray() now always respects the endColumn

src/ChunkReader.php

@@ -14,7 +14,6 @@
 use Maatwebsite\Excel\Concerns\WithEvents;
 use Maatwebsite\Excel\Concerns\WithLimit;
 use Maatwebsite\Excel\Concerns\WithProgressBar;
-use Maatwebsite\Excel\Events\BeforeImport;
 use Maatwebsite\Excel\Files\TemporaryFile;
 use Maatwebsite\Excel\Imports\HeadingRowExtractor;
 use Maatwebsite\Excel\Jobs\AfterImportJob;
@@ -42,7 +41,7 @@ public function __construct(Container $container)
      */
     public function read(WithChunkReading $import, Reader $reader, TemporaryFile $temporaryFile)
     {
-        if ($import instanceof WithEvents && isset($import->registerEvents()[BeforeImport::class])) {
+        if ($import instanceof WithEvents) {
             $reader->beforeImport($import);
         }
 

src/Concerns/RegistersEventListeners.php

@@ -2,6 +2,8 @@
 
 namespace Maatwebsite\Excel\Concerns;
 
+use Maatwebsite\Excel\Events\AfterBatch;
+use Maatwebsite\Excel\Events\AfterChunk;
 use Maatwebsite\Excel\Events\AfterImport;
 use Maatwebsite\Excel\Events\AfterSheet;
 use Maatwebsite\Excel\Events\BeforeExport;
@@ -17,34 +19,25 @@ trait RegistersEventListeners
      */
     public function registerEvents(): array
     {
+        $listenersClasses = [
+            BeforeExport::class  => 'beforeExport',
+            BeforeWriting::class => 'beforeWriting',
+            BeforeImport::class  => 'beforeImport',
+            AfterImport::class   => 'afterImport',
+            AfterBatch::class    => 'afterBatch',
+            AfterChunk::class    => 'afterChunk',
+            ImportFailed::class  => 'importFailed',
+            BeforeSheet::class   => 'beforeSheet',
+            AfterSheet::class    => 'afterSheet',
+        ];
         $listeners = [];
 
-        if (method_exists($this, 'beforeExport')) {
-            $listeners[BeforeExport::class] = [static::class, 'beforeExport'];
-        }
-
-        if (method_exists($this, 'beforeWriting')) {
-            $listeners[BeforeWriting::class] = [static::class, 'beforeWriting'];
-        }
-
-        if (method_exists($this, 'beforeImport')) {
-            $listeners[BeforeImport::class] = [static::class, 'beforeImport'];
-        }
-
-        if (method_exists($this, 'afterImport')) {
-            $listeners[AfterImport::class] = [static::class, 'afterImport'];
-        }
-
-        if (method_exists($this, 'importFailed')) {
-            $listeners[ImportFailed::class] = [static::class, 'importFailed'];
-        }
-
-        if (method_exists($this, 'beforeSheet')) {
-            $listeners[BeforeSheet::class] = [static::class, 'beforeSheet'];
-        }
-
-        if (method_exists($this, 'afterSheet')) {
-            $listeners[AfterSheet::class] = [static::class, 'afterSheet'];
+        foreach ($listenersClasses as $class => $name) {
+            // Method names are case insensitive in php
+            if (method_exists($this, $name)) {
+                // Allow methods to not be static
+                $listeners[$class] = [$this, $name];
+            }
         }
 
         return $listeners;

src/Events/AfterBatch.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Maatwebsite\Excel\Events;
+
+use Maatwebsite\Excel\Imports\ModelManager;
+
+class AfterBatch extends Event
+{
+    /**
+     * @var ModelManager
+     */
+    public $manager;
+
+    /**
+     * @var int
+     */
+    private $batchSize;
+
+    /**
+     * @var int
+     */
+    private $startRow;
+
+    /**
+     * @param  ModelManager  $manager
+     * @param  object  $importable
+     * @param  int  $batchSize
+     * @param  int  $startRow
+     */
+    public function __construct(ModelManager $manager, $importable, int $batchSize, int $startRow)
+    {
+        $this->manager   = $manager;
+        $this->batchSize = $batchSize;
+        $this->startRow  = $startRow;
+        parent::__construct($importable);
+    }
+
+    public function getManager(): ModelManager
+    {
+        return $this->manager;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getDelegate()
+    {
+        return $this->manager;
+    }
+
+    public function getBatchSize(): int
+    {
+        return $this->batchSize;
+    }
+
+    public function getStartRow(): int
+    {
+        return $this->startRow;
+    }
+}

src/Events/AfterChunk.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Maatwebsite\Excel\Events;
+
+use Maatwebsite\Excel\Sheet;
+
+class AfterChunk extends Event
+{
+    /**
+     * @var Sheet
+     */
+    private $sheet;
+
+    /**
+     * @var int
+     */
+    private $startRow;
+
+    public function __construct(Sheet $sheet, $importable, int $startRow)
+    {
+        $this->sheet     = $sheet;
+        $this->startRow  = $startRow;
+        parent::__construct($importable);
+    }
+
+    public function getSheet(): Sheet
+    {
+        return $this->sheet;
+    }
+
+    public function getDelegate()
+    {
+        return $this->sheet;
+    }
+
+    public function getStartRow(): int
+    {
+        return $this->startRow;
+    }
+}

src/Events/AfterImport.php

@@ -11,19 +11,14 @@ class AfterImport extends Event
      */
     public $reader;
 
-    /**
-     * @var object
-     */
-    private $importable;
-
     /**
      * @param  Reader  $reader
      * @param  object  $importable
      */
     public function __construct(Reader $reader, $importable)
     {
         $this->reader     = $reader;
-        $this->importable = $importable;
+        parent::__construct($importable);
     }
 
     /**
@@ -34,14 +29,6 @@ public function getReader(): Reader
         return $this->reader;
     }
 
-    /**
-     * @return object
-     */
-    public function getConcernable()
-    {
-        return $this->importable;
-    }
-
     /**
      * @return mixed
      */

src/Events/AfterSheet.php

@@ -11,19 +11,14 @@ class AfterSheet extends Event
      */
     public $sheet;
 
-    /**
-     * @var object
-     */
-    private $exportable;
-
     /**
      * @param  Sheet  $sheet
      * @param  object  $exportable
      */
     public function __construct(Sheet $sheet, $exportable)
     {
         $this->sheet      = $sheet;
-        $this->exportable = $exportable;
+        parent::__construct($exportable);
     }
 
     /**
@@ -34,14 +29,6 @@ public function getSheet(): Sheet
         return $this->sheet;
     }
 
-    /**
-     * @return object
-     */
-    public function getConcernable()
-    {
-        return $this->exportable;
-    }
-
     /**
      * @return mixed
      */

src/Events/BeforeExport.php

@@ -11,19 +11,14 @@ class BeforeExport extends Event
      */
     public $writer;
 
-    /**
-     * @var object
-     */
-    private $exportable;
-
     /**
      * @param  Writer  $writer
      * @param  object  $exportable
      */
     public function __construct(Writer $writer, $exportable)
     {
         $this->writer     = $writer;
-        $this->exportable = $exportable;
+        parent::__construct($exportable);
     }
 
     /**
@@ -34,14 +29,6 @@ public function getWriter(): Writer
         return $this->writer;
     }
 
-    /**
-     * @return object
-     */
-    public function getConcernable()
-    {
-        return $this->exportable;
-    }
-
     /**
      * @return mixed
      */

src/Events/BeforeImport.php

@@ -11,19 +11,14 @@ class BeforeImport extends Event
      */
     public $reader;
 
-    /**
-     * @var object
-     */
-    private $importable;
-
     /**
      * @param  Reader  $reader
      * @param  object  $importable
      */
     public function __construct(Reader $reader, $importable)
     {
         $this->reader     = $reader;
-        $this->importable = $importable;
+        parent::__construct($importable);
     }
 
     /**
@@ -34,14 +29,6 @@ public function getReader(): Reader
         return $this->reader;
     }
 
-    /**
-     * @return object
-     */
-    public function getConcernable()
-    {
-        return $this->importable;
-    }
-
     /**
      * @return mixed
      */

src/Events/BeforeSheet.php

@@ -11,19 +11,14 @@ class BeforeSheet extends Event
      */
     public $sheet;
 
-    /**
-     * @var object
-     */
-    private $exportable;
-
     /**
      * @param  Sheet  $sheet
      * @param  object  $exportable
      */
     public function __construct(Sheet $sheet, $exportable)
     {
         $this->sheet       = $sheet;
-        $this->exportable  = $exportable;
+        parent::__construct($exportable);
     }
 
     /**
@@ -34,14 +29,6 @@ public function getSheet(): Sheet
         return $this->sheet;
     }
 
-    /**
-     * @return object
-     */
-    public function getConcernable()
-    {
-        return $this->exportable;
-    }
-
     /**
      * @return mixed
      */