Merge branch 'develop' of https://github.com/PHPOffice/PHPExcel into develop

This commit is contained in:
Mark Baker 2013-04-27 22:48:20 +01:00
commit 82fb4382fd
23 changed files with 74 additions and 54 deletions

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
*/ */

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;
} }

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
*/ */

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
*/ */

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
*/ */

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
*/ */

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
*/ */

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);

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
*/ */

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
*/ */

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
*/ */

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) {

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)

View File

@ -1861,7 +1861,7 @@ class PHPExcel_Worksheet implements PHPExcel_IComparable
/** /**
* Set AutoFilter * Set AutoFilter
* *
* @param PHPExcel_Worksheet_AutoFilter|string $pValue * @param PHPExcel_Worksheet_AutoFilter|string $pValue
* A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility * A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
* @throws PHPExcel_Exception * @throws PHPExcel_Exception
* @return PHPExcel_Worksheet * @return PHPExcel_Worksheet
@ -1879,10 +1879,10 @@ class PHPExcel_Worksheet implements PHPExcel_IComparable
/** /**
* Set Autofilter Range by using numeric cell coordinates * Set Autofilter Range by using numeric cell coordinates
* *
* @param int $pColumn1 Numeric column coordinate of the first cell * @param integer $pColumn1 Numeric column coordinate of the first cell
* @param int $pRow1 Numeric row coordinate of the first cell * @param integer $pRow1 Numeric row coordinate of the first cell
* @param int $pColumn2 Numeric column coordinate of the second cell * @param integer $pColumn2 Numeric column coordinate of the second cell
* @param int $pRow2 Numeric row coordinate of the second cell * @param integer $pRow2 Numeric row coordinate of the second cell
* @throws PHPExcel_Exception * @throws PHPExcel_Exception
* @return PHPExcel_Worksheet * @return PHPExcel_Worksheet
*/ */

View File

@ -61,6 +61,9 @@ class PHPExcel_Worksheet_AutoFilter
/** /**
* Create a new PHPExcel_Worksheet_AutoFilter * Create a new PHPExcel_Worksheet_AutoFilter
*
* @param string $pRange Cell range (i.e. A1:E10)
* @param PHPExcel_Worksheet $pSheet
*/ */
public function __construct($pRange = '', PHPExcel_Worksheet $pSheet = NULL) public function __construct($pRange = '', PHPExcel_Worksheet $pSheet = NULL)
{ {
@ -80,7 +83,7 @@ class PHPExcel_Worksheet_AutoFilter
/** /**
* Set AutoFilter Parent Worksheet * Set AutoFilter Parent Worksheet
* *
* @param PHPExcel_Worksheet * @param PHPExcel_Worksheet $pSheet
* @return PHPExcel_Worksheet_AutoFilter * @return PHPExcel_Worksheet_AutoFilter
*/ */
public function setParent(PHPExcel_Worksheet $pSheet = NULL) { public function setParent(PHPExcel_Worksheet $pSheet = NULL) {
@ -243,7 +246,7 @@ class PHPExcel_Worksheet_AutoFilter
/** /**
* Clear a specified AutoFilter Column * Clear a specified AutoFilter Column
* *
* @param string $pColumn Column name (e.g. A) * @param string $pColumn Column name (e.g. A)
* @throws PHPExcel_Exception * @throws PHPExcel_Exception
* @return PHPExcel_Worksheet_AutoFilter * @return PHPExcel_Worksheet_AutoFilter
*/ */
@ -347,10 +350,10 @@ class PHPExcel_Worksheet_AutoFilter
* Test if cell value is within a set of values defined by a ruleset * Test if cell value is within a set of values defined by a ruleset
* *
* @param mixed $cellValue * @param mixed $cellValue
* @param mixed[] $dataSet * @param mixed[] $ruleSet
* @return boolean * @return boolean
*/ */
private static function _filterTestInCustomDataSet($cellValue,$ruleSet) private static function _filterTestInCustomDataSet($cellValue, $ruleSet)
{ {
$dataSet = $ruleSet['filterRules']; $dataSet = $ruleSet['filterRules'];
$join = $ruleSet['join']; $join = $ruleSet['join'];
@ -424,10 +427,10 @@ class PHPExcel_Worksheet_AutoFilter
* Test if cell date value is matches a set of values defined by a set of months * Test if cell date value is matches a set of values defined by a set of months
* *
* @param mixed $cellValue * @param mixed $cellValue
* @param mixed[] $dataSet * @param mixed[] $monthSet
* @return boolean * @return boolean
*/ */
private static function _filterTestInPeriodDateSet($cellValue,$monthSet) private static function _filterTestInPeriodDateSet($cellValue, $monthSet)
{ {
// Blank cells are always ignored, so return a FALSE // Blank cells are always ignored, so return a FALSE
if (($cellValue == '') || ($cellValue === NULL)) { if (($cellValue == '') || ($cellValue === NULL)) {
@ -457,7 +460,7 @@ class PHPExcel_Worksheet_AutoFilter
* Convert a dynamic rule daterange to a custom filter range expression for ease of calculation * Convert a dynamic rule daterange to a custom filter range expression for ease of calculation
* *
* @param string $dynamicRuleType * @param string $dynamicRuleType
* @param PHPExcel_Worksheet_AutoFilter_Column $filterColumn * @param PHPExcel_Worksheet_AutoFilter_Column &$filterColumn
* @return mixed[] * @return mixed[]
*/ */
private function _dynamicFilterDateRange($dynamicRuleType, &$filterColumn) private function _dynamicFilterDateRange($dynamicRuleType, &$filterColumn)

View File

@ -44,6 +44,11 @@ class PHPExcel_Worksheet_AutoFilter_Column
// e.g. filtered by date = TODAY // e.g. filtered by date = TODAY
const AUTOFILTER_FILTERTYPE_TOPTENFILTER = 'top10'; const AUTOFILTER_FILTERTYPE_TOPTENFILTER = 'top10';
/**
* Types of autofilter rules
*
* @var string[]
*/
private static $_filterTypes = array( private static $_filterTypes = array(
// Currently we're not handling // Currently we're not handling
// colorFilter // colorFilter
@ -59,6 +64,11 @@ class PHPExcel_Worksheet_AutoFilter_Column
const AUTOFILTER_COLUMN_JOIN_AND = 'and'; const AUTOFILTER_COLUMN_JOIN_AND = 'and';
const AUTOFILTER_COLUMN_JOIN_OR = 'or'; const AUTOFILTER_COLUMN_JOIN_OR = 'or';
/**
* Join options for autofilter rules
*
* @var string[]
*/
private static $_ruleJoins = array( private static $_ruleJoins = array(
self::AUTOFILTER_COLUMN_JOIN_AND, self::AUTOFILTER_COLUMN_JOIN_AND,
self::AUTOFILTER_COLUMN_JOIN_OR, self::AUTOFILTER_COLUMN_JOIN_OR,
@ -114,6 +124,9 @@ class PHPExcel_Worksheet_AutoFilter_Column
/** /**
* Create a new PHPExcel_Worksheet_AutoFilter_Column * Create a new PHPExcel_Worksheet_AutoFilter_Column
*
* @param string $pColumn Column (e.g. A)
* @param PHPExcel_Worksheet_AutoFilter $pParent Autofilter for this column
*/ */
public function __construct($pColumn, PHPExcel_Worksheet_AutoFilter $pParent = NULL) public function __construct($pColumn, PHPExcel_Worksheet_AutoFilter $pParent = NULL)
{ {

View File

@ -269,6 +269,8 @@ class PHPExcel_Worksheet_AutoFilter_Column_Rule
/** /**
* Create a new PHPExcel_Worksheet_AutoFilter_Column_Rule * Create a new PHPExcel_Worksheet_AutoFilter_Column_Rule
*
* @param PHPExcel_Worksheet_AutoFilter_Column $pParent
*/ */
public function __construct(PHPExcel_Worksheet_AutoFilter_Column $pParent = NULL) public function __construct(PHPExcel_Worksheet_AutoFilter_Column $pParent = NULL)
{ {

View File

@ -836,10 +836,10 @@ class PHPExcel_Writer_Excel5_Workbook extends PHPExcel_Writer_Excel5_BIFFwriter
/** /**
* Write a short NAME record * Write a short NAME record
* *
* @param string $name * @param string $name
* @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global
* @param int[][] $range rangeboundaries * @param integer[][] $rangeBounds range boundaries
* @param bool $isHidden * @param boolean $isHidden
* @return string Complete binary record data * @return string Complete binary record data
* */ * */
private function _writeShortNameBiff8($name, $sheetIndex = 0, $rangeBounds, $isHidden = false){ private function _writeShortNameBiff8($name, $sheetIndex = 0, $rangeBounds, $isHidden = false){

View File

@ -38,8 +38,8 @@ interface PHPExcel_Writer_IWriter
/** /**
* Save PHPExcel to file * Save PHPExcel to file
* *
* @param string $pFilename * @param string $pFilename NAme of the file to save
* @throws PHPExcel_Writer_Exception * @throws PHPExcel_Writer_Exception
*/ */
public function save($pFilename = NULL); public function save($pFilename = NULL);

View File

@ -261,7 +261,7 @@ abstract class PHPExcel_Writer_PDF_Core extends PHPExcel_Writer_HTML
/** /**
* Set Paper Size * Set Paper Size
* *
* @param int $pValue * @param string $pValue Paper size
* @return PHPExcel_Writer_PDF * @return PHPExcel_Writer_PDF
*/ */
public function setPaperSize($pValue = PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER) public function setPaperSize($pValue = PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER)
@ -283,7 +283,7 @@ abstract class PHPExcel_Writer_PDF_Core extends PHPExcel_Writer_HTML
/** /**
* Set Orientation * Set Orientation
* *
* @param string $pValue * @param string $pValue Page orientation
* @return PHPExcel_Writer_PDF * @return PHPExcel_Writer_PDF
*/ */
public function setOrientation($pValue = PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT) public function setOrientation($pValue = PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT)
@ -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 Name of the file to save as * @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

@ -46,7 +46,7 @@ class PHPExcel_Writer_PDF_DomPDF extends PHPExcel_Writer_PDF_Core implements PHP
/** /**
* Create a new PHPExcel_Writer_PDF * Create a new PHPExcel_Writer_PDF
* *
* @param PHPExcel $phpExcel PHPExcel object * @param PHPExcel $phpExcel PHPExcel object
*/ */
public function __construct(PHPExcel $phpExcel) public function __construct(PHPExcel $phpExcel)
{ {
@ -56,8 +56,8 @@ class PHPExcel_Writer_PDF_DomPDF extends PHPExcel_Writer_PDF_Core implements PHP
/** /**
* Save PHPExcel to file * Save PHPExcel to file
* *
* @param string $pFileName Name of the file to save as * @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

@ -46,7 +46,7 @@ class PHPExcel_Writer_PDF_mPDF extends PHPExcel_Writer_PDF_Core implements PHPEx
/** /**
* Create a new PHPExcel_Writer_PDF * Create a new PHPExcel_Writer_PDF
* *
* @param PHPExcel $phpExcel PHPExcel object * @param PHPExcel $phpExcel PHPExcel object
*/ */
public function __construct(PHPExcel $phpExcel) 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 * Save PHPExcel to file
* *
* @param string $pFileName Name of the file to save as * @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

@ -47,7 +47,7 @@ class PHPExcel_Writer_PDF_tcPDF extends PHPExcel_Writer_PDF_Core implements PHPE
/** /**
* Create a new PHPExcel_Writer_PDF * Create a new PHPExcel_Writer_PDF
* *
* @param PHPExcel $phpExcel PHPExcel object * @param PHPExcel $phpExcel PHPExcel object
*/ */
public function __construct(PHPExcel $phpExcel) public function __construct(PHPExcel $phpExcel)
{ {
@ -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 Name of the file to save as * @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)