alex
/
PhpSpreadsheet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add further description to PHPDoc blocks 

git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@69404 2327b42d-5241-43d6-9e2a-de5ac946f064
This commit is contained in:
Mark Baker 2011-02-25 16:52:43 +00:00
parent 5b71914eea
commit 901d20e6f9
4 changed files with 149 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
Classes/PHPExcel/Reader/Excel2007.php
View File

@ -36,25 +36,28 @@ if (!defined('PHPEXCEL_ROOT')) {
} }
/** /**
* PHPExcel_Reader_Excel2007 * PHPExcel_Reader_Excel2007
* *
* @category PHPExcel * @category PHPExcel
* @package PHPExcel_Reader * @package PHPExcel_Reader
* @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)
*/ */
class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
{ {
/** /**
* Read data only? * 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; private $_readDataOnly = false;
/** /**
* Restict which sheets should 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 * @var array of string
*/ */
private $_loadSheetsOnly = null; private $_loadSheetsOnly = null;
@ -65,25 +68,40 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
*/ */
private $_readFilter = null; private $_readFilter = null;
/**
* PHPExcel_ReferenceHelper instance
*
* @var PHPExcel_ReferenceHelper
*/
private $_referenceHelper = null; private $_referenceHelper = null;
/**
* PHPExcel_Reader_Excel2007_Theme instance
*
* @var PHPExcel_Reader_Excel2007_Theme
*/
private static $_theme = null; private static $_theme = null;
/** /**
* 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() { public function getReadDataOnly() {
return $this->_readDataOnly; 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) { public function setReadDataOnly($pValue = false) {
$this->_readDataOnly = $pValue; $this->_readDataOnly = $pValue;
@ -91,9 +109,11 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
} }
/** /**
* Get which sheets to load * 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() public function getLoadSheetsOnly()
{ {
@ -101,10 +121,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
* @return PHPExcel_Reader_Excel2007 * 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
*/ */
public function setLoadSheetsOnly($value = null) public function setLoadSheetsOnly($value = null)
{ {
@ -114,9 +137,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() public function setLoadAllSheets()
{ {

57
Classes/PHPExcel/Reader/Excel5.php
View File

@ -67,13 +67,13 @@ if (!defined('PHPEXCEL_ROOT')) {
} }
/** /**
* PHPExcel_Reader_Excel5 * PHPExcel_Reader_Excel5
* *
* This class uses {@link http://sourceforge.net/projects/phpexcelreader/parseXL} * This class uses {@link http://sourceforge.net/projects/phpexcelreader/parseXL}
* *
* @category PHPExcel * @category PHPExcel
* @package PHPExcel_Reader_Excel5 * @package PHPExcel_Reader_Excel5
* @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)
*/ */
class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
{ {
@ -159,16 +159,19 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
const XLS_Type_UNKNOWN = 0xffff; const XLS_Type_UNKNOWN = 0xffff;
/** /**
* Read data only? * 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; private $_readDataOnly = false;
/** /**
* Restict which sheets should 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 * @var array of string
*/ */
private $_loadSheetsOnly = null; private $_loadSheetsOnly = null;
@ -398,10 +401,13 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
*/ */
private $_sharedFormulaParts; private $_sharedFormulaParts;
/** /**
* 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() public function getReadDataOnly()
{ {
@ -409,10 +415,13 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
} }
/** /**
* 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_Excel5 *
* @return PHPExcel_Reader_Excel5
*/ */
public function setReadDataOnly($pValue = false) public function setReadDataOnly($pValue = false)
{ {
@ -421,9 +430,11 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
} }
/** /**
* Get which sheets to load * 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() public function getLoadSheetsOnly()
{ {
@ -431,10 +442,13 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
} }
/** /**
* Set which sheets to load * Set which sheets to load
* *
* @param mixed $value * @param mixed $value
* @return PHPExcel_Reader_Excel5 * 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_Excel5
*/ */
public function setLoadSheetsOnly($value = null) public function setLoadSheetsOnly($value = null)
{ {
@ -444,9 +458,10 @@ class PHPExcel_Reader_Excel5 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_Excel5 * @return PHPExcel_Reader_Excel5
*/ */
public function setLoadAllSheets() public function setLoadAllSheets()
{ {

54
Classes/PHPExcel/Reader/Gnumeric.php
View File

@ -36,25 +36,28 @@ if (!defined('PHPEXCEL_ROOT')) {
} }
/** /**
* PHPExcel_Reader_Gnumeric * PHPExcel_Reader_Gnumeric
* *
* @category PHPExcel * @category PHPExcel
* @package PHPExcel_Reader * @package PHPExcel_Reader
* @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)
*/ */
class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
{ {
/** /**
* Read data only? * 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; private $_readDataOnly = false;
/** /**
* Restict which sheets should 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 * @var array of string
*/ */
private $_loadSheetsOnly = null; private $_loadSheetsOnly = null;
@ -83,19 +86,24 @@ class PHPExcel_Reader_Gnumeric 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() { public function getReadDataOnly() {
return $this->_readDataOnly; 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_Gnumeric *
* @return PHPExcel_Reader_Gnumeric
*/ */
public function setReadDataOnly($pValue = false) { public function setReadDataOnly($pValue = false) {
$this->_readDataOnly = $pValue; $this->_readDataOnly = $pValue;
@ -103,9 +111,11 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
} }
/** /**
* Get which sheets to load * 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() public function getLoadSheetsOnly()
{ {
@ -113,10 +123,13 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
} }
/** /**
* Set which sheets to load * Set which sheets to load
* *
* @param mixed $value * @param mixed $value
* @return PHPExcel_Reader_Gnumeric * 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_Gnumeric
*/ */
public function setLoadSheetsOnly($value = null) public function setLoadSheetsOnly($value = null)
{ {
@ -126,9 +139,10 @@ class PHPExcel_Reader_Gnumeric 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_Gnumeric * @return PHPExcel_Reader_Gnumeric
*/ */
public function setLoadAllSheets() public function setLoadAllSheets()
{ {

54
Classes/PHPExcel/Reader/OOCalc.php
View File

@ -36,25 +36,28 @@ if (!defined('PHPEXCEL_ROOT')) {
} }
/** /**
* PHPExcel_Reader_OOCalc * PHPExcel_Reader_OOCalc
* *
* @category PHPExcel * @category PHPExcel
* @package PHPExcel_Reader * @package PHPExcel_Reader
* @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)
*/ */
class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
{ {
/** /**
* Read data only? * 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; private $_readDataOnly = false;
/** /**
* Restict which sheets should 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 * @var array of string
*/ */
private $_loadSheetsOnly = null; private $_loadSheetsOnly = null;
@ -74,19 +77,24 @@ class PHPExcel_Reader_OOCalc 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() { public function getReadDataOnly() {
return $this->_readDataOnly; 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_OOCalc *
* @return PHPExcel_Reader_OOCalc
*/ */
public function setReadDataOnly($pValue = false) { public function setReadDataOnly($pValue = false) {
$this->_readDataOnly = $pValue; $this->_readDataOnly = $pValue;
@ -94,9 +102,11 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
} }
/** /**
* Get which sheets to load * 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() public function getLoadSheetsOnly()
{ {
@ -104,10 +114,13 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
} }
/** /**
* Set which sheets to load * Set which sheets to load
* *
* @param mixed $value * @param mixed $value
* @return PHPExcel_Reader_OOCalc * 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_OOCalc
*/ */
public function setLoadSheetsOnly($value = null) public function setLoadSheetsOnly($value = null)
{ {
@ -117,9 +130,10 @@ class PHPExcel_Reader_OOCalc 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_OOCalc * @return PHPExcel_Reader_OOCalc
*/ */
public function setLoadAllSheets() public function setLoadAllSheets()
{ {