<?php

namespace Maatwebsite\Excel;

use ArrayAccess;
use Closure;
use Illuminate\Support\Collection;
use PhpOffice\PhpSpreadsheet\Worksheet\Row as SpreadsheetRow;

/** @mixin SpreadsheetRow */
class Row implements ArrayAccess
{
    use DelegatedMacroable;

    /**
     * @var array
     */
    protected $headingRow = [];

    /**
     * @var array
     */
    protected $headerIsGrouped = [];

    /**
     * @var \Closure
     */
    protected $preparationCallback;

    /**
     * @var SpreadsheetRow
     */
    protected $row;

    /**
     * @var array|null
     */
    protected $rowCache;

    /**
     * @var bool|null
     */
    protected $rowCacheFormatData;

    /**
     * @var string|null
     */
    protected $rowCacheEndColumn;

    /**
     * @param  SpreadsheetRow  $row
     * @param  array  $headingRow
     * @param  array  $headerIsGrouped
     */
    public function __construct(SpreadsheetRow $row, array $headingRow = [], array $headerIsGrouped = [])
    {
        $this->row             = $row;
        $this->headingRow      = $headingRow;
        $this->headerIsGrouped = $headerIsGrouped;
    }

    /**
     * @return SpreadsheetRow
     */
    public function getDelegate(): SpreadsheetRow
    {
        return $this->row;
    }

    /**
     * @param  null  $nullValue
     * @param  bool  $calculateFormulas
     * @param  bool  $formatData
     * @param  string|null  $endColumn
     * @return Collection
     */
    public function toCollection($nullValue = null, $calculateFormulas = false, $formatData = true, ?string $endColumn = null): Collection
    {
        return new Collection($this->toArray($nullValue, $calculateFormulas, $formatData, $endColumn));
    }

    /**
     * @param  null  $nullValue
     * @param  bool  $calculateFormulas
     * @param  bool  $formatData
     * @param  string|null  $endColumn
     * @return array
     */
    public function toArray($nullValue = null, $calculateFormulas = false, $formatData = true, ?string $endColumn = null)
    {
        if (is_array($this->rowCache) && ($this->rowCacheFormatData === $formatData) && ($this->rowCacheEndColumn === $endColumn)) {
            return $this->rowCache;
        }

        $cells = [];

        $i = 0;
        foreach ($this->row->getCellIterator('A', $endColumn) as $cell) {
            $value = (new Cell($cell))->getValue($nullValue, $calculateFormulas, $formatData);

            if (isset($this->headingRow[$i])) {
                if (!$this->headerIsGrouped[$i]) {
                    $cells[$this->headingRow[$i]] = $value;
                } else {
                    $cells[$this->headingRow[$i]][] = $value;
                }
            } else {
                $cells[] = $value;
            }

            $i++;
        }

        if (isset($this->preparationCallback)) {
            $cells = ($this->preparationCallback)($cells, $this->row->getRowIndex());
        }

        $this->rowCache           = $cells;
        $this->rowCacheFormatData = $formatData;
        $this->rowCacheEndColumn  = $endColumn;

        return $cells;
    }

    /**
     * @param  bool  $calculateFormulas
     * @param  string|null  $endColumn
     * @return bool
     */
    public function isEmpty($calculateFormulas = false, ?string $endColumn = null): bool
    {
        return count(array_filter($this->toArray(null, $calculateFormulas, false, $endColumn))) === 0;
    }

    /**
     * @return int
     */
    public function getIndex(): int
    {
        return $this->row->getRowIndex();
    }

    #[\ReturnTypeWillChange]
    public function offsetExists($offset)
    {
        return isset($this->toArray()[$offset]);
    }

    #[\ReturnTypeWillChange]
    public function offsetGet($offset)
    {
        return $this->toArray()[$offset];
    }

    #[\ReturnTypeWillChange]
    public function offsetSet($offset, $value)
    {
        //
    }

    #[\ReturnTypeWillChange]
    public function offsetUnset($offset)
    {
        //
    }

    /**
     * @param  \Closure  $preparationCallback
     *
     * @internal
     */
    public function setPreparationCallback(Closure $preparationCallback = null)
    {
        $this->preparationCallback = $preparationCallback;
    }
}

• [D] Cache
• [D] Concerns
• [D] Console
• [D] Events
• [D] Exceptions
• [D] Facades
• [D] Factories
• [D] Fakes
• [D] Files
• [D] Filters
• [D] Helpers
• [D] Imports
• [D] Jobs
• [D] Middleware
• [D] Mixins
• [D] Transactions
• [D] Validators
• [F] Cell.php
  Delete
• [F] ChunkReader.php
  Delete
• [F] DefaultValueBinder.php
  Delete
• [F] DelegatedMacroable.php
  Delete
• [F] Excel.php
  Delete
• [F] ExcelServiceProvider.php
  Delete
• [F] Exporter.php
  Delete
• [F] HasEventBus.php
  Delete
• [F] HeadingRowImport.php
  Delete
• [F] Importer.php
  Delete
• [F] MappedReader.php
  Delete
• [F] QueuedWriter.php
  Delete
• [F] Reader.php
  Delete
• [F] RegistersCustomConcerns.php
  Delete
• [F] Row.php
  Delete
• [F] SettingsProvider.php
  Delete
• [F] Sheet.php
  Delete
• [F] Writer.php
  Delete

Developer

• Support

Back to Home page