| commit | author | age | ||
| 2207d6 | 1 | # Calculation Engine - Formula Function Reference |
| W | 2 | |
| 3 | ## Function Reference | |
| 4 | ||
| 5 | ### Handling Date and Time Values | |
| 6 | ||
| 7 | #### Excel functions that return a Date and Time value | |
| 8 | ||
| 9 | 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. | |
| 10 | ||
| 11 | It is possible for scripts to change the data type used for returning date values by calling the PHPExcel_Calculation_Functions::setReturnDateType() method: | |
| 12 | ||
| 13 | ```php | |
| 14 | PHPExcel_Calculation_Functions::setReturnDateType($returnDateType); | |
| 15 | ``` | |
| 16 | ||
| 17 | where the following constants can be used for $returnDateType | |
| 18 | ||
| 19 | - PHPExcel_Calculation_Functions::RETURNDATE_PHP_NUMERIC | |
| 20 | - PHPExcel_Calculation_Functions::RETURNDATE_PHP_OBJECT | |
| 21 | - PHPExcel_Calculation_Functions::RETURNDATE_EXCEL | |
| 22 | ||
| 23 | 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). | |
| 24 | ||
| 25 | The PHPExcel_Calculation_Functions::getReturnDateType() method can be used to determine the current value of this setting: | |
| 26 | ||
| 27 | ```php | |
| 28 | $returnDateType = PHPExcel_Calculation_Functions::getReturnDateType(); | |
| 29 | ``` | |
| 30 | ||
| 31 | The default is RETURNDATE_PHP_NUMERIC. | |
| 32 | ||
| 33 | ##### PHP Timestamps | |
| 34 | ||
| 35 | 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. | |
| 36 | ||
| 37 | ##### PHP DateTime Objects | |
| 38 | ||
| 39 | 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. | |
| 40 | ||
| 41 | ##### Excel Timestamps | |
| 42 | ||
| 43 | 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. | |
| 44 | ||
| 45 | It is possible for scripts to change the calendar used for calculating Excel date values by calling the PHPExcel_Shared_Date::setExcelCalendar() method: | |
| 46 | ||
| 47 | ```php | |
| 48 | PHPExcel_Shared_Date::setExcelCalendar($baseDate); | |
| 49 | ``` | |
| 50 | ||
| 51 | where the following constants can be used for $baseDate | |
| 52 | ||
| 53 | - PHPExcel_Shared_Date::CALENDAR_WINDOWS_1900 | |
| 54 | - PHPExcel_Shared_Date::CALENDAR_MAC_1904 | |
| 55 | ||
| 56 | The method will return a Boolean True on success, False on failure (e.g. if an invalid value is passed in). | |
| 57 | ||
| 58 | The PHPExcel_Shared_Date::getExcelCalendar() method can be used to determine the current value of this setting: | |
| 59 | ||
| 60 | ```php | |
| 61 | $baseDate = PHPExcel_Shared_Date::getExcelCalendar(); | |
| 62 | ``` | |
| 63 | The default is CALENDAR_WINDOWS_1900. | |
| 64 | ||
| 65 | ##### Functions that return a Date/Time Value | |
| 66 | ||
| 67 | - DATE | |
| 68 | - DATEVALUE | |
| 69 | - EDATE | |
| 70 | - EOMONTH | |
| 71 | - NOW | |
| 72 | - TIME | |
| 73 | - TIMEVALUE | |
| 74 | - TODAY | |
| 75 | ||
| 76 | #### Excel functions that accept Date and Time values as parameters | |
| 77 | ||
| 78 | 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: | |
| 79 | ||
| 80 | 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 doesn’t 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. | |
| 81 | ||
| 82 | 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. | |
| 83 | ||
| 84 | ##### Functions that expect a Date/Time Value | |
| 85 | ||
| 86 | - DATEDIF | |
| 87 | - DAY | |
| 88 | - DAYS360 | |
| 89 | - EDATE | |
| 90 | - EOMONTH | |
| 91 | - HOUR | |
| 92 | - MINUTE | |
| 93 | - MONTH | |
| 94 | - NETWORKDAYS | |
| 95 | - SECOND | |
| 96 | - WEEKDAY | |
| 97 | - WEEKNUM | |
| 98 | - WORKDAY | |
| 99 | - YEAR | |
| 100 | - YEARFRAC | |
| 101 | ||
| 102 | #### Helper Methods | |
| 103 | ||
| 104 | 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: | |
| 105 | ||
| 106 | ##### PHPExcel_Shared_Date::ExcelToPHP($excelDate) | |
| 107 | ||
| 108 | Converts a date/time from an Excel date timestamp to return a PHP serialized date/timestamp. | |
| 109 | ||
| 110 | Note that this method does not trap for Excel dates that fall outside of the valid range for a PHP date timestamp. | |
| 111 | ||
| 112 | ##### PHPExcel_Shared_Date::ExcelToPHPObject($excelDate) | |
| 113 | ||
| 114 | Converts a date from an Excel date/timestamp to return a PHP DateTime object. | |
| 115 | ||
| 116 | ##### PHPExcel_Shared_Date::PHPToExcel($PHPDate) | |
| 117 | ||
| 118 | Converts a PHP serialized date/timestamp or a PHP DateTime object to return an Excel date timestamp. | |
| 119 | ||
| 120 | ##### PHPExcel_Shared_Date::FormattedPHPToExcel($year, $month, $day, $hours=0, $minutes=0, $seconds=0) | |
| 121 | ||
| 122 | Takes year, month and day values (and optional hour, minute and second values) and returns an Excel date timestamp value. | |
| 123 | ||
