136 lines
3.7 KiB
PHP
136 lines
3.7 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Reader\ODS;
|
|
|
|
use Box\Spout\Common\Exception\IOException;
|
|
use Box\Spout\Reader\Exception\XMLProcessingException;
|
|
use Box\Spout\Reader\IteratorInterface;
|
|
use Box\Spout\Reader\Wrapper\XMLReader;
|
|
|
|
/**
|
|
* Class SheetIterator
|
|
* Iterate over ODS sheet.
|
|
*
|
|
* @package Box\Spout\Reader\ODS
|
|
*/
|
|
class SheetIterator implements IteratorInterface
|
|
{
|
|
/** Definition of XML nodes name and attribute used to parse sheet data */
|
|
const XML_NODE_TABLE = 'table:table';
|
|
const XML_ATTRIBUTE_TABLE_NAME = 'table:name';
|
|
|
|
/** @var string $filePath Path of the file to be read */
|
|
protected $filePath;
|
|
|
|
/** @var XMLReader The XMLReader object that will help read sheet's XML data */
|
|
protected $xmlReader;
|
|
|
|
/** @var \Box\Spout\Common\Escaper\ODS Used to unescape XML data */
|
|
protected $escaper;
|
|
|
|
/** @var bool Whether there are still at least a sheet to be read */
|
|
protected $hasFoundSheet;
|
|
|
|
/** @var int The index of the sheet being read (zero-based) */
|
|
protected $currentSheetIndex;
|
|
|
|
/**
|
|
* @param string $filePath Path of the file to be read
|
|
* @throws \Box\Spout\Reader\Exception\NoSheetsFoundException If there are no sheets in the file
|
|
*/
|
|
public function __construct($filePath)
|
|
{
|
|
$this->filePath = $filePath;
|
|
$this->xmlReader = new XMLReader();
|
|
|
|
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
|
|
$this->escaper = new \Box\Spout\Common\Escaper\ODS();
|
|
}
|
|
|
|
/**
|
|
* Rewind the Iterator to the first element
|
|
* @link http://php.net/manual/en/iterator.rewind.php
|
|
*
|
|
* @return void
|
|
* @throws \Box\Spout\Common\Exception\IOException If unable to open the XML file containing sheets' data
|
|
*/
|
|
public function rewind()
|
|
{
|
|
$this->xmlReader->close();
|
|
|
|
$contentXmlFilePath = $this->filePath . '#content.xml';
|
|
if ($this->xmlReader->open('zip://' . $contentXmlFilePath) === false) {
|
|
throw new IOException("Could not open \"{$contentXmlFilePath}\".");
|
|
}
|
|
|
|
try {
|
|
$this->hasFoundSheet = $this->xmlReader->readUntilNodeFound(self::XML_NODE_TABLE);
|
|
} catch (XMLProcessingException $exception) {
|
|
throw new IOException("The content.xml file is invalid and cannot be read. [{$exception->getMessage()}]");
|
|
}
|
|
|
|
$this->currentSheetIndex = 0;
|
|
}
|
|
|
|
/**
|
|
* Checks if current position is valid
|
|
* @link http://php.net/manual/en/iterator.valid.php
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function valid()
|
|
{
|
|
return $this->hasFoundSheet;
|
|
}
|
|
|
|
/**
|
|
* Move forward to next element
|
|
* @link http://php.net/manual/en/iterator.next.php
|
|
*
|
|
* @return void
|
|
*/
|
|
public function next()
|
|
{
|
|
$this->hasFoundSheet = $this->xmlReader->readUntilNodeFound(self::XML_NODE_TABLE);
|
|
|
|
if ($this->hasFoundSheet) {
|
|
$this->currentSheetIndex++;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the current element
|
|
* @link http://php.net/manual/en/iterator.current.php
|
|
*
|
|
* @return \Box\Spout\Reader\ODS\Sheet
|
|
*/
|
|
public function current()
|
|
{
|
|
$escapedSheetName = $this->xmlReader->getAttribute(self::XML_ATTRIBUTE_TABLE_NAME);
|
|
$sheetName = $this->escaper->unescape($escapedSheetName);
|
|
|
|
return new Sheet($this->xmlReader, $sheetName, $this->currentSheetIndex);
|
|
}
|
|
|
|
/**
|
|
* Return the key of the current element
|
|
* @link http://php.net/manual/en/iterator.key.php
|
|
*
|
|
* @return int
|
|
*/
|
|
public function key()
|
|
{
|
|
return $this->currentSheetIndex + 1;
|
|
}
|
|
|
|
/**
|
|
* Cleans up what was created to iterate over the object.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function end()
|
|
{
|
|
$this->xmlReader->close();
|
|
}
|
|
}
|