class DateTime (View source)

Methods

static bool
isLeapYear(int|string $year)

Identify if a year is a leap year or not.

static mixed
getDateValue(string $dateValue)

getDateValue.

static mixed
DATETIMENOW()

DATETIMENOW.

static mixed
DATENOW()

DATENOW.

static mixed
DATE(int $year = 0, int $month = 1, int $day = 1)

DATE.

static mixed
TIME(int $hour = 0, int $minute = 0, int $second = 0)

TIME.

static mixed
DATEVALUE(string $dateValue = 1)

DATEVALUE.

static mixed
TIMEVALUE(string $timeValue)

TIMEVALUE.

static int|string
DATEDIF(mixed $startDate = 0, mixed $endDate = 0, string $unit = 'D')

DATEDIF.

static int|string
DAYS(DateTimeImmutable|float|int|string $endDate = 0, DateTimeImmutable|float|int|string $startDate = 0)

DAYS.

static int|string
DAYS360(mixed $startDate = 0, mixed $endDate = 0, bool $method = false)

DAYS360.

static float
YEARFRAC(mixed $startDate = 0, mixed $endDate = 0, int $method = 0)

YEARFRAC.

static int|string
NETWORKDAYS($startDate, $endDate, ...$dateArgs)

NETWORKDAYS.

static mixed
WORKDAY($startDate, $endDays, ...$dateArgs)

WORKDAY.

static int|string
DAYOFMONTH(mixed $dateValue = 1)

DAYOFMONTH.

static int|string
WEEKDAY(int $dateValue = 1, int $style = 1)

WEEKDAY.

static int|string
WEEKNUM(mixed $dateValue = 1, int $method = 1)

WEEKNUM.

static int|string
ISOWEEKNUM(mixed $dateValue = 1)

ISOWEEKNUM.

static int|string
MONTHOFYEAR(mixed $dateValue = 1)

MONTHOFYEAR.

static int|string
YEAR(mixed $dateValue = 1)

YEAR.

static int|string
HOUROFDAY(mixed $timeValue = 0)

HOUROFDAY.

static int|string
MINUTE(mixed $timeValue = 0)

MINUTE.

static int|string
SECOND(mixed $timeValue = 0)

SECOND.

static mixed
EDATE(mixed $dateValue = 1, int $adjustmentMonths = 0)

EDATE.

static mixed
EOMONTH(mixed $dateValue = 1, int $adjustmentMonths = 0)

EOMONTH.

Details

static bool isLeapYear(int|string $year)

Identify if a year is a leap year or not.

Parameters

int|string $year The year to test

Return Value

bool TRUE if the year is a leap year, otherwise FALSE

static mixed getDateValue(string $dateValue)

getDateValue.

Parameters

string $dateValue

Return Value

mixed Excel date/time serial value, or string if error

static mixed DATETIMENOW()

DATETIMENOW.

Returns the current date and time. The NOW function is useful when you need to display the current date and time on a worksheet or calculate a value based on the current date and time, and have that value updated each time you open the worksheet.

NOTE: When used in a Cell Formula, MS Excel changes the cell format so that it matches the date and time format of your regional settings. PhpSpreadsheet does not change cell formatting in this way.

Excel Function: NOW()

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static mixed DATENOW()

DATENOW.

Returns the current date. The NOW function is useful when you need to display the current date and time on a worksheet or calculate a value based on the current date and time, and have that value updated each time you open the worksheet.

NOTE: When used in a Cell Formula, MS Excel changes the cell format so that it matches the date and time format of your regional settings. PhpSpreadsheet does not change cell formatting in this way.

Excel Function: TODAY()

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static mixed DATE(int $year = 0, int $month = 1, int $day = 1)

DATE.

The DATE function returns a value that represents a particular date.

NOTE: When used in a Cell Formula, MS Excel changes the cell format so that it matches the date format of your regional settings. PhpSpreadsheet does not change cell formatting in this way.

Excel Function: DATE(year,month,day)

PhpSpreadsheet is a lot more forgiving than MS Excel when passing non numeric values to this function. A Month name or abbreviation (English only at this point) such as 'January' or 'Jan' will still be accepted, as will a day value with a suffix (e.g. '21st' rather than simply 21); again only English language.

Parameters

int $year The value of the year argument can include one to four digits. Excel interprets the year argument according to the configured date system: 1900 or 1904. If year is between 0 (zero) and 1899 (inclusive), Excel adds that value to 1900 to calculate the year. For example, DATE(108,1,2) returns January 2, 2008 (1900+108). If year is between 1900 and 9999 (inclusive), Excel uses that value as the year. For example, DATE(2008,1,2) returns January 2, 2008. If year is less than 0 or is 10000 or greater, Excel returns the #NUM! error value.
int $month A positive or negative integer representing the month of the year from 1 to 12 (January to December). If month is greater than 12, month adds that number of months to the first month in the year specified. For example, DATE(2008,14,2) returns the serial number representing February 2, 2009. If month is less than 1, month subtracts the magnitude of that number of months, plus 1, from the first month in the year specified. For example, DATE(2008,-3,2) returns the serial number representing September 2, 2007.
int $day A positive or negative integer representing the day of the month from 1 to 31. If day is greater than the number of days in the month specified, day adds that number of days to the first day in the month. For example, DATE(2008,1,35) returns the serial number representing February 4, 2008. If day is less than 1, day subtracts the magnitude that number of days, plus one, from the first day of the month specified. For example, DATE(2008,1,-15) returns the serial number representing December 16, 2007.

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static mixed TIME(int $hour = 0, int $minute = 0, int $second = 0)

TIME.

The TIME function returns a value that represents a particular time.

NOTE: When used in a Cell Formula, MS Excel changes the cell format so that it matches the time format of your regional settings. PhpSpreadsheet does not change cell formatting in this way.

Excel Function: TIME(hour,minute,second)

Parameters

int $hour A number from 0 (zero) to 32767 representing the hour. Any value greater than 23 will be divided by 24 and the remainder will be treated as the hour value. For example, TIME(27,0,0) = TIME(3,0,0) = .125 or 3:00 AM.
int $minute A number from 0 to 32767 representing the minute. Any value greater than 59 will be converted to hours and minutes. For example, TIME(0,750,0) = TIME(12,30,0) = .520833 or 12:30 PM.
int $second A number from 0 to 32767 representing the second. Any value greater than 59 will be converted to hours, minutes, and seconds. For example, TIME(0,0,2000) = TIME(0,33,22) = .023148 or 12:33:20 AM

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static mixed DATEVALUE(string $dateValue = 1)

DATEVALUE.

Returns a value that represents a particular date. Use DATEVALUE to convert a date represented by a text string to an Excel or PHP date/time stamp value.

NOTE: When used in a Cell Formula, MS Excel changes the cell format so that it matches the date format of your regional settings. PhpSpreadsheet does not change cell formatting in this way.

Excel Function: DATEVALUE(dateValue)

Parameters

string $dateValue Text that represents a date in a Microsoft Excel date format. For example, "1/30/2008" or "30-Jan-2008" are text strings within quotation marks that represent dates. Using the default date system in Excel for Windows, date_text must represent a date from January 1, 1900, to December 31, 9999. Using the default date system in Excel for the Macintosh, date_text must represent a date from January 1, 1904, to December 31, 9999. DATEVALUE returns the #VALUE! error value if date_text is out of this range.

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static mixed TIMEVALUE(string $timeValue)

TIMEVALUE.

Returns a value that represents a particular time. Use TIMEVALUE to convert a time represented by a text string to an Excel or PHP date/time stamp value.

NOTE: When used in a Cell Formula, MS Excel changes the cell format so that it matches the time format of your regional settings. PhpSpreadsheet does not change cell formatting in this way.

Excel Function: TIMEVALUE(timeValue)

Parameters

string $timeValue A text string that represents a time in any one of the Microsoft Excel time formats; for example, "6:45 PM" and "18:45" text strings within quotation marks that represent time. Date information in time_text is ignored.

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static int|string DATEDIF(mixed $startDate = 0, mixed $endDate = 0, string $unit = 'D')

DATEDIF.

Parameters

mixed $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object or a standard date string
mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object or a standard date string
string $unit

Return Value

int|string Interval between the dates

static int|string DAYS(DateTimeImmutable|float|int|string $endDate = 0, DateTimeImmutable|float|int|string $startDate = 0)

DAYS.

Returns the number of days between two dates

Excel Function: DAYS(endDate, startDate)

Parameters

DateTimeImmutable|float|int|string $endDate Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
DateTimeImmutable|float|int|string $startDate Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string

Return Value

int|string Number of days between start date and end date or an error

static int|string DAYS360(mixed $startDate = 0, mixed $endDate = 0, bool $method = false)

DAYS360.

Returns the number of days between two dates based on a 360-day year (twelve 30-day months), which is used in some accounting calculations. Use this function to help compute payments if your accounting system is based on twelve 30-day months.

Excel Function: DAYS360(startDate,endDate[,method])

Parameters

mixed $startDate Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
mixed $endDate Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
bool $method US or European Method FALSE or omitted: U.S. (NASD) method. If the starting date is the last day of a month, it becomes equal to the 30th of the same month. If the ending date is the last day of a month and the starting date is earlier than the 30th of a month, the ending date becomes equal to the 1st of the next month; otherwise the ending date becomes equal to the 30th of the same month. TRUE: European method. Starting dates and ending dates that occur on the 31st of a month become equal to the 30th of the same month.

Return Value

int|string Number of days between start date and end date

static float YEARFRAC(mixed $startDate = 0, mixed $endDate = 0, int $method = 0)

YEARFRAC.

Calculates the fraction of the year represented by the number of whole days between two dates (the start_date and the end_date). Use the YEARFRAC worksheet function to identify the proportion of a whole year's benefits or obligations to assign to a specific term.

Excel Function: YEARFRAC(startDate,endDate[,method])

Parameters

mixed $startDate Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
mixed $endDate Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
int $method Method used for the calculation 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360

Return Value

float fraction of the year

static int|string NETWORKDAYS($startDate, $endDate, ...$dateArgs)

NETWORKDAYS.

Returns the number of whole working days between start_date and end_date. Working days exclude weekends and any dates identified in holidays. Use NETWORKDAYS to calculate employee benefits that accrue based on the number of days worked during a specific term.

Excel Function: NETWORKDAYS(startDate,endDate[,holidays[,holiday[,...]]])

Parameters

$startDate
$endDate
...$dateArgs

Return Value

int|string Interval between the dates

static mixed WORKDAY($startDate, $endDays, ...$dateArgs)

WORKDAY.

Returns the date that is the indicated number of working days before or after a date (the starting date). Working days exclude weekends and any dates identified as holidays. Use WORKDAY to exclude weekends or holidays when you calculate invoice due dates, expected delivery times, or the number of days of work performed.

Excel Function: WORKDAY(startDate,endDays[,holidays[,holiday[,...]]])

Parameters

$startDate
$endDays
...$dateArgs

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static int|string DAYOFMONTH(mixed $dateValue = 1)

DAYOFMONTH.

Returns the day of the month, for a specified date. The day is given as an integer ranging from 1 to 31.

Excel Function: DAY(dateValue)

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string

Return Value

int|string Day of the month

static int|string WEEKDAY(int $dateValue = 1, int $style = 1)

WEEKDAY.

Returns the day of the week for a specified date. The day is given as an integer ranging from 0 to 7 (dependent on the requested style).

Excel Function: WEEKDAY(dateValue[,style])

Parameters

int $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
int $style A number that determines the type of return value 1 or omitted Numbers 1 (Sunday) through 7 (Saturday). 2 Numbers 1 (Monday) through 7 (Sunday). 3 Numbers 0 (Monday) through 6 (Sunday).

Return Value

int|string Day of the week value

static int|string WEEKNUM(mixed $dateValue = 1, int $method = 1)

WEEKNUM.

Returns the week of the year for a specified date. The WEEKNUM function considers the week containing January 1 to be the first week of the year. However, there is a European standard that defines the first week as the one with the majority of days (four or more) falling in the new year. This means that for years in which there are three days or less in the first week of January, the WEEKNUM function returns week numbers that are incorrect according to the European standard.

Excel Function: WEEKNUM(dateValue[,style])

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
int $method Week begins on Sunday or Monday 1 or omitted Week begins on Sunday. 2 Week begins on Monday.

Return Value

int|string Week Number

static int|string ISOWEEKNUM(mixed $dateValue = 1)

ISOWEEKNUM.

Returns the ISO 8601 week number of the year for a specified date.

Excel Function: ISOWEEKNUM(dateValue)

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string

Return Value

int|string Week Number

static int|string MONTHOFYEAR(mixed $dateValue = 1)

MONTHOFYEAR.

Returns the month of a date represented by a serial number. The month is given as an integer, ranging from 1 (January) to 12 (December).

Excel Function: MONTH(dateValue)

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string

Return Value

int|string Month of the year

static int|string YEAR(mixed $dateValue = 1)

YEAR.

Returns the year corresponding to a date. The year is returned as an integer in the range 1900-9999.

Excel Function: YEAR(dateValue)

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string

Return Value

int|string Year

static int|string HOUROFDAY(mixed $timeValue = 0)

HOUROFDAY.

Returns the hour of a time value. The hour is given as an integer, ranging from 0 (12:00 A.M.) to 23 (11:00 P.M.).

Excel Function: HOUR(timeValue)

Parameters

mixed $timeValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard time string

Return Value

int|string Hour

static int|string MINUTE(mixed $timeValue = 0)

MINUTE.

Returns the minutes of a time value. The minute is given as an integer, ranging from 0 to 59.

Excel Function: MINUTE(timeValue)

Parameters

mixed $timeValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard time string

Return Value

int|string Minute

static int|string SECOND(mixed $timeValue = 0)

SECOND.

Returns the seconds of a time value. The second is given as an integer in the range 0 (zero) to 59.

Excel Function: SECOND(timeValue)

Parameters

mixed $timeValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard time string

Return Value

int|string Second

static mixed EDATE(mixed $dateValue = 1, int $adjustmentMonths = 0)

EDATE.

Returns the serial number that represents the date that is the indicated number of months before or after a specified date (the start_date). Use EDATE to calculate maturity dates or due dates that fall on the same day of the month as the date of issue.

Excel Function: EDATE(dateValue,adjustmentMonths)

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
int $adjustmentMonths The number of months before or after start_date. A positive value for months yields a future date; a negative value yields a past date.

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

static mixed EOMONTH(mixed $dateValue = 1, int $adjustmentMonths = 0)

EOMONTH.

Returns the date value for the last day of the month that is the indicated number of months before or after start_date. Use EOMONTH to calculate maturity dates or due dates that fall on the last day of the month.

Excel Function: EOMONTH(dateValue,adjustmentMonths)

Parameters

mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), PHP DateTime object, or a standard date string
int $adjustmentMonths The number of months before or after start_date. A positive value for months yields a future date; a negative value yields a past date.

Return Value

mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag