first commit

This commit is contained in:
aschwarz
2023-01-30 08:01:11 +01:00
commit dd253ca7e9
1663 changed files with 846601 additions and 0 deletions

View File

@ -0,0 +1,11 @@
# Calculation Engine - Formula Function Reference
## Frequently asked questions
The up-to-date F.A.Q. page for PHPExcel can be found on [http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=FAQ&referringTitle=Requirements][1].
### Formulas dont seem to be calculated in Excel2003 using compatibility pack?
This is normal behaviour of the compatibility pack, Excel2007 displays this correctly. Use PHPExcel_Writer_Excel5 if you really need calculated values, or force recalculation in Excel2003.
[1]: http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=FAQ&referringTitle=Requirements

View File

@ -0,0 +1,123 @@
# Calculation Engine - Formula Function Reference
## Function Reference
### Handling Date and Time Values
#### Excel functions that return a Date and Time value
Any of the Date and Time functions that return a date value in Excel can return either an Excel timestamp or a PHP timestamp or date object.
It is possible for scripts to change the data type used for returning date values by calling the PHPExcel_Calculation_Functions::setReturnDateType() method:
```php
PHPExcel_Calculation_Functions::setReturnDateType($returnDateType);
```
where the following constants can be used for $returnDateType
- PHPExcel_Calculation_Functions::RETURNDATE_PHP_NUMERIC
- PHPExcel_Calculation_Functions::RETURNDATE_PHP_OBJECT
- PHPExcel_Calculation_Functions::RETURNDATE_EXCEL
The method will return a Boolean True on success, False on failure (e.g. if an invalid value is passed in for the return date type).
The PHPExcel_Calculation_Functions::getReturnDateType() method can be used to determine the current value of this setting:
```php
$returnDateType = PHPExcel_Calculation_Functions::getReturnDateType();
```
The default is RETURNDATE_PHP_NUMERIC.
##### PHP Timestamps
If RETURNDATE_PHP_NUMERIC is set for the Return Date Type, then any date value returned to the calling script by any access to the Date and Time functions in Excel will be an integer value that represents the number of seconds from the PHP/Unix base date. The PHP/Unix base date (0) is 00:00 UST on 1st January 1970. This value can be positive or negative: so a value of -3600 would be 23:00 hrs on 31st December 1969; while a value of +3600 would be 01:00 hrs on 1st January 1970. This gives PHP a date range of between 14th December 1901 and 19th January 2038.
##### PHP DateTime Objects
If the Return Date Type is set for RETURNDATE_PHP_NUMERIC, then any date value returned to the calling script by any access to the Date and Time functions in Excel will be a PHP date/time object.
##### Excel Timestamps
If RETURNDATE_EXCEL is set for the Return Date Type, then the returned date value by any access to the Date and Time functions in Excel will be a floating point value that represents a number of days from the Excel base date. The Excel base date is determined by which calendar Excel uses: the Windows 1900 or the Mac 1904 calendar. 1st January 1900 is the base date for the Windows 1900 calendar while 1st January 1904 is the base date for the Mac 1904 calendar.
It is possible for scripts to change the calendar used for calculating Excel date values by calling the PHPExcel_Shared_Date::setExcelCalendar() method:
```php
PHPExcel_Shared_Date::setExcelCalendar($baseDate);
```
where the following constants can be used for $baseDate
- PHPExcel_Shared_Date::CALENDAR_WINDOWS_1900
- PHPExcel_Shared_Date::CALENDAR_MAC_1904
The method will return a Boolean True on success, False on failure (e.g. if an invalid value is passed in).
The PHPExcel_Shared_Date::getExcelCalendar() method can be used to determine the current value of this setting:
```php
$baseDate = PHPExcel_Shared_Date::getExcelCalendar();
```
The default is CALENDAR_WINDOWS_1900.
##### Functions that return a Date/Time Value
- DATE
- DATEVALUE
- EDATE
- EOMONTH
- NOW
- TIME
- TIMEVALUE
- TODAY
#### Excel functions that accept Date and Time values as parameters
Date values passed in as parameters to a function can be an Excel timestamp or a PHP timestamp; or date object; or a string containing a date value (e.g. '1-Jan-2009'). PHPExcel will attempt to identify their type based on the PHP datatype:
An integer numeric value will be treated as a PHP/Unix timestamp. A real (floating point) numeric value will be treated as an Excel date/timestamp. Any PHP DateTime object will be treated as a DateTime object. Any string value (even one containing straight numeric data) will be converted to a date/time object for validation as a date value based on the server locale settings, so passing through an ambiguous value of '07/08/2008' will be treated as 7th August 2008 if your server settings are UK, but as 8th July 2008 if your server settings are US. However, if you pass through a value such as '31/12/2008' that would be considered an error by a US-based server, but which is not ambiguous, then PHPExcel will attempt to correct this to 31st December 2008. If the content of the string doesnt match any of the formats recognised by the php date/time object implementation of strtotime() (which can handle a wider range of formats than the normal strtotime() function), then the function will return a '#VALUE' error. However, Excel recommends that you should always use date/timestamps for your date functions, and the recommendation for PHPExcel is the same: avoid strings because the result is not predictable.
The same principle applies when data is being written to Excel. Cells containing date actual values (rather than Excel functions that return a date value) are always written as Excel dates, converting where necessary. If a cell formatted as a date contains an integer or date/time object value, then it is converted to an Excel value for writing: if a cell formatted as a date contains a real value, then no conversion is required. Note that string values are written as strings rather than converted to Excel date timestamp values.
##### Functions that expect a Date/Time Value
- DATEDIF
- DAY
- DAYS360
- EDATE
- EOMONTH
- HOUR
- MINUTE
- MONTH
- NETWORKDAYS
- SECOND
- WEEKDAY
- WEEKNUM
- WORKDAY
- YEAR
- YEARFRAC
#### Helper Methods
In addition to the setExcelCalendar() and getExcelCalendar() methods, a number of other methods are available in the PHPExcel_Shared_Date class that can help when working with dates:
##### PHPExcel_Shared_Date::ExcelToPHP($excelDate)
Converts a date/time from an Excel date timestamp to return a PHP serialized date/timestamp.
Note that this method does not trap for Excel dates that fall outside of the valid range for a PHP date timestamp.
##### PHPExcel_Shared_Date::ExcelToPHPObject($excelDate)
Converts a date from an Excel date/timestamp to return a PHP DateTime object.
##### PHPExcel_Shared_Date::PHPToExcel($PHPDate)
Converts a PHP serialized date/timestamp or a PHP DateTime object to return an Excel date timestamp.
##### PHPExcel_Shared_Date::FormattedPHPToExcel($year, $month, $day, $hours=0, $minutes=0, $seconds=0)
Takes year, month and day values (and optional hour, minute and second values) and returns an Excel date timestamp value.

View File

@ -0,0 +1,36 @@
# Calculation Engine - Formula Function Reference
## General Introduction
### Function that are not Supported in Excel5
Not all functions are supported by the Excel 5 Writer. Use of these functions within your workbooks will result in an error when trying to write to Excel5.
The following is the list of those functions that are implemented within PHPExcel, but that cannot currently be written to Excel 5.
#### Cube Functions
Excel Function | Notes
--------------------|---------
CUBEKPIMEMBER | Not yet Implemented
CUBEMEMBER | Not yet Implemented
CUBEMEMBERPROPERTY | Not yet Implemented
CUBERANKEDMEMBER | Not yet Implemented
CUBESET | Not yet Implemented
CUBESETCOUNT | Not yet Implemented
CUBEVALUE | Not yet Implemented
#### Database Functions
Excel Function | Notes
---------------|---------
#### Date and Time Functions
Excel Function | Notes
---------------|---------
EDATE | Not a standard function within Excel 5, but an add-in from the Analysis ToolPak.
EOMONTH | Not a standard function within Excel 5, but an add-in from the Analysis ToolPak.

View File

@ -0,0 +1,34 @@
# Calculation Engine - Formula Function Reference
## Function Reference
### Cube Functions
#### CUBEKPIMEMBER
Not yet implemented.
#### CUBEMEMBER
Not yet implemented.
#### CUBEMEMBERPROPERTY
Not yet implemented.
#### CUBERANKEDMEMBER
Not yet implemented.
#### CUBESET
Not yet implemented.
#### CUBESETCOUNT
Not yet implemented.
#### CUBEVALUE
Not yet implemented.

View File

@ -0,0 +1,618 @@
# Calculation Engine - Formula Function Reference
## Function Reference
### Database Functions
#### DAVERAGE
The DAVERAGE function returns the average value of the cells in a column of a list or database that match conditions you specify.
##### Syntax
```
DAVERAGE (database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The average value of the matching cells.
This is the statistical mean.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DAVERAGE(A4:E10,"Yield",A1:B2)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 12
```
##### Notes
There are no additional notes on this function
#### DCOUNT
The DCOUNT function returns the count of cells that contain a number in a column of a list or database matching conditions that you specify.
##### Syntax
```
DCOUNT(database, [field], criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The count of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DCOUNT(A4:E10,"Height",A1:B3)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 3
```
##### Notes
In MS Excel, The field argument is optional. If field is omitted, DCOUNT counts all records in the database that match the criteria. This logic has not yet been implemented in PHPExcel.
#### DCOUNTA
The DCOUNT function returns the count of cells that arent blank in a column of a list or database and that match conditions that you specify.
##### Syntax
```
DCOUNTA(database, [field], criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The count of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DCOUNTA(A4:E10,"Yield",A1:A3)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 5
```
##### Notes
In MS Excel, The field argument is optional. If field is omitted, DCOUNTA counts all records in the database that match the criteria. This logic has not yet been implemented in PHPExcel.
#### DGET
The DGET function extracts a single value from a column of a list or database that matches conditions that you specify.
##### Syntax
```
DGET(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**mixed** The value from the selected column of the matching row.
#### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=GET(A4:E10,"Age",A1:F2)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 14
```
##### Notes
There are no additional notes on this function
#### DMAX
The DMAX function returns the largest number in a column of a list or database that matches conditions you specify.
##### Syntax
```
DMAX(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The maximum value of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DMAX(A4:E10,"Profit",A1:B2)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 105
```
##### Notes
There are no additional notes on this function
#### DMIN
The DMIN function returns the smallest number in a column of a list or database that matches conditions you specify.
##### Syntax
```
DMIN(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The minimum value of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DMIN(A4:E10,"Yield",A1:A3)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 6
```
##### Notes
There are no additional notes on this function
#### DPRODUCT
The DPRODUCT function multiplies the values in a column of a list or database that match conditions that you specify.
##### Syntax
```
DPRODUCT(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The product of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DPRODUCT(A4:E10,"Yield",A1:B2)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 140
```
##### Notes
There are no additional notes on this function
#### DSTDEV
The DSTDEV function estimates the standard deviation of a population based on a sample by using the numbers in a column of a list or database that match conditions that you specify.
##### Syntax
```
DSTDEV(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The estimated standard deviation of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DSTDEV(A4:E10,"Yield",A1:A3)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 2.97
```
##### Notes
There are no additional notes on this function
#### DSTDEVP
The DSTDEVP function calculates the standard deviation of a population based on the entire population by using the numbers in a column of a list or database that match conditions that you specify.
##### Syntax
```
DSTDEVP(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The estimated standard deviation of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DSTDEVP(A4:E10,"Yield",A1:A3)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 2.65
```
##### Notes
There are no additional notes on this function
#### DSUM
The DSUM function adds the numbers in a column of a list or database that matches conditions you specify.
##### Syntax
```
DSUM(database, field, criteria)
```
##### Parameters
**database** The range of cells that makes up the list or database.
A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
**field** Indicates which column of the database is used in the function.
Enter the column label as a string (enclosed between double quotation marks), such as "Age" or "Yield," or as a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
**criteria** The range of cells that contains the conditions you specify.
You can use any range for the criteria argument, as long as it includes at least one column label and at least one cell below the column label in which you specify a condition for the column.
##### Return Value
**float** The total value of the matching cells.
##### Examples
```php
$database = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit' ),
array( 'Apple', 18, 20, 14, 105.00 ),
array( 'Pear', 12, 12, 10, 96.00 ),
array( 'Cherry', 13, 14, 9, 105.00 ),
array( 'Apple', 14, 15, 10, 75.00 ),
array( 'Pear', 9, 8, 8, 76.80 ),
array( 'Apple', 8, 9, 6, 45.00 ),
);
$criteria = array(
array( 'Tree', 'Height', 'Age', 'Yield', 'Profit', 'Height' ),
array( '="=Apple"', '>10', NULL, NULL, NULL, '<16' ),
array( '="=Pear"', NULL, NULL, NULL, NULL, NULL ),
);
$worksheet->fromArray( $criteria, NULL, 'A1' )
->fromArray( $database, NULL, 'A4' );
$worksheet->setCellValue('A12', '=DMIN(A4:E10,"Profit",A1:A2)');
$retVal = $worksheet->getCell('A12')->getCalculatedValue();
// $retVal = 225
```
##### Notes
There are no additional notes on this function
#### DVAR
Not yet documented.
#### DVARP
Not yet documented.

View File

@ -0,0 +1,19 @@
# PHPExcel AutoFilter Reference
## AutoFilters
Each worksheet in an Excel Workbook can contain a single autoFilter range. Filtered data displays only the rows that meet criteria that you specify and hides rows that you do not want displayed. You can filter by more than one column: filters are additive, which means that each additional filter is based on the current filter and further reduces the subset of data.
![01-01-autofilter.png](./images/01-01-autofilter.png "")
When an AutoFilter is applied to a range of cells, the first row in an autofilter range will be the heading row, which displays the autoFilter dropdown icons. It is not part of the actual autoFiltered data. All subsequent rows are the autoFiltered data. So an AutoFilter range should always contain the heading row and one or more data rows (one data row is pretty meaningless), but PHPExcel won't actually stop you specifying a meaningless range: it's up to you as the developer to avoid such errors.
To determine if a filter is applied, note the icon in the column heading. A drop-down arrow (![01-03-filter-icon-1.png](./images/01-03-filter-icon-1.png "")) means that filtering is enabled but not applied. In MS Excel, when you hover over the heading of a column with filtering enabled but not applied, a screen tip displays the cell text for the first row in that column, and the message "(Showing All)".
![01-02-autofilter.png](./images/01-02-autofilter.png "")
A Filter button (![01-03-filter-icon-2.png](./images/01-03-filter-icon-2.png "")) means that a filter is applied. When you hover over the heading of a filtered column, a screen tip displays the filter that has been applied to that column, such as "Equals a red cell color" or "Larger than 150".
![01-04-autofilter.png](./images/01-04-autofilter.png "")

View File

@ -0,0 +1,24 @@
# PHPExcel AutoFilter Reference
## Setting an AutoFilter area on a worksheet
To set an autoFilter on a range of cells.
```php
$objPHPExcel->getActiveSheet()->setAutoFilter('A1:E20');
```
The first row in an autofilter range will be the heading row, which displays the autoFilter dropdown icons. It is not part of the actual autoFiltered data. All subsequent rows are the autoFiltered data. So an AutoFilter range should always contain the heading row and one or more data rows (one data row is pretty meaningless, but PHPExcel won't actually stop you specifying a meaningless range: it's up to you as the developer to avoid such errors.
If you want to set the whole worksheet as an autofilter region
```php
$objPHPExcel->getActiveSheet()->setAutoFilter(
$objPHPExcel->getActiveSheet()
->calculateWorksheetDimension()
);
```
This enables filtering, but does not actually apply any filters.

View File

@ -0,0 +1,27 @@
# PHPExcel AutoFilter Reference
## Autofilter Expressions
PHPEXcel 1.7.8 introduced the ability to actually create, read and write filter expressions; initially only for Excel2007 files, but later releases will extend this to other formats.
To apply a filter expression to an autoFilter range, you first need to identify which column you're going to be applying this filter to.
```php
$autoFilter = $objPHPExcel->getActiveSheet()->getAutoFilter();
$columnFilter = $autoFilter->getColumn('C');
```
This returns an autoFilter column object, and you can then apply filter expressions to that column.
There are a number of different types of autofilter expressions. The most commonly used are:
- Simple Filters
- DateGroup Filters
- Custom filters
- Dynamic Filters
- Top Ten Filters
These different types are mutually exclusive within any single column. You should not mix the different types of filter in the same column. PHPExcel will not actively prevent you from doing this, but the results are unpredictable.
Other filter expression types (such as cell colour filters) are not yet supported.

View File

@ -0,0 +1,52 @@
# PHPExcel AutoFilter Reference
## Autofilter Expressions
### Simple filters
In MS Excel, Simple Filters are a dropdown list of all values used in that column, and the user can select which ones they want to display and which ones they want to hide by ticking and unticking the checkboxes alongside each option. When the filter is applied, rows containing the checked entries will be displayed, rows that don't contain those values will be hidden.
![04-01-simple-autofilter.png](./images/04-01-simple-autofilter.png "")
To create a filter expression, we need to start by identifying the filter type. In this case, we're just going to specify that this filter is a standard filter.
```php
$columnFilter->setFilterType(
PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_FILTER
);
```
Now we've identified the filter type, we can create a filter rule and set the filter values:
When creating a simple filter in PHPExcel, you only need to specify the values for "checked" columns: you do this by creating a filter rule for each value.
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
'France'
);
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
'Germany'
);
```
This creates two filter rules: the column will be filtered by values that match “France” OR “Germany”. For Simple Filters, you can create as many rules as you want
Simple filters are always a comparison match of EQUALS, and multiple standard filters are always treated as being joined by an OR condition.
#### Matching Blanks
If you want to create a filter to select blank cells, you would use:
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
''
);
```

View File

@ -0,0 +1,48 @@
# PHPExcel AutoFilter Reference
## Autofilter Expressions
### DateGroup Filters
In MS Excel, DateGroup filters provide a series of dropdown filter selectors for date values, so you can specify entire years, or months within a year, or individual days within each month.
![04-02-dategroup-autofilter.png](./images/04-02-dategroup-autofilter.png "")
DateGroup filters are still applied as a Standard Filter type.
```php
$columnFilter->setFilterType(
PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_FILTER
);
```
Creating a dateGroup filter in PHPExcel, you specify the values for "checked" columns as an associative array of year. month, day, hour minute and second. To select a year and month, you need to create a DateGroup rule identifying the selected year and month:
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
array(
'year' => 2012,
'month' => 1
)
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_DATEGROUP
);
```
The key values for the associative array are:
- year
- month
- day
- hour
- minute
- second
Like Standard filters, DateGroup filters are always a match of EQUALS, and multiple standard filters are always treated as being joined by an OR condition.
Note that we alse specify a ruleType: to differentiate this from a standard filter, we explicitly set the Rule's Type to AUTOFILTER_RULETYPE_DATEGROUP. As with standard filters, we can create any number of DateGroup Filters.

View File

@ -0,0 +1,84 @@
# PHPExcel AutoFilter Reference
## Autofilter Expressions
### Custom filters
In MS Excel, Custom filters allow us to select more complex conditions using an operator as well as a value. Typical examples might be values that fall within a range (e.g. between -20 and +20), or text values with wildcards (e.g. beginning with the letter U). To handle this, they
![04-03-custom-autofilter-1.png](./images/04-03-custom-autofilter-1.png "")
![04-03-custom-autofilter-2.png](./images/04-03-custom-autofilter-2.png "")
Custom filters are limited to 2 rules, and these can be joined using either an AND or an OR.
We start by specifying a Filter type, this time a CUSTOMFILTER.
```php
$columnFilter->setFilterType(
PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_CUSTOMFILTER
);
```
And then define our rules.
The following shows a simple wildcard filter to show all column entries beginning with the letter 'U'.
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
'U*'
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER
);
```
MS Excel uses \* as a wildcard to match any number of characters, and ? as a wildcard to match a single character. 'U\*' equates to "begins with a 'U'"; '\*U' equates to "ends with a 'U'"; and '\*U\*' equates to "contains a 'U'"
If you want to match explicitly against a \* or a ? character, you can escape it with a tilde (~), so ?~\*\* would explicitly match for a \* character as the second character in the cell value, followed by any number of other characters. The only other character that needs escaping is the ~ itself.
To create a "between" condition, we need to define two rules:
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL,
-20
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER
);
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL,
20
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER
);
```
We also set the rule type to CUSTOMFILTER.
This defined two rules, filtering numbers that are >= -20 OR <= 20, so we also need to modify the join condition to reflect AND rather than OR.
```php
$columnFilter->setAndOr(
PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_COLUMN_ANDOR_AND
);
```
The valid set of operators for Custom Filters are defined in the PHPExcel_Worksheet_AutoFilter_Column_Rule class, and comprise:
Operator Constant | Value |
------------------------------------------|----------------------|
AUTOFILTER_COLUMN_RULE_EQUAL | 'equal' |
AUTOFILTER_COLUMN_RULE_NOTEQUAL | 'notEqual' |
AUTOFILTER_COLUMN_RULE_GREATERTHAN | 'greaterThan' |
AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL | 'greaterThanOrEqual' |
AUTOFILTER_COLUMN_RULE_LESSTHAN | 'lessThan' |
AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL | 'lessThanOrEqual' |

View File

@ -0,0 +1,88 @@
# PHPExcel AutoFilter Reference
## Autofilter Expressions
### Dynamic Filters
Dynamic Filters are based on a dynamic comparison condition, where the value we're comparing against the cell values is variable, such as 'today'; or when we're testing against an aggregate of the cell data (e.g. 'aboveAverage'). Only a single dynamic filter can be applied to a column at a time.
![04-04-dynamic-autofilter.png](./images/04-04-dynamic-autofilter.png "")
Again, we start by specifying a Filter type, this time a DYNAMICFILTER.
```php
$columnFilter->setFilterType(
PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_DYNAMICFILTER
);
```
When defining the rule for a dynamic filter, we don't define a value (we can simply set that to NULL) but we do specify the dynamic filter category.
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_EQUAL,
NULL,
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_DYNAMICFILTER
);
```
We also set the rule type to DYNAMICFILTER.
The valid set of dynamic filter categories is defined in the PHPExcel_Worksheet_AutoFilter_Column_Rule class, and comprises:
Operator Constant | Value |
-----------------------------------------|----------------|
AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY | 'yesterday' |
AUTOFILTER_RULETYPE_DYNAMIC_TODAY | 'today' |
AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW | 'tomorrow' |
AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE | 'yearToDate' |
AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR | 'thisYear' |
AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER | 'thisQuarter' |
AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH | 'thisMonth' |
AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK | 'thisWeek' |
AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR | 'lastYear' |
AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER | 'lastQuarter' |
AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH | 'lastMonth' |
AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK | 'lastWeek' |
AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR | 'nextYear' |
AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER | 'nextQuarter' |
AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH | 'nextMonth' |
AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK | 'nextWeek' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1 | 'M1' |
AUTOFILTER_RULETYPE_DYNAMIC_JANUARY | 'M1' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2 | 'M2' |
AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY | 'M2' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3 | 'M3' |
AUTOFILTER_RULETYPE_DYNAMIC_MARCH | 'M3' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4 | 'M4' |
AUTOFILTER_RULETYPE_DYNAMIC_APRIL | 'M4' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5 | 'M5' |
AUTOFILTER_RULETYPE_DYNAMIC_MAY | 'M5' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6 | 'M6' |
AUTOFILTER_RULETYPE_DYNAMIC_JUNE | 'M6' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7 | 'M7' |
AUTOFILTER_RULETYPE_DYNAMIC_JULY | 'M7' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8 | 'M8' |
AUTOFILTER_RULETYPE_DYNAMIC_AUGUST | 'M8' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9 | 'M9' |
AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER | 'M9' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10 | 'M10' |
AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER | 'M10' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11 | 'M11' |
AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER | 'M11' |
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12 | 'M12' |
AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER | 'M12' |
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1 | 'Q1' |
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2 | 'Q2' |
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3 | 'Q3' |
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4 | 'Q4' |
AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE | 'aboveAverage' |
AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE | 'belowAverage' |
We can only apply a single Dynamic Filter rule to a column at a time.

View File

@ -0,0 +1,69 @@
# PHPExcel AutoFilter Reference
## Autofilter Expressions
### Top Ten Filters
Top Ten Filters are similar to Dynamic Filters in that they are based on a summarisation of the actual data values in the cells. However, unlike Dynamic Filters where you can only select a single option, Top Ten Filters allow you to select based on a number of criteria:
![04-05-custom-topten-1.png](./images/04-05-topten-autofilter-1.png "")
![04-05-custom-topten-2.png](./images/04-05-topten-autofilter-2.png "")
You can identify whether you want the top (highest) or bottom (lowest) values.You can identify how many values you wish to select in the filterYou can identify whether this should be a percentage or a number of items.
Like Dynamic Filters, only a single Top Ten filter can be applied to a column at a time.
We start by specifying a Filter type, this time a DYNAMICFILTER.
```php
$columnFilter->setFilterType(
PHPExcel_Worksheet_AutoFilter_Column::AUTOFILTER_FILTERTYPE_TOPTENFILTER
);
```
Then we create the rule:
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT,
5,
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_TOP
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_TOPTENFILTER
);
```
This will filter the Top 5 percent of values in the column.
To specify the lowest (bottom 2 values), we would specify a rule of:
```php
$columnFilter->createRule()
->setRule(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE,
5,
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM
)
->setRuleType(
PHPExcel_Worksheet_AutoFilter_Column_Rule::AUTOFILTER_RULETYPE_TOPTENFILTER
);
```
The option values for TopTen Filters top/bottom value/percent are all defined in the PHPExcel_Worksheet_AutoFilter_Column_Rule class, and comprise:
Operator Constant | Value |
---------------------------------------|-------------|
AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE | 'byValue' |
AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT | 'byPercent' |
and
Operator Constant | Value |
-------------------------------------|----------|
AUTOFILTER_COLUMN_RULE_TOPTEN_TOP | 'top' |
AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM | 'bottom' |

View File

@ -0,0 +1,42 @@
# PHPExcel AutoFilter Reference
## Executing an AutoFilter
When an autofilter is applied in MS Excel, it sets the row hidden/visible flags for each row of the autofilter area based on the selected criteria, so that only those rows that match the filter criteria are displayed.
PHPExcel will not execute the equivalent function automatically when you set or change a filter expression, but only when the file is saved.
### Applying the Filter
If you wish to execute your filter from within a script, you need to do this manually. You can do this using the autofilters showHideRows() method.
```php
$autoFilter = $objPHPExcel->getActiveSheet()->getAutoFilter();
$autoFilter->showHideRows();
```
This will set all rows that match the filter criteria to visible, while hiding all other rows within the autofilter area.
### Displaying Filtered Rows
Simply looping through the rows in an autofilter area will still access ever row, whether it matches the filter criteria or not. To selectively access only the filtered rows, you need to test each rows visibility settings.
```php
foreach ($objPHPExcel->getActiveSheet()->getRowIterator() as $row) {
if ($objPHPExcel->getActiveSheet()
->getRowDimension($row->getRowIndex())->getVisible()) {
echo ' Row number - ' , $row->getRowIndex() , ' ';
echo $objPHPExcel->getActiveSheet()
->getCell(
'C'.$row->getRowIndex()
)
->getValue(), ' ';
echo $objPHPExcel->getActiveSheet()
->getCell(
'D'.$row->getRowIndex()
)->getFormattedValue(), ' ';
echo EOL;
}
}
```

View File

@ -0,0 +1,7 @@
# PHPExcel AutoFilter Reference
## AutoFilter Sorting
In MS Excel, Autofiltering also allows the rows to be sorted. This feature is ***not*** supported by PHPExcel.

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 453 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 640 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -0,0 +1,411 @@
## CATEGORY_CUBE
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
CUBEKPIMEMBER | **\*\*\* Not yet Implemented**
CUBEMEMBER | **\*\*\* Not yet Implemented**
CUBEMEMBERPROPERTY | **\*\*\* Not yet Implemented**
CUBERANKEDMEMBER | **\*\*\* Not yet Implemented**
CUBESET | **\*\*\* Not yet Implemented**
CUBESETCOUNT | **\*\*\* Not yet Implemented**
CUBEVALUE | **\*\*\* Not yet Implemented**
## CATEGORY_DATABASE
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
DAVERAGE | PHPExcel_Calculation_Database::DAVERAGE
DCOUNT | PHPExcel_Calculation_Database::DCOUNT
DCOUNTA | PHPExcel_Calculation_Database::DCOUNTA
DGET | PHPExcel_Calculation_Database::DGET
DMAX | PHPExcel_Calculation_Database::DMAX
DMIN | PHPExcel_Calculation_Database::DMIN
DPRODUCT | PHPExcel_Calculation_Database::DPRODUCT
DSTDEV | PHPExcel_Calculation_Database::DSTDEV
DSTDEVP | PHPExcel_Calculation_Database::DSTDEVP
DSUM | PHPExcel_Calculation_Database::DSUM
DVAR | PHPExcel_Calculation_Database::DVAR
DVARP | PHPExcel_Calculation_Database::DVARP
## CATEGORY_DATE_AND_TIME
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
DATE | PHPExcel_Calculation_DateTime::DATE
DATEDIF | PHPExcel_Calculation_DateTime::DATEDIF
DATEVALUE | PHPExcel_Calculation_DateTime::DATEVALUE
DAY | PHPExcel_Calculation_DateTime::DAYOFMONTH
DAYS360 | PHPExcel_Calculation_DateTime::DAYS360
EDATE | PHPExcel_Calculation_DateTime::EDATE
EOMONTH | PHPExcel_Calculation_DateTime::EOMONTH
HOUR | PHPExcel_Calculation_DateTime::HOUROFDAY
MINUTE | PHPExcel_Calculation_DateTime::MINUTEOFHOUR
MONTH | PHPExcel_Calculation_DateTime::MONTHOFYEAR
NETWORKDAYS | PHPExcel_Calculation_DateTime::NETWORKDAYS
NOW | PHPExcel_Calculation_DateTime::DATETIMENOW
SECOND | PHPExcel_Calculation_DateTime::SECONDOFMINUTE
TIME | PHPExcel_Calculation_DateTime::TIME
TIMEVALUE | PHPExcel_Calculation_DateTime::TIMEVALUE
TODAY | PHPExcel_Calculation_DateTime::DATENOW
WEEKDAY | PHPExcel_Calculation_DateTime::DAYOFWEEK
WEEKNUM | PHPExcel_Calculation_DateTime::WEEKOFYEAR
WORKDAY | PHPExcel_Calculation_DateTime::WORKDAY
YEAR | PHPExcel_Calculation_DateTime::YEAR
YEARFRAC | PHPExcel_Calculation_DateTime::YEARFRAC
## CATEGORY_ENGINEERING
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
BESSELI | PHPExcel_Calculation_Engineering::BESSELI
BESSELJ | PHPExcel_Calculation_Engineering::BESSELJ
BESSELK | PHPExcel_Calculation_Engineering::BESSELK
BESSELY | PHPExcel_Calculation_Engineering::BESSELY
BIN2DEC | PHPExcel_Calculation_Engineering::BINTODEC
BIN2HEX | PHPExcel_Calculation_Engineering::BINTOHEX
BIN2OCT | PHPExcel_Calculation_Engineering::BINTOOCT
COMPLEX | PHPExcel_Calculation_Engineering::COMPLEX
CONVERT | PHPExcel_Calculation_Engineering::CONVERTUOM
DEC2BIN | PHPExcel_Calculation_Engineering::DECTOBIN
DEC2HEX | PHPExcel_Calculation_Engineering::DECTOHEX
DEC2OCT | PHPExcel_Calculation_Engineering::DECTOOCT
DELTA | PHPExcel_Calculation_Engineering::DELTA
ERF | PHPExcel_Calculation_Engineering::ERF
ERFC | PHPExcel_Calculation_Engineering::ERFC
GESTEP | PHPExcel_Calculation_Engineering::GESTEP
HEX2BIN | PHPExcel_Calculation_Engineering::HEXTOBIN
HEX2DEC | PHPExcel_Calculation_Engineering::HEXTODEC
HEX2OCT | PHPExcel_Calculation_Engineering::HEXTOOCT
IMABS | PHPExcel_Calculation_Engineering::IMABS
IMAGINARY | PHPExcel_Calculation_Engineering::IMAGINARY
IMARGUMENT | PHPExcel_Calculation_Engineering::IMARGUMENT
IMCONJUGATE | PHPExcel_Calculation_Engineering::IMCONJUGATE
IMCOS | PHPExcel_Calculation_Engineering::IMCOS
IMDIV | PHPExcel_Calculation_Engineering::IMDIV
IMEXP | PHPExcel_Calculation_Engineering::IMEXP
IMLN | PHPExcel_Calculation_Engineering::IMLN
IMLOG10 | PHPExcel_Calculation_Engineering::IMLOG10
IMLOG2 | PHPExcel_Calculation_Engineering::IMLOG2
IMPOWER | PHPExcel_Calculation_Engineering::IMPOWER
IMPRODUCT | PHPExcel_Calculation_Engineering::IMPRODUCT
IMREAL | PHPExcel_Calculation_Engineering::IMREAL
IMSIN | PHPExcel_Calculation_Engineering::IMSIN
IMSQRT | PHPExcel_Calculation_Engineering::IMSQRT
IMSUB | PHPExcel_Calculation_Engineering::IMSUB
IMSUM | PHPExcel_Calculation_Engineering::IMSUM
OCT2BIN | PHPExcel_Calculation_Engineering::OCTTOBIN
OCT2DEC | PHPExcel_Calculation_Engineering::OCTTODEC
OCT2HEX | PHPExcel_Calculation_Engineering::OCTTOHEX
## CATEGORY_FINANCIAL
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
ACCRINT | PHPExcel_Calculation_Financial::ACCRINT
ACCRINTM | PHPExcel_Calculation_Financial::ACCRINTM
AMORDEGRC | PHPExcel_Calculation_Financial::AMORDEGRC
AMORLINC | PHPExcel_Calculation_Financial::AMORLINC
COUPDAYBS | PHPExcel_Calculation_Financial::COUPDAYBS
COUPDAYS | PHPExcel_Calculation_Financial::COUPDAYS
COUPDAYSNC | PHPExcel_Calculation_Financial::COUPDAYSNC
COUPNCD | PHPExcel_Calculation_Financial::COUPNCD
COUPNUM | PHPExcel_Calculation_Financial::COUPNUM
COUPPCD | PHPExcel_Calculation_Financial::COUPPCD
CUMIPMT | PHPExcel_Calculation_Financial::CUMIPMT
CUMPRINC | PHPExcel_Calculation_Financial::CUMPRINC
DB | PHPExcel_Calculation_Financial::DB
DDB | PHPExcel_Calculation_Financial::DDB
DISC | PHPExcel_Calculation_Financial::DISC
DOLLARDE | PHPExcel_Calculation_Financial::DOLLARDE
DOLLARFR | PHPExcel_Calculation_Financial::DOLLARFR
DURATION | **\*\*\* Not yet Implemented**
EFFECT | PHPExcel_Calculation_Financial::EFFECT
FV | PHPExcel_Calculation_Financial::FV
FVSCHEDULE | PHPExcel_Calculation_Financial::FVSCHEDULE
INTRATE | PHPExcel_Calculation_Financial::INTRATE
IPMT | PHPExcel_Calculation_Financial::IPMT
IRR | PHPExcel_Calculation_Financial::IRR
ISPMT | PHPExcel_Calculation_Financial::ISPMT
MDURATION | **\*\*\* Not yet Implemented**
MIRR | PHPExcel_Calculation_Financial::MIRR
NOMINAL | PHPExcel_Calculation_Financial::NOMINAL
NPER | PHPExcel_Calculation_Financial::NPER
NPV | PHPExcel_Calculation_Financial::NPV
ODDFPRICE | **\*\*\* Not yet Implemented**
ODDFYIELD | **\*\*\* Not yet Implemented**
ODDLPRICE | **\*\*\* Not yet Implemented**
ODDLYIELD | **\*\*\* Not yet Implemented**
PMT | PHPExcel_Calculation_Financial::PMT
PPMT | PHPExcel_Calculation_Financial::PPMT
PRICE | PHPExcel_Calculation_Financial::PRICE
PRICEDISC | PHPExcel_Calculation_Financial::PRICEDISC
PRICEMAT | PHPExcel_Calculation_Financial::PRICEMAT
PV | PHPExcel_Calculation_Financial::PV
RATE | PHPExcel_Calculation_Financial::RATE
RECEIVED | PHPExcel_Calculation_Financial::RECEIVED
SLN | PHPExcel_Calculation_Financial::SLN
SYD | PHPExcel_Calculation_Financial::SYD
TBILLEQ | PHPExcel_Calculation_Financial::TBILLEQ
TBILLPRICE | PHPExcel_Calculation_Financial::TBILLPRICE
TBILLYIELD | PHPExcel_Calculation_Financial::TBILLYIELD
USDOLLAR | **\*\*\* Not yet Implemented**
VDB | **\*\*\* Not yet Implemented**
XIRR | PHPExcel_Calculation_Financial::XIRR
XNPV | PHPExcel_Calculation_Financial::XNPV
YIELD | **\*\*\* Not yet Implemented**
YIELDDISC | PHPExcel_Calculation_Financial::YIELDDISC
YIELDMAT | PHPExcel_Calculation_Financial::YIELDMAT
## CATEGORY_INFORMATION
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
CELL | **\*\*\* Not yet Implemented**
ERROR.TYPE | PHPExcel_Calculation_Functions::ERROR_TYPE
INFO | **\*\*\* Not yet Implemented**
ISBLANK | PHPExcel_Calculation_Functions::IS_BLANK
ISERR | PHPExcel_Calculation_Functions::IS_ERR
ISERROR | PHPExcel_Calculation_Functions::IS_ERROR
ISEVEN | PHPExcel_Calculation_Functions::IS_EVEN
ISLOGICAL | PHPExcel_Calculation_Functions::IS_LOGICAL
ISNA | PHPExcel_Calculation_Functions::IS_NA
ISNONTEXT | PHPExcel_Calculation_Functions::IS_NONTEXT
ISNUMBER | PHPExcel_Calculation_Functions::IS_NUMBER
ISODD | PHPExcel_Calculation_Functions::IS_ODD
ISREF | **\*\*\* Not yet Implemented**
ISTEXT | PHPExcel_Calculation_Functions::IS_TEXT
N | PHPExcel_Calculation_Functions::N
NA | PHPExcel_Calculation_Functions::NA
TYPE | PHPExcel_Calculation_Functions::TYPE
VERSION | PHPExcel_Calculation_Functions::VERSION
## CATEGORY_LOGICAL
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
AND | PHPExcel_Calculation_Logical::LOGICAL_AND
FALSE | PHPExcel_Calculation_Logical::FALSE
IF | PHPExcel_Calculation_Logical::STATEMENT_IF
IFERROR | PHPExcel_Calculation_Logical::IFERROR
NOT | PHPExcel_Calculation_Logical::NOT
OR | PHPExcel_Calculation_Logical::LOGICAL_OR
TRUE | PHPExcel_Calculation_Logical::TRUE
## CATEGORY_LOOKUP_AND_REFERENCE
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
ADDRESS | PHPExcel_Calculation_LookupRef::CELL_ADDRESS
AREAS | **\*\*\* Not yet Implemented**
CHOOSE | PHPExcel_Calculation_LookupRef::CHOOSE
COLUMN | PHPExcel_Calculation_LookupRef::COLUMN
COLUMNS | PHPExcel_Calculation_LookupRef::COLUMNS
GETPIVOTDATA | **\*\*\* Not yet Implemented**
HLOOKUP | **\*\*\* Not yet Implemented**
HYPERLINK | PHPExcel_Calculation_LookupRef::HYPERLINK
INDEX | PHPExcel_Calculation_LookupRef::INDEX
INDIRECT | PHPExcel_Calculation_LookupRef::INDIRECT
LOOKUP | PHPExcel_Calculation_LookupRef::LOOKUP
MATCH | PHPExcel_Calculation_LookupRef::MATCH
OFFSET | PHPExcel_Calculation_LookupRef::OFFSET
ROW | PHPExcel_Calculation_LookupRef::ROW
ROWS | PHPExcel_Calculation_LookupRef::ROWS
RTD | **\*\*\* Not yet Implemented**
TRANSPOSE | PHPExcel_Calculation_LookupRef::TRANSPOSE
VLOOKUP | PHPExcel_Calculation_LookupRef::VLOOKUP
## CATEGORY_MATH_AND_TRIG
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
ABS | abs
ACOS | acos
ACOSH | acosh
ASIN | asin
ASINH | asinh
ATAN | atan
ATAN2 | PHPExcel_Calculation_MathTrig::REVERSE_ATAN2
ATANH | atanh
CEILING | PHPExcel_Calculation_MathTrig::CEILING
COMBIN | PHPExcel_Calculation_MathTrig::COMBIN
COS | cos
COSH | cosh
DEGREES | rad2deg
EVEN | PHPExcel_Calculation_MathTrig::EVEN
EXP | exp
FACT | PHPExcel_Calculation_MathTrig::FACT
FACTDOUBLE | PHPExcel_Calculation_MathTrig::FACTDOUBLE
FLOOR | PHPExcel_Calculation_MathTrig::FLOOR
GCD | PHPExcel_Calculation_MathTrig::GCD
INT | PHPExcel_Calculation_MathTrig::INT
LCM | PHPExcel_Calculation_MathTrig::LCM
LN | log
LOG | PHPExcel_Calculation_MathTrig::LOG_BASE
LOG10 | log10
MDETERM | PHPExcel_Calculation_MathTrig::MDETERM
MINVERSE | PHPExcel_Calculation_MathTrig::MINVERSE
MMULT | PHPExcel_Calculation_MathTrig::MMULT
MOD | PHPExcel_Calculation_MathTrig::MOD
MROUND | PHPExcel_Calculation_MathTrig::MROUND
MULTINOMIAL | PHPExcel_Calculation_MathTrig::MULTINOMIAL
ODD | PHPExcel_Calculation_MathTrig::ODD
PI | pi
POWER | PHPExcel_Calculation_MathTrig::POWER
PRODUCT | PHPExcel_Calculation_MathTrig::PRODUCT
QUOTIENT | PHPExcel_Calculation_MathTrig::QUOTIENT
RADIANS | deg2rad
RAND | PHPExcel_Calculation_MathTrig::RAND
RANDBETWEEN | PHPExcel_Calculation_MathTrig::RAND
ROMAN | PHPExcel_Calculation_MathTrig::ROMAN
ROUND | round
ROUNDDOWN | PHPExcel_Calculation_MathTrig::ROUNDDOWN
ROUNDUP | PHPExcel_Calculation_MathTrig::ROUNDUP
SERIESSUM | PHPExcel_Calculation_MathTrig::SERIESSUM
SIGN | PHPExcel_Calculation_MathTrig::SIGN
SIN | sin
SINH | sinh
SQRT | sqrt
SQRTPI | PHPExcel_Calculation_MathTrig::SQRTPI
SUBTOTAL | PHPExcel_Calculation_MathTrig::SUBTOTAL
SUM | PHPExcel_Calculation_MathTrig::SUM
SUMIF | PHPExcel_Calculation_MathTrig::SUMIF
SUMIFS | **\*\*\* Not yet Implemented**
SUMPRODUCT | PHPExcel_Calculation_MathTrig::SUMPRODUCT
SUMSQ | PHPExcel_Calculation_MathTrig::SUMSQ
SUMX2MY2 | PHPExcel_Calculation_MathTrig::SUMX2MY2
SUMX2PY2 | PHPExcel_Calculation_MathTrig::SUMX2PY2
SUMXMY2 | PHPExcel_Calculation_MathTrig::SUMXMY2
TAN | tan
TANH | tanh
TRUNC | PHPExcel_Calculation_MathTrig::TRUNC
## CATEGORY_STATISTICAL
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
AVEDEV | PHPExcel_Calculation_Statistical::AVEDEV
AVERAGE | PHPExcel_Calculation_Statistical::AVERAGE
AVERAGEA | PHPExcel_Calculation_Statistical::AVERAGEA
AVERAGEIF | PHPExcel_Calculation_Statistical::AVERAGEIF
AVERAGEIFS | **\*\*\* Not yet Implemented**
BETADIST | PHPExcel_Calculation_Statistical::BETADIST
BETAINV | PHPExcel_Calculation_Statistical::BETAINV
BINOMDIST | PHPExcel_Calculation_Statistical::BINOMDIST
CHIDIST | PHPExcel_Calculation_Statistical::CHIDIST
CHIINV | PHPExcel_Calculation_Statistical::CHIINV
CHITEST | **\*\*\* Not yet Implemented**
CONFIDENCE | PHPExcel_Calculation_Statistical::CONFIDENCE
CORREL | PHPExcel_Calculation_Statistical::CORREL
COUNT | PHPExcel_Calculation_Statistical::COUNT
COUNTA | PHPExcel_Calculation_Statistical::COUNTA
COUNTBLANK | PHPExcel_Calculation_Statistical::COUNTBLANK
COUNTIF | PHPExcel_Calculation_Statistical::COUNTIF
COUNTIFS | **\*\*\* Not yet Implemented**
COVAR | PHPExcel_Calculation_Statistical::COVAR
CRITBINOM | PHPExcel_Calculation_Statistical::CRITBINOM
DEVSQ | PHPExcel_Calculation_Statistical::DEVSQ
EXPONDIST | PHPExcel_Calculation_Statistical::EXPONDIST
FDIST | **\*\*\* Not yet Implemented**
FINV | **\*\*\* Not yet Implemented**
FISHER | PHPExcel_Calculation_Statistical::FISHER
FISHERINV | PHPExcel_Calculation_Statistical::FISHERINV
FORECAST | PHPExcel_Calculation_Statistical::FORECAST
FREQUENCY | **\*\*\* Not yet Implemented**
FTEST | **\*\*\* Not yet Implemented**
GAMMADIST | PHPExcel_Calculation_Statistical::GAMMADIST
GAMMAINV | PHPExcel_Calculation_Statistical::GAMMAINV
GAMMALN | PHPExcel_Calculation_Statistical::GAMMALN
GEOMEAN | PHPExcel_Calculation_Statistical::GEOMEAN
GROWTH | PHPExcel_Calculation_Statistical::GROWTH
HARMEAN | PHPExcel_Calculation_Statistical::HARMEAN
HYPGEOMDIST | PHPExcel_Calculation_Statistical::HYPGEOMDIST
INTERCEPT | PHPExcel_Calculation_Statistical::INTERCEPT
KURT | PHPExcel_Calculation_Statistical::KURT
LARGE | PHPExcel_Calculation_Statistical::LARGE
LINEST | PHPExcel_Calculation_Statistical::LINEST
LOGEST | PHPExcel_Calculation_Statistical::LOGEST
LOGINV | PHPExcel_Calculation_Statistical::LOGINV
LOGNORMDIST | PHPExcel_Calculation_Statistical::LOGNORMDIST
MAX | PHPExcel_Calculation_Statistical::MAX
MAXA | PHPExcel_Calculation_Statistical::MAXA
MAXIF | PHPExcel_Calculation_Statistical::MAXIF
MEDIAN | PHPExcel_Calculation_Statistical::MEDIAN
MEDIANIF | **\*\*\* Not yet Implemented**
MIN | PHPExcel_Calculation_Statistical::MIN
MINA | PHPExcel_Calculation_Statistical::MINA
MINIF | PHPExcel_Calculation_Statistical::MINIF
MODE | PHPExcel_Calculation_Statistical::MODE
NEGBINOMDIST | PHPExcel_Calculation_Statistical::NEGBINOMDIST
NORMDIST | PHPExcel_Calculation_Statistical::NORMDIST
NORMINV | PHPExcel_Calculation_Statistical::NORMINV
NORMSDIST | PHPExcel_Calculation_Statistical::NORMSDIST
NORMSINV | PHPExcel_Calculation_Statistical::NORMSINV
PEARSON | PHPExcel_Calculation_Statistical::CORREL
PERCENTILE | PHPExcel_Calculation_Statistical::PERCENTILE
PERCENTRANK | PHPExcel_Calculation_Statistical::PERCENTRANK
PERMUT | PHPExcel_Calculation_Statistical::PERMUT
POISSON | PHPExcel_Calculation_Statistical::POISSON
PROB | **\*\*\* Not yet Implemented**
QUARTILE | PHPExcel_Calculation_Statistical::QUARTILE
RANK | PHPExcel_Calculation_Statistical::RANK
RSQ | PHPExcel_Calculation_Statistical::RSQ
SKEW | PHPExcel_Calculation_Statistical::SKEW
SLOPE | PHPExcel_Calculation_Statistical::SLOPE
SMALL | PHPExcel_Calculation_Statistical::SMALL
STANDARDIZE | PHPExcel_Calculation_Statistical::STANDARDIZE
STDEV | PHPExcel_Calculation_Statistical::STDEV
STDEVA | PHPExcel_Calculation_Statistical::STDEVA
STDEVP | PHPExcel_Calculation_Statistical::STDEVP
STDEVPA | PHPExcel_Calculation_Statistical::STDEVPA
STEYX | PHPExcel_Calculation_Statistical::STEYX
TDIST | PHPExcel_Calculation_Statistical::TDIST
TINV | PHPExcel_Calculation_Statistical::TINV
TREND | PHPExcel_Calculation_Statistical::TREND
TRIMMEAN | PHPExcel_Calculation_Statistical::TRIMMEAN
TTEST | **\*\*\* Not yet Implemented**
VAR | PHPExcel_Calculation_Statistical::VARFunc
VARA | PHPExcel_Calculation_Statistical::VARA
VARP | PHPExcel_Calculation_Statistical::VARP
VARPA | PHPExcel_Calculation_Statistical::VARPA
WEIBULL | PHPExcel_Calculation_Statistical::WEIBULL
ZTEST | PHPExcel_Calculation_Statistical::ZTEST
## CATEGORY_TEXT_AND_DATA
Excel Function | PHPExcel Function
--------------------|-------------------------------------------
ASC | **\*\*\* Not yet Implemented**
BAHTTEXT | **\*\*\* Not yet Implemented**
CHAR | PHPExcel_Calculation_TextData::CHARACTER
CLEAN | PHPExcel_Calculation_TextData::TRIMNONPRINTABLE
CODE | PHPExcel_Calculation_TextData::ASCIICODE
CONCATENATE | PHPExcel_Calculation_TextData::CONCATENATE
DOLLAR | PHPExcel_Calculation_TextData::DOLLAR
EXACT | **\*\*\* Not yet Implemented**
FIND | PHPExcel_Calculation_TextData::SEARCHSENSITIVE
FINDB | PHPExcel_Calculation_TextData::SEARCHSENSITIVE
FIXED | PHPExcel_Calculation_TextData::FIXEDFORMAT
JIS | **\*\*\* Not yet Implemented**
LEFT | PHPExcel_Calculation_TextData::LEFT
LEFTB | PHPExcel_Calculation_TextData::LEFT
LEN | PHPExcel_Calculation_TextData::STRINGLENGTH
LENB | PHPExcel_Calculation_TextData::STRINGLENGTH
LOWER | PHPExcel_Calculation_TextData::LOWERCASE
MID | PHPExcel_Calculation_TextData::MID
MIDB | PHPExcel_Calculation_TextData::MID
PHONETIC | **\*\*\* Not yet Implemented**
PROPER | PHPExcel_Calculation_TextData::PROPERCASE
REPLACE | PHPExcel_Calculation_TextData::REPLACE
REPLACEB | PHPExcel_Calculation_TextData::REPLACE
REPT | str_repeat
RIGHT | PHPExcel_Calculation_TextData::RIGHT
RIGHTB | PHPExcel_Calculation_TextData::RIGHT
SEARCH | PHPExcel_Calculation_TextData::SEARCHINSENSITIVE
SEARCHB | PHPExcel_Calculation_TextData::SEARCHINSENSITIVE
SUBSTITUTE | PHPExcel_Calculation_TextData::SUBSTITUTE
T | PHPExcel_Calculation_TextData::RETURNSTRING
TEXT | PHPExcel_Calculation_TextData::TEXTFORMAT
TRIM | PHPExcel_Calculation_TextData::TRIMSPACES
UPPER | PHPExcel_Calculation_TextData::UPPERCASE
VALUE | **\*\*\* Not yet Implemented**

View File

@ -0,0 +1,485 @@
#A
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
ABS | CATEGORY_MATH_AND_TRIG | abs
ACCRINT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::ACCRINT
ACCRINTM | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::ACCRINTM
ACOS | CATEGORY_MATH_AND_TRIG | acos
ACOSH | CATEGORY_MATH_AND_TRIG | acosh
ADDRESS | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::CELL_ADDRESS
AMORDEGRC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::AMORDEGRC
AMORLINC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::AMORLINC
AND | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::LOGICAL_AND
AREAS | CATEGORY_LOOKUP_AND_REFERENCE | **\*\*\* Not yet Implemented**
ASC | CATEGORY_TEXT_AND_DATA | **\*\*\* Not yet Implemented**
ASIN | CATEGORY_MATH_AND_TRIG | asin
ASINH | CATEGORY_MATH_AND_TRIG | asinh
ATAN | CATEGORY_MATH_AND_TRIG | atan
ATAN2 | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::REVERSE_ATAN2
ATANH | CATEGORY_MATH_AND_TRIG | atanh
AVEDEV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::AVEDEV
AVERAGE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::AVERAGE
AVERAGEA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::AVERAGEA
AVERAGEIF | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::AVERAGEIF
AVERAGEIFS | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
#B
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
BAHTTEXT | CATEGORY_TEXT_AND_DATA | **\*\*\* Not yet Implemented**
BESSELI | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BESSELI
BESSELJ | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BESSELJ
BESSELK | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BESSELK
BESSELY | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BESSELY
BETADIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::BETADIST
BETAINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::BETAINV
BIN2DEC | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BINTODEC
BIN2HEX | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BINTOHEX
BIN2OCT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::BINTOOCT
BINOMDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::BINOMDIST
#C
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
CEILING | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::CEILING
CELL | CATEGORY_INFORMATION | **\*\*\* Not yet Implemented**
CHAR | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::CHARACTER
CHIDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::CHIDIST
CHIINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::CHIINV
CHITEST | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
CHOOSE | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::CHOOSE
CLEAN | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::TRIMNONPRINTABLE
CODE | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::ASCIICODE
COLUMN | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::COLUMN
COLUMNS | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::COLUMNS
COMBIN | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::COMBIN
COMPLEX | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::COMPLEX
CONCATENATE | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::CONCATENATE
CONFIDENCE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::CONFIDENCE
CONVERT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::CONVERTUOM
CORREL | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::CORREL
COS | CATEGORY_MATH_AND_TRIG | cos
COSH | CATEGORY_MATH_AND_TRIG | cosh
COUNT | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::COUNT
COUNTA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::COUNTA
COUNTBLANK | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::COUNTBLANK
COUNTIF | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::COUNTIF
COUNTIFS | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
COUPDAYBS | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::COUPDAYBS
COUPDAYS | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::COUPDAYS
COUPDAYSNC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::COUPDAYSNC
COUPNCD | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::COUPNCD
COUPNUM | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::COUPNUM
COUPPCD | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::COUPPCD
COVAR | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::COVAR
CRITBINOM | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::CRITBINOM
CUBEKPIMEMBER | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUBEMEMBER | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUBEMEMBERPROPERTY | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUBERANKEDMEMBER | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUBESET | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUBESETCOUNT | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUBEVALUE | CATEGORY_CUBE | **\*\*\* Not yet Implemented**
CUMIPMT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::CUMIPMT
CUMPRINC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::CUMPRINC
#D
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
DATE | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DATE
DATEDIF | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DATEDIF
DATEVALUE | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DATEVALUE
DAVERAGE | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DAVERAGE
DAY | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DAYOFMONTH
DAYS360 | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DAYS360
DB | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::DB
DCOUNT | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DCOUNT
DCOUNTA | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DCOUNTA
DDB | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::DDB
DEC2BIN | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::DECTOBIN
DEC2HEX | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::DECTOHEX
DEC2OCT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::DECTOOCT
DEGREES | CATEGORY_MATH_AND_TRIG | rad2deg
DELTA | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::DELTA
DEVSQ | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::DEVSQ
DGET | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DGET
DISC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::DISC
DMAX | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DMAX
DMIN | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DMIN
DOLLAR | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::DOLLAR
DOLLARDE | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::DOLLARDE
DOLLARFR | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::DOLLARFR
DPRODUCT | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DPRODUCT
DSTDEV | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DSTDEV
DSTDEVP | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DSTDEVP
DSUM | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DSUM
DURATION | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
DVAR | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DVAR
DVARP | CATEGORY_DATABASE | PHPExcel_Calculation_Database::DVARP
#E
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
EDATE | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::EDATE
EFFECT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::EFFECT
EOMONTH | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::EOMONTH
ERF | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::ERF
ERFC | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::ERFC
ERROR.TYPE | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::ERROR_TYPE
EVEN | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::EVEN
EXACT | CATEGORY_TEXT_AND_DATA | **\*\*\* Not yet Implemented**
EXP | CATEGORY_MATH_AND_TRIG | exp
EXPONDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::EXPONDIST
#F
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
FACT | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::FACT
FACTDOUBLE | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::FACTDOUBLE
FALSE | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::FALSE
FDIST | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
FIND | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::SEARCHSENSITIVE
FINDB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::SEARCHSENSITIVE
FINV | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
FISHER | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::FISHER
FISHERINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::FISHERINV
FIXED | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::FIXEDFORMAT
FLOOR | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::FLOOR
FORECAST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::FORECAST
FREQUENCY | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
FTEST | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
FV | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::FV
FVSCHEDULE | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::FVSCHEDULE
#G
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
GAMMADIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::GAMMADIST
GAMMAINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::GAMMAINV
GAMMALN | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::GAMMALN
GCD | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::GCD
GEOMEAN | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::GEOMEAN
GESTEP | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::GESTEP
GETPIVOTDATA | CATEGORY_LOOKUP_AND_REFERENCE | **\*\*\* Not yet Implemented**
GROWTH | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::GROWTH
#H
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
HARMEAN | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::HARMEAN
HEX2BIN | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::HEXTOBIN
HEX2DEC | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::HEXTODEC
HEX2OCT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::HEXTOOCT
HLOOKUP | CATEGORY_LOOKUP_AND_REFERENCE | **\*\*\* Not yet Implemented**
HOUR | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::HOUROFDAY
HYPERLINK | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::HYPERLINK
HYPGEOMDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::HYPGEOMDIST
#I
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
IF | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::STATEMENT_IF
IFERROR | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::IFERROR
IMABS | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMABS
IMAGINARY | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMAGINARY
IMARGUMENT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMARGUMENT
IMCONJUGATE | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMCONJUGATE
IMCOS | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMCOS
IMDIV | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMDIV
IMEXP | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMEXP
IMLN | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMLN
IMLOG10 | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMLOG10
IMLOG2 | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMLOG2
IMPOWER | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMPOWER
IMPRODUCT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMPRODUCT
IMREAL | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMREAL
IMSIN | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMSIN
IMSQRT | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMSQRT
IMSUB | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMSUB
IMSUM | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::IMSUM
INDEX | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::INDEX
INDIRECT | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::INDIRECT
INFO | CATEGORY_INFORMATION | **\*\*\* Not yet Implemented**
INT | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::INT
INTERCEPT | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::INTERCEPT
INTRATE | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::INTRATE
IPMT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::IPMT
IRR | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::IRR
ISBLANK | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_BLANK
ISERR | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_ERR
ISERROR | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_ERROR
ISEVEN | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_EVEN
ISLOGICAL | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_LOGICAL
ISNA | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_NA
ISNONTEXT | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_NONTEXT
ISNUMBER | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_NUMBER
ISODD | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_ODD
ISPMT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::ISPMT
ISREF | CATEGORY_INFORMATION | **\*\*\* Not yet Implemented**
ISTEXT | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::IS_TEXT
#J
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
JIS | CATEGORY_TEXT_AND_DATA | **\*\*\* Not yet Implemented**
#K
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
KURT | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::KURT
#L
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
LARGE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::LARGE
LCM | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::LCM
LEFT | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::LEFT
LEFTB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::LEFT
LEN | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::STRINGLENGTH
LENB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::STRINGLENGTH
LINEST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::LINEST
LN | CATEGORY_MATH_AND_TRIG | log
LOG | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::LOG_BASE
LOG10 | CATEGORY_MATH_AND_TRIG | log10
LOGEST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::LOGEST
LOGINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::LOGINV
LOGNORMDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::LOGNORMDIST
LOOKUP | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::LOOKUP
LOWER | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::LOWERCASE
#M
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
MATCH | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::MATCH
MAX | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MAX
MAXA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MAXA
MAXIF | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MAXIF
MDETERM | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::MDETERM
MDURATION | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
MEDIAN | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MEDIAN
MEDIANIF | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
MID | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::MID
MIDB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::MID
MIN | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MIN
MINA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MINA
MINIF | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MINIF
MINUTE | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::MINUTEOFHOUR
MINVERSE | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::MINVERSE
MIRR | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::MIRR
MMULT | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::MMULT
MOD | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::MOD
MODE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::MODE
MONTH | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::MONTHOFYEAR
MROUND | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::MROUND
MULTINOMIAL | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::MULTINOMIAL
#N
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
N | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::N
NA | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::NA
NEGBINOMDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::NEGBINOMDIST
NETWORKDAYS | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::NETWORKDAYS
NOMINAL | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::NOMINAL
NORMDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::NORMDIST
NORMINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::NORMINV
NORMSDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::NORMSDIST
NORMSINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::NORMSINV
NOT | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::NOT
NOW | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DATETIMENOW
NPER | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::NPER
NPV | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::NPV
#O
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
OCT2BIN | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::OCTTOBIN
OCT2DEC | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::OCTTODEC
OCT2HEX | CATEGORY_ENGINEERING | PHPExcel_Calculation_Engineering::OCTTOHEX
ODD | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::ODD
ODDFPRICE | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
ODDFYIELD | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
ODDLPRICE | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
ODDLYIELD | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
OFFSET | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::OFFSET
OR | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::LOGICAL_OR
#P
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
PEARSON | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::CORREL
PERCENTILE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::PERCENTILE
PERCENTRANK | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::PERCENTRANK
PERMUT | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::PERMUT
PHONETIC | CATEGORY_TEXT_AND_DATA | **\*\*\* Not yet Implemented**
PI | CATEGORY_MATH_AND_TRIG | pi
PMT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::PMT
POISSON | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::POISSON
POWER | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::POWER
PPMT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::PPMT
PRICE | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::PRICE
PRICEDISC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::PRICEDISC
PRICEMAT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::PRICEMAT
PROB | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
PRODUCT | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::PRODUCT
PROPER | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::PROPERCASE
PV | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::PV
#Q
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
QUARTILE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::QUARTILE
QUOTIENT | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::QUOTIENT
#R
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
RADIANS | CATEGORY_MATH_AND_TRIG | deg2rad
RAND | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::RAND
RANDBETWEEN | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::RAND
RANK | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::RANK
RATE | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::RATE
RECEIVED | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::RECEIVED
REPLACE | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::REPLACE
REPLACEB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::REPLACE
REPT | CATEGORY_TEXT_AND_DATA | str_repeat
RIGHT | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::RIGHT
RIGHTB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::RIGHT
ROMAN | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::ROMAN
ROUND | CATEGORY_MATH_AND_TRIG | round
ROUNDDOWN | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::ROUNDDOWN
ROUNDUP | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::ROUNDUP
ROW | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::ROW
ROWS | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::ROWS
RSQ | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::RSQ
RTD | CATEGORY_LOOKUP_AND_REFERENCE | **\*\*\* Not yet Implemented**
#S
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
SEARCH | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::SEARCHINSENSITIVE
SEARCHB | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::SEARCHINSENSITIVE
SECOND | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::SECONDOFMINUTE
SERIESSUM | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SERIESSUM
SIGN | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SIGN
SIN | CATEGORY_MATH_AND_TRIG | sin
SINH | CATEGORY_MATH_AND_TRIG | sinh
SKEW | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::SKEW
SLN | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::SLN
SLOPE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::SLOPE
SMALL | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::SMALL
SQRT | CATEGORY_MATH_AND_TRIG | sqrt
SQRTPI | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SQRTPI
STANDARDIZE | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::STANDARDIZE
STDEV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::STDEV
STDEVA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::STDEVA
STDEVP | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::STDEVP
STDEVPA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::STDEVPA
STEYX | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::STEYX
SUBSTITUTE | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::SUBSTITUTE
SUBTOTAL | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUBTOTAL
SUM | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUM
SUMIF | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUMIF
SUMIFS | CATEGORY_MATH_AND_TRIG | **\*\*\* Not yet Implemented**
SUMPRODUCT | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUMPRODUCT
SUMSQ | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUMSQ
SUMX2MY2 | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUMX2MY2
SUMX2PY2 | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUMX2PY2
SUMXMY2 | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::SUMXMY2
SYD | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::SYD
#T
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
T | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::RETURNSTRING
TAN | CATEGORY_MATH_AND_TRIG | tan
TANH | CATEGORY_MATH_AND_TRIG | tanh
TBILLEQ | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::TBILLEQ
TBILLPRICE | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::TBILLPRICE
TBILLYIELD | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::TBILLYIELD
TDIST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::TDIST
TEXT | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::TEXTFORMAT
TIME | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::TIME
TIMEVALUE | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::TIMEVALUE
TINV | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::TINV
TODAY | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DATENOW
TRANSPOSE | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::TRANSPOSE
TREND | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::TREND
TRIM | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::TRIMSPACES
TRIMMEAN | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::TRIMMEAN
TRUE | CATEGORY_LOGICAL | PHPExcel_Calculation_Logical::TRUE
TRUNC | CATEGORY_MATH_AND_TRIG | PHPExcel_Calculation_MathTrig::TRUNC
TTEST | CATEGORY_STATISTICAL | **\*\*\* Not yet Implemented**
TYPE | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::TYPE
#U
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
UPPER | CATEGORY_TEXT_AND_DATA | PHPExcel_Calculation_TextData::UPPERCASE
USDOLLAR | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
#V
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
VALUE | CATEGORY_TEXT_AND_DATA | **\*\*\* Not yet Implemented**
VAR | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::VARFunc
VARA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::VARA
VARP | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::VARP
VARPA | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::VARPA
VDB | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
VERSION | CATEGORY_INFORMATION | PHPExcel_Calculation_Functions::VERSION
VLOOKUP | CATEGORY_LOOKUP_AND_REFERENCE | PHPExcel_Calculation_LookupRef::VLOOKUP
#W
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
WEEKDAY | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::DAYOFWEEK
WEEKNUM | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::WEEKOFYEAR
WEIBULL | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::WEIBULL
WORKDAY | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::WORKDAY
#X
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
XIRR | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::XIRR
XNPV | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::XNPV
#Y
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
YEAR | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::YEAR
YEARFRAC | CATEGORY_DATE_AND_TIME | PHPExcel_Calculation_DateTime::YEARFRAC
YIELD | CATEGORY_FINANCIAL | **\*\*\* Not yet Implemented**
YIELDDISC | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::YIELDDISC
YIELDMAT | CATEGORY_FINANCIAL | PHPExcel_Calculation_Financial::YIELDMAT
#Z
Excel Function | Category | PHPExcel Function
--------------------|--------------------------------|-------------------------------------------
ZTEST | CATEGORY_STATISTICAL | PHPExcel_Calculation_Statistical::ZTEST

View File

@ -0,0 +1,179 @@
# PHPExcel Developer Documentation
## Prerequisites, Installation, FAQ and Links
### Software requirements
The following software is required to develop using PHPExcel:
- PHP version 5.2.0 or newer
- PHP extension php_zip enabled [^phpzip_footnote]
- PHP extension php_xml enabled
- PHP extension php_gd2 enabled (if not compiled in)
### Installation instructions
Installation is quite easy: copy the contents of the Classes folder to any location within your application source directories.
*Example:*
If your web root folder is /var/www/ you may want to create a subfolder called /var/www/Classes/ and copy the files into that folder so you end up with files:
/var/www/Classes/PHPExcel.php
/var/www/Classes/PHPExcel/Calculation.php
/var/www/Classes/PHPExcel/Cell.php
...
### Getting started
A good way to get started is to run some of the tests included in the download.
Copy the "Examples" folder next to your "Classes" folder from above so you end up with:
/var/www/Examples/01simple.php
/var/www/Examples/02types.php
...
Start running the tests by pointing your browser to the test scripts:
http://example.com/Tests/01simple.php
http://example.com/Tests/02types.php
...
**Note:** It may be necessary to modify the include/require statements at the beginning of each of the test scripts if your "Classes" folder from above is named differently.
### Useful links and tools
There are some links and tools which are very useful when developing using PHPExcel. Please refer to the [PHPExcel CodePlex pages][2] for an update version of the list below.
#### OpenXML / SpreadsheetML
- __File format documentation__
[http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm][3]
- __OpenXML Explained e-book__
[http://openxmldeveloper.org/articles/1970.aspx][4]
- __Microsoft Office Compatibility Pack for Word, Excel, and PowerPoint 2007 File Formats__
[http://www.microsoft.com/downloads/details.aspx?familyid=941b3470-3ae9-4aee-8f43-c6bb74cd1466&displaylang=en][5]
- __OpenXML Package Explorer__
[http://www.codeplex.com/PackageExplorer/][6]
### Frequently asked questions
The up-to-date F.A.Q. page for PHPExcel can be found on [http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=FAQ&referringTitle=Requirements][7].
##### There seems to be a problem with character encoding...
It is necessary to use UTF-8 encoding for all texts in PHPExcel. If the script uses different encoding then you can convert those texts with PHP's iconv() or mb_convert_encoding() functions.
##### PHP complains about ZipArchive not being found
Make sure you meet all requirements, especially php_zip extension should be enabled.
The ZipArchive class is only required when reading or writing formats that use Zip compression (Excel2007 and OOCalc). Since version 1.7.6 the PCLZip library has been bundled with PHPExcel as an alternative to the ZipArchive class.
This can be enabled by calling:
```php
PHPExcel_Settings::setZipClass(PHPExcel_Settings::PCLZIP);
```
*before* calling the save method of the Excel2007 Writer.
You can revert to using ZipArchive by calling:
```php
PHPExcel_Settings::setZipClass(PHPExcel_Settings::ZIPARCHIVE);
```
At present, this only allows you to write Excel2007 files without the need for ZipArchive (not to read Excel2007 or OOCalc)
##### Excel 2007 cannot open the file generated by PHPExcel_Writer_2007 on Windows
"Excel found unreadable content in '*.xlsx'. Do you want to recover the contents of this workbook? If you trust the source of this workbook, click Yes."
Some older versions of the 5.2.x php_zip extension on Windows contain an error when creating ZIP files. The version that can be found on [http://snaps.php.net/win32/php5.2-win32-latest.zip][8] should work at all times.
Alternatively, upgrading to at least PHP 5.2.9 should solve the problem.
If you can't locate a clean copy of ZipArchive, then you can use the PCLZip library as an alternative when writing Excel2007 files, as described above.
##### Fatal error: Allowed memory size of xxx bytes exhausted (tried to allocate yyy bytes) in zzz on line aaa
PHPExcel holds an "in memory" representation of a spreadsheet, so it is susceptible to PHP's memory limitations. The memory made available to PHP can be increased by editing the value of the memory_limit directive in your php.ini file, or by using ini_set('memory_limit', '128M') within your code (ISP permitting).
Some Readers and Writers are faster than others, and they also use differing amounts of memory. You can find some indication of the relative performance and memory usage for the different Readers and Writers, over the different versions of PHPExcel, on the [discussion board][9].
If you've already increased memory to a maximum, or can't change your memory limit, then [this discussion][10] on the board describes some of the methods that can be applied to reduce the memory usage of your scripts using PHPExcel.
##### Protection on my worksheet is not working?
When you make use of any of the worksheet protection features (e.g. cell range protection, prohibiting deleting rows, ...), make sure you enable worksheet security. This can for example be done like this:
```php
$objPHPExcel->getActiveSheet()->getProtection()->setSheet(true);
```
##### Feature X is not working with PHPExcel_Reader_Y / PHPExcel_Writer_Z
Not all features of PHPExcel are implemented in all of the Reader / Writer classes. This is mostly due to underlying libraries not supporting a specific feature or not having implemented a specific feature.
For example autofilter is not implemented in PEAR Spreadsheet_Excel_writer, which is the base of our Excel5 writer.
We are slowly building up a list of features, together with the different readers and writers that support them, in the "Functionality Cross-Reference.xls" file in the /Documentation folder.
##### Formulas don't seem to be calculated in Excel2003 using compatibility pack?
This is normal behaviour of the compatibility pack, Excel2007 displays this correctly. Use PHPExcel_Writer_Excel5 if you really need calculated values, or force recalculation in Excel2003.
##### Setting column width is not 100% accurate
Trying to set column width, I experience one problem. When I open the file in Excel, the actual width is 0.71 less than it should be.
The short answer is that PHPExcel uses a measure where padding is included. See section: "Setting a column's width" for more details.
##### How do I use PHPExcel with my framework
- There are some instructions for using PHPExcel with Joomla on the [Joomla message board][11]
- A page of advice on using [PHPExcel in the Yii framework][12]
- [The Bakery][13] has some helper classes for reading and writing with PHPExcel within CakePHP
- Integrating [PHPExcel into Kohana 3][14] and [?????????? PHPExcel ? Kohana Framework][15]
- Using [PHPExcel with Typo3][16]
##### Joomla Autoloader interferes with PHPExcel Autoloader
Thanks to peterrlynch for the following advice on resolving issues between the [PHPExcel autoloader and Joomla Autoloader][17]
#### Tutorials
- __English PHPExcel tutorial__
[http://openxmldeveloper.org][18]
- __French PHPExcel tutorial__
[http://g-ernaelsten.developpez.com/tutoriels/excel2007/][19]
- __A Japanese-language introduction to PHPExcel__
[http://journal.mycom.co.jp/articles/2009/03/06/phpexcel/index.html][21]
[2]: http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=Documents&referringTitle=Home
[3]: http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm
[4]: http://openxmldeveloper.org/articles/1970.aspx
[5]: http://www.microsoft.com/downloads/details.aspx?familyid=941b3470-3ae9-4aee-8f43-c6bb74cd1466&displaylang=en
[6]: http://www.codeplex.com/PackageExplorer/
[7]: http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=FAQ&referringTitle=Requirements
[8]: http://snaps.php.net/win32/php5.2-win32-latest.zip
[9]: http://phpexcel.codeplex.com/Thread/View.aspx?ThreadId=234150
[10]: http://phpexcel.codeplex.com/Thread/View.aspx?ThreadId=242712
[11]: http://http:/forum.joomla.org/viewtopic.php?f=304&t=433060
[12]: http://www.yiiframework.com/wiki/101/how-to-use-phpexcel-external-library-with-yii/
[13]: http://bakery.cakephp.org/articles/melgior/2010/01/26/simple-excel-spreadsheet-helper
[14]: http://www.flynsarmy.com/2010/07/phpexcel-module-for-kohana-3/
[15]: http://szpargalki.blogspot.com/2011/02/phpexcel-kohana-framework.html
[16]: http://typo3.org/documentation/document-library/extension-manuals/phpexcel_library/1.1.1/view/toc/0/
[17]: http://phpexcel.codeplex.com/discussions/211925
[18]: http://openxmldeveloper.org
[19]: http://g-ernaelsten.developpez.com/tutoriels/excel2007/
[20]: http://www.web-junior.net/sozdanie-excel-fajjlov-s-pomoshhyu-phpexcel/
[21]: http://journal.mycom.co.jp/articles/2009/03/06/phpexcel/index.html
[^phpzip_footnote]: __php_zip__ is only needed by __PHPExcel_Reader_Excel2007__, __PHPExcel_Writer_Excel2007__ and __PHPExcel_Reader_OOCalc__. In other words, if you need PHPExcel to handle .xlsx or .ods files you will need the zip extension, but otherwise not.<br />You can remove this dependency for writing Excel2007 files (though not yet for reading) by using the PCLZip library that is bundled with PHPExcel. See the FAQ section of this document for details about this. PCLZip does have a dependency on PHP's zlib extension being enabled.

View File

@ -0,0 +1,76 @@
# PHPExcel Developer Documentation
## Architecture
### Schematical
![01-schematic.png](./images/01-schematic.png "Basic Architecture Schematic")
### Lazy Loader
PHPExcel implements an autoloader or "lazy loader", which means that it is not necessary to include every file within PHPExcel. It is only necessary to include the initial PHPExcel class file, then the autoloader will include other class files as and when required, so only those files that are actually required by your script will be loaded into PHP memory. The main benefit of this is that it reduces the memory footprint of PHPExcel itself, so that it uses less PHP memory.
If your own scripts already define an autoload function, then this may be overwritten by the PHPExcel autoload function. For example, if you have:
```php
function __autoload($class) {
...
}
```
Do this instead:
```php
function myAutoload($class) {
...
}
spl_autoload_register('myAutoload');
```
Your autoloader will then co-exist with the autoloader of PHPExcel.
### Spreadsheet in memory
PHPExcel's architecture is built in a way that it can serve as an in-memory spreadsheet. This means that, if one would want to create a web based view of a spreadsheet which communicates with PHPExcel's object model, he would only have to write the front-end code.
Just like desktop spreadsheet software, PHPExcel represents a spreadsheet containing one or more worksheets, which contain cells with data, formulas, images, ...
### Readers and writers
On its own, PHPExcel does not provide the functionality to read from or write to a persisted spreadsheet (on disk or in a database). To provide that functionality, readers and writers can be used.
By default, the PHPExcel package provides some readers and writers, including one for the Open XML spreadsheet format (a.k.a. Excel 2007 file format). You are not limited to the default readers and writers, as you are free to implement the PHPExcel_Reader_IReader and PHPExcel_Writer_IWriter interface in a custom class.
![02-readers-writers.png](./images/02-readers-writers.png "Readers/Writers")
### Fluent interfaces
PHPExcel supports fluent interfaces in most locations. This means that you can easily "chain" calls to specific methods without requiring a new PHP statement. For example, take the following code:
```php
$objPHPExcel->getProperties()->setCreator("Maarten Balliauw");
$objPHPExcel->getProperties()->setLastModifiedBy("Maarten Balliauw");
$objPHPExcel->getProperties()->setTitle("Office 2007 XLSX Test Document");
$objPHPExcel->getProperties()->setSubject("Office 2007 XLSX Test Document");
$objPHPExcel->getProperties()->setDescription("Test document for Office 2007 XLSX, generated using PHP classes.");
$objPHPExcel->getProperties()->setKeywords("office 2007 openxml php");
$objPHPExcel->getProperties()->setCategory("Test result file");
```
This can be rewritten as:
```php
$objPHPExcel->getProperties()
->setCreator("Maarten Balliauw")
->setLastModifiedBy("Maarten Balliauw")
->setTitle("Office 2007 XLSX Test Document")
->setSubject("Office 2007 XLSX Test Document")
->setDescription("Test document for Office 2007 XLSX, generated using PHP classes.")
->setKeywords("office 2007 openxml php")
->setCategory("Test result file");
```
> __Using fluent interfaces is not required__
> Fluent interfaces have been implemented to provide a convenient programming API. Use of them is not required, but can make your code easier to read and maintain.
> It can also improve performance, as you are reducing the overall number of calls to PHPExcel methods: in the above example, the `getProperties()` method is being called only once rather than 7 times in the non-fluent version.

View File

@ -0,0 +1,34 @@
# PHPExcel Developer Documentation
## Creating a spreadsheet
### The PHPExcel class
The PHPExcel class is the core of PHPExcel. It contains references to the contained worksheets, document security settings and document meta data.
To simplify the PHPExcel concept: the PHPExcel class represents your workbook.
Typically, you will create a workbook in one of two ways, either by loading it from a spreadsheet file, or creating it manually. A third option, though less commonly used, is cloning an existing workbook that has been created using one of the previous two methods.
#### Loading a Workbook from a file
Details of the different spreadsheet formats supported, and the options available to read them into a PHPExcel object are described fully in the PHPExcel User Documentation - Reading Spreadsheet Files document.
```php
$inputFileName = './sampleData/example1.xls';
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = PHPExcel_IOFactory::load($inputFileName);
```
#### Creating a new workbook
If you want to create a new workbook, rather than load one from file, then you simply need to instantiate it as a new PHPExcel object.
```php
/** Create a new PHPExcel Object **/
$objPHPExcel = new PHPExcel();
```
A new workbook will always be created with a single worksheet.

View File

@ -0,0 +1,140 @@
# PHPExcel Developer Documentation
## Configuration Settings
Once you have included the PHPExcel files in your script, but before instantiating a PHPExcel object or loading a workbook file, there are a number of configuration options that can be set which will affect the subsequent behaviour of the script.
### Cell Caching
PHPExcel uses an average of about 1k/cell in your worksheets, so large workbooks can quickly use up available memory. Cell caching provides a mechanism that allows PHPExcel to maintain the cell objects in a smaller size of memory, on disk, or in APC, memcache or Wincache, rather than in PHP memory. This allows you to reduce the memory usage for large workbooks, although at a cost of speed to access cell data.
By default, PHPExcel still holds all cell objects in memory, but you can specify alternatives. To enable cell caching, you must call the PHPExcel_Settings::setCacheStorageMethod() method, passing in the caching method that you wish to use.
```php
$cacheMethod = PHPExcel_CachedObjectStorageFactory::cache_in_memory;
PHPExcel_Settings::setCacheStorageMethod($cacheMethod);
```
setCacheStorageMethod() will return a boolean true on success, false on failure (for example if trying to cache to APC when APC is not enabled).
A separate cache is maintained for each individual worksheet, and is automatically created when the worksheet is instantiated based on the caching method and settings that you have configured. You cannot change the configuration settings once you have started to read a workbook, or have created your first worksheet.
Currently, the following caching methods are available.
#### PHPExcel_CachedObjectStorageFactory::cache_in_memory
The default. If you don't initialise any caching method, then this is the method that PHPExcel will use. Cell objects are maintained in PHP memory as at present.
#### PHPExcel_CachedObjectStorageFactory::cache_in_memory_serialized
Using this caching method, cells are held in PHP memory as an array of serialized objects, which reduces the memory footprint with minimal performance overhead.
#### PHPExcel_CachedObjectStorageFactory::cache_in_memory_gzip
Like cache_in_memory_serialized, this method holds cells in PHP memory as an array of serialized objects, but gzipped to reduce the memory usage still further, although access to read or write a cell is slightly slower.
#### PHPExcel_CachedObjectStorageFactory::cache_igbinary
Uses PHPs igbinary extension (if its available) to serialize cell objects in memory. This is normally faster and uses less memory than standard PHP serialization, but isnt available in most hosting environments.
#### PHPExcel_CachedObjectStorageFactory::cache_to_discISAM
When using cache_to_discISAM all cells are held in a temporary disk file, with only an index to their location in that file maintained in PHP memory. This is slower than any of the cache_in_memory methods, but significantly reduces the memory footprint. By default, PHPExcel will use PHP's temp directory for the cache file, but you can specify a different directory when initialising cache_to_discISAM.
```php
$cacheMethod = PHPExcel_CachedObjectStorageFactory:: cache_to_discISAM;
$cacheSettings = array(
'dir' => '/usr/local/tmp'
);
PHPExcel_Settings::setCacheStorageMethod($cacheMethod, $cacheSettings);
```
The temporary disk file is automatically deleted when your script terminates.
#### PHPExcel_CachedObjectStorageFactory::cache_to_phpTemp
Like cache_to_discISAM, when using cache_to_phpTemp all cells are held in the php://temp I/O stream, with only an index to their location maintained in PHP memory. In PHP, the php://memory wrapper stores data in the memory: php://temp behaves similarly, but uses a temporary file for storing the data when a certain memory limit is reached. The default is 1 MB, but you can change this when initialising cache_to_phpTemp.
```php
$cacheMethod = PHPExcel_CachedObjectStorageFactory:: cache_to_phpTemp;
$cacheSettings = array(
'memoryCacheSize' => '8MB'
);
PHPExcel_Settings::setCacheStorageMethod($cacheMethod, $cacheSettings);
```
The php://temp file is automatically deleted when your script terminates.
#### PHPExcel_CachedObjectStorageFactory::cache_to_apc
When using cache_to_apc, cell objects are maintained in APC with only an index maintained in PHP memory to identify that the cell exists. By default, an APC cache timeout of 600 seconds is used, which should be enough for most applications: although it is possible to change this when initialising cache_to_APC.
```php
$cacheMethod = PHPExcel_CachedObjectStorageFactory::cache_to_APC;
$cacheSettings = array(
'cacheTime' => 600
);
PHPExcel_Settings::setCacheStorageMethod($cacheMethod, $cacheSettings);
```
When your script terminates all entries will be cleared from APC, regardless of the cacheTime value, so it cannot be used for persistent storage using this mechanism.
#### PHPExcel_CachedObjectStorageFactory::cache_to_memcache
When using cache_to_memcache, cell objects are maintained in memcache with only an index maintained in PHP memory to identify that the cell exists.
By default, PHPExcel looks for a memcache server on localhost at port 11211. It also sets a memcache timeout limit of 600 seconds. If you are running memcache on a different server or port, then you can change these defaults when you initialise cache_to_memcache:
```php
$cacheMethod = PHPExcel_CachedObjectStorageFactory::cache_to_memcache;
$cacheSettings = array(
'memcacheServer' => 'localhost',
'memcachePort' => 11211,
'cacheTime' => 600
);
PHPExcel_Settings::setCacheStorageMethod($cacheMethod, $cacheSettings);
```
When your script terminates all entries will be cleared from memcache, regardless of the cacheTime value, so it cannot be used for persistent storage using this mechanism.
#### PHPExcel_CachedObjectStorageFactory::cache_to_wincache
When using cache_to_wincache, cell objects are maintained in Wincache with only an index maintained in PHP memory to identify that the cell exists. By default, a Wincache cache timeout of 600 seconds is used, which should be enough for most applications: although it is possible to change this when initialising cache_to_wincache.
```php
$cacheMethod = PHPExcel_CachedObjectStorageFactory::cache_to_wincache;
$cacheSettings = array(
'cacheTime' => 600
);
PHPExcel_Settings::setCacheStorageMethod($cacheMethod, $cacheSettings);
```
When your script terminates all entries will be cleared from Wincache, regardless of the cacheTime value, so it cannot be used for persistent storage using this mechanism.
#### PHPExcel_CachedObjectStorageFactory::cache_to_sqlite
Uses an SQLite 2 "in-memory" database for caching cell data. Unlike other caching methods, neither cells nor an index are held in PHP memory - an indexed database table makes it unnecessary to hold any index in PHP memory, which makes this the most memory-efficient of the cell caching methods.
#### PHPExcel_CachedObjectStorageFactory::cache_to_sqlite3;
Uses an SQLite 3 "in-memory" database for caching cell data. Unlike other caching methods, neither cells nor an index are held in PHP memory - an indexed database table makes it unnecessary to hold any index in PHP memory, which makes this the most memory-efficient of the cell caching methods.
### Language/Locale
Some localisation elements have been included in PHPExcel. You can set a locale by changing the settings. To set the locale to Brazilian Portuguese you would use:
```php
$locale = 'pt_br';
$validLocale = PHPExcel_Settings::setLocale($locale);
if (!$validLocale) {
echo 'Unable to set locale to ' . $locale . " - reverting to en_us" . PHP_EOL;
}
```
If Brazilian Portuguese language files aren't available, then Portuguese will be enabled instead: if Portuguese language files aren't available, then the setLocale() method will return an error, and American English (en_us) settings will be used throughout.
More details of the features available once a locale has been set, including a list of the languages and locales currently supported, can be found in the section of this document entitled "Locale Settings for Formulae".

View File

@ -0,0 +1,13 @@
# PHPExcel Developer Documentation
## Clearing a Workbook from memory
The PHPExcel object contains cyclic references (e.g. the workbook is linked to the worksheets, and the worksheets are linked to their parent workbook) which cause problems when PHP tries to clear the objects from memory when they are unset(), or at the end of a function when they are in local scope. The result of this is "memory leaks", which can easily use a large amount of PHP's limited memory.
This can only be resolved manually: if you need to unset a workbook, then you also need to "break" these cyclic references before doing so. PHPExcel provides the disconnectWorksheets() method for this purpose.
```php
$objPHPExcel->disconnectWorksheets();
unset($objPHPExcel);
```

View File

@ -0,0 +1,94 @@
# PHPExcel Developer Documentation
## Worksheets
A worksheet is a collection of cells, formulae, images, graphs, etc. It holds all data necessary to represent a spreadsheet worksheet.
When you load a workbook from a spreadsheet file, it will be loaded with all its existing worksheets (unless you specified that only certain sheets should be loaded). When you load from non-spreadsheet files (such as a CSV or HTML file) or from spreadsheet formats that don't identify worksheets by name (such as SYLK), then a single worksheet called "WorkSheet1" will be created containing the data from that file.
When you instantiate a new workbook, PHPExcel will create it with a single worksheet called "WorkSheet1"<22>.
The `getSheetCount()` method will tell you the number of worksheets in the workbook; while the `getSheetNames()` method will return a list of all worksheets in the workbook, indexed by the order in which their "tabs" would appear when opened in MS Excel (or other appropriate Spreadsheet program).
Individual worksheets can be accessed by name, or by their index position in the workbook. The index position represents the order that each worksheet "tab" is shown when the workbook is opened in MS Excel (or other appropriate Spreadsheet program). To access a sheet by its index, use the `getSheet()` method.
```php
// Get the second sheet in the workbook
// Note that sheets are indexed from 0
$objPHPExcel->getSheet(1);
```
If you don't specify a sheet index, then the first worksheet will be returned.
Methods also exist allowing you to reorder the worksheets in the workbook.
To access a sheet by name, use the `getSheetByName()` method, specifying the name of the worksheet that you want to access.
```php
// Retrieve the worksheet called 'Worksheet 1'
$objPHPExcel->getSheetByName('Worksheet 1');
```
Alternatively, one worksheet is always the currently active worksheet, and you can access that directly. The currently active worksheet is the one that will be active when the workbook is opened in MS Excel (or other appropriate Spreadsheet program).
```php
// Retrieve the current active worksheet
$objPHPExcel->getActiveSheet();
```
You can change the currently active sheet by index or by name using the `setActiveSheetIndex()` and `setActiveSheetIndexByName()` methods.
### Adding a new Worksheet
You can add a new worksheet to the workbook using the `createSheet()` method of the PHPExcel object. By default, this will be created as a new "last<73>" sheet; but you can also specify an index position as an argument, and the worksheet will be inserted at that position, shuffling all subsequent worksheets in the collection down a place.
```php
$objPHPExcel->createSheet();
```
A new worksheet created using this method will be called "Worksheet\<n\>"<22> where "\<n\>"<22> is the lowest number possible to guarantee that the title is unique.
Alternatively, you can instantiate a new worksheet (setting the title to whatever you choose) and then insert it into your workbook using the addSheet() method.
```php
// Create a new worksheet called "My Data"
$myWorkSheet = new PHPExcel_Worksheet($objPHPExcel, 'My Data');
// Attach the "My Data" worksheet as the first worksheet in the PHPExcel object
$objPHPExcel->addSheet($myWorkSheet, 0);
```
If you don't specify an index position as the second argument, then the new worksheet will be added after the last existing worksheet.
### Copying Worksheets
Sheets within the same workbook can be copied by creating a clone of the worksheet you wish to copy, and then using the addSheet() method to insert the clone into the workbook.
```php
$objClonedWorksheet = clone $objPHPExcel->getSheetByName('Worksheet 1');
$objClonedWorksheet->setTitle('Copy of Worksheet 1')
$objPHPExcel->addSheet($objClonedWorksheet);
```
You can also copy worksheets from one workbook to another, though this is more complex as PHPExcel also has to replicate the styling between the two workbooks. The addExternalSheet() method is provided for this purpose.
```
$objClonedWorksheet = clone $objPHPExcel1->getSheetByName('Worksheet 1');
$objPHPExcel->addExternalSheet($objClonedWorksheet);
```
In both cases, it is the developer's responsibility to ensure that worksheet names are not duplicated. PHPExcel will throw an exception if you attempt to copy worksheets that will result in a duplicate name.
### Removing a Worksheet
You can delete a worksheet from a workbook, identified by its index position, using the removeSheetByIndex() method
```php
$sheetIndex = $objPHPExcel->getIndex(
$objPHPExcel->getSheetByName('Worksheet 1')
);
$objPHPExcel->removeSheetByIndex($sheetIndex);
```
If the currently active worksheet is deleted, then the sheet at the previous index position will become the currently active sheet.

View File

@ -0,0 +1,390 @@
# PHPExcel Developer Documentation
## Accessing cells
Accessing cells in a PHPExcel worksheet should be pretty straightforward. This topic lists some of the options to access a cell.
### Setting a cell value by coordinate
Setting a cell value by coordinate can be done using the worksheet's `setCellValue()` method.
```php
// Set cell A1 with a string value
$objPHPExcel->getActiveSheet()->setCellValue('A1', 'PHPExcel');
// Set cell A2 with a numeric value
$objPHPExcel->getActiveSheet()->setCellValue('A2', 12345.6789);
// Set cell A3 with a boolean value
$objPHPExcel->getActiveSheet()->setCellValue('A3', TRUE);
// Set cell A4 with a formula
$objPHPExcel->getActiveSheet()->setCellValue(
'A4',
'=IF(A3, CONCATENATE(A1, " ", A2), CONCATENATE(A2, " ", A1))'
);
```
Alternatively, you can retrieve the cell object, and then call the cells setValue() method:
```php
$objPHPExcel->getActiveSheet()
->getCell('B8')
->setValue('Some value');
```
**Excel DataTypes**
MS Excel supports 7 basic datatypes
- string
- number
- boolean
- null
- formula
- error
- Inline (or rich text) string
By default, when you call the worksheet's `setCellValue()` method or the cell's `setValue()` method, PHPExcel will use the appropriate datatype for PHP nulls, booleans, floats or integers; or cast any string data value that you pass to the method into the most appropriate datatype, so numeric strings will be cast to numbers, while string values beginning with “=” will be converted to a formula. Strings that aren't numeric, or that don't begin with a leading "=" will be treated as genuine string values.
This "conversion" is handled by a cell "value binder", and you can write custom "value binders" to change the behaviour of these "conversions". The standard PHPExcel package also provides an "advanced value binder" that handles a number of more complex conversions, such as converting strings with a fractional format like "3/4" to a number value (0.75 in this case) and setting an appropriate "fraction" number format mask. Similarly, strings like "5%" will be converted to a value of 0.05, and a percentage number format mask applied, and strings containing values that look like dates will be converted to Excel serialized datetimestamp values, and a corresponding mask applied. This is particularly useful when loading data from csv files, or setting cell values from a database.
Formats handled by the advanced value binder include
- TRUE or FALSE (dependent on locale settings) are converted to booleans.
- Numeric strings identified as scientific (exponential) format are converted to numbers.
- Fractions and vulgar fractions are converted to numbers, and an appropriate number format mask applied.
- Percentages are converted to numbers, divided by 100, and an appropriate number format mask applied.
- Dates and times are converted to Excel timestamp values (numbers), and an appropriate number format mask applied.
- When strings contain a newline character ("\n"), then the cell styling is set to wrap.
You can read more about value binders later in this section of the documentation.
#### Setting a date and/or time value in a cell
Date or time values are held as timestamp in Excel (a simple floating point value), and a number format mask is used to show how that value should be formatted; so if we want to store a date in a cell, we need to calculate the correct Excel timestamp, and set a number format mask.
```php
// Get the current date/time and convert to an Excel date/time
$dateTimeNow = time();
$excelDateValue = PHPExcel_Shared_Date::PHPToExcel( $dateTimeNow );
// Set cell A6 with the Excel date/time value
$objPHPExcel->getActiveSheet()->setCellValue(
'A6',
$excelDateValue
);
// Set the number format mask so that the excel timestamp will be displayed as a human-readable date/time
$objPHPExcel->getActiveSheet()->getStyle('A6')
->getNumberFormat()
->setFormatCode(
PHPExcel_Style_NumberFormat::FORMAT_DATE_DATETIME
);
```
#### Setting a number with leading zeroes
By default, PHPExcel will automatically detect the value type and set it to the appropriate Excel numeric datatype. This type conversion is handled by a value binder, as described in the section of this document entitled "Using value binders to facilitate data entry".
Numbers don't have leading zeroes, so if you try to set a numeric value that does have leading zeroes (such as a telephone number) then these will be normally be lost as the value is cast to a number, so "01513789642" will be displayed as 1513789642.
There are two ways you can force PHPExcel to override this behaviour.
Firstly, you can set the datatype explicitly as a string so that it is not converted to a number.
```php
// Set cell A8 with a numeric value, but tell PHPExcel it should be treated as a string
$objPHPExcel->getActiveSheet()->setCellValueExplicit(
'A8',
"01513789642",
PHPExcel_Cell_DataType::TYPE_STRING
);
```
Alternatively, you can use a number format mask to display the value with leading zeroes.
```php
// Set cell A9 with a numeric value
$objPHPExcel->getActiveSheet()->setCellValue('A9', 1513789642);
// Set a number format mask to display the value as 11 digits with leading zeroes
$objPHPExcel->getActiveSheet()->getStyle('A9')
->getNumberFormat()
->setFormatCode(
'00000000000'
);
```
With number format masking, you can even break up the digits into groups to make the value more easily readable.
```php
// Set cell A10 with a numeric value
$objPHPExcel->getActiveSheet()->setCellValue('A10', 1513789642);
// Set a number format mask to display the value as 11 digits with leading zeroes
$objPHPExcel->getActiveSheet()->getStyle('A10')
->getNumberFormat()
->setFormatCode(
'0000-000-0000'
);
```
![07-simple-example-1.png](./images/07-simple-example-1.png "")
**Note** that not all complex format masks such as this one will work when retrieving a formatted value to display "on screen", or for certain writers such as HTML or PDF, but it will work with the true spreadsheet writers (Excel2007 and Excel5).
### Setting a range of cells from an array
It is also possible to set a range of cell values in a single call by passing an array of values to the `fromArray()` method.
```php
$arrayData = array(
array(NULL, 2010, 2011, 2012),
array('Q1', 12, 15, 21),
array('Q2', 56, 73, 86),
array('Q3', 52, 61, 69),
array('Q4', 30, 32, 0),
);
$objPHPExcel->getActiveSheet()
->fromArray(
$arrayData, // The data to set
NULL, // Array values with this value will not be set
'C3' // Top left coordinate of the worksheet range where
// we want to set these values (default is A1)
);
```
![07-simple-example-2.png](./images/07-simple-example-2.png "")
If you pass a 2-d array, then this will be treated as a series of rows and columns. A 1-d array will be treated as a single row, which is particularly useful if you're fetching an array of data from a database.
```php
$rowArray = array('Value1', 'Value2', 'Value3', 'Value4');
$objPHPExcel->getActiveSheet()
->fromArray(
$rowArray, // The data to set
NULL, // Array values with this value will not be set
'C3' // Top left coordinate of the worksheet range where
// we want to set these values (default is A1)
);
```
![07-simple-example-3.png](./images/07-simple-example-3.png "")
If you have a simple 1-d array, and want to write it as a column, then the following will convert it into an appropriately structured 2-d array that can be fed to the `fromArray()` method:
```php
$rowArray = array('Value1', 'Value2', 'Value3', 'Value4');
$columnArray = array_chunk($rowArray, 1);
$objPHPExcel->getActiveSheet()
->fromArray(
$columnArray, // The data to set
NULL, // Array values with this value will not be set
'C3' // Top left coordinate of the worksheet range where
// we want to set these values (default is A1)
);
```
![07-simple-example-4.png](./images/07-simple-example-4.png "")
### Retrieving a cell value by coordinate
To retrieve the value of a cell, the cell should first be retrieved from the worksheet using the `getCell()` method. A cell's value can be read using the `getValue()` method.
```php
// Get the value fom cell A1
$cellValue = $objPHPExcel->getActiveSheet()->getCell('A1')
->getValue();
```
This will retrieve the raw, unformatted value contained in the cell.
If a cell contains a formula, and you need to retrieve the calculated value rather than the formula itself, then use the cell's `getCalculatedValue()` method. This is further explained in .
```php
// Get the value fom cell A4
$cellValue = $objPHPExcel->getActiveSheet()->getCell('A4')
->getCalculatedValue();
```
Alternatively, if you want to see the value with any cell formatting applied (e.g. for a human-readable date or time value), then you can use the cell's `getFormattedValue()` method.
```php
// Get the value fom cell A6
$cellValue = $objPHPExcel->getActiveSheet()->getCell('A6')
->getFormattedValue();
```
### Setting a cell value by column and row
Setting a cell value by coordinate can be done using the worksheet's `setCellValueByColumnAndRow()` method.
```php
// Set cell B5 with a string value
$objPHPExcel->getActiveSheet()->setCellValueByColumnAndRow(1, 5, 'PHPExcel');
```
**Note** that column references start with '0' for column 'A', rather than from '1'.
### Retrieving a cell value by column and row
To retrieve the value of a cell, the cell should first be retrieved from the worksheet using the getCellByColumnAndRow method. A cells value can be read again using the following line of code:
```php
// Get the value fom cell B5
$cellValue = $objPHPExcel->getActiveSheet()->getCellByColumnAndRow(1, 5)
->getValue();
```
If you need the calculated value of a cell, use the following code. This is further explained in .
```php
// Get the value fom cell A4
$cellValue = $objPHPExcel->getActiveSheet()->getCellByColumnAndRow(0, 4)
->getCalculatedValue();
```
### Retrieving a range of cell values to an array
It is also possible to retrieve a range of cell values to an array in a single call using the `toArray()`, `rangeToArray()` or `namedRangeToArray()` methods.
```php
$dataArray = $objPHPExcel->getActiveSheet()
->rangeToArray(
'C3:E5', // The worksheet range that we want to retrieve
NULL, // Value that should be returned for empty cells
TRUE, // Should formulas be calculated (the equivalent of getCalculatedValue() for each cell)
TRUE, // Should values be formatted (the equivalent of getFormattedValue() for each cell)
TRUE // Should the array be indexed by cell row and cell column
);
```
These methods will all return a 2-d array of rows and columns. The `toArray()` method will return the whole worksheet; `rangeToArray()` will return a specified range or cells; while `namedRangeToArray()` will return the cells within a defined `named range`.
### Looping through cells
#### Looping through cells using iterators
The easiest way to loop cells is by using iterators. Using iterators, one can use foreach to loop worksheets, rows within a worksheet, and cells within a row.
Below is an example where we read all the values in a worksheet and display them in a table.
```php
$objReader = PHPExcel_IOFactory::createReader('Excel2007');
$objReader->setReadDataOnly(TRUE);
$objPHPExcel = $objReader->load("test.xlsx");
$objWorksheet = $objPHPExcel->getActiveSheet();
echo '<table>' . PHP_EOL;
foreach ($objWorksheet->getRowIterator() as $row) {
echo '<tr>' . PHP_EOL;
$cellIterator = $row->getCellIterator();
$cellIterator->setIterateOnlyExistingCells(FALSE); // This loops through all cells,
// even if a cell value is not set.
// By default, only cells that have a value
// set will be iterated.
foreach ($cellIterator as $cell) {
echo '<td>' .
$cell->getValue() .
'</td>' . PHP_EOL;
}
echo '</tr>' . PHP_EOL;
}
echo '</table>' . PHP_EOL;
```
Note that we have set the cell iterator's `setIterateOnlyExistingCells()` to FALSE. This makes the iterator loop all cells within the worksheet range, even if they have not been set.
The cell iterator will return a __NULL__ as the cell value if it is not set in the worksheet.
Setting the cell iterator's setIterateOnlyExistingCells() to FALSE will loop all cells in the worksheet that can be available at that moment. This will create new cells if required and increase memory usage! Only use it if it is intended to loop all cells that are possibly available.
#### Looping through cells using indexes
One can use the possibility to access cell values by column and row index like (0,1) instead of 'A1' for reading and writing cell values in loops.
Note: In PHPExcel column index is 0-based while row index is 1-based. That means 'A1' ~ (0,1)
Below is an example where we read all the values in a worksheet and display them in a table.
```php
$objReader = PHPExcel_IOFactory::createReader('Excel2007');
$objReader->setReadDataOnly(TRUE);
$objPHPExcel = $objReader->load("test.xlsx");
$objWorksheet = $objPHPExcel->getActiveSheet();
// Get the highest row and column numbers referenced in the worksheet
$highestRow = $objWorksheet->getHighestRow(); // e.g. 10
$highestColumn = $objWorksheet->getHighestColumn(); // e.g 'F'
$highestColumnIndex = PHPExcel_Cell::columnIndexFromString($highestColumn); // e.g. 5
echo '<table>' . "\n";
for ($row = 1; $row <= $highestRow; ++$row) {
echo '<tr>' . PHP_EOL;
for ($col = 0; $col <= $highestColumnIndex; ++$col) {
echo '<td>' .
$objWorksheet->getCellByColumnAndRow($col, $row)
->getValue() .
'</td>' . PHP_EOL;
}
echo '</tr>' . PHP_EOL;
}
echo '</table>' . PHP_EOL;
```
Alternatively, you can take advantage of PHP's "Perl-style" character incrementors to loop through the cells by coordinate:
```php
$objReader = PHPExcel_IOFactory::createReader('Excel2007');
$objReader->setReadDataOnly(TRUE);
$objPHPExcel = $objReader->load("test.xlsx");
$objWorksheet = $objPHPExcel->getActiveSheet();
// Get the highest row number and column letter referenced in the worksheet
$highestRow = $objWorksheet->getHighestRow(); // e.g. 10
$highestColumn = $objWorksheet->getHighestColumn(); // e.g 'F'
// Increment the highest column letter
$highestColumn++;
echo '<table>' . "\n";
for ($row = 1; $row <= $highestRow; ++$row) {
echo '<tr>' . PHP_EOL;
for ($col = 'A'; $col != $highestColumn; ++$col) {
echo '<td>' .
$objWorksheet->getCell($col . $row)
->getValue() .
'</td>' . PHP_EOL;
}
echo '</tr>' . PHP_EOL;
}
echo '</table>' . PHP_EOL;
```
Note that we can't use a <= comparison here, because 'AA' would match as <= 'B', so we increment the highest column letter and then loop while $col != the incremented highest column.
### Using value binders to facilitate data entry
Internally, PHPExcel uses a default PHPExcel_Cell_IValueBinder implementation (PHPExcel_Cell_DefaultValueBinder) to determine data types of entered data using a cell's `setValue()` method (the `setValueExplicit()` method bypasses this check).
Optionally, the default behaviour of PHPExcel can be modified, allowing easier data entry. For example, a PHPExcel_Cell_AdvancedValueBinder class is available. It automatically converts percentages, number in scientific format, and dates entered as strings to the correct format, also setting the cell's style information. The following example demonstrates how to set the value binder in PHPExcel:
```php
/** PHPExcel */
require_once 'PHPExcel.php';
// Set value binder
PHPExcel_Cell::setValueBinder( new PHPExcel_Cell_AdvancedValueBinder() );
// Create new PHPExcel object
$objPHPExcel = new PHPExcel();
// ...
// Add some data, resembling some different data types
$objPHPExcel->getActiveSheet()->setCellValue('A4', 'Percentage value:');
// Converts the string value to 0.1 and sets percentage cell style
$objPHPExcel->getActiveSheet()->setCellValue('B4', '10%');
$objPHPExcel->getActiveSheet()->setCellValue('A5', 'Date/time value:');
// Converts the string value to an Excel datestamp and sets the date format cell style
$objPHPExcel->getActiveSheet()->setCellValue('B5', '21 December 1983');
```
__Creating your own value binder is easy.__
When advanced value binding is required, you can implement the PHPExcel_Cell_IValueBinder interface or extend the PHPExcel_Cell_DefaultValueBinder or PHPExcel_Cell_AdvancedValueBinder classes.

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,52 @@
# PHPExcel Developer Documentation
## Using the PHPExcel calculation engine
### Performing formula calculations
As PHPExcel represents an in-memory spreadsheet, it also offers formula calculation capabilities. A cell can be of a value type (containing a number or text), or a formula type (containing a formula which can be evaluated). For example, the formula "=SUM(A1:A10)" evaluates to the sum of values in A1, A2, ..., A10.
To calculate a formula, you can call the cell containing the formulas method getCalculatedValue(), for example:
```php
$objPHPExcel->getActiveSheet()->getCell('E11')->getCalculatedValue();
```
If you write the following line of code in the invoice demo included with PHPExcel, it evaluates to the value "64":
![09-command-line-calculation.png](./images/09-command-line-calculation.png "")
Another nice feature of PHPExcel's formula parser, is that it can automatically adjust a formula when inserting/removing rows/columns. Here's an example:
![09-formula-in-cell-1.png](./images/09-formula-in-cell-1.png "")
You see that the formula contained in cell E11 is "SUM(E4:E9)". Now, when I write the following line of code, two new product lines are added:
```php
$objPHPExcel->getActiveSheet()->insertNewRowBefore(7, 2);
```
![09-formula-in-cell-2.png](./images/09-formula-in-cell-2.png "")
Did you notice? The formula in the former cell E11 (now E13, as I inserted 2 new rows), changed to "SUM(E4:E11)". Also, the inserted cells duplicate style information of the previous cell, just like Excel's behaviour. Note that you can both insert rows and columns.
### Known limitations
There are some known limitations to the PHPExcel calculation engine. Most of them are due to the fact that an Excel formula is converted into PHP code before being executed. This means that Excel formula calculation is subject to PHP's language characteristics.
#### Operator precedence
In Excel '+' wins over '&', just like '*' wins over '+' in ordinary algebra. The former rule is not what one finds using the calculation engine shipped with PHPExcel.
Reference for operator precedence in Excel: [http://support.microsoft.com/kb/25189][18]
Reference for operator precedence in PHP: [http://www.php.net/operators][19]
#### Formulas involving numbers and text
Formulas involving numbers and text may produce unexpected results or even unreadable file contents. For example, the formula '=3+"Hello "' is expected to produce an error in Excel (#VALUE!). Due to the fact that PHP converts “Hello” to a numeric value (zero), the result of this formula is evaluated as 3 instead of evaluating as an error. This also causes the Excel document being generated as containing unreadable content.
Reference for this behaviour in PHP: [http://be.php.net/manual/en/language.types.string.php#language.types.string.conversion][20]
[18]: http://support.microsoft.com/kb/25189
[19]: http://www.php.net/operators
[20]: http://be.php.net/manual/en/language.types.string.php#language.types.string.conversion

View File

@ -0,0 +1,714 @@
# PHPExcel Developer Documentation
## Reading and writing to file
As you already know from part REF _Ref191885438 \w \h 3.3 REF _Ref191885438 \h Readers and writers, reading and writing to a persisted storage is not possible using the base PHPExcel classes. For this purpose, PHPExcel provides readers and writers, which are implementations of PHPExcel_Writer_IReader and PHPExcel_Writer_IWriter.
### PHPExcel_IOFactory
The PHPExcel API offers multiple methods to create a PHPExcel_Writer_IReader or PHPExcel_Writer_IWriter instance:
Direct creation via PHPExcel_IOFactory. All examples underneath demonstrate the direct creation method. Note that you can also use the PHPExcel_IOFactory class to do this.
#### Creating PHPExcel_Reader_IReader using PHPExcel_IOFactory
There are 2 methods for reading in a file into PHPExcel: using automatic file type resolving or explicitly.
Automatic file type resolving checks the different PHPExcel_Reader_IReader distributed with PHPExcel. If one of them can load the specified file name, the file is loaded using that PHPExcel_Reader_IReader. Explicit mode requires you to specify which PHPExcel_Reader_IReader should be used.
You can create a PHPExcel_Reader_IReader instance using PHPExcel_IOFactory in automatic file type resolving mode using the following code sample:
```php
$objPHPExcel = PHPExcel_IOFactory::load("05featuredemo.xlsx");
```
A typical use of this feature is when you need to read files uploaded by your users, and you dont know whether they are uploading xls or xlsx files.
If you need to set some properties on the reader, (e.g. to only read data, see more about this later), then you may instead want to use this variant:
```php
$objReader = PHPExcel_IOFactory::createReaderForFile("05featuredemo.xlsx");
$objReader->setReadDataOnly(true);
$objReader->load("05featuredemo.xlsx");
```
You can create a PHPExcel_Reader_IReader instance using PHPExcel_IOFactory in explicit mode using the following code sample:
```php
$objReader = PHPExcel_IOFactory::createReader("Excel2007");
$objPHPExcel = $objReader->load("05featuredemo.xlsx");
```
Note that automatic type resolving mode is slightly slower than explicit mode.
#### Creating PHPExcel_Writer_IWriter using PHPExcel_IOFactory
You can create a PHPExcel_Writer_Iwriter instance using PHPExcel_IOFactory:
```php
$objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, "Excel2007");
$objWriter->save("05featuredemo.xlsx");
```
### Excel 2007 (SpreadsheetML) file format
Excel2007 file format is the main file format of PHPExcel. It allows outputting the in-memory spreadsheet to a .xlsx file.
#### PHPExcel_Reader_Excel2007
##### Reading a spreadsheet
You can read an .xlsx file using the following code:
```php
$objReader = new PHPExcel_Reader_Excel2007();
$objPHPExcel = $objReader->load("05featuredemo.xlsx");
```
##### Read data only
You can set the option setReadDataOnly on the reader, to instruct the reader to ignore styling, data validation, … and just read cell data:
```php
$objReader = new PHPExcel_Reader_Excel2007();
$objReader->setReadDataOnly(true);
$objPHPExcel = $objReader->load("05featuredemo.xlsx");
```
##### Read specific sheets only
You can set the option setLoadSheetsOnly on the reader, to instruct the reader to only load the sheets with a given name:
```php
$objReader = new PHPExcel_Reader_Excel2007();
$objReader->setLoadSheetsOnly( array("Sheet 1", "My special sheet") );
$objPHPExcel = $objReader->load("05featuredemo.xlsx");
```
##### Read specific cells only
You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
The following code will only read row 1 and rows 20 30 of any sheet in the Excel file:
```php
class MyReadFilter implements PHPExcel_Reader_IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
if ($row == 1 || ($row >= 20 && $row <= 30)) {
return true;
}
return false;
}
}
$objReader = new PHPExcel_Reader_Excel2007();
$objReader->setReadFilter( new MyReadFilter() );
$objPHPExcel = $objReader->load("06largescale.xlsx");
```
#### PHPExcel_Writer_Excel2007
##### Writing a spreadsheet
You can write an .xlsx file using the following code:
```php
$objWriter = new PHPExcel_Writer_Excel2007($objPHPExcel);
$objWriter->save("05featuredemo.xlsx");
```
##### Formula pre-calculation
By default, this writer pre-calculates all formulas in the spreadsheet. This can be slow on large spreadsheets, and maybe even unwanted. You can however disable formula pre-calculation:
```php
$objWriter = new PHPExcel_Writer_Excel2007($objPHPExcel);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.xlsx");
```
##### Office 2003 compatibility pack
Because of a bug in the Office2003 compatibility pack, there can be some small issues when opening Excel2007 spreadsheets (mostly related to formula calculation). You can enable Office2003 compatibility with the following code:
```
$objWriter = new PHPExcel_Writer_Excel2007($objPHPExcel);
$objWriter->setOffice2003Compatibility(true);
$objWriter->save("05featuredemo.xlsx");
```
__Office2003 compatibility should only be used when needed__
Office2003 compatibility option should only be used when needed. This option disables several Office2007 file format options, resulting in a lower-featured Office2007 spreadsheet when this option is used.
### Excel 5 (BIFF) file format
Excel5 file format is the old Excel file format, implemented in PHPExcel to provide a uniform manner to create both .xlsx and .xls files. It is basically a modified version of [PEAR Spreadsheet_Excel_Writer][21], although it has been extended and has fewer limitations and more features than the old PEAR library. This can read all BIFF versions that use OLE2: BIFF5 (introduced with office 95) through BIFF8, but cannot read earlier versions.
Excel5 file format will not be developed any further, it just provides an additional file format for PHPExcel.
__Excel5 (BIFF) limitations__
Please note that BIFF file format has some limits regarding to styling cells and handling large spreadsheets via PHP.
#### PHPExcel_Reader_Excel5
##### Reading a spreadsheet
You can read an .xls file using the following code:
```php
$objReader = new PHPExcel_Reader_Excel5();
$objPHPExcel = $objReader->load("05featuredemo.xls");
```
##### Read data only
You can set the option setReadDataOnly on the reader, to instruct the reader to ignore styling, data validation, … and just read cell data:
```php
$objReader = new PHPExcel_Reader_Excel5();
$objReader->setReadDataOnly(true);
$objPHPExcel = $objReader->load("05featuredemo.xls");
```
##### Read specific sheets only
You can set the option setLoadSheetsOnly on the reader, to instruct the reader to only load the sheets with a given name:
```php
$objReader = new PHPExcel_Reader_Excel5();
$objReader->setLoadSheetsOnly( array("Sheet 1", "My special sheet") );
$objPHPExcel = $objReader->load("05featuredemo.xls");
```
##### Read specific cells only
You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the Excel file:
```php
class MyReadFilter implements PHPExcel_Reader_IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
if ($row == 1 || ($row >= 20 && $row <= 30)) {
return true;
}
return false;
}
}
$objReader = new PHPExcel_Reader_Excel5();
$objReader->setReadFilter( new MyReadFilter() );
$objPHPExcel = $objReader->load("06largescale.xls");
```
#### PHPExcel_Writer_Excel5
##### Writing a spreadsheet
You can write an .xls file using the following code:
```php
$objWriter = new PHPExcel_Writer_Excel5($objPHPExcel);
$objWriter->save("05featuredemo.xls");
```
### Excel 2003 XML file format
Excel 2003 XML file format is a file format which can be used in older versions of Microsoft Excel.
__Excel 2003 XML limitations__
Please note that Excel 2003 XML format has some limits regarding to styling cells and handling large spreadsheets via PHP.
#### PHPExcel_Reader_Excel2003XML
##### Reading a spreadsheet
You can read an Excel 2003 .xml file using the following code:
```php
$objReader = new PHPExcel_Reader_Excel2003XML();
$objPHPExcel = $objReader->load("05featuredemo.xml");
```
##### Read specific cells only
You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the Excel file:
```php
class MyReadFilter implements PHPExcel_Reader_IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
if ($row == 1 || ($row >= 20 && $row <= 30)) {
return true;
}
return false;
}
}
$objReader = new PHPExcel_Reader_Excel2003XML();
$objReader->setReadFilter( new MyReadFilter() );
$objPHPExcel = $objReader->load("06largescale.xml");
```
### Symbolic LinK (SYLK)
Symbolic Link (SYLK) is a Microsoft file format typically used to exchange data between applications, specifically spreadsheets. SYLK files conventionally have a .slk suffix. Composed of only displayable ANSI characters, it can be easily created and processed by other applications, such as databases.
__SYLK limitations__
Please note that SYLK file format has some limits regarding to styling cells and handling large spreadsheets via PHP.
#### PHPExcel_Reader_SYLK
##### Reading a spreadsheet
You can read an .slk file using the following code:
```php
$objReader = new PHPExcel_Reader_SYLK();
$objPHPExcel = $objReader->load("05featuredemo.slk");
```
##### Read specific cells only
You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the SYLK file:
```php
class MyReadFilter implements PHPExcel_Reader_IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
if ($row == 1 || ($row >= 20 && $row <= 30)) {
return true;
}
return false;
}
}
$objReader = new PHPExcel_Reader_SYLK();
$objReader->setReadFilter( new MyReadFilter() );
$objPHPExcel = $objReader->load("06largescale.slk");
```
### Open/Libre Office (.ods)
Open Office or Libre Office .ods files are the standard file format for Open Office or Libre Office Calc files.
#### PHPExcel_Reader_OOCalc
##### Reading a spreadsheet
You can read an .ods file using the following code:
```php
$objReader = new PHPExcel_Reader_OOCalc();
$objPHPExcel = $objReader->load("05featuredemo.ods");
```
##### Read specific cells only
You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the Calc file:
```php
class MyReadFilter implements PHPExcel_Reader_IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
if ($row == 1 || ($row >= 20 && $row <= 30)) {
return true;
}
return false;
}
}
$objReader = new PHPExcel_Reader_OOcalc();
$objReader->setReadFilter( new MyReadFilter() );
$objPHPExcel = $objReader->load("06largescale.ods");
```
### CSV (Comma Separated Values)
CSV (Comma Separated Values) are often used as an import/export file format with other systems. PHPExcel allows reading and writing to CSV files.
__CSV limitations__
Please note that CSV file format has some limits regarding to styling cells, number formatting, ...
#### PHPExcel_Reader_CSV
##### Reading a CSV file
You can read a .csv file using the following code:
```php
$objReader = new PHPExcel_Reader_CSV();
$objPHPExcel = $objReader->load("sample.csv");
```
##### Setting CSV options
Often, CSV files are not really “comma separated”, or use semicolon (;) as a separator. You can instruct PHPExcel_Reader_CSV some options before reading a CSV file.
Note that PHPExcel_Reader_CSV by default assumes that the loaded CSV file is UTF-8 encoded. If you are reading CSV files that were created in Microsoft Office Excel the correct input encoding may rather be Windows-1252 (CP1252). Always make sure that the input encoding is set appropriately.
```php
$objReader = new PHPExcel_Reader_CSV();
$objReader->setInputEncoding('CP1252');
$objReader->setDelimiter(';');
$objReader->setEnclosure('');
$objReader->setLineEnding("\r\n");
$objReader->setSheetIndex(0);
$objPHPExcel = $objReader->load("sample.csv");
```
##### Read a specific worksheet
CSV files can only contain one worksheet. Therefore, you can specify which sheet to read from CSV:
```php
$objReader->setSheetIndex(0);
```
##### Read into existing spreadsheet
When working with CSV files, it might occur that you want to import CSV data into an existing PHPExcel object. The following code loads a CSV file into an existing $objPHPExcel containing some sheets, and imports onto the 6th sheet:
```php
$objReader = new PHPExcel_Reader_CSV();
$objReader->setDelimiter(';');
$objReader->setEnclosure('');
$objReader->setLineEnding("\r\n");
$objReader->setSheetIndex(5);
$objReader->loadIntoExisting("05featuredemo.csv", $objPHPExcel);
```
#### PHPExcel_Writer_CSV
##### Writing a CSV file
You can write a .csv file using the following code:
```php
$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
$objWriter->save("05featuredemo.csv");
```
##### Setting CSV options
Often, CSV files are not really “comma separated”, or use semicolon (;) as a separator. You can instruct PHPExcel_Writer_CSV some options before writing a CSV file:
```php
$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
$objWriter->setDelimiter(';');
$objWriter->setEnclosure('');
$objWriter->setLineEnding("\r\n");
$objWriter->setSheetIndex(0);
$objWriter->save("05featuredemo.csv");
```
##### Write a specific worksheet
CSV files can only contain one worksheet. Therefore, you can specify which sheet to write to CSV:
```php
$objWriter->setSheetIndex(0);
```
##### Formula pre-calculation
By default, this writer pre-calculates all formulas in the spreadsheet. This can be slow on large spreadsheets, and maybe even unwanted. You can however disable formula pre-calculation:
```php
$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.csv");
```
##### Writing UTF-8 CSV files
A CSV file can be marked as UTF-8 by writing a BOM file header. This can be enabled by using the following code:
```php
$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
$objWriter->setUseBOM(true);
$objWriter->save("05featuredemo.csv");
```
##### Decimal and thousands separators
If the worksheet you are exporting contains numbers with decimal or thousands separators then you should think about what characters you want to use for those before doing the export.
By default PHPExcel looks up in the server's locale settings to decide what characters to use. But to avoid problems it is recommended to set the characters explicitly as shown below.
English users will want to use this before doing the export:
```php
PHPExcel_Shared_String::setDecimalSeparator('.');
PHPExcel_Shared_String::setThousandsSeparator(',');
```
German users will want to use the opposite values.
```php
PHPExcel_Shared_String::setDecimalSeparator(',');
PHPExcel_Shared_String::setThousandsSeparator('.');
```
Note that the above code sets decimal and thousand separators as global options. This also affects how HTML and PDF is exported.
### HTML
PHPExcel allows you to read or write a spreadsheet as HTML format, for quick representation of the data in it to anyone who does not have a spreadsheet application on their PC, or loading files saved by other scripts that simply create HTML markup and give it a .xls file extension.
__HTML limitations__
Please note that HTML file format has some limits regarding to styling cells, number formatting, ...
#### PHPExcel_Reader_HTML
##### Reading a spreadsheet
You can read an .html or .htm file using the following code:
```php
$objReader = new PHPExcel_Reader_HTML();
$objPHPExcel = $objReader->load("05featuredemo.html");
```
__HTML limitations__
Please note that HTML reader is still experimental and does not yet support merged cells or nested tables cleanly
#### PHPExcel_Writer_HTML
Please note that PHPExcel_Writer_HTML only outputs the first worksheet by default.
##### Writing a spreadsheet
You can write a .htm file using the following code:
```php
$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
$objWriter->save("05featuredemo.htm");
```
##### Write all worksheets
HTML files can contain one or more worksheets. If you want to write all sheets into a single HTML file, use the following code:
```php
$objWriter->writeAllSheets();
```
##### Write a specific worksheet
HTML files can contain one or more worksheets. Therefore, you can specify which sheet to write to HTML:
```php
$objWriter->setSheetIndex(0);
```
##### Setting the images root of the HTML file
There might be situations where you want to explicitly set the included images root. For example, one might want to see
```html
<img style="position: relative; left: 0px; top: 0px; width: 140px; height: 78px;" src="http://www.domain.com/*images/logo.jpg" border="0">
```
instead of
```html
<img style="position: relative; left: 0px; top: 0px; width: 140px; height: 78px;" src="./images/logo.jpg" border="0">.
```
You can use the following code to achieve this result:
```php
$objWriter->setImagesRoot('http://www.example.com');
```
##### Formula pre-calculation
By default, this writer pre-calculates all formulas in the spreadsheet. This can be slow on large spreadsheets, and maybe even unwanted. You can however disable formula pre-calculation:
```php
$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.htm");
```
##### Embedding generated HTML in a web page
There might be a situation where you want to embed the generated HTML in an existing website. PHPExcel_Writer_HTML provides support to generate only specific parts of the HTML code, which allows you to use these parts in your website.
Supported methods:
- generateHTMLHeader()
- generateStyles()
- generateSheetData()
- generateHTMLFooter()
Here's an example which retrieves all parts independently and merges them into a resulting HTML page:
```php
<?php
$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
echo $objWriter->generateHTMLHeader();
?>
<style>
<!--
html {
font-family: Times New Roman;
font-size: 9pt;
background-color: white;
}
<?php
echo $objWriter->generateStyles(false); // do not write <style> and </style>
?>
-->
</style>
<?php
echo $objWriter->generateSheetData();
echo $objWriter->generateHTMLFooter();
?>
```
##### Writing UTF-8 HTML files
A HTML file can be marked as UTF-8 by writing a BOM file header. This can be enabled by using the following code:
```php
$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
$objWriter->setUseBOM(true);
$objWriter->save("05featuredemo.htm");
```
##### Decimal and thousands separators
See section PHPExcel_Writer_CSV how to control the appearance of these.
### PDF
PHPExcel allows you to write a spreadsheet into PDF format, for fast distribution of represented data.
__PDF limitations__
Please note that PDF file format has some limits regarding to styling cells, number formatting, ...
#### PHPExcel_Writer_PDF
PHPExcels PDF Writer is a wrapper for a 3rd-Party PDF Rendering library such as tcPDF, mPDF or DomPDF. Prior to version 1.7.8 of PHPExcel, the tcPDF library was bundled with PHPExcel; but from version 1.7.8 this was removed. Instead, you must now install a PDF Rendering library yourself; but PHPExcel will work with a number of different libraries.
Currently, the following libraries are supported:
Library | Version used for testing | Downloadable from | PHPExcel Internal Constant
--------|--------------------------|----------------------------------|----------------------------
tcPDF | 5.9 | http://www.tcpdf.org/ | PDF_RENDERER_TCPDF
mPDF | 5.4 | http://www.mpdf1.com/mpdf/ | PDF_RENDERER_MPDF
domPDF | 0.6.0 beta 3 | http://code.google.com/p/dompdf/ | PDF_RENDERER_DOMPDF
The different libraries have different strengths and weaknesses. Some generate better formatted output than others, some are faster or use less memory than others, while some generate smaller .pdf files. It is the developers choice which one they wish to use, appropriate to their own circumstances.
Before instantiating a Writer to generate PDF output, you will need to indicate which Rendering library you are using, and where it is located.
```php
$rendererName = PHPExcel_Settings::PDF_RENDERER_MPDF;
$rendererLibrary = 'mPDF5.4';
$rendererLibraryPath = dirname(__FILE__).'/../../../libraries/PDF/' . $rendererLibrary;
if (!PHPExcel_Settings::setPdfRenderer(
$rendererName,
$rendererLibraryPath
)) {
die(
'Please set the $rendererName and $rendererLibraryPath values' .
PHP_EOL .
' as appropriate for your directory structure'
);
}
```
##### Writing a spreadsheet
Once you have identified the Renderer that you wish to use for PDF generation, you can write a .pdf file using the following code:
```php
$objWriter = new PHPExcel_Writer_PDF($objPHPExcel);
$objWriter->save("05featuredemo.pdf");
```
Please note that PHPExcel_Writer_PDF only outputs the first worksheet by default.
##### Write all worksheets
PDF files can contain one or more worksheets. If you want to write all sheets into a single PDF file, use the following code:
```php
$objWriter->writeAllSheets();
```
##### Write a specific worksheet
PDF files can contain one or more worksheets. Therefore, you can specify which sheet to write to PDF:
```php
$objWriter->setSheetIndex(0);
```
##### Formula pre-calculation
By default, this writer pre-calculates all formulas in the spreadsheet. This can be slow on large spreadsheets, and maybe even unwanted. You can however disable formula pre-calculation:
```php
$objWriter = new PHPExcel_Writer_PDF($objPHPExcel);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.pdf");
```
##### Decimal and thousands separators
See section PHPExcel_Writer_CSV how to control the appearance of these.
### Generating Excel files from templates (read, modify, write)
Readers and writers are the tools that allow you to generate Excel files from templates. This requires less coding effort than generating the Excel file from scratch, especially if your template has many styles, page setup properties, headers etc.
Here is an example how to open a template file, fill in a couple of fields and save it again:
```php
$objPHPexcel = PHPExcel_IOFactory::load('template.xlsx');
$objWorksheet = $objPHPexcel->getActiveSheet();
$objWorksheet->getCell('A1')->setValue('John');
$objWorksheet->getCell('A2')->setValue('Smith');
$objWriter = PHPExcel_IOFactory::createWriter($objPHPexcel, 'Excel5');
$objWriter->save('write.xls');
```
Notice that it is ok to load an xlsx file and generate an xls file.
[21]: http://pear.php.net/package/Spreadsheet_Excel_Writer
[22]: http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=Credits&referringTitle=Home

View File

@ -0,0 +1,100 @@
# PHPExcel Developer Documentation
## Credits
Please refer to the internet page [http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=Credits&referringTitle=Home][22] for up-to-date credits.
## Valid array keys for style applyFromArray()
The following table lists the valid array keys for PHPExcel_Style applyFromArray() classes. If the "Maps to property"<22> column maps a key to a setter, the value provided for that key will be applied directly. If the "Maps to property" column maps a key to a getter, the value provided for that key will be applied as another style array.
__PHPExcel_Style__
Array key | Maps to property
-------------|-------------------
fill | getFill()
font | getFont()
borders | getBorders()
alignment | getAlignment()
numberformat | getNumberFormat()
protection | getProtection()
__PHPExcel_Style_Fill__
Array key | Maps to property
-----------|-------------------
type | setFillType()
rotation | setRotation()
startcolor | getStartColor()
endcolor | getEndColor()
color | getStartColor()
__PHPExcel_Style_Font__
Array key | Maps to property
------------|-------------------
name | setName()
bold | setBold()
italic | setItalic()
underline | setUnderline()
strike | setStrikethrough()
color | getColor()
size | setSize()
superScript | setSuperScript()
subScript | setSubScript()
__PHPExcel_Style_Borders__
Array key | Maps to property
------------------|-------------------
allborders | getLeft(); getRight(); getTop(); getBottom()
left | getLeft()
right | getRight()
top | getTop()
bottom | getBottom()
diagonal | getDiagonal()
vertical | getVertical()
horizontal | getHorizontal()
diagonaldirection | setDiagonalDirection()
outline | setOutline()
__PHPExcel_Style_Border__
Array key | Maps to property
----------|-------------------
style | setBorderStyle()
color | getColor()
__PHPExcel_Style_Alignment__
Array key | Maps to property
------------|-------------------
horizontal | setHorizontal()
vertical | setVertical()
rotation | setTextRotation()
wrap | setWrapText()
shrinkToFit | setShrinkToFit()
indent | setIndent()
__PHPExcel_Style_NumberFormat__
Array key | Maps to property
----------|-------------------
code | setFormatCode()
__PHPExcel_Style_Protection__
Array key | Maps to property
----------|-------------------
locked | setLocked()
hidden | setHidden()
[22]: http://www.codeplex.com/PHPExcel/Wiki/View.aspx?title=Credits&referringTitle=Home

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

View File

@ -0,0 +1,60 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Spreadsheet File Formats
PHPExcel can read a number of different spreadsheet and file formats, although not all features are supported by all of the readers. Check the Functionality Cross-Reference document (Functionality Cross-Reference.xls) for a list that identifies which features are supported by which readers.
Currently, PHPExcel supports the following File Types for Reading:
### Excel5
The Microsoft Excel™ Binary file format (BIFF5 and BIFF8) is a binary file format that was used by Microsoft Excel™ between versions 95 and 2003. The format is supported (to various extents) by most spreadsheet programs. BIFF files normally have an extension of .xls. Documentation describing the format can be found online at [http://msdn.microsoft.com/en-us/library/cc313154(v=office.12).aspx][1] or from [http://download.microsoft.com/download/2/4/8/24862317-78F0-4C4B-B355-C7B2C1D997DB/[MS-XLS].pdf][2] (as a downloadable PDF).
### Excel2003XML
Microsoft Excel™ 2003 included options for a file format called SpreadsheetML. This file is a zipped XML document. It is not very common, but its core features are supported. Documentation for the format can be found at [http://msdn.microsoft.com/en-us/library/aa140066%28office.10%29.aspx][3] though its sadly rather sparse in its detail.
### Excel2007
Microsoft Excel™ 2007 shipped with a new file format, namely Microsoft Office Open XML SpreadsheetML, and Excel 2010 extended this still further with its new features such as sparklines. These files typically have an extension of .xlsx. This format is based around a zipped collection of eXtensible Markup Language (XML) files. Microsoft Office Open XML SpreadsheetML is mostly standardized in ECMA 376 ([http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm][4]) and ISO 29500.
### OOCalc
aka Open Document Format (ODF) or OASIS, this is the OpenOffice.org XML File Format for spreadsheets. It comprises a zip archive including several components all of which are text files, most of these with markup in the eXtensible Markup Language (XML). It is the standard file format for OpenOffice.org Calc and StarCalc, and files typically have an extension of .ods. The published specification for the file format is available from the OASIS Open Office XML Format Technical Committee web page ([http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office#technical][5]). Other information is available from the OpenOffice.org XML File Format web page ([http://xml.openoffice.org/general.html][6]), part of the OpenOffice.org project.
### SYLK
This is the Microsoft Multiplan Symbolic Link Interchange (SYLK) file format. Multiplan was a predecessor to Microsoft Excel™. Files normally have an extension of .slk. While not common, there are still a few applications that generate SYLK files as a cross-platform option, because (despite being limited to a single worksheet) it is a simple format to implement, and supports some basic data and cell formatting options (unlike CSV files).
### Gnumeric
The Gnumeric file format is used by the Gnome Gnumeric spreadsheet application, and typically files have an extension of .gnumeric. The file contents are stored using eXtensible Markup Language (XML) markup, and the file is then compressed using the GNU project's gzip compression library. [http://projects.gnome.org/gnumeric/doc/file-format-gnumeric.shtml][7]
### CSV
Comma Separated Value (CSV) file format is a common structuring strategy for text format files. In CSV flies, each line in the file represents a row of data and (within each line of the file) the different data fields (or columns) are separated from one another using a comma (","). If a data field contains a comma, then it should be enclosed (typically in quotation marks ("). Sometimes tabs "\t", or the pipe symbol ("|"), or a semi-colon (";") are used as separators instead of a comma, although other symbols can be used. Because CSV is a text-only format, it doesn't support any data formatting options.
"CSV" is not a single, well-defined format (although see RFC 4180 for one definition that is commonly used). Rather, in practice the term "CSV" refers to any file that:
- is plain text using a character set such as ASCII, Unicode, EBCDIC, or Shift JIS,
- consists of records (typically one record per line),
- with the records divided into fields separated by delimiters (typically a single reserved character such as comma, semicolon, or tab,
- where every record has the same sequence of fields.
Within these general constraints, many variations are in use. Therefore "CSV" files are not entirely portable. Nevertheless, the variations are fairly small, and many implementations allow users to glance at the file (which is feasible because it is plain text), and then specify the delimiter character(s), quoting rules, etc.
**Warning:** Microsoft Excel™ will open .csv files, but depending on the system's regional settings, it may expect a semicolon as a separator instead of a comma, since in some languages the comma is used as the decimal separator. Also, many regional versions of Excel will not be able to deal with Unicode characters in a CSV file.
### HTML
HyperText Markup Language (HTML) is the main markup language for creating web pages and other information that can be displayed in a web browser. Files typically have an extension of .html or .htm. HTML markup provides a means to create structured documents by denoting structural semantics for text such as headings, paragraphs, lists, links, quotes and other items. Since 1996, the HTML specifications have been maintained, with input from commercial software vendors, by the World Wide Web Consortium (W3C). However, in 2000, HTML also became an international standard (ISO/IEC 15445:2000). HTML 4.01 was published in late 1999, with further errata published through 2001. In 2004 development began on HTML5 in the Web Hypertext Application Technology Working Group (WHATWG), which became a joint deliverable with the W3C in 2008.
[1]: http://msdn.microsoft.com/en-us/library/cc313154(v=office.12).aspx
[2]: http://download.microsoft.com/download/2/4/8/24862317-78F0-4C4B-B355-C7B2C1D997DB/%5bMS-XLS%5d.pdf
[3]: http://msdn.microsoft.com/en-us/library/aa140066%28office.10%29.aspx
[4]: http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm
[5]: http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office
[6]: http://xml.openoffice.org/general.html
[7]: http://projects.gnome.org/gnumeric/doc/file-format-gnumeric.shtml

View File

@ -0,0 +1,13 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Security
XML-based formats such as OfficeOpen XML, Excel2003 XML, OASIS and Gnumeric are susceptible to XML External Entity Processing (XXE) injection attacks (for an explanation of XXE injection see http://websec.io/2012/08/27/Preventing-XEE-in-PHP.html) when reading spreadsheet files. This can lead to:
- Disclosure whether a file is existent
- Server Side Request Forgery
- Command Execution (depending on the installed PHP wrappers)
To prevent this, PHPExcel sets `libxml_disable_entity_loader` to `true` for the XML-based Readers by default.

View File

@ -0,0 +1,21 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Loading a Spreadsheet File
The simplest way to load a workbook file is to let PHPExcel's IO Factory identify the file type and load it, calling the static load() method of the PHPExcel_IOFactory class.
```php
$inputFileName = './sampleData/example1.xls';
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = PHPExcel_IOFactory::load($inputFileName);
```
> See Examples/Reader/exampleReader01.php for a working example of this code.
The load() method will attempt to identify the file type, and instantiate a loader for that file type; using it to load the file and store the data and any formatting in a PHPExcel object.
The method makes an initial guess at the loader to instantiate based on the file extension; but will test the file before actually executing the load: so if (for example) the file is actually a CSV file or contains HTML markup, but that has been given a .xls extension (quite a common practise), it will reject the Excel5 loader that it would normally use for a .xls file; and test the file using the other loaders until it finds the appropriate loader, and then use that to read the file.
While easy to implement in your code, and you don't need to worry about the file type; this isn't the most efficient method to load a file; and it lacks the flexibility to configure the loader in any way before actually reading the file into a PHPExcel object.

View File

@ -0,0 +1,56 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Creating a Reader and Loading a Spreadsheet File
If you know the file type of the spreadsheet file that you need to load, you can instantiate a new reader object for that file type, then use the reader's load() method to read the file to a PHPExcel object. It is possible to instantiate the reader objects for each of the different supported filetype by name. However, you may get unpredictable results if the file isn't of the right type (e.g. it is a CSV with an extension of .xls), although this type of exception should normally be trapped.
```php
$inputFileName = './sampleData/example1.xls';
/** Create a new Excel5 Reader **/
$objReader = new PHPExcel_Reader_Excel5();
// $objReader = new PHPExcel_Reader_Excel2007();
// $objReader = new PHPExcel_Reader_Excel2003XML();
// $objReader = new PHPExcel_Reader_OOCalc();
// $objReader = new PHPExcel_Reader_SYLK();
// $objReader = new PHPExcel_Reader_Gnumeric();
// $objReader = new PHPExcel_Reader_CSV();
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader02.php for a working example of this code.
Alternatively, you can use the IO Factory's createReader() method to instantiate the reader object for you, simply telling it the file type of the reader that you want instantiating.
```php
$inputFileType = 'Excel5';
// $inputFileType = 'Excel2007';
// $inputFileType = 'Excel2003XML';
// $inputFileType = 'OOCalc';
// $inputFileType = 'SYLK';
// $inputFileType = 'Gnumeric';
// $inputFileType = 'CSV';
$inputFileName = './sampleData/example1.xls';
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader03.php for a working example of this code.
If you're uncertain of the filetype, you can use the IO Factory's identify() method to identify the reader that you need, before using the createReader() method to instantiate the reader object.
```php
$inputFileName = './sampleData/example1.xls';
/** Identify the type of $inputFileName **/
$inputFileType = PHPExcel_IOFactory::identify($inputFileName);
/** Create a new Reader of the type that has been identified **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader04.php for a working example of this code.

View File

@ -0,0 +1,392 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Spreadsheet Reader Options
Once you have created a reader object for the workbook that you want to load, you have the opportunity to set additional options before executing the load() method.
### Reading Only Data from a Spreadsheet File
If you're only interested in the cell values in a workbook, but don't need any of the cell formatting information, then you can set the reader to read only the data values and any formulae from each cell using the setReadDataOnly() method.
```php
$inputFileType = 'Excel5';
$inputFileName = './sampleData/example1.xls';
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Advise the Reader that we only want to load cell data **/
$objReader->setReadDataOnly(true);
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader05.php for a working example of this code.
It is important to note that Workbooks (and PHPExcel) store dates and times as simple numeric values: they can only be distinguished from other numeric values by the format mask that is applied to that cell. When setting read data only to true, PHPExcel doesn't read the cell format masks, so it is not possible to differentiate between dates/times and numbers.
The Gnumeric loader has been written to read the format masks for date values even when read data only has been set to true, so it can differentiate between dates/times and numbers; but this change hasn't yet been implemented for the other readers.
Reading Only Data from a Spreadsheet File applies to Readers:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | YES | Excel5 | YES | Excel2003XML | YES |
OOCalc | YES | SYLK | NO | Gnumeric | YES |
CSV | NO | HTML | NO
### Reading Only Named WorkSheets from a File
If your workbook contains a number of worksheets, but you are only interested in reading some of those, then you can use the setLoadSheetsOnly() method to identify those sheets you are interested in reading.
To read a single sheet, you can pass that sheet name as a parameter to the setLoadSheetsOnly() method.
```php
$inputFileType = 'Excel5';
$inputFileName = './sampleData/example1.xls';
$sheetname = 'Data Sheet #2';
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Advise the Reader of which WorkSheets we want to load **/
$objReader->setLoadSheetsOnly($sheetname);
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader07.php for a working example of this code.
If you want to read more than just a single sheet, you can pass a list of sheet names as an array parameter to the setLoadSheetsOnly() method.
```php
$inputFileType = 'Excel5';
$inputFileName = './sampleData/example1.xls';
$sheetnames = array('Data Sheet #1','Data Sheet #3');
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Advise the Reader of which WorkSheets we want to load **/
$objReader->setLoadSheetsOnly($sheetnames);
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader08.php for a working example of this code.
To reset this option to the default, you can call the setLoadAllSheets() method.
```php
$inputFileType = 'Excel5';
$inputFileName = './sampleData/example1.xls';
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Advise the Reader to load all Worksheets **/
$objReader->setLoadAllSheets();
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader06.php for a working example of this code.
Reading Only Named WorkSheets from a File applies to Readers:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | YES | Excel5 | YES | Excel2003XML | YES |
OOCalc | YES | SYLK | NO | Gnumeric | YES |
CSV | NO | HTML | NO
### Reading Only Specific Columns and Rows from a File (Read Filters)
If you are only interested in reading part of a worksheet, then you can write a filter class that identifies whether or not individual cells should be read by the loader. A read filter must implement the PHPExcel_Reader_IReadFilter interface, and contain a readCell() method that accepts arguments of $column, $row and $worksheetName, and return a boolean true or false that indicates whether a workbook cell identified by those arguments should be read or not.
```php
$inputFileType = 'Excel5';
$inputFileName = './sampleData/example1.xls';
$sheetname = 'Data Sheet #3';
/** Define a Read Filter class implementing PHPExcel_Reader_IReadFilter */
class MyReadFilter implements PHPExcel_Reader_IReadFilter
{
public function readCell($column, $row, $worksheetName = '') {
// Read rows 1 to 7 and columns A to E only
if ($row >= 1 && $row <= 7) {
if (in_array($column,range('A','E'))) {
return true;
}
}
return false;
}
}
/** Create an Instance of our Read Filter **/
$filterSubset = new MyReadFilter();
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Tell the Reader that we want to use the Read Filter **/
$objReader->setReadFilter($filterSubset);
/** Load only the rows and columns that match our filter to PHPExcel **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader09.php for a working example of this code.
This example is not particularly useful, because it can only be used in a very specific circumstance (when you only want cells in the range A1:E7 from your worksheet. A generic Read Filter would probably be more useful:
```php
/** Define a Read Filter class implementing PHPExcel_Reader_IReadFilter */
class MyReadFilter implements PHPExcel_Reader_IReadFilter
{
private $_startRow = 0;
private $_endRow = 0;
private $_columns = array();
/** Get the list of rows and columns to read */
public function __construct($startRow, $endRow, $columns) {
$this->_startRow = $startRow;
$this->_endRow = $endRow;
$this->_columns = $columns;
}
public function readCell($column, $row, $worksheetName = '') {
// Only read the rows and columns that were configured
if ($row >= $this->_startRow && $row <= $this->_endRow) {
if (in_array($column,$this->_columns)) {
return true;
}
}
return false;
}
}
/** Create an Instance of our Read Filter, passing in the cell range **/
$filterSubset = new MyReadFilter(9,15,range('G','K'));
```
> See Examples/Reader/exampleReader10.php for a working example of this code.
This can be particularly useful for conserving memory, by allowing you to read and process a large workbook in “chunks”: an example of this usage might be when transferring data from an Excel worksheet to a database.
```php
$inputFileType = 'Excel5';
$inputFileName = './sampleData/example2.xls';
/** Define a Read Filter class implementing PHPExcel_Reader_IReadFilter */
class chunkReadFilter implements PHPExcel_Reader_IReadFilter
{
private $_startRow = 0;
private $_endRow = 0;
/** Set the list of rows that we want to read */
public function setRows($startRow, $chunkSize) {
$this->_startRow = $startRow;
$this->_endRow = $startRow + $chunkSize;
}
public function readCell($column, $row, $worksheetName = '') {
// Only read the heading row, and the configured rows
if (($row == 1) || ($row >= $this->_startRow && $row < $this->_endRow)) {
return true;
}
return false;
}
}
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Define how many rows we want to read for each "chunk" **/
$chunkSize = 2048;
/** Create a new Instance of our Read Filter **/
$chunkFilter = new chunkReadFilter();
/** Tell the Reader that we want to use the Read Filter **/
$objReader->setReadFilter($chunkFilter);
/** Loop to read our worksheet in "chunk size" blocks **/
for ($startRow = 2; $startRow <= 65536; $startRow += $chunkSize) {
/** Tell the Read Filter which rows we want this iteration **/
$chunkFilter->setRows($startRow,$chunkSize);
/** Load only the rows that match our filter **/
$objPHPExcel = $objReader->load($inputFileName);
// Do some processing here
}
```
> See Examples/Reader/exampleReader12.php for a working example of this code.
Using Read Filters applies to:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | YES | Excel5 | YES | Excel2003XML | YES |
OOCalc | YES | SYLK | NO | Gnumeric | YES |
CSV | YES | HTML | NO
### Combining Multiple Files into a Single PHPExcel Object
While you can limit the number of worksheets that are read from a workbook file using the setLoadSheetsOnly() method, certain readers also allow you to combine several individual "sheets" from different files into a single PHPExcel object, where each individual file is a single worksheet within that workbook. For each file that you read, you need to indicate which worksheet index it should be loaded into using the setSheetIndex() method of the $objReader, then use the loadIntoExisting() method rather than the load() method to actually read the file into that worksheet.
```php
$inputFileType = 'CSV';
$inputFileNames = array('./sampleData/example1.csv',
'./sampleData/example2.csv'
'./sampleData/example3.csv'
);
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Extract the first named file from the array list **/
$inputFileName = array_shift($inputFileNames);
/** Load the initial file to the first worksheet in a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
/** Set the worksheet title (to the filename that we've loaded) **/
$objPHPExcel->getActiveSheet()
->setTitle(pathinfo($inputFileName,PATHINFO_BASENAME));
/** Loop through all the remaining files in the list **/
foreach($inputFileNames as $sheet => $inputFileName) {
/** Increment the worksheet index pointer for the Reader **/
$objReader->setSheetIndex($sheet+1);
/** Load the current file into a new worksheet in PHPExcel **/
$objReader->loadIntoExisting($inputFileName,$objPHPExcel);
/** Set the worksheet title (to the filename that we've loaded) **/
$objPHPExcel->getActiveSheet()
->setTitle(pathinfo($inputFileName,PATHINFO_BASENAME));
}
```
> See Examples/Reader/exampleReader13.php for a working example of this code.
Note that using the same sheet index for multiple sheets won't append files into the same sheet, but overwrite the results of the previous load. You cannot load multiple CSV files into the same worksheet.
Combining Multiple Files into a Single PHPExcel Object applies to:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | NO | Excel5 | NO | Excel2003XML | NO |
OOCalc | NO | SYLK | YES | Gnumeric | NO |
CSV | YES | HTML | NO
### Combining Read Filters with the setSheetIndex() method to split a large CSV file across multiple Worksheets
An Excel5 BIFF .xls file is limited to 65536 rows in a worksheet, while the Excel2007 Microsoft Office Open XML SpreadsheetML .xlsx file is limited to 1,048,576 rows in a worksheet; but a CSV file is not limited other than by available disk space. This means that we wouldnt ordinarily be able to read all the rows from a very large CSV file that exceeded those limits, and save it as an Excel5 or Excel2007 file. However, by using Read Filters to read the CSV file in “chunks” (using the chunkReadFilter Class that we defined in section REF _Ref275604563 \r \p 5.3 above), and the setSheetIndex() method of the $objReader, we can split the CSV file across several individual worksheets.
```php
$inputFileType = 'CSV';
$inputFileName = './sampleData/example2.csv';
echo 'Loading file ',pathinfo($inputFileName,PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
/** Create a new Reader of the type defined in $inputFileType **/
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Define how many rows we want to read for each "chunk" **/
$chunkSize = 65530;
/** Create a new Instance of our Read Filter **/
$chunkFilter = new chunkReadFilter();
/** Tell the Reader that we want to use the Read Filter **/
/** and that we want to store it in contiguous rows/columns **/
$objReader->setReadFilter($chunkFilter)
->setContiguous(true);
/** Instantiate a new PHPExcel object manually **/
$objPHPExcel = new PHPExcel();
/** Set a sheet index **/
$sheet = 0;
/** Loop to read our worksheet in "chunk size" blocks **/
/** $startRow is set to 2 initially because we always read the headings in row #1 **/
for ($startRow = 2; $startRow <= 1000000; $startRow += $chunkSize) {
/** Tell the Read Filter which rows we want to read this loop **/
$chunkFilter->setRows($startRow,$chunkSize);
/** Increment the worksheet index pointer for the Reader **/
$objReader->setSheetIndex($sheet);
/** Load only the rows that match our filter into a new worksheet **/
$objReader->loadIntoExisting($inputFileName,$objPHPExcel);
/** Set the worksheet title for the sheet that we've justloaded) **/
/** and increment the sheet index as well **/
$objPHPExcel->getActiveSheet()->setTitle('Country Data #'.(++$sheet));
}
```
> See Examples/Reader/exampleReader14.php for a working example of this code.
This code will read 65,530 rows at a time from the CSV file that were loading, and store each "chunk" in a new worksheet.
The setContiguous() method for the Reader is important here. It is applicable only when working with a Read Filter, and identifies whether or not the cells should be stored by their position within the CSV file, or their position relative to the filter.
For example, if the filter returned true for cells in the range B2:C3, then with setContiguous set to false (the default) these would be loaded as B2:C3 in the PHPExcel object; but with setContiguous set to true, they would be loaded as A1:B2.
Splitting a single loaded file across multiple worksheets applies to:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | NO | Excel5 | NO | Excel2003XML | NO |
OOCalc | NO | SYLK | NO | Gnumeric | NO |
CSV | YES | HTML | NO
### Pipe or Tab Separated Value Files
The CSV loader defaults to loading a file where comma is used as the separator, but you can modify this to load tab- or pipe-separated value files using the setDelimiter() method.
```php
$inputFileType = 'CSV';
$inputFileName = './sampleData/example1.tsv';
/** Create a new Reader of the type defined in $inputFileType **/ $objReader = PHPExcel_IOFactory::createReader($inputFileType);
/** Set the delimiter to a TAB character **/
$objReader->setDelimiter("\t");
// $objReader->setDelimiter('|');
/** Load the file to a PHPExcel Object **/
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader15.php for a working example of this code.
In addition to the delimiter, you can also use the following methods to set other attributes for the data load:
setEnclosure() | default is "
setLineEnding() | default is PHP_EOL
setInputEncoding() | default is UTF-8
Setting CSV delimiter applies to:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | NO | Excel5 | NO | Excel2003XML | NO |
OOCalc | NO | SYLK | NO | Gnumeric | NO |
CSV | YES | HTML | NO
### A Brief Word about the Advanced Value Binder
When loading data from a file that contains no formatting information, such as a CSV file, then data is read either as strings or numbers (float or integer). This means that PHPExcel does not automatically recognise dates/times (such as "16-Apr-2009" or "13:30"), booleans ("TRUE" or "FALSE"), percentages ("75%"), hyperlinks ("http://www.phpexcel.net"), etc as anything other than simple strings. However, you can apply additional processing that is executed against these values during the load process within a Value Binder.
A Value Binder is a class that implement the PHPExcel_Cell_IValueBinder interface. It must contain a bindValue() method that accepts a PHPExcel_Cell and a value as arguments, and return a boolean true or false that indicates whether the workbook cell has been populated with the value or not. The Advanced Value Binder implements such a class: amongst other tests, it identifies a string comprising "TRUE" or "FALSE" (based on locale settings) and sets it to a boolean; or a number in scientific format (e.g. "1.234e-5") and converts it to a float; or dates and times, converting them to their Excel timestamp value before storing the value in the cell object. It also sets formatting for strings that are identified as dates, times or percentages. It could easily be extended to provide additional handling (including text or cell formatting) when it encountered a hyperlink, or HTML markup within a CSV file.
So using a Value Binder allows a great deal more flexibility in the loader logic when reading unformatted text files.
```php
/** Tell PHPExcel that we want to use the Advanced Value Binder **/
PHPExcel_Cell::setValueBinder( new PHPExcel_Cell_AdvancedValueBinder() );
$inputFileType = 'CSV';
$inputFileName = './sampleData/example1.tsv';
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
$objReader->setDelimiter("\t");
$objPHPExcel = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader15.php for a working example of this code.
Loading using a Value Binder applies to:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
Excel2007 | NO | Excel5 | NO | Excel2003XML | NO |
OOCalc | NO | SYLK | NO | Gnumeric | NO |
CSV | YES | HTML | YES

View File

@ -0,0 +1,20 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Error Handling
Of course, you should always apply some error handling to your scripts as well. PHPExcel throws exceptions, so you can wrap all your code that accesses the library methods within Try/Catch blocks to trap for any problems that are encountered, and deal with them in an appropriate manner.
The PHPExcel Readers throw a PHPExcel_Reader_Exception.
```php
$inputFileName = './sampleData/example-1.xls';
try {
/** Load $inputFileName to a PHPExcel Object **/
$objPHPExcel = PHPExcel_IOFactory::load($inputFileName);
} catch(PHPExcel_Reader_Exception $e) {
die('Error loading file: '.$e->getMessage());
}
```
> See Examples/Reader/exampleReader16.php for a working example of this code.

View File

@ -0,0 +1,47 @@
# PHPExcel User Documentation Reading Spreadsheet Files
## Helper Methods
You can retrieve a list of worksheet names contained in a file without loading the whole file by using the Readers `listWorksheetNames()` method; similarly, a `listWorksheetInfo()` method will retrieve the dimensions of worksheet in a file without needing to load and parse the whole file.
### listWorksheetNames
The `listWorksheetNames()` method returns a simple array listing each worksheet name within the workbook:
```php
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
$worksheetNames = $objReader->listWorksheetNames($inputFileName);
echo '<h3>Worksheet Names</h3>';
echo '<ol>';
foreach ($worksheetNames as $worksheetName) {
echo '<li>', $worksheetName, '</li>';
}
echo '</ol>';
```
> See Examples/Reader/exampleReader18.php for a working example of this code.
### listWorksheetInfo
The `listWorksheetInfo()` method returns a nested array, with each entry listing the name and dimensions for a worksheet:
```php
$objReader = PHPExcel_IOFactory::createReader($inputFileType);
$worksheetData = $objReader->listWorksheetInfo($inputFileName);
echo '<h3>Worksheet Information</h3>';
echo '<ol>';
foreach ($worksheetData as $worksheet) {
echo '<li>', $worksheet['worksheetName'], '<br />';
echo 'Rows: ', $worksheet['totalRows'],
' Columns: ', $worksheet['totalColumns'], '<br />';
echo 'Cell Range: A1:',
$worksheet['lastColumnLetter'], $worksheet['totalRows'];
echo '</li>';
}
echo '</ol>';
```
> See Examples/Reader/exampleReader19.php for a working example of this code.