Pim\Bundle\ExcelConnectorBundle\Iterator\InitFileIterator

Complexity

Total Complexity

36

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	current()	0	13	4
A	key()	0	6	1
A	valid()	0	4	3
A	next()	0	11	3
A	rewind()	0	13	2
A	trimRight()	0	10	3
A	initializeValuesIterator()	0	11	4
A	isReadableWorksheet()	0	4	2
A	isIncludedWorksheet()	0	14	4
A	isExcludedWorksheet()	0	14	4
A	createValuesIterator()	0	14	4
A	configureOptions()	0	15	1

<?php

namespace Pim\Bundle\ExcelConnectorBundle\Iterator;

use Box\Spout\Reader\XLSX\Sheet;
use Box\Spout\Reader\XLSX\SheetIterator;
use Pim\Component\Connector\Reader\File\FileIterator;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * XSLX initialization file iterator
 *
 * @author    JM Leroux <jean-marie.leroux@akeneo.com>
 * @author    Antoine Guigan <antoine@akeneo.com>
 * @copyright 2013 Akeneo SAS (http://www.akeneo.com)
 * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */
class InitFileIterator extends FileIterator
{
    /** @var SheetIterator */
    protected $worksheetIterator;

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

    /** @var bool */
    protected $nextWorksheet = false;

    /**
     * {@inheritdoc}
     */
    public function __construct($type, $filePath, array $options = [])
    {
        parent::__construct($type, $filePath, $options);
        $resolver = new OptionsResolver();
        $this->configureOptions($resolver);
        $this->options = $resolver->resolve($options);
    }

    /**
     * {@inheritdoc}
     */
    public function current()
    {
        $data = $this->rows->current();
        if (!$this->valid() || null === $data || empty($data)) {
            $this->rewind();

            return null;
        }

        $data = $this->trimRight($data);

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function key()
    {
        $worksheetName = $this->worksheetIterator->current()->getName();

        return sprintf('%s/%s', $worksheetName, $this->rows->key());
    }

    /**
     * @inheritdoc
     */
    public function valid()
    {
        return $this->worksheetIterator->valid() && $this->rows && $this->rows->valid();
    }

    /**
     * {@inheritdoc}
     */
    public function next()
    {
        $this->rows->next();
        if (!$this->rows->valid()) {
            $this->worksheetIterator->next();
            $this->nextWorksheet = true;
            if ($this->worksheetIterator->valid()) {
                $this->initializeValuesIterator();
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function rewind()
    {
        $this->worksheetIterator = new \CallbackFilterIterator(

It seems like new \CallbackFilterIterator($this->reader->getSheetIterator(), function (\Box\Spout\Reader\XLSX\Sheet $currentSheet) { return $this->isReadableWorksheet($currentSheet->getName()); }) of type object<CallbackFilterIterator> is incompatible with the declared type object<Box\Spout\Reader\XLSX\SheetIterator> of property $worksheetIterator.

            $this->reader->getSheetIterator(),
            function (Sheet $currentSheet) {
                return $this->isReadableWorksheet($currentSheet->getName());
            }
        );
        $this->worksheetIterator->rewind();
        if ($this->worksheetIterator->valid()) {
            $this->initializeValuesIterator();
        }
    }

    protected function trimRight($data)
    {
        $lastElement = end($data);
        while (false !== $lastElement && empty($lastElement)) {
            array_pop($data);
            $lastElement = end($data);
        }

        return $data;
    }

    /**
     * Initializes the current worksheet
     */
    protected function initializeValuesIterator()
    {
        $this->createValuesIterator();

        if (!$this->rows->valid() || !$this->isReadableWorksheet($this->reader->getSheetIterator()->current()->getName())) {
            $this->worksheetIterator->next();
            if ($this->worksheetIterator->valid()) {
                $this->initializeValuesIterator();
            }
        }
    }

    /**
     * Returns true if the worksheet should be read
     *
     * @param string $title
     *
     * @return boolean
     */
    protected function isReadableWorksheet($title)
    {
        return $this->isIncludedWorksheet($title) && !$this->isExcludedWorksheet($title);
    }

    /**
     * Returns true if the worksheet should be indluded
     *
     * @param string $title The title of the worksheet
     *
     * @return boolean
     */
    protected function isIncludedWorksheet($title)
    {
        if (!isset($this->options['include_worksheets'])) {
            return true;
        }

        foreach ($this->options['include_worksheets'] as $regexp) {
            if (preg_match($regexp, $title)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Returns true if the worksheet should be excluded
     *
     * @param string $title The title of the worksheet
     *
     * @return boolean
     */
    protected function isExcludedWorksheet($title)
    {
        if (!isset($this->options['exclude_worksheets'])) {
            return false;
        }

        foreach ($this->options['exclude_worksheets'] as $regexp) {
            if (preg_match($regexp, $title)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Create the values iterator according to the 'header_key' option
     * Set the headers
     * Leave reader cursor on the headers, like in the PIM
     */
    protected function createValuesIterator()
    {
        $sheet = $this->worksheetIterator->current();
        $this->rows = $sheet->getRowIterator();
        $this->rows->rewind();
        while ($this->rows->valid() && ($this->options['header_key'] !== trim($this->rows->current()[0]))) {
            $this->rows->next();
        }
        $this->headers = $this->trimRight($this->rows->current());
        if ($this->nextWorksheet) {
            $this->rows->next();
        }
        $this->nextWorksheet = false;
    }

    /**
     * {@inheritdoc}
     */
    protected function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'skip_empty' => false,
        ]);

        $resolver->setRequired([
            'header_key',
        ]);

        $resolver->setDefined([
            'include_worksheets',
            'exclude_worksheets',
        ]);
    }
}