ae3ee357ff
Instead of the hasNext() / next() syntax, readers now implements the PHP iterator pattern. It allows readers to be used with a foreach() loop. All readers now share the same structure (CSV is treated as having exactly one sheet): - one concrete Reader - one SheetIterator, exposed by the Reader - one or more Sheets, returned at every iteration - one RowIterator, exposed by the Sheet Introducing the concept of sheets for CSV may be kind of confusing but it makes Spout way more consistent. Also, this confusion may be resolved by creating a wrapper around the readers if needed. -- This commit does not delete the old files, not change the folder structure for Writers. This will be done in another commit.
112 lines
3.3 KiB
PHP
112 lines
3.3 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Reader;
|
|
|
|
use Box\Spout\Common\Exception\IOException;
|
|
use Box\Spout\Reader\Exception\ReaderNotOpenedException;
|
|
use Box\Spout\Reader\Exception\EndOfFileReachedException;
|
|
|
|
/**
|
|
* Class AbstractReader2
|
|
*
|
|
* @package Box\Spout\Reader
|
|
* @abstract
|
|
*/
|
|
abstract class AbstractReader2 implements ReaderInterface2
|
|
{
|
|
/** @var bool Indicates whether the stream is currently open */
|
|
protected $isStreamOpened = false;
|
|
|
|
/** @var \Box\Spout\Common\Helper\GlobalFunctionsHelper Helper to work with global functions */
|
|
protected $globalFunctionsHelper;
|
|
|
|
/**
|
|
* Opens the file at the given file path to make it ready to be read
|
|
*
|
|
* @param string $filePath Path of the file to be read
|
|
* @return void
|
|
*/
|
|
abstract protected function openReader($filePath);
|
|
|
|
/**
|
|
* Returns an iterator to iterate over sheets.
|
|
*
|
|
* @return \Iterator To iterate over sheets
|
|
*/
|
|
abstract public function getSheetIterator();
|
|
|
|
/**
|
|
* Closes the reader. To be used after reading the file.
|
|
*
|
|
* @return AbstractReader
|
|
*/
|
|
abstract protected function closeReader();
|
|
|
|
/**
|
|
* @param $globalFunctionsHelper
|
|
* @return AbstractReader
|
|
*/
|
|
public function setGlobalFunctionsHelper($globalFunctionsHelper)
|
|
{
|
|
$this->globalFunctionsHelper = $globalFunctionsHelper;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Prepares the reader to read the given file. It also makes sure
|
|
* that the file exists and is readable.
|
|
*
|
|
* @param string $filePath Path of the file to be read
|
|
* @return void
|
|
* @throws \Box\Spout\Common\Exception\IOException If the file at the given path does not exist, is not readable or is corrupted
|
|
*/
|
|
public function open($filePath)
|
|
{
|
|
if (!$this->isPhpStream($filePath)) {
|
|
// we skip the checks if the provided file path points to a PHP stream
|
|
if (!$this->globalFunctionsHelper->file_exists($filePath)) {
|
|
throw new IOException('Could not open ' . $filePath . ' for reading! File does not exist.');
|
|
} else if (!$this->globalFunctionsHelper->is_readable($filePath)) {
|
|
throw new IOException('Could not open ' . $filePath . ' for reading! File is not readable.');
|
|
}
|
|
}
|
|
|
|
try {
|
|
$this->openReader($filePath);
|
|
$this->isStreamOpened = true;
|
|
} catch (\Exception $exception) {
|
|
throw new IOException('Could not open ' . $filePath . ' for reading! (' . $exception->getMessage() . ')');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if a path is a PHP stream (like php://output, php://memory, ...)
|
|
*
|
|
* @param string $filePath Path of the file to be read
|
|
* @return bool Whether the given path maps to a PHP stream
|
|
*/
|
|
protected function isPhpStream($filePath)
|
|
{
|
|
return (strpos($filePath, 'php://') === 0);
|
|
}
|
|
|
|
/**
|
|
* Closes the reader, preventing any additional reading
|
|
*
|
|
* @return void
|
|
*/
|
|
public function close()
|
|
{
|
|
if ($this->isStreamOpened) {
|
|
$this->closeReader();
|
|
|
|
$sheetIterator = $this->getSheetIterator();
|
|
if ($sheetIterator) {
|
|
$sheetIterator->end();
|
|
}
|
|
|
|
$this->isStreamOpened = false;
|
|
}
|
|
}
|
|
}
|