fastbolt/entity-importer

<?php

/**
 * Copyright © Fastbolt Schraubengroßhandels GmbH.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Fastbolt\EntityImporter\Reader;

use PhpOffice\PhpSpreadsheet\IOFactory;
use SplFileObject;

/**
 * @psalm-suppress PropertyNotSetInConstructor
 */
class XlsxReader implements ReaderInterface
{
    /**
     * Faulty rows
     *
     * @var array<int,array<int,mixed>>|null
     */
    protected ?array $errors = null;

    /**
     * @var array
     */
    protected array $columnHeaders;

    /**
     * Total number of rows
     *
     * @var int
     */
    protected int $count;

    /**
     * @var int|null
     */
    protected ?int $headerRowNumber = null;

    /**
     * @var int
     */
    protected int $pointer = 0;

    /**
     * @var array
     */
    protected array $worksheet;

    /**
     * @param SplFileObject     $file
     * @param array<int,string> $columnHeaders
     * @param ?int              $headerRowNumber
     */
    public function __construct(SplFileObject $file, array $columnHeaders, ?int $headerRowNumber)
    {
        $reader = IOFactory::createReaderForFile($file->getPathName());
        $reader->setReadDataOnly(true);

        $spreadsheet = $reader->load($file->getPathname());

        $this->worksheet = $spreadsheet->getActiveSheet()->toArray();

        if (null !== $headerRowNumber) {
            $this->setHeaderRowNumber($headerRowNumber);
        }
        $this->setColumnHeaders($columnHeaders);
    }

    /**
     * @param array $columnHeaders
     *
     * @return void
     */
    public function setColumnHeaders(array $columnHeaders): void
    {
        $this->columnHeaders = $columnHeaders;
    }

    /**
     * @inheritDoc
     */
    public function getErrors(): array
    {
        if (null === $this->errors) {
            $this->errors = [];
            /**
             * @var int              $index
             * @var array<int,mixed> $line
             */
            foreach ($this->worksheet as $index => $line) {
                if (count($this->columnHeaders) === count($line)) {
                    continue;
                }

                $this->errors[$index] = $line;
            }
        }

        /** @psalm-var array<int,array<int,mixed>> */
        return $this->errors;
    }

    /**
     * @return mixed
     */
    public function current(): mixed
    {
        /** @var array $row */
        $row = $this->worksheet[$this->pointer];

        // If the spreadsheet file has column headers, use them to construct an associative
        // array for the columns in this line
        if (!empty($this->columnHeaders) && count($this->columnHeaders) === count($row)) {
            /** @var array<int, array-key> $headers */
            $headers = array_values($this->columnHeaders);
            return array_combine($headers, $row);
        }

        // Else just return the column values
        return $row;
    }

    /**
     * @param int $rowNumber
     *
     * @return void
     */
    public function setHeaderRowNumber(int $rowNumber): void
    {
        $this->headerRowNumber = $rowNumber;
        /**
         * @psalm-suppress MixedAssignment
         */
        $this->columnHeaders   = $this->worksheet[$rowNumber];
    }

    /**
     * @return array
     */
    public function getColumnHeaders(): array
    {
        return $this->columnHeaders;
    }

    /**
     * @return void
     */
    public function next(): void
    {
        $this->pointer++;
    }

    /**
     * @return int
     */
    public function key(): int
    {
        return $this->pointer;
    }

    /**
     * @return bool
     */
    public function valid(): bool
    {
        return isset($this->worksheet[$this->pointer]);
    }

    /**
     * @return void
     */
    public function rewind(): void
    {
        if (null === $this->headerRowNumber) {
            $this->pointer = 0;
        } else {
            $this->pointer = $this->headerRowNumber + 1;
        }
    }
}