akeneo-labs / spreadsheet-parser

src/Xlsx/Spreadsheet.php

<?php

namespace Akeneo\Component\SpreadsheetParser\Xlsx;

use Akeneo\Component\SpreadsheetParser\SpreadsheetInterface;

/**
 * Represents an XLSX spreadsheet
 *
 * @author    Antoine Guigan <antoine@akeneo.com>
 * @copyright 2014 Akeneo SAS (http://www.akeneo.com)
 * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */
class Spreadsheet implements SpreadsheetInterface
{

    /**
     * @staticvar string Path to the relationships file inside the XLSX archive
     */
    const RELATIONSHIPS_PATH = 'xl/_rels/workbook.xml.rels';

    /**
     * @staticvar string Path to the spreadsheets file inside the XLSX archive
     */
    const WORKBOOK_PATH = 'xl/workbook.xml';

    /**
     * @var RelationshipsLoader
     */
    protected $relationshipsLoader;

    /**
     * @var ValueTransformerFactory
     */
    protected $valueTransformerFactory;

    /**
     *
     * @var SharedStringsLoader
     */
    protected $sharedStringsLoader;

    /**
     *
     * @var RowIteratorFactory
     */
    protected $rowIteratorFactory;

    /**
     * @var Archive
     */
    protected $archive;

    /**
     * @var StylesLoader
     */
    protected $stylesLoader;

    /**
     * @var WorksheetListReader
     */
    protected $worksheetListReader;

    /**
     * @var Relationships
     */
    private $relationships;

    /**
     * @var ValueTransformer
     */
    private $valueTransformer;

    /**
     * @var SharedStrings
     */
    private $sharedStrings;

    /**
     * @var array
     */
    private $worksheetPaths;

    /**
     * @var Styles
     */
    private $styles;

    /**
     * Constructor
     *
     * @param Archive                 $archive
     * @param RelationshipsLoader     $relationshipsLoader
     * @param SharedStringsLoader     $sharedStringsLoader
     * @param StylesLoader            $stylesLoader
     * @param WorksheetListReader     $worksheetListReader
     * @param ValueTransformerFactory $valueTransformerFactory
     * @param RowIteratorFactory      $rowIteratorFactory
     */
    public function __construct(

This method seems to be duplicated in your project.

        Archive $archive,
        RelationshipsLoader $relationshipsLoader,
        SharedStringsLoader $sharedStringsLoader,
        StylesLoader $stylesLoader,
        WorksheetListReader $worksheetListReader,
        ValueTransformerFactory $valueTransformerFactory,
        RowIteratorFactory $rowIteratorFactory
    ) {
        $this->archive = $archive;
        $this->relationshipsLoader = $relationshipsLoader;
        $this->sharedStringsLoader = $sharedStringsLoader;
        $this->stylesLoader = $stylesLoader;
        $this->worksheetListReader = $worksheetListReader;
        $this->valueTransformerFactory = $valueTransformerFactory;
        $this->rowIteratorFactory = $rowIteratorFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getWorksheets()
    {
        return array_keys($this->getWorksheetPaths());
    }

    /**
     * {@inheritdoc}
     */
    public function createRowIterator($worksheetIndex, array $options = [])
    {
        $paths = array_values($this->getWorksheetPaths());

        return $this->rowIteratorFactory->create(
            $this->getValueTransformer(),
            $this->archive->extract($paths[$worksheetIndex]),
            $options,
            $this->archive
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getWorksheetIndex($name)
    {
        return array_search($name, $this->getWorksheets());
    }

    /**
     * @return Relationships
     */
    protected function getRelationships()
    {
        if (!$this->relationships) {
            $path = $this->archive->extract(static::RELATIONSHIPS_PATH);
            $this->relationships = $this->relationshipsLoader->open($path);
        }

        return $this->relationships;
    }

    /**
     * @return ValueTransformer
     */
    protected function getValueTransformer()
    {
        if (!$this->valueTransformer) {
            $this->valueTransformer = $this->valueTransformerFactory->create(
                $this->getSharedStrings(),
                $this->getStyles()
            );
        }

        return $this->valueTransformer;
    }

    /**
     * @return SharedStrings
     */
    protected function getSharedStrings()
    {
        if (!$this->sharedStrings) {
            $path = $this->archive->extract($this->relationships->getSharedStringsPath());
            $this->sharedStrings = $this->sharedStringsLoader->open($path, $this->archive);
        }

        return $this->sharedStrings;
    }

    /**
     * @return array
     */
    protected function getWorksheetPaths()
    {
        if (!$this->worksheetPaths) {

The expression $this->worksheetPaths of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $path = $this->archive->extract(static::WORKBOOK_PATH);
            $this->worksheetPaths = $this->worksheetListReader->getWorksheetPaths($this->getRelationships(), $path);
        }

        return $this->worksheetPaths;
    }

    /**
     * @return Styles
     */
    protected function getStyles()
    {
        if (!$this->styles) {
            $path = $this->archive->extract($this->relationships->getStylesPath());
            $this->styles = $this->stylesLoader->open($path, $this->archive);
        }

        return $this->styles;
    }
}