From 901d20e6f908093ef14161e9e57f9b34ce627cd1 Mon Sep 17 00:00:00 2001 From: Mark Baker Date: Fri, 25 Feb 2011 16:52:43 +0000 Subject: [PATCH] Add further description to PHPDoc blocks git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@69404 2327b42d-5241-43d6-9e2a-de5ac946f064 --- Classes/PHPExcel/Reader/Excel2007.php | 66 ++++++++++++++++++--------- Classes/PHPExcel/Reader/Excel5.php | 57 ++++++++++++++--------- Classes/PHPExcel/Reader/Gnumeric.php | 54 ++++++++++++++-------- Classes/PHPExcel/Reader/OOCalc.php | 54 ++++++++++++++-------- 4 files changed, 149 insertions(+), 82 deletions(-) diff --git a/Classes/PHPExcel/Reader/Excel2007.php b/Classes/PHPExcel/Reader/Excel2007.php index b4c80ac..7cbe0ea 100644 --- a/Classes/PHPExcel/Reader/Excel2007.php +++ b/Classes/PHPExcel/Reader/Excel2007.php @@ -36,25 +36,28 @@ if (!defined('PHPEXCEL_ROOT')) { } /** - * PHPExcel_Reader_Excel2007 + * PHPExcel_Reader_Excel2007 * - * @category PHPExcel - * @package PHPExcel_Reader - * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) + * @category PHPExcel + * @package PHPExcel_Reader + * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) */ 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; /** - * 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; @@ -65,25 +68,40 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader */ private $_readFilter = null; - + /** + * PHPExcel_ReferenceHelper instance + * + * @var PHPExcel_ReferenceHelper + */ private $_referenceHelper = null; + /** + * PHPExcel_Reader_Excel2007_Theme instance + * + * @var PHPExcel_Reader_Excel2007_Theme + */ 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() { 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 - * @return PHPExcel_Reader_Excel2007 + * @param boolean $pValue + * + * @return PHPExcel_Reader_Excel2007 */ public function setReadDataOnly($pValue = false) { $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() { @@ -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 - * @return PHPExcel_Reader_Excel2007 + * @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 */ 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() { diff --git a/Classes/PHPExcel/Reader/Excel5.php b/Classes/PHPExcel/Reader/Excel5.php index a6acee2..741285e 100644 --- a/Classes/PHPExcel/Reader/Excel5.php +++ b/Classes/PHPExcel/Reader/Excel5.php @@ -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 - * @package PHPExcel_Reader_Excel5 - * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) + * @category PHPExcel + * @package PHPExcel_Reader_Excel5 + * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) */ 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; /** - * 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; /** - * 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; @@ -398,10 +401,13 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader */ 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() { @@ -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 - * @return PHPExcel_Reader_Excel5 + * @param boolean $pValue + * + * @return PHPExcel_Reader_Excel5 */ 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() { @@ -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 - * @return PHPExcel_Reader_Excel5 + * @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_Excel5 */ 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() { diff --git a/Classes/PHPExcel/Reader/Gnumeric.php b/Classes/PHPExcel/Reader/Gnumeric.php index 4ea57ba..55061bc 100644 --- a/Classes/PHPExcel/Reader/Gnumeric.php +++ b/Classes/PHPExcel/Reader/Gnumeric.php @@ -36,25 +36,28 @@ if (!defined('PHPEXCEL_ROOT')) { } /** - * PHPExcel_Reader_Gnumeric + * PHPExcel_Reader_Gnumeric * - * @category PHPExcel - * @package PHPExcel_Reader - * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) + * @category PHPExcel + * @package PHPExcel_Reader + * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) */ 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; /** - * 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; @@ -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() { 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 - * @return PHPExcel_Reader_Gnumeric + * @param boolean $pValue + * + * @return PHPExcel_Reader_Gnumeric */ public function setReadDataOnly($pValue = false) { $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() { @@ -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 - * @return PHPExcel_Reader_Gnumeric + * @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_Gnumeric */ 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() { diff --git a/Classes/PHPExcel/Reader/OOCalc.php b/Classes/PHPExcel/Reader/OOCalc.php index c66241e..44524cf 100644 --- a/Classes/PHPExcel/Reader/OOCalc.php +++ b/Classes/PHPExcel/Reader/OOCalc.php @@ -36,25 +36,28 @@ if (!defined('PHPEXCEL_ROOT')) { } /** - * PHPExcel_Reader_OOCalc + * PHPExcel_Reader_OOCalc * - * @category PHPExcel - * @package PHPExcel_Reader - * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) + * @category PHPExcel + * @package PHPExcel_Reader + * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) */ 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; /** - * 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; @@ -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() { 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 - * @return PHPExcel_Reader_OOCalc + * @param boolean $pValue + * + * @return PHPExcel_Reader_OOCalc */ public function setReadDataOnly($pValue = false) { $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() { @@ -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 - * @return PHPExcel_Reader_OOCalc + * @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_OOCalc */ 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() {