diff --git a/Classes/PHPExcel.php b/Classes/PHPExcel.php index 19213c24..6090edf5 100644 --- a/Classes/PHPExcel.php +++ b/Classes/PHPExcel.php @@ -664,7 +664,7 @@ class PHPExcel /** * Check if style exists in style collection * - * @param PHPExcel_Style $style + * @param PHPExcel_Style $pCellStyle * @return boolean */ public function cellXfExists($pCellStyle = null) @@ -883,6 +883,11 @@ class PHPExcel } } + /** + * Return the unique ID value assigned to this spreadsheet workbook + * + * @return string + */ public function getID() { return $this->_uniqueID; } diff --git a/Classes/PHPExcel/CachedObjectStorage/CacheBase.php b/Classes/PHPExcel/CachedObjectStorage/CacheBase.php index c4b57817..249abaf5 100644 --- a/Classes/PHPExcel/CachedObjectStorage/CacheBase.php +++ b/Classes/PHPExcel/CachedObjectStorage/CacheBase.php @@ -86,6 +86,11 @@ abstract class PHPExcel_CachedObjectStorage_CacheBase { } // function __construct() + /** + * Return the parent worksheet for this cell collection + * + * @return PHPExcel_Worksheet + */ public function getParent() { return $this->_parent; @@ -214,17 +219,32 @@ abstract class PHPExcel_CachedObjectStorage_CacheBase { } + /** + * Return the cell address of the currently active cell object + * + * @return string + */ public function getCurrentAddress() { return $this->_currentObjectID; } + /** + * Return the column address of the currently active cell object + * + * @return string + */ public function getCurrentColumn() { sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row); return $column; } + /** + * Return the row address of the currently active cell object + * + * @return string + */ public function getCurrentRow() { sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row); diff --git a/Classes/PHPExcel/CachedObjectStorage/SQLite3.php b/Classes/PHPExcel/CachedObjectStorage/SQLite3.php index ecd80294..f573b039 100644 --- a/Classes/PHPExcel/CachedObjectStorage/SQLite3.php +++ b/Classes/PHPExcel/CachedObjectStorage/SQLite3.php @@ -49,9 +49,32 @@ class PHPExcel_CachedObjectStorage_SQLite3 extends PHPExcel_CachedObjectStorage_ */ private $_DBHandle = null; + /** + * Prepared statement for a SQLite3 select query + * + * @var SQLite3Stmt + */ private $_selectQuery; + + /** + * Prepared statement for a SQLite3 insert query + * + * @var SQLite3Stmt + */ private $_insertQuery; + + /** + * Prepared statement for a SQLite3 update query + * + * @var SQLite3Stmt + */ private $_updateQuery; + + /** + * Prepared statement for a SQLite3 delete query + * + * @var SQLite3Stmt + */ private $_deleteQuery; /** diff --git a/Classes/PHPExcel/CachedObjectStorageFactory.php b/Classes/PHPExcel/CachedObjectStorageFactory.php index f68431e3..0e7648d8 100644 --- a/Classes/PHPExcel/CachedObjectStorageFactory.php +++ b/Classes/PHPExcel/CachedObjectStorageFactory.php @@ -237,6 +237,10 @@ class PHPExcel_CachedObjectStorageFactory } // function getInstance() + /** + * Clear the cache storage + * + **/ public static function finalize() { self::$_cacheStorageMethod = NULL; diff --git a/Classes/PHPExcel/Writer/PDF.php b/Classes/PHPExcel/Writer/PDF.php index cacd9c73..d346f8af 100644 --- a/Classes/PHPExcel/Writer/PDF.php +++ b/Classes/PHPExcel/Writer/PDF.php @@ -36,13 +36,18 @@ class PHPExcel_Writer_PDF { + /** + * The wrapper for the requested PDF rendering engine + * + * @var PHPExcel_Writer_PDF_Core + */ private $_renderer = NULL; /** * Instantiate a new renderer of the configured type within this container class * - * @param PHPExcel $phpExcel PHPExcel object - * @throws PHPExcel_Writer_Exception when PDF library is not configured + * @param PHPExcel $phpExcel PHPExcel object + * @throws PHPExcel_Writer_Exception when PDF library is not configured */ public function __construct(PHPExcel $phpExcel) { @@ -67,16 +72,16 @@ class PHPExcel_Writer_PDF /** - * Magic method to handle direct calls to the configured PDF renderer wrapper class + * Magic method to handle direct calls to the configured PDF renderer wrapper class. * - * @param string $name Renderer library method name - * @param mixed[] $arguments Array of arguments to pass to the renderer method - * @return mixed Returned data from the PDF renderer wrapper method + * @param string $name Renderer library method name + * @param mixed[] $arguments Array of arguments to pass to the renderer method + * @return mixed Returned data from the PDF renderer wrapper method */ public function __call($name, $arguments) { if ($this->_renderer === NULL) { - throw new PHPExcel_Writer_Exception("PDF Renderer has not been defined."); + throw new PHPExcel_Writer_Exception("PDF Rendering library has not been defined."); } return call_user_func_array(array($this->_renderer, $name), $arguments); diff --git a/Classes/PHPExcel/Writer/PDF/Core.php b/Classes/PHPExcel/Writer/PDF/Core.php index 8669333e..6c270f98 100644 --- a/Classes/PHPExcel/Writer/PDF/Core.php +++ b/Classes/PHPExcel/Writer/PDF/Core.php @@ -322,7 +322,7 @@ abstract class PHPExcel_Writer_PDF_Core extends PHPExcel_Writer_HTML /** * Save PHPExcel to PDF file, pre-save * - * @param string $pFileName + * @param string $pFileName Name of the file to save as * @throws PHPExcel_Writer_Exception */ protected function prepareForSave($pFilename = NULL) diff --git a/Classes/PHPExcel/Writer/PDF/DomPDF.php b/Classes/PHPExcel/Writer/PDF/DomPDF.php index 5abd0a3c..d06bc4df 100644 --- a/Classes/PHPExcel/Writer/PDF/DomPDF.php +++ b/Classes/PHPExcel/Writer/PDF/DomPDF.php @@ -56,7 +56,7 @@ class PHPExcel_Writer_PDF_DomPDF extends PHPExcel_Writer_PDF_Core implements PHP /** * Save PHPExcel to file * - * @param string $pFileName + * @param string $pFileName Name of the file to save as * @throws PHPExcel_Writer_Exception */ public function save($pFilename = NULL) diff --git a/Classes/PHPExcel/Writer/PDF/mPDF.php b/Classes/PHPExcel/Writer/PDF/mPDF.php index a9b6b0fc..e9b8a6e3 100644 --- a/Classes/PHPExcel/Writer/PDF/mPDF.php +++ b/Classes/PHPExcel/Writer/PDF/mPDF.php @@ -46,7 +46,7 @@ class PHPExcel_Writer_PDF_mPDF extends PHPExcel_Writer_PDF_Core implements PHPEx /** * Create a new PHPExcel_Writer_PDF * - * @param PHPExcel $phpExcel PHPExcel object + * @param PHPExcel $phpExcel PHPExcel object */ public function __construct(PHPExcel $phpExcel) { @@ -56,7 +56,7 @@ class PHPExcel_Writer_PDF_mPDF extends PHPExcel_Writer_PDF_Core implements PHPEx /** * Save PHPExcel to file * - * @param string $pFileName + * @param string $pFileName Name of the file to save as * @throws PHPExcel_Writer_Exception */ public function save($pFilename = NULL) diff --git a/Classes/PHPExcel/Writer/PDF/tcPDF.php b/Classes/PHPExcel/Writer/PDF/tcPDF.php index 23a6e315..289610a2 100644 --- a/Classes/PHPExcel/Writer/PDF/tcPDF.php +++ b/Classes/PHPExcel/Writer/PDF/tcPDF.php @@ -57,7 +57,7 @@ class PHPExcel_Writer_PDF_tcPDF extends PHPExcel_Writer_PDF_Core implements PHPE /** * Save PHPExcel to file * - * @param string $pFileName + * @param string $pFileName Name of the file to save as * @throws PHPExcel_Writer_Exception */ public function save($pFilename = NULL)