Docblock modifications

This commit is contained in:
Mark Baker 2013-04-27 14:49:08 +01:00
parent 4e9bfc4607
commit cfdd19e47c
9 changed files with 70 additions and 13 deletions

View File

@ -664,7 +664,7 @@ class PHPExcel
/** /**
* Check if style exists in style collection * Check if style exists in style collection
* *
* @param PHPExcel_Style $style * @param PHPExcel_Style $pCellStyle
* @return boolean * @return boolean
*/ */
public function cellXfExists($pCellStyle = null) 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() { public function getID() {
return $this->_uniqueID; return $this->_uniqueID;
} }

View File

@ -86,6 +86,11 @@ abstract class PHPExcel_CachedObjectStorage_CacheBase {
} // function __construct() } // function __construct()
/**
* Return the parent worksheet for this cell collection
*
* @return PHPExcel_Worksheet
*/
public function getParent() public function getParent()
{ {
return $this->_parent; 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() public function getCurrentAddress()
{ {
return $this->_currentObjectID; return $this->_currentObjectID;
} }
/**
* Return the column address of the currently active cell object
*
* @return string
*/
public function getCurrentColumn() public function getCurrentColumn()
{ {
sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row); sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row);
return $column; return $column;
} }
/**
* Return the row address of the currently active cell object
*
* @return string
*/
public function getCurrentRow() public function getCurrentRow()
{ {
sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row); sscanf($this->_currentObjectID, '%[A-Z]%d', $column, $row);

View File

@ -49,9 +49,32 @@ class PHPExcel_CachedObjectStorage_SQLite3 extends PHPExcel_CachedObjectStorage_
*/ */
private $_DBHandle = null; private $_DBHandle = null;
/**
* Prepared statement for a SQLite3 select query
*
* @var SQLite3Stmt
*/
private $_selectQuery; private $_selectQuery;
/**
* Prepared statement for a SQLite3 insert query
*
* @var SQLite3Stmt
*/
private $_insertQuery; private $_insertQuery;
/**
* Prepared statement for a SQLite3 update query
*
* @var SQLite3Stmt
*/
private $_updateQuery; private $_updateQuery;
/**
* Prepared statement for a SQLite3 delete query
*
* @var SQLite3Stmt
*/
private $_deleteQuery; private $_deleteQuery;
/** /**

View File

@ -237,6 +237,10 @@ class PHPExcel_CachedObjectStorageFactory
} // function getInstance() } // function getInstance()
/**
* Clear the cache storage
*
**/
public static function finalize() public static function finalize()
{ {
self::$_cacheStorageMethod = NULL; self::$_cacheStorageMethod = NULL;

View File

@ -36,6 +36,11 @@
class PHPExcel_Writer_PDF class PHPExcel_Writer_PDF
{ {
/**
* The wrapper for the requested PDF rendering engine
*
* @var PHPExcel_Writer_PDF_Core
*/
private $_renderer = NULL; private $_renderer = NULL;
/** /**
@ -67,7 +72,7 @@ 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 string $name Renderer library method name
* @param mixed[] $arguments Array of arguments to pass to the renderer method * @param mixed[] $arguments Array of arguments to pass to the renderer method
@ -76,7 +81,7 @@ class PHPExcel_Writer_PDF
public function __call($name, $arguments) public function __call($name, $arguments)
{ {
if ($this->_renderer === NULL) { 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); return call_user_func_array(array($this->_renderer, $name), $arguments);

View File

@ -322,7 +322,7 @@ abstract class PHPExcel_Writer_PDF_Core extends PHPExcel_Writer_HTML
/** /**
* Save PHPExcel to PDF file, pre-save * Save PHPExcel to PDF file, pre-save
* *
* @param string $pFileName * @param string $pFileName Name of the file to save as
* @throws PHPExcel_Writer_Exception * @throws PHPExcel_Writer_Exception
*/ */
protected function prepareForSave($pFilename = NULL) protected function prepareForSave($pFilename = NULL)

View File

@ -56,7 +56,7 @@ class PHPExcel_Writer_PDF_DomPDF extends PHPExcel_Writer_PDF_Core implements PHP
/** /**
* Save PHPExcel to file * Save PHPExcel to file
* *
* @param string $pFileName * @param string $pFileName Name of the file to save as
* @throws PHPExcel_Writer_Exception * @throws PHPExcel_Writer_Exception
*/ */
public function save($pFilename = NULL) public function save($pFilename = NULL)

View File

@ -56,7 +56,7 @@ class PHPExcel_Writer_PDF_mPDF extends PHPExcel_Writer_PDF_Core implements PHPEx
/** /**
* Save PHPExcel to file * Save PHPExcel to file
* *
* @param string $pFileName * @param string $pFileName Name of the file to save as
* @throws PHPExcel_Writer_Exception * @throws PHPExcel_Writer_Exception
*/ */
public function save($pFilename = NULL) public function save($pFilename = NULL)

View File

@ -57,7 +57,7 @@ class PHPExcel_Writer_PDF_tcPDF extends PHPExcel_Writer_PDF_Core implements PHPE
/** /**
* Save PHPExcel to file * Save PHPExcel to file
* *
* @param string $pFileName * @param string $pFileName Name of the file to save as
* @throws PHPExcel_Writer_Exception * @throws PHPExcel_Writer_Exception
*/ */
public function save($pFilename = NULL) public function save($pFilename = NULL)