Doc Block changes

git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@87638 2327b42d-5241-43d6-9e2a-de5ac946f064
This commit is contained in:
Mark Baker
2012-03-11 17:58:38 +00:00
parent 953b1e82fb
commit 891981928d
44 changed files with 1931 additions and 1790 deletions
+36 -36
View File
@@ -36,36 +36,36 @@ if (!defined('PHPEXCEL_ROOT')) {
}
/**
* PHPExcel_Reader_Excel2007
* PHPExcel_Reader_Excel2007
*
* @category PHPExcel
* @package PHPExcel_Reader
* @copyright Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
* @category PHPExcel
* @package PHPExcel_Reader
* @copyright Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
*/
class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
{
/**
* Read data only?
* Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
* Read data only?
* Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
* or whether it should read both data and formatting
*
* @var boolean
* @var boolean
*/
private $_readDataOnly = false;
/**
* Read charts that are defined in the workbook?
* Identifies whether the Reader should read the definitions for any charts that exist in the workbook;
* Read charts that are defined in the workbook?
* Identifies whether the Reader should read the definitions for any charts that exist in the workbook;
*
* @var boolean
* @var boolean
*/
private $_includeCharts = false;
/**
* Restrict which sheets should be loaded?
* This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
* Restrict which sheets should be loaded?
* This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
*
* @var array of string
* @var array of string
*/
private $_loadSheetsOnly = null;
@@ -92,24 +92,24 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
/**
* Read data only?
* Read data only?
* If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
* If false (the default) it will read data and formatting.
*
* @return boolean
* @return boolean
*/
public function getReadDataOnly() {
return $this->_readDataOnly;
}
/**
* Set read data only
* Set read data only
* Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
* Set to false (the default) to advise the Reader to read both data and formatting for cells.
*
* @param boolean $pValue
* @param boolean $pValue
*
* @return PHPExcel_Reader_Excel2007
* @return PHPExcel_Reader_Excel2007
*/
public function setReadDataOnly($pValue = false) {
$this->_readDataOnly = $pValue;
@@ -117,26 +117,26 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
}
/**
* Read charts in workbook?
* Read charts in workbook?
* If this is true, then the Reader will include any charts that exist in the workbook.
* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
* If false (the default) it will ignore any charts defined in the workbook file.
*
* @return boolean
* @return boolean
*/
public function getIncludeCharts() {
return $this->_includeCharts;
}
/**
* Set read charts in workbook
* Set read charts in workbook
* Set to true, to advise the Reader to include any charts that exist in the workbook.
* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
* Set to false (the default) to discard charts.
*
* @param boolean $pValue
* @param boolean $pValue
*
* @return PHPExcel_Reader_Excel2007
* @return PHPExcel_Reader_Excel2007
*/
public function setIncludeCharts($pValue = false) {
$this->_includeCharts = (boolean) $pValue;
@@ -144,11 +144,11 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
}
/**
* Get which sheets to load
* Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
* indicating that all worksheets in the workbook should be loaded.
* Get which sheets to load
* Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
* indicating that all worksheets in the workbook should be loaded.
*
* @return mixed
* @return mixed
*/
public function getLoadSheetsOnly()
{
@@ -156,13 +156,13 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
}
/**
* Set which sheets to load
* Set which sheets to load
*
* @param mixed $value
* @param mixed $value
* This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
* If NULL, then it tells the Reader to read all worksheets in the workbook
*
* @return PHPExcel_Reader_Excel2007
* @return PHPExcel_Reader_Excel2007
*/
public function setLoadSheetsOnly($value = null)
{
@@ -172,10 +172,10 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
}
/**
* Set all sheets to load
* Set all sheets to load
* Tells the Reader to load all worksheets from the workbook.
*
* @return PHPExcel_Reader_Excel2007
* @return PHPExcel_Reader_Excel2007
*/
public function setLoadAllSheets()
{
@@ -212,11 +212,11 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
}
/**
* Can the current PHPExcel_Reader_IReader read the file?
* Can the current PHPExcel_Reader_IReader read the file?
*
* @param string $pFileName
* @return boolean
* @throws Exception
* @param string $pFileName
* @return boolean
* @throws Exception
*/
public function canRead($pFilename)
{