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

Docblocks

This commit is contained in:
Mark Baker 2013-04-27 18:07:12 +01:00
parent 28f266bbba
commit c660492446
13 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Classes/PHPExcel/IOFactory.php
View File

@ -183,7 +183,7 @@ class PHPExcel_IOFactory
* *
* @static * @static
* @access public * @access public
* @param string $pFileName The name of the spreadsheet file * @param string $pFilename The name of the spreadsheet file
* @return PHPExcel * @return PHPExcel
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */
@ -197,7 +197,7 @@ class PHPExcel_IOFactory
* *
* @static * @static
* @access public * @access public
* @param string $pFileName The name of the spreadsheet file to identify * @param string $pFilename The name of the spreadsheet file to identify
* @return string * @return string
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */
@ -214,7 +214,7 @@ class PHPExcel_IOFactory
* *
* @static * @static
* @access public * @access public
* @param string $pFileName The name of the spreadsheet file * @param string $pFilename The name of the spreadsheet file
* @return PHPExcel_Reader_IReader * @return PHPExcel_Reader_IReader
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

10
Classes/PHPExcel/Reader/CSV.php
View File

@ -113,7 +113,7 @@ class PHPExcel_Reader_CSV extends PHPExcel_Reader_Abstract implements PHPExcel_R
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @access public * @access public
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */
@ -434,7 +434,7 @@ class PHPExcel_Reader_CSV extends PHPExcel_Reader_Abstract implements PHPExcel_R
* Set sheet index * Set sheet index
* *
* @access public * @access public
* @param int $pValue Sheet index * @param integer $pValue Sheet index
* @return PHPExcel_Reader_CSV * @return PHPExcel_Reader_CSV
*/ */
public function setSheetIndex($pValue = 0) { public function setSheetIndex($pValue = 0) {
@ -447,11 +447,11 @@ class PHPExcel_Reader_CSV extends PHPExcel_Reader_Abstract implements PHPExcel_R
* Set Contiguous * Set Contiguous
* *
* @access public * @access public
* @param string $pValue Input encoding * @param boolean $contiguous
*/ */
public function setContiguous($contiguous = false) public function setContiguous($contiguous = FALSE)
{ {
$this->_contiguous = (bool)$contiguous; $this->_contiguous = (bool) $contiguous;
if (!$contiguous) { if (!$contiguous) {
$this->_contiguousRow = -1; $this->_contiguousRow = -1;
} }

2
Classes/PHPExcel/Reader/Excel2003XML.php
View File

@ -70,7 +70,7 @@ class PHPExcel_Reader_Excel2003XML extends PHPExcel_Reader_Abstract implements P
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

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

@ -71,7 +71,7 @@ class PHPExcel_Reader_Excel2007 extends PHPExcel_Reader_Abstract implements PHPE
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

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

@ -391,7 +391,7 @@ class PHPExcel_Reader_Excel5 extends PHPExcel_Reader_Abstract implements PHPExce
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

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

@ -73,7 +73,7 @@ class PHPExcel_Reader_Gnumeric extends PHPExcel_Reader_Abstract implements PHPEx
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

2
Classes/PHPExcel/Reader/HTML.php
View File

@ -111,7 +111,7 @@ class PHPExcel_Reader_HTML extends PHPExcel_Reader_Abstract implements PHPExcel_
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

4
Classes/PHPExcel/Reader/IReader.php
View File

@ -38,7 +38,7 @@ interface PHPExcel_Reader_IReader
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
*/ */
public function canRead($pFilename); public function canRead($pFilename);
@ -46,7 +46,7 @@ interface PHPExcel_Reader_IReader
/** /**
* Loads PHPExcel from file * Loads PHPExcel from file
* *
* @param string $pFileName * @param string $pFilename
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */
public function load($pFilename); public function load($pFilename);

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

@ -63,7 +63,7 @@ class PHPExcel_Reader_OOCalc extends PHPExcel_Reader_Abstract implements PHPExce
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

2
Classes/PHPExcel/Reader/SYLK.php
View File

@ -83,7 +83,7 @@ class PHPExcel_Reader_SYLK extends PHPExcel_Reader_Abstract implements PHPExcel_
/** /**
* Can the current PHPExcel_Reader_IReader read the file? * Can the current PHPExcel_Reader_IReader read the file?
* *
* @param string $pFileName * @param string $pFilename
* @return boolean * @return boolean
* @throws PHPExcel_Reader_Exception * @throws PHPExcel_Reader_Exception
*/ */

1
Classes/PHPExcel/ReferenceHelper.php
View File

@ -641,6 +641,7 @@ class PHPExcel_ReferenceHelper
* @param int $pBefore Insert before this one * @param int $pBefore Insert before this one
* @param int $pNumCols Number of columns to insert * @param int $pNumCols Number of columns to insert
* @param int $pNumRows Number of rows to insert * @param int $pNumRows Number of rows to insert
* @param string $sheetName Worksheet name/title
* @return string Updated formula * @return string Updated formula
* @throws PHPExcel_Exception * @throws PHPExcel_Exception
*/ */

10
Classes/PHPExcel/Shared/Font.php
View File

@ -244,11 +244,11 @@ class PHPExcel_Shared_Font
/** /**
* Calculate an (approximate) OpenXML column width, based on font size and text contained * Calculate an (approximate) OpenXML column width, based on font size and text contained
* *
* @param int $fontSize Font size (in pixels or points) * @param PHPExcel_Style_Font $font Font object
* @param bool $fontSizeInPixels Is the font size specified in pixels (true) or in points (false) ? * @param PHPExcel_RichText|string $cellText Text to calculate width
* @param string $cellText Text to calculate width * @param integer $rotation Rotation angle
* @param int $rotation Rotation angle * @param PHPExcel_Style_Font|NULL $defaultFont Font object
* @return int Column width * @return integer Column width
*/ */
public static function calculateColumnWidth(PHPExcel_Style_Font $font, $cellText = '', $rotation = 0, PHPExcel_Style_Font $defaultFont = null) { public static function calculateColumnWidth(PHPExcel_Style_Font $font, $cellText = '', $rotation = 0, PHPExcel_Style_Font $defaultFont = null) {

9
Classes/PHPExcel/Shared/String.php
View File

@ -427,7 +427,8 @@ class PHPExcel_Shared_String
* although this will give wrong results for non-ASCII strings * although this will give wrong results for non-ASCII strings
* see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect. 2.5.3 * see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect. 2.5.3
* *
* @param string $value UTF-8 encoded string * @param string $value UTF-8 encoded string
* @param mixed[] $arrcRuns Details of rich text runs in $value
* @return string * @return string
*/ */
public static function UTF8toBIFF8UnicodeShort($value, $arrcRuns = array()) public static function UTF8toBIFF8UnicodeShort($value, $arrcRuns = array())
@ -523,7 +524,7 @@ class PHPExcel_Shared_String
* @author Rasmus Andersson {@link http://rasmusandersson.se/} * @author Rasmus Andersson {@link http://rasmusandersson.se/}
* @author vadik56 * @author vadik56
*/ */
public static function utf16_decode( $str, $bom_be=true ) { public static function utf16_decode($str, $bom_be = TRUE) {
if( strlen($str) < 2 ) return $str; if( strlen($str) < 2 ) return $str;
$c0 = ord($str{0}); $c0 = ord($str{0});
$c1 = ord($str{1}); $c1 = ord($str{1});
@ -564,8 +565,8 @@ class PHPExcel_Shared_String
* Get a substring of a UTF-8 encoded string. First try mbstring, then iconv, finally strlen * Get a substring of a UTF-8 encoded string. First try mbstring, then iconv, finally strlen
* *
* @param string $pValue UTF-8 encoded string * @param string $pValue UTF-8 encoded string
* @param int $start Start offset * @param int $pStart Start offset
* @param int $length Maximum number of characters in substring * @param int $pLength Maximum number of characters in substring
* @return string * @return string
*/ */
public static function Substring($pValue = '', $pStart = 0, $pLength = 0) public static function Substring($pValue = '', $pStart = 0, $pLength = 0)