Add defaultSheetIndex for multiple sheets export

[sody1981]

Hi,
I had a request from client to set default sheet when exporting multiple sheets.
Reviewing the code it was easy to set.
in maatwebsite/excel/src/Writer.php I saw that its hardcoded to 0 in write function:
$this->spreadsheet->setActiveSheetIndex(0), the idea is to add extra parameter $defaultSheetIndex=0 in write function and export function in Writer.php.
implemented asto this,

public function export($export, string $writerType,$defaultSheetIndex=0): TemporaryFile
    {
        $this->open($export);

        $sheetExports = [$export];
        if ($export instanceof WithMultipleSheets) {
            $sheetExports = $export->sheets();
        }

        foreach ($sheetExports as $sheetExport) {
            $this->addNewSheet()->export($sheetExport);
        }

        return $this->write($export, $this->temporaryFileFactory->makeLocal(null, strtolower($writerType)), $writerType,$defaultSheetIndex);
    }


public function write($export, TemporaryFile $temporaryFile, string $writerType,$defaultSheetIndex=0): TemporaryFile
    {
        $this->exportable = $export;

        $this->spreadsheet->setActiveSheetIndex($defaultSheetIndex);
.
.
.

in order to complete it also needs to be added in: maatwebsite/excel/src/Exporter.php interface in download function:
public function download($export, string $fileName, string $writerType = null, array $headers = [],$defaultSheetIndex);

also in maatwebsite/excel/src/Excel.php in functions export and write functions:

public function download($export, string $fileName, string $writerType = null, array $headers = [],$defaultSheetIndex=0)
    {
        return response()->download(
            $this->export($export, $fileName, $writerType,$defaultSheetIndex)->getLocalPath(),
            $fileName,
            $headers
        )->deleteFileAfterSend(true);
    }

 protected function export($export, string $fileName, string $writerType = null,$defaultSheetIndex=0): TemporaryFile
    {
        $writerType = FileTypeDetector::detectStrict($fileName, $writerType);

        return $this->writer->export($export, $writerType,$defaultSheetIndex);
    }

In sheets() function i set selectedSheetIndex variable, and in my case I also implemented function in myExport class that generates the sheet this:

public function getSelectedSheetIndex() {
        $this->sheets();
        return $this->selectedSheetIndex;
    }

there might be another effiecent implemenatation as sheets() get called twice in my case, but it does the job:

$exp = (new \App\Export\myExport($id, $req));
 return Excel::download($exp,'myExport-'.date("d-m-Y",strtotime(now())).'.xlsx',null,[],$exp->getSelectedSheetIndex());

Hope to see this upstream

Sami

[patrickbrouwers]

You should be able to use the BeforeWriting event to set the sheet index to your choice

[sody1981]

where is that documented ? I didn't see it in documentation, maybe i missed.. can you point to it ?

[patrickbrouwers]

https://docs.laravel-excel.com/3.1/exports/extending.html#events

You can also use the search

[sody1981]

Thank you. That did the trick.

for reference:

class myExport implements WithMultipleSheets, WithEvents
{
    use Exportable, RegistersEventListeners;
    private $id;
    private $req;
    public static $selectedSheetIndex  = 0;


    public static function beforeWriting(BeforeWriting $event)
    {
        $event->getWriter()->getDelegate()->setActiveSheetIndex(self::$selectedSheetIndex);
    }
.
.
.

and in my sheets() function i set the index as:
self::$selectedSheetIndex = $j; //$j is variable i assigned manually before

Thank you again. I Closed the discussion.
Sami