Pim\Bundle\ExcelConnectorBundle\Reader\AbstractIteratorReader

Complexity

Total Complexity

11

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setStepExecution()	0	4	1
A	read()	0	18	4
A	reset()	0	4	1
A	initialize()	0	4	1
A	convertNumericIdentifierToString()	0	4	1
A	initializeIterator()	0	8	2
	createIterator()	0	1	?

<?php

namespace Pim\Bundle\ExcelConnectorBundle\Reader;

use Akeneo\Component\Batch\Model\StepExecution;
use Akeneo\Component\Batch\Item\AbstractConfigurableStepElement;
use Akeneo\Component\Batch\Item\ItemReaderInterface;
use Akeneo\Component\Batch\Step\StepExecutionAwareInterface;

/**
 * Abstract iterator based reader
 *
 * @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)
 */
abstract class AbstractIteratorReader extends AbstractConfigurableStepElement implements ItemReaderInterface,
    StepExecutionAwareInterface
{
    /** @var \Iterator */
    protected $iterator;

    /** @var StepExecution */
    protected $stepExecution;

    /** @var boolean */
    protected $batchMode;

    /**
     * @param boolean $batchMode
     */
    public function __construct($batchMode = false)
    {
        $this->batchMode = $batchMode;
    }

    /**
     * {@inheritdoc}
     */
    public function setStepExecution(StepExecution $stepExecution)
    {
        $this->stepExecution = $stepExecution;
    }

    /**
     * {@inheritdoc}
     */
    public function read()
    {
        if (!isset($this->iterator)) {
            $this->initializeIterator();
        }

        if (!$this->iterator->valid()) {
            return null;
        }

        $current = $this->iterator->current();
        if ($this->stepExecution) {
            $this->stepExecution->incrementSummaryInfo('read');
        }
        $this->iterator->next();

        return $this->convertNumericIdentifierToString($current);
    }

    /**
     * Resets the state of the reader
     *
     * @deprecated will be remove in 1.7. Use initialize method instead.
     */
    public function reset()
    {
        $this->iterator = null;
    }

    /**
     * Initializes the iterator allowing to use the same service in two successive steps
     *
     * {@inheritdoc}
     */
    public function initialize()
    {
        $this->iterator = null;
    }

    /**
     * Converts an entity numerical identifier ('sku' for products,
     * 'code' for other entities) into string to allow import.
     *
     * @param array $item
     *
     * @return array
     */
    protected function convertNumericIdentifierToString(array $item)
    {
        return $item;
    }

    /**
     * Initializes the iterator
     */
    protected function initializeIterator()
    {
        $this->iterator = $this->createIterator();
        if ($this->batchMode) {
            $this->iterator = new \ArrayIterator(array(iterator_to_array($this->iterator)));
        }
        $this->iterator->rewind();
    }

    /**
     * Creates the iterator
     *
     * @return \Iterator
     */
    abstract protected function createIterator();
}