4
* PHPExcel_Reader_Abstract
6
* Copyright (c) 2006 - 2015 PHPExcel
8
* This library is free software; you can redistribute it and/or
9
* modify it under the terms of the GNU Lesser General Public
10
* License as published by the Free Software Foundation; either
11
* version 2.1 of the License, or (at your option) any later version.
13
* This library is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
* Lesser General Public License for more details.
18
* You should have received a copy of the GNU Lesser General Public
19
* License along with this library; if not, write to the Free Software
20
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23
* @package PHPExcel_Reader
24
* @copyright Copyright (c) 2006 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
25
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
26
* @version ##VERSION##, ##DATE##
28
abstract class PHPExcel_Reader_Abstract implements PHPExcel_Reader_IReader
32
* Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
33
* or whether it should read both data and formatting
37
protected $readDataOnly = false;
41
* Identifies whether the Reader should read data values for cells all cells, or should ignore cells containing
42
* null value or empty string
46
protected $readEmptyCells = true;
49
* Read charts that are defined in the workbook?
50
* Identifies whether the Reader should read the definitions for any charts that exist in the workbook;
54
protected $includeCharts = false;
57
* Restrict which sheets should be loaded?
58
* This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
60
* @var array of string
62
protected $loadSheetsOnly;
65
* PHPExcel_Reader_IReadFilter instance
67
* @var PHPExcel_Reader_IReadFilter
69
protected $readFilter;
71
protected $fileHandle = null;
76
* If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
77
* If false (the default) it will read data and formatting.
81
public function getReadDataOnly()
83
return $this->readDataOnly;
88
* Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
89
* Set to false (the default) to advise the Reader to read both data and formatting for cells.
91
* @param boolean $pValue
93
* @return PHPExcel_Reader_IReader
95
public function setReadDataOnly($pValue = false)
97
$this->readDataOnly = $pValue;
103
* If this is true (the default), then the Reader will read data values for all cells, irrespective of value.
104
* If false it will not read data for cells containing a null value or an empty string.
108
public function getReadEmptyCells()
110
return $this->readEmptyCells;
114
* Set read empty cells
115
* Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.
116
* Set to false to advise the Reader to ignore cells containing a null value or an empty string.
118
* @param boolean $pValue
120
* @return PHPExcel_Reader_IReader
122
public function setReadEmptyCells($pValue = true)
124
$this->readEmptyCells = $pValue;
129
* Read charts in workbook?
130
* If this is true, then the Reader will include any charts that exist in the workbook.
131
* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
132
* If false (the default) it will ignore any charts defined in the workbook file.
136
public function getIncludeCharts()
138
return $this->includeCharts;
142
* Set read charts in workbook
143
* Set to true, to advise the Reader to include any charts that exist in the workbook.
144
* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
145
* Set to false (the default) to discard charts.
147
* @param boolean $pValue
149
* @return PHPExcel_Reader_IReader
151
public function setIncludeCharts($pValue = false)
153
$this->includeCharts = (boolean) $pValue;
158
* Get which sheets to load
159
* Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
160
* indicating that all worksheets in the workbook should be loaded.
164
public function getLoadSheetsOnly()
166
return $this->loadSheetsOnly;
170
* Set which sheets to load
172
* @param mixed $value
173
* This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
174
* If NULL, then it tells the Reader to read all worksheets in the workbook
176
* @return PHPExcel_Reader_IReader
178
public function setLoadSheetsOnly($value = null)
180
if ($value === null) {
181
return $this->setLoadAllSheets();
184
$this->loadSheetsOnly = is_array($value) ? $value : array($value);
189
* Set all sheets to load
190
* Tells the Reader to load all worksheets from the workbook.
192
* @return PHPExcel_Reader_IReader
194
public function setLoadAllSheets()
196
$this->loadSheetsOnly = null;
203
* @return PHPExcel_Reader_IReadFilter
205
public function getReadFilter()
207
return $this->readFilter;
213
* @param PHPExcel_Reader_IReadFilter $pValue
214
* @return PHPExcel_Reader_IReader
216
public function setReadFilter(PHPExcel_Reader_IReadFilter $pValue)
218
$this->readFilter = $pValue;
223
* Open file for reading
225
* @param string $pFilename
226
* @throws PHPExcel_Reader_Exception
229
protected function openFile($pFilename)
231
// Check if file exists
232
if (!file_exists($pFilename) || !is_readable($pFilename)) {
233
throw new PHPExcel_Reader_Exception("Could not open " . $pFilename . " for reading! File does not exist.");
237
$this->fileHandle = fopen($pFilename, 'r');
238
if ($this->fileHandle === false) {
239
throw new PHPExcel_Reader_Exception("Could not open file " . $pFilename . " for reading.");
244
* Can the current PHPExcel_Reader_IReader read the file?
246
* @param string $pFilename
248
* @throws PHPExcel_Reader_Exception
250
public function canRead($pFilename)
252
// Check if file exists
254
$this->openFile($pFilename);
255
} catch (Exception $e) {
259
$readable = $this->isValidFormat();
260
fclose($this->fileHandle);
265
* Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks
268
* @throws PHPExcel_Reader_Exception
270
public function securityScan($xml)
272
$pattern = '/\\0?' . implode('\\0?', str_split('<!DOCTYPE')) . '\\0?/';
273
if (preg_match($pattern, $xml)) {
274
throw new PHPExcel_Reader_Exception('Detected use of ENTITY in XML, spreadsheet file load() aborted to prevent XXE/XEE attacks');
280
* Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks
282
* @param string $filestream
283
* @throws PHPExcel_Reader_Exception
285
public function securityScanFile($filestream)
287
return $this->securityScan(file_get_contents($filestream));
added
removed
tools/PHPExcel/PHPExcel/Reader/Abstract.php
