[PROPOSAL] Passing index to map()

[darron1217]

Prerequisites

Versions

• PHP version: PHP 7.4.5 (cli) (built: Apr 14 2020 16:17:19) ( NTS Visual C++ 2017 x64 )
• Laravel version: 5.5.49
• Package version: 3.1.19

Description

Export Class which implements WithMapping interface has map($row) function to manipulate rows.

I needed to use index, but I couldn't get index data from it.

How about passing index parameter to map()?

Example

Make those lines
https://github.com/Maatwebsite/Laravel-Excel/blob/90977aa13e687f7a11eda97a5037267919cfd1f0/src/Sheet.php#L530-L538

into this (just adding $index is enough!)

        $rows = (new Collection($rows))->flatMap(function ($row, $index) use ($sheetExport) {
            if ($sheetExport instanceof WithMapping) {
                $row = $sheetExport->map($row, $index);
            }

            return ArrayHelper::ensureMultipleRows(
                static::mapArraybleRow($row)
            );
        })->toArray();

Also
https://github.com/Maatwebsite/Laravel-Excel/blob/90977aa13e687f7a11eda97a5037267919cfd1f0/src/Sheet.php#L310-L322

into

        foreach ($this->worksheet->getRowIterator($startRow, $endRow) as $index => $row) {
            $row = (new Row($row, $headingRow))->toArray($nullValue, $calculateFormulas, $formatData);

            if ($import instanceof WithMapping) {
                $row = $import->map($row, $index);
            }

            $rows[] = $row;

            if ($import instanceof WithProgressBar) {
                $import->getConsoleOutput()->progressAdvance();
            }
        }

Also
https://github.com/Maatwebsite/Laravel-Excel/blob/90977aa13e687f7a11eda97a5037267919cfd1f0/src/Concerns/WithMapping.php#L7-L12

into

    /**
     * @param mixed $row
     * @param int $index
     *
     * @return array
     */
    public function map($row, $index): array;

Additional Information

[patrickbrouwers]

That would be a breaking change, so that won't be possible. The next release will have a RemembersRowNumber that will help you with this situation.

[allestaire]

Is this functionality already on version 3?

[bkkrishna]

+1. Is this feature added in v3? A simple workaround is here though.