123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348 |
- <?php
- /**
- * Main class for spreadsheet reading
- *
- * @version 0.5.10
- * @author Martins Pilsetnieks
- */
- class SpreadsheetReader implements SeekableIterator, Countable
- {
- const TYPE_XLSX = 'XLSX';
- const TYPE_XLS = 'XLS';
- const TYPE_CSV = 'CSV';
- const TYPE_ODS = 'ODS';
- private $Options = array(
- 'Delimiter' => '',
- 'Enclosure' => '"'
- );
- /**
- * @var int Current row in the file
- */
- private $Index = 0;
- /**
- * @var SpreadsheetReader_* Handle for the reader object
- */
- private $Handle = array();
- /**
- * @var TYPE_* Type of the contained spreadsheet
- */
- private $Type = false;
- /**
- * @param string Path to file
- * @param string Original filename (in case of an uploaded file), used to determine file type, optional
- * @param string MIME type from an upload, used to determine file type, optional
- */
- public function __construct($Filepath, $OriginalFilename = false, $MimeType = false)
- {
- if (!is_readable($Filepath))
- {
- throw new Exception('SpreadsheetReader: File ('.$Filepath.') not readable');
- }
- // To avoid timezone warnings and exceptions for formatting dates retrieved from files
- $DefaultTZ = @date_default_timezone_get();
- if ($DefaultTZ)
- {
- date_default_timezone_set($DefaultTZ);
- }
- // Checking the other parameters for correctness
- // This should be a check for string but we're lenient
- if (!empty($OriginalFilename) && !is_scalar($OriginalFilename))
- {
- throw new Exception('SpreadsheetReader: Original file (2nd parameter) path is not a string or a scalar value.');
- }
- if (!empty($MimeType) && !is_scalar($MimeType))
- {
- throw new Exception('SpreadsheetReader: Mime type (3nd parameter) path is not a string or a scalar value.');
- }
- // 1. Determine type
- if (!$OriginalFilename)
- {
- $OriginalFilename = $Filepath;
- }
- $Extension = strtolower(pathinfo($OriginalFilename, PATHINFO_EXTENSION));
- switch ($MimeType)
- {
- case 'text/csv':
- case 'text/comma-separated-values':
- case 'text/plain':
- $this -> Type = self::TYPE_CSV;
- break;
- case 'application/vnd.ms-excel':
- case 'application/msexcel':
- case 'application/x-msexcel':
- case 'application/x-ms-excel':
- case 'application/vnd.ms-excel':
- case 'application/x-excel':
- case 'application/x-dos_ms_excel':
- case 'application/xls':
- case 'application/xlt':
- case 'application/x-xls':
- // Excel does weird stuff
- if (in_array($Extension, array('csv', 'tsv', 'txt')))
- {
- $this -> Type = self::TYPE_CSV;
- }
- else
- {
- $this -> Type = self::TYPE_XLS;
- }
- break;
- case 'application/vnd.oasis.opendocument.spreadsheet':
- case 'application/vnd.oasis.opendocument.spreadsheet-template':
- $this -> Type = self::TYPE_ODS;
- break;
- case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
- case 'application/vnd.openxmlformats-officedocument.spreadsheetml.template':
- case 'application/xlsx':
- case 'application/xltx':
- $this -> Type = self::TYPE_XLSX;
- break;
- case 'application/xml':
- // Excel 2004 xml format uses this
- break;
- }
- if (!$this -> Type)
- {
- switch ($Extension)
- {
- case 'xlsx':
- case 'xltx': // XLSX template
- case 'xlsm': // Macro-enabled XLSX
- case 'xltm': // Macro-enabled XLSX template
- $this -> Type = self::TYPE_XLSX;
- break;
- case 'xls':
- case 'xlt':
- $this -> Type = self::TYPE_XLS;
- break;
- case 'ods':
- case 'odt':
- $this -> Type = self::TYPE_ODS;
- break;
- default:
- $this -> Type = self::TYPE_CSV;
- break;
- }
- }
- // Pre-checking XLS files, in case they are renamed CSV or XLSX files
- if ($this -> Type == self::TYPE_XLS)
- {
- self::Load(self::TYPE_XLS);
- $this -> Handle = new SpreadsheetReader_XLS($Filepath);
- if ($this -> Handle -> Error)
- {
- $this -> Handle -> __destruct();
- if (is_resource($ZipHandle = zip_open($Filepath)))
- {
- $this -> Type = self::TYPE_XLSX;
- zip_close($ZipHandle);
- }
- else
- {
- $this -> Type = self::TYPE_CSV;
- }
- }
- }
- // 2. Create handle
- switch ($this -> Type)
- {
- case self::TYPE_XLSX:
- self::Load(self::TYPE_XLSX);
- $this -> Handle = new SpreadsheetReader_XLSX($Filepath);
- break;
- case self::TYPE_CSV:
- self::Load(self::TYPE_CSV);
- $this -> Handle = new SpreadsheetReader_CSV($Filepath, $this -> Options);
- break;
- case self::TYPE_XLS:
- // Everything already happens above
- break;
- case self::TYPE_ODS:
- self::Load(self::TYPE_ODS);
- $this -> Handle = new SpreadsheetReader_ODS($Filepath, $this -> Options);
- break;
- }
- }
- /**
- * Gets information about separate sheets in the given file
- *
- * @return array Associative array where key is sheet index and value is sheet name
- */
- public function Sheets()
- {
- return $this -> Handle -> Sheets();
- }
- /**
- * Changes the current sheet to another from the file.
- * Note that changing the sheet will rewind the file to the beginning, even if
- * the current sheet index is provided.
- *
- * @param int Sheet index
- *
- * @return bool True if sheet could be changed to the specified one,
- * false if not (for example, if incorrect index was provided.
- */
- public function ChangeSheet($Index)
- {
- return $this -> Handle -> ChangeSheet($Index);
- }
- /**
- * Autoloads the required class for the particular spreadsheet type
- *
- * @param TYPE_* Spreadsheet type, one of TYPE_* constants of this class
- */
- private static function Load($Type)
- {
- if (!in_array($Type, array(self::TYPE_XLSX, self::TYPE_XLS, self::TYPE_CSV, self::TYPE_ODS)))
- {
- throw new Exception('SpreadsheetReader: Invalid type ('.$Type.')');
- }
- // 2nd parameter is to prevent autoloading for the class.
- // If autoload works, the require line is unnecessary, if it doesn't, it ends badly.
- if (!class_exists('SpreadsheetReader_'.$Type, false))
- {
- require(dirname(__FILE__).DIRECTORY_SEPARATOR.'SpreadsheetReader_'.$Type.'.php');
- }
- }
- // !Iterator interface methods
- /**
- * Rewind the Iterator to the first element.
- * Similar to the reset() function for arrays in PHP
- */
- public function rewind()
- {
- $this -> Index = 0;
- if ($this -> Handle)
- {
- $this -> Handle -> rewind();
- }
- }
- /**
- * Return the current element.
- * Similar to the current() function for arrays in PHP
- *
- * @return mixed current element from the collection
- */
- public function current()
- {
- if ($this -> Handle)
- {
- return $this -> Handle -> current();
- }
- return null;
- }
- /**
- * Move forward to next element.
- * Similar to the next() function for arrays in PHP
- */
- public function next()
- {
- if ($this -> Handle)
- {
- $this -> Index++;
- return $this -> Handle -> next();
- }
- return null;
- }
- /**
- * Return the identifying key of the current element.
- * Similar to the key() function for arrays in PHP
- *
- * @return mixed either an integer or a string
- */
- public function key()
- {
- if ($this -> Handle)
- {
- return $this -> Handle -> key();
- }
- return null;
- }
- /**
- * Check if there is a current element after calls to rewind() or next().
- * Used to check if we've iterated to the end of the collection
- *
- * @return boolean FALSE if there's nothing more to iterate over
- */
- public function valid()
- {
- if ($this -> Handle)
- {
- return $this -> Handle -> valid();
- }
- return false;
- }
- // !Countable interface method
- public function count()
- {
- if ($this -> Handle)
- {
- return $this -> Handle -> count();
- }
- return 0;
- }
- /**
- * Method for SeekableIterator interface. Takes a posiiton and traverses the file to that position
- * The value can be retrieved with a `current()` call afterwards.
- *
- * @param int Position in file
- */
- public function seek($Position)
- {
- if (!$this -> Handle)
- {
- throw new OutOfBoundsException('SpreadsheetReader: No file opened');
- }
- $CurrentIndex = $this -> Handle -> key();
- if ($CurrentIndex != $Position)
- {
- if ($Position < $CurrentIndex || is_null($CurrentIndex) || $Position == 0)
- {
- $this -> rewind();
- }
- while ($this -> Handle -> valid() && ($Position > $this -> Handle -> key()))
- {
- $this -> Handle -> next();
- }
- if (!$this -> Handle -> valid())
- {
- throw new OutOfBoundsException('SpreadsheetError: Position '.$Position.' not found');
- }
- }
- return null;
- }
- }
- ?>
|