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

Document blocks

This commit is contained in:
Mark Baker 2013-04-27 21:57:30 +01:00
parent c660492446
commit e9a09c8903
10 changed files with 46 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Classes/PHPExcel/Worksheet.php
View File

@ -1861,7 +1861,7 @@ class PHPExcel_Worksheet implements PHPExcel_IComparable
/**
* 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
* @throws PHPExcel_Exception
* @return PHPExcel_Worksheet
@ -1879,10 +1879,10 @@ class PHPExcel_Worksheet implements PHPExcel_IComparable
/**
* Set Autofilter Range by using numeric cell coordinates
*
* @param int $pColumn1 Numeric column coordinate of the first cell
* @param int $pRow1 Numeric row coordinate of the first cell
* @param int $pColumn2 Numeric column coordinate of the second cell
* @param int $pRow2 Numeric row coordinate of the second cell
* @param integer $pColumn1 Numeric column coordinate of the first cell
* @param integer $pRow1 Numeric row coordinate of the first cell
* @param integer $pColumn2 Numeric column coordinate of the second cell
* @param integer $pRow2 Numeric row coordinate of the second cell
* @throws PHPExcel_Exception
* @return PHPExcel_Worksheet
*/

17
Classes/PHPExcel/Worksheet/AutoFilter.php
View File

@ -61,6 +61,9 @@ class 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)
{
@ -80,7 +83,7 @@ class PHPExcel_Worksheet_AutoFilter
/**
* Set AutoFilter Parent Worksheet
*
* @param PHPExcel_Worksheet
* @param PHPExcel_Worksheet $pSheet
* @return PHPExcel_Worksheet_AutoFilter
*/
public function setParent(PHPExcel_Worksheet $pSheet = NULL) {
@ -243,7 +246,7 @@ class PHPExcel_Worksheet_AutoFilter
/**
* Clear a specified AutoFilter Column
*
* @param string $pColumn Column name (e.g. A)
* @param string $pColumn Column name (e.g. A)
* @throws PHPExcel_Exception
* @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
*
* @param mixed $cellValue
* @param mixed[] $dataSet
* @param mixed[] $ruleSet
* @return boolean
*/
private static function _filterTestInCustomDataSet($cellValue,$ruleSet)
private static function _filterTestInCustomDataSet($cellValue, $ruleSet)
{
$dataSet = $ruleSet['filterRules'];
$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
*
* @param mixed $cellValue
* @param mixed[] $dataSet
* @param mixed[] $monthSet
* @return boolean
*/
private static function _filterTestInPeriodDateSet($cellValue,$monthSet)
private static function _filterTestInPeriodDateSet($cellValue, $monthSet)
{
// Blank cells are always ignored, so return a FALSE
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
*
* @param string $dynamicRuleType
* @param PHPExcel_Worksheet_AutoFilter_Column $filterColumn
* @param PHPExcel_Worksheet_AutoFilter_Column &$filterColumn
* @return mixed[]
*/
private function _dynamicFilterDateRange($dynamicRuleType, &$filterColumn)

13
Classes/PHPExcel/Worksheet/AutoFilter/Column.php
View File

@ -44,6 +44,11 @@ class PHPExcel_Worksheet_AutoFilter_Column
// e.g. filtered by date = TODAY
const AUTOFILTER_FILTERTYPE_TOPTENFILTER = 'top10';
/**
* Types of autofilter rules
*
* @var string[]
*/
private static $_filterTypes = array(
// Currently we're not handling
// colorFilter
@ -59,6 +64,11 @@ class PHPExcel_Worksheet_AutoFilter_Column
const AUTOFILTER_COLUMN_JOIN_AND = 'and';
const AUTOFILTER_COLUMN_JOIN_OR = 'or';
/**
* Join options for autofilter rules
*
* @var string[]
*/
private static $_ruleJoins = array(
self::AUTOFILTER_COLUMN_JOIN_AND,
self::AUTOFILTER_COLUMN_JOIN_OR,
@ -114,6 +124,9 @@ class 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)
{

2
Classes/PHPExcel/Worksheet/AutoFilter/Column/Rule.php
View File

@ -269,6 +269,8 @@ class 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)
{

8
Classes/PHPExcel/Writer/Excel5/Workbook.php
View File

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

4
Classes/PHPExcel/Writer/IWriter.php
View File

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

6
Classes/PHPExcel/Writer/PDF/Core.php
View File

@ -261,7 +261,7 @@ abstract class PHPExcel_Writer_PDF_Core extends PHPExcel_Writer_HTML
/**
* Set Paper Size
*
* @param int $pValue
* @param string $pValue Paper size
* @return PHPExcel_Writer_PDF
*/
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
*
* @param string $pValue
* @param string $pValue Page orientation
* @return PHPExcel_Writer_PDF
*/
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
*
* @param string $pFileName Name of the file to save as
* @param string $pFilename Name of the file to save as
* @throws PHPExcel_Writer_Exception
*/
protected function prepareForSave($pFilename = NULL)

6
Classes/PHPExcel/Writer/PDF/DomPDF.php
View File

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

4
Classes/PHPExcel/Writer/PDF/mPDF.php
View File

@ -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 Name of the file to save as
* @param string $pFilename Name of the file to save as
* @throws PHPExcel_Writer_Exception
*/
public function save($pFilename = NULL)

4
Classes/PHPExcel/Writer/PDF/tcPDF.php
View File

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