Extends the built-in DateTime class to provide handy methods and locale-aware formatting helpers
This object provides an immutable variant of Cake\I18n\Time
int 7 string 'Y-m-d H:i:s' int 5 int 24 int 60 int 1 int 3 int 12 int 6 int 60 int 7 int 4 int 2 string 'unixTimestampFormat' int 3 int 52 int 100 int 10 \IntlDateFormatter[]In-memory cache of date formatters
string|int|int[]|\ClosureThe format to use when converting this object to JSON.
arrayHolds the last error generated by createFromFormat
string|int|int[]The format to use when formatting a time using Cake\I18n\FrozenTime::i18nFormat() and __toString. This format is also used by parseDateTime().
arrayNames of days of the week.
string|nullThe default locale to be used for displaying formatted date strings.
\Cake\Chronos\DifferenceFormatterInterfaceInstance of the diff formatting object.
boolWhether lenient parsing is enabled for IntlDateFormatter.
string|int|int[]The format to use when formatting a time using Cake\I18n\FrozenTime::nice()
stringRegex for relative period.
\Cake\Chronos\ChronosInterface|nullA test ChronosInterface instance to be returned when now instances are created
stringFormat to use for __toString method when type juggling occurs.
intLast day of week
intFirst day of week
arrayDays of weekend
string[]The format to use when formatting a time using Time::timeAgoInWords() and the difference is less than Time::$wordEnd
stringThe end of relative time telling
string|int|int[]The format to use when formatting a time using Cake\I18n\FrozenTime::timeAgoInWords() and the difference is more than Cake\I18n\FrozenTime::$wordEnd
Add days to the instance. Positive $value travels forward while negative $value travels into the past.
Add hours to the instance. Positive $value travels forward while negative $value travels into the past.
Add minutes to the instance. Positive $value travels forward while negative $value travels into the past.
Add months to the instance. Positive $value travels forward while negative $value travels into the past.
Add months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
Add seconds to the instance. Positive $value travels forward while negative $value travels into the past.
Add weekdays to the instance. Positive $value travels forward while negative $value travels into the past.
Add weeks to the instance. Positive $value travels forward while negative $value travels into the past.
Add years to the instance. Positive $value travel forward while negative $value travel into the past.
Add years with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
Modify the current instance to the average of a given instance (default now) and the current instance.
Creates a ChronosInterface instance from an array of date and time values.
Create a ChronosInterface instance from just a date. The time portion is set to now.
Create a ChronosInterface instance from just a time. The date portion is set to today.
Modify to the first occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the first day of the current month. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
Modify to the first occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the first day of the current quarter. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
Modify to the first occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the first day of the current year. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
Returns any errors or warnings that were found during the parsing of the last object created by this class.
Get the ChronosInterface instance (real or mock) to be returned when a "now" instance is created.
Determine if there is a relative keyword in the time string, this is to create dates relative to now for test instances. e.g.: next tuesday
Determine if there is a valid test instance set. A valid test instance is anything that is not null.
Returns a formatted string for this time object using the preferred format and language for the specified locale.
Returns a string that should be serialized when converting this object to JSON
Modify to the last occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the last day of the current month. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
Modify to the last occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the last day of the current quarter. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
Modify to the last occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the last day of the current year. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
Get the maximum instance between a given instance (default now) and the current instance.
Get the minimum instance between a given instance (default now) and the current instance.
Modify to the given occurrence of a given day of the week in the current month. If the calculated occurrence is outside the scope of the current month, then return false and no modifications are made.
Modify to the given occurrence of a given day of the week in the current quarter. If the calculated occurrence is outside the scope of the current quarter, then return false and no modifications are made.
Modify to the given occurrence of a given day of the week in the current year. If the calculated occurrence is outside the scope of the current year, then return false and no modifications are made.
Create a ChronosInterface instance from a string. This is an alias for the constructor that allows better fluent syntax as it allows you to do ChronosInterface::parse('Monday next week')->fn() rather than (new Chronos('Monday next week'))->fn()
Returns a new Time object after parsing the provided $date string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
Returns a new Time object after parsing the provided time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
Returns a new Time object after parsing the provided $time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
Resets the format used to the default when converting an instance of this type to a string
Sets the default format used when converting this object to JSON
Set a ChronosInterface instance (real or mock) to be returned when a "now" instance is created. The provided instance will be returned specifically under the following conditions:
Sets the default format used when type converting instances of this type to string
Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
Returns either a relative or a formatted absolute date depending on the difference between the current time and this object.
__construct(mixed $time, mixed $tz)
Create a new immutable time instance.
string|int|\DateTimeInterface|null $time optional Fixed or relative time
\DateTimeZone|string|null $tz optional The timezone for the instance
__debugInfo()
Returns the data that should be displayed when debugging this object
array__get(string $name)
Get a part of the ChronosInterface object
string $name The property name to read.
string|int|bool|\DateTimeZoneThe property value.
InvalidArgumentException__isset(string $name)
Check if an attribute exists on the object
string $name The property name to check.
boolWhether or not the property exists.
__toString()
Format the instance as a string using the set format
string_formatObject(mixed $date, mixed $format, ?string $locale)
Returns a translated and localized date string.
Implements what IntlDateFormatter::formatObject() is in PHP 5.5+
\DateTime|\DateTimeImmutable $date Date.
string|int|int[] $format Format.
string|null $locale The locale name in which the date should be displayed.
stringaddDay(int $value)
Add a day to the instance
int $value optional The number of days to add.
staticaddDays(int $value)
Add days to the instance. Positive $value travels forward while negative $value travels into the past.
int $value The number of days to add.
staticaddHour(int $value)
Add an hour to the instance
int $value optional The number of hours to add.
staticaddHours(int $value)
Add hours to the instance. Positive $value travels forward while negative $value travels into the past.
int $value The number of hours to add.
staticaddMinute(int $value)
Add a minute to the instance
int $value optional The number of minutes to add.
staticaddMinutes(int $value)
Add minutes to the instance. Positive $value travels forward while negative $value travels into the past.
int $value The number of minutes to add.
staticaddMonth(int $value)
Add a month to the instance.
Has the same behavior as addMonths().
int $value optional The number of months to add.
staticaddMonthWithOverflow(int $value)
Add a month with overflow to the instance.
Has the same behavior as addMonthsWithOverflow().
int $value optional The number of months to add.
staticaddMonths(int $value)
Add months to the instance. Positive $value travels forward while negative $value travels into the past.
If the new date does not exist, the last day of the month is used instead instead of overflowing into the next month.
(new Chronos('2015-01-03'))->addMonths(1); // Results in 2015-02-03
(new Chronos('2015-01-31'))->addMonths(1); // Results in 2015-02-28 int $value The number of months to add.
staticaddMonthsWithOverflow(int $value)
Add months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
If the new date does not exist, the days overflow into the next month.
(new Chronos('2012-01-30'))->addMonthsWithOverflow(1); // Results in 2013-03-01 int $value The number of months to add.
staticaddSecond(int $value)
Add a second to the instance
int $value optional The number of seconds to add.
staticaddSeconds(int $value)
Add seconds to the instance. Positive $value travels forward while negative $value travels into the past.
int $value The number of seconds to add.
staticaddWeek(int $value)
Add a week to the instance
int $value optional The number of weeks to add.
staticaddWeekday(int $value)
Add a weekday to the instance
int $value optional The number of weekdays to add.
staticaddWeekdays(int $value)
Add weekdays to the instance. Positive $value travels forward while negative $value travels into the past.
int $value The number of weekdays to add.
staticaddWeeks(int $value)
Add weeks to the instance. Positive $value travels forward while negative $value travels into the past.
int $value The number of weeks to add.
staticaddYear(int $value)
Add a year to the instance
Has the same behavior as addYears().
int $value optional The number of years to add.
staticaddYearWithOverflow(int $value)
Add a year with overflow to the instance
Has the same behavior as addYearsWithOverflow().
int $value optional The number of years to add.
staticaddYears(int $value)
Add years to the instance. Positive $value travel forward while negative $value travel into the past.
If the new date does not exist, the last day of the month is used instead instead of overflowing into the next month.
(new Chronos('2015-01-03'))->addYears(1); // Results in 2016-01-03
(new Chronos('2012-02-29'))->addYears(1); // Results in 2013-02-28 int $value The number of years to add.
staticaddYearsWithOverflow(int $value)
Add years with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
If the new date does not exist, the days overflow into the next month.
(new Chronos('2012-02-29'))->addYearsWithOverflow(1); // Results in 2013-03-01 int $value The number of years to add.
staticaverage(?\Cake\Chronos\ChronosInterface $dt)
Modify the current instance to the average of a given instance (default now) and the current instance.
\Cake\Chronos\ChronosInterface $dt optional The instance to compare with.
staticbetween(\Cake\Chronos\ChronosInterface $dt1, \Cake\Chronos\ChronosInterface $dt2, bool $equal)
Determines if the instance is between two others
\Cake\Chronos\ChronosInterface $dt1 The instance to compare with.
\Cake\Chronos\ChronosInterface $dt2 The instance to compare with.
bool $equal optional Indicates if a > and < comparison should be used or <= or >=
boolclosest(\Cake\Chronos\ChronosInterface $dt1, \Cake\Chronos\ChronosInterface $dt2)
Get the closest date from the instance.
\Cake\Chronos\ChronosInterface $dt1 The instance to compare with.
\Cake\Chronos\ChronosInterface $dt2 The instance to compare with.
staticcopy()
Get a copy of the instance
staticcreate(?int $year, ?int $month, ?int $day, ?int $hour, ?int $minute, ?int $second, ?int $microsecond, mixed $tz)
Create a new ChronosInterface instance from a specific date and time.
If any of $year, $month or $day are set to null their now() values will be used.
If $hour is null it will be set to its now() value and the default values for $minute, $second and $microsecond will be their now() values. If $hour is not null then the default values for $minute, $second and $microsecond will be 0.
int|null $year optional The year to create an instance with.
int|null $month optional The month to create an instance with.
int|null $day optional The day to create an instance with.
int|null $hour optional The hour to create an instance with.
int|null $minute optional The minute to create an instance with.
int|null $second optional The second to create an instance with.
int|null $microsecond optional The microsecond to create an instance with.
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
staticcreateFromArray(array $values)
Creates a ChronosInterface instance from an array of date and time values.
The 'year', 'month' and 'day' values must all be set for a date. The time values all default to 0.
The 'timezone' value can be any format supported by \DateTimeZone.
Allowed values:
(int|string)[] $values Array of date and time values.
staticcreateFromDate(?int $year, ?int $month, ?int $day, mixed $tz)
Create a ChronosInterface instance from just a date. The time portion is set to now.
int|null $year optional The year to create an instance with.
int|null $month optional The month to create an instance with.
int|null $day optional The day to create an instance with.
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
staticcreateFromFormat(mixed $format, mixed $time, mixed $tz)
Create a ChronosInterface instance from a specific format
string $format The date() compatible format string.
string $time The formatted date string to interpret.
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
staticInvalidArgumentExceptioncreateFromTime(?int $hour, ?int $minute, ?int $second, ?int $microsecond, mixed $tz)
Create a ChronosInterface instance from just a time. The date portion is set to today.
int|null $hour optional The hour to create an instance with.
int|null $minute optional The minute to create an instance with.
int|null $second optional The second to create an instance with.
int|null $microsecond optional The microsecond to create an instance with.
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
staticcreateFromTimestamp(int $timestamp, mixed $tz)
Create a ChronosInterface instance from a timestamp
int $timestamp The timestamp to create an instance from.
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
staticcreateFromTimestampUTC(int $timestamp)
Create a ChronosInterface instance from an UTC timestamp
int $timestamp The UTC timestamp to create an instance from.
staticday(int $value)
Set the instance's day
int $value The day value.
staticdiffFiltered(\Cake\Chronos\ChronosInterval $ci, callable $callback, ?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference by the given interval using a filter callable
\Cake\Chronos\ChronosInterval $ci An interval to traverse by
callable $callback The callback to use for filtering.
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffForHumans(?\Cake\Chronos\ChronosInterface $other, bool $absolute)
Get the difference in a human readable format in the current locale.
When comparing a value in the past to default now: 1 hour ago 5 months ago
When comparing a value in the future to default now: 1 hour from now 5 months from now
When comparing a value in the past to another value: 1 hour before 5 months before
When comparing a value in the future to another value: 1 hour after 5 months after
\Cake\Chronos\ChronosInterface|null $other optional The datetime to compare with.
bool $absolute optional Removes time difference modifiers ago, after, etc
stringdiffFormatter(?\Cake\Chronos\DifferenceFormatterInterface $formatter)
Get the difference formatter instance or overwrite the current one.
\Cake\Chronos\DifferenceFormatterInterface|null $formatter optional The formatter instance when setting.
\Cake\Chronos\DifferenceFormatterInterfaceThe formatter instance.
diffInDays(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in days
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInDaysFiltered(callable $callback, ?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in days using a filter callable
callable $callback The callback to use for filtering.
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInHours(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in hours
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInHoursFiltered(callable $callback, ?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in hours using a filter callable
callable $callback The callback to use for filtering.
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInMinutes(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in minutes
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInMonths(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in months
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInSeconds(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in seconds
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInWeekdays(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in weekdays
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInWeekendDays(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in weekend days using a filter
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInWeeks(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in weeks
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdiffInYears(?\Cake\Chronos\ChronosInterface $dt, bool $abs)
Get the difference in years
\Cake\Chronos\ChronosInterface|null $dt optional The instance to difference from.
bool $abs optional Get the absolute of the difference
intdisableLenientParsing()
Enables lenient parsing for locale formats.
enableLenientParsing()
Enables lenient parsing for locale formats.
endOfCentury()
Resets the date to end of the century and time to 23:59:59
staticendOfDay()
Resets the time to 23:59:59
staticendOfDecade()
Resets the date to end of the decade and time to 23:59:59
staticendOfMonth()
Resets the date to end of the month and time to 23:59:59
staticendOfWeek()
Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59
staticendOfYear()
Resets the date to end of the year and time to 23:59:59
staticeq(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolequals(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolfarthest(\Cake\Chronos\ChronosInterface $dt1, \Cake\Chronos\ChronosInterface $dt2)
Get the farthest date from the instance.
\Cake\Chronos\ChronosInterface $dt1 The instance to compare with.
\Cake\Chronos\ChronosInterface $dt2 The instance to compare with.
staticfirstOfMonth(?int $dayOfWeek)
Modify to the first occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the first day of the current month. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedfirstOfQuarter(?int $dayOfWeek)
Modify to the first occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the first day of the current quarter. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedfirstOfYear(?int $dayOfWeek)
Modify to the first occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the first day of the current year. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedfromNow(mixed $datetime)
Convenience method for getting the remaining time from a given time.
\DateTime|\DateTimeImmutable $datetime The date to get the remaining time from.
\DateInterval|boolThe DateInterval object representing the difference between the two dates or FALSE on failure.
getDefaultLocale()
Gets the default locale.
string|nullThe default locale string to be used or null.
getDiffFormatter()
Get the difference formatter instance.
\Cake\Chronos\DifferenceFormatterInterfacegetLastErrors()
Returns any errors or warnings that were found during the parsing of the last object created by this class.
arraygetTestNow()
Get the ChronosInterface instance (real or mock) to be returned when a "now" instance is created.
\Cake\Chronos\ChronosInterface|nullThe current instance used for testing
getWeekEndsAt()
Get the last day of week
intgetWeekStartsAt()
Get the first day of week
intgetWeekendDays()
Get weekend days
arraygreaterThan(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is greater (after) than another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolgreaterThanOrEquals(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is greater (after) than or equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolgt(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is greater (after) than another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolgte(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is greater (after) than or equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolhasRelativeKeywords(?string $time)
Determine if there is a relative keyword in the time string, this is to create dates relative to now for test instances. e.g.: next tuesday
string|null $time The time string to check.
booltrue if there is a keyword, otherwise false
hasTestNow()
Determine if there is a valid test instance set. A valid test instance is anything that is not null.
boolTrue if there is a test instance, otherwise false
hour(int $value)
Set the instance's hour
int $value The hour value.
statici18nFormat(mixed $format, mixed $timezone, mixed $locale)
Returns a formatted string for this time object using the preferred format and language for the specified locale.
It is possible to specify the desired format for the string to be displayed. You can either pass IntlDateFormatter constants as the first argument of this function, or pass a full ICU date formatting string as specified in the following resource: http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details.
Additional to IntlDateFormatter constants and date formatting string you can use Time::UNIX_TIMESTAMP_FORMAT to get a unix timestamp
$time = new Time('2014-04-20 22:10');
$time->i18nFormat(); // outputs '4/20/14, 10:10 PM' for the en-US locale
$time->i18nFormat(\IntlDateFormatter::FULL); // Use the full date and time format
$time->i18nFormat([\IntlDateFormatter::FULL, \IntlDateFormatter::SHORT]); // Use full date but short time format
$time->i18nFormat('yyyy-MM-dd HH:mm:ss'); // outputs '2014-04-20 22:10'
$time->i18nFormat(Time::UNIX_TIMESTAMP_FORMAT); // outputs '1398031800' You can control the default format used through Time::setToStringFormat().
You can read about the available IntlDateFormatter constants at https://secure.php.net/manual/en/class.intldateformatter.php
If you need to display the date in a different timezone than the one being used for this Time object without altering its internal state, you can pass a timezone string or object as the second parameter.
Finally, should you need to use a different locale for displaying this time object, pass a locale string as the third parameter to this function.
$time = new Time('2014-04-20 22:10');
$time->i18nFormat(null, null, 'de-DE');
$time->i18nFormat(\IntlDateFormatter::FULL, 'Europe/Berlin', 'de-DE'); You can control the default locale used through Time::setDefaultLocale(). If empty, the default will be taken from the intl.default_locale ini config.
string|int|int[]|null $format optional Format string.
string|\DateTimeZone|null $timezone optional Timezone string or DateTimeZone object in which the date will be displayed. The timezone stored for this object will not be changed.
string|null $locale optional The locale name in which the date should be displayed (e.g. pt-BR)
string|intFormatted and translated date string
instance(\DateTimeInterface $dt)
Create a ChronosInterface instance from a DateTimeInterface one
\DateTimeInterface $dt The datetime instance to convert.
staticisBirthday(\Cake\Chronos\ChronosInterface $dt)
Check if its the birthday. Compares the date/month values of the two dates.
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolisFriday()
Checks if this day is a Friday.
boolisFuture()
Determines if the instance is in the future, ie. greater (after) than now
boolisLastMonth()
Determines if the instance is within the last month
boolisLastWeek()
Determines if the instance is within the last week
boolisLastYear()
Determines if the instance is within the last year
boolisLeapYear()
Determines if the instance is a leap year
boolisMonday()
Checks if this day is a Monday.
boolisMutable()
Check if instance of ChronosInterface is mutable.
boolisNextMonth()
Determines if the instance is within the next month
boolisNextWeek()
Determines if the instance is within the next week
boolisNextYear()
Determines if the instance is within the next year
boolisPast()
Determines if the instance is in the past, ie. less (before) than now
boolisSameDay(\Cake\Chronos\ChronosInterface $dt)
Checks if the passed in date is the same day as the instance current day.
\Cake\Chronos\ChronosInterface $dt The instance to check against.
boolisSaturday()
Checks if this day is a Saturday.
boolisSunday()
Checks if this day is a Sunday.
boolisThisMonth()
Returns true if this object represents a date within the current month
boolisThisWeek()
Returns true if this object represents a date within the current week
boolisThisYear()
Returns true if this object represents a date within the current year
boolisThursday()
Checks if this day is a Thursday.
boolisToday()
Determines if the instance is today
boolisTomorrow()
Determines if the instance is tomorrow
boolisTuesday()
Checks if this day is a Tuesday.
boolisWednesday()
Checks if this day is a Wednesday.
boolisWeekday()
Determines if the instance is a weekday
boolisWeekend()
Determines if the instance is a weekend day
boolisWithinNext(mixed $timeInterval)
Returns true this instance will happen within the specified interval
string|int $timeInterval the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
boolisYesterday()
Determines if the instance is yesterday
booljsonSerialize()
Returns a string that should be serialized when converting this object to JSON
string|intlastOfMonth(?int $dayOfWeek)
Modify to the last occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the last day of the current month. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedlastOfQuarter(?int $dayOfWeek)
Modify to the last occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the last day of the current quarter. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedlastOfYear(?int $dayOfWeek)
Modify to the last occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the last day of the current year. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedlenientParsingEnabled()
Gets whether locale format parsing is set to lenient.
boollessThan(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is less (before) than another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boollessThanOrEquals(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is less (before) or equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boollistTimezones(mixed $filter, ?string $country, mixed $options)
Get list of timezone identifiers
int|string|null $filter optional A regex to filter identifier Or one of DateTimeZone class constants
string|null $country optional A two-letter ISO 3166-1 compatible country code. This option is only used when $filter is set to DateTimeZone::PER_COUNTRY
bool|array $options optional If true (default value) groups the identifiers list by primary region. Otherwise, an array containing group, abbr, before, and after keys. Setting group and abbr to true will group results and append timezone abbreviation in the display value. Set before and after to customize the abbreviation wrapper.
arrayList of timezone identifiers
lt(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is less (before) than another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boollte(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is less (before) or equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolmax(?\Cake\Chronos\ChronosInterface $dt)
Get the maximum instance between a given instance (default now) and the current instance.
\Cake\Chronos\ChronosInterface|null $dt optional The instance to compare with.
staticmaxValue()
Create a ChronosInterface instance for the greatest supported date.
\Cake\Chronos\ChronosInterfacemin(?\Cake\Chronos\ChronosInterface $dt)
Get the minimum instance between a given instance (default now) and the current instance.
\Cake\Chronos\ChronosInterface|null $dt optional The instance to compare with.
staticminValue()
Create a ChronosInterface instance for the lowest supported date.
\Cake\Chronos\ChronosInterfaceminute(int $value)
Set the instance's minute
int $value The minute value.
staticmodify(string $relative)
string $relative month(int $value)
Set the instance's month
int $value The month value.
staticne(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is not equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolnext(?int $dayOfWeek)
Modify to the next occurrence of a given day of the week.
If no dayOfWeek is provided, modify to the next occurrence of the current day of the week. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixednice(mixed $timezone, mixed $locale)
Returns a nicely formatted date string for this object.
The format to be used is stored in the static property Time::niceFormat.
string|\DateTimeZone|null $timezone optional Timezone string or DateTimeZone object in which the date will be displayed. The timezone stored for this object will not be changed.
string|null $locale optional The locale name in which the date should be displayed (e.g. pt-BR)
stringFormatted date string
notEquals(\Cake\Chronos\ChronosInterface $dt)
Determines if the instance is not equal to another
\Cake\Chronos\ChronosInterface $dt The instance to compare with.
boolnow(mixed $tz)
Get a ChronosInterface instance for the current date and time
\DateTimeZone|string|null $tz The DateTimeZone object or timezone name.
staticnthOfMonth(int $nth, int $dayOfWeek)
Modify to the given occurrence of a given day of the week in the current month. If the calculated occurrence is outside the scope of the current month, then return false and no modifications are made.
Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int $nth The offset to use.
int $dayOfWeek The day of the week to move to.
mixednthOfQuarter(int $nth, int $dayOfWeek)
Modify to the given occurrence of a given day of the week in the current quarter. If the calculated occurrence is outside the scope of the current quarter, then return false and no modifications are made.
Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int $nth The offset to use.
int $dayOfWeek The day of the week to move to.
mixednthOfYear(int $nth, int $dayOfWeek)
Modify to the given occurrence of a given day of the week in the current year. If the calculated occurrence is outside the scope of the current year, then return false and no modifications are made.
Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int $nth The offset to use.
int $dayOfWeek The day of the week to move to.
mixedparse(mixed $time, mixed $tz)
Create a ChronosInterface instance from a string. This is an alias for the constructor that allows better fluent syntax as it allows you to do ChronosInterface::parse('Monday next week')->fn() rather than (new Chronos('Monday next week'))->fn()
\DateTimeInterface|string|int $time optional The strtotime compatible string to parse
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name.
staticparseDate(string $date, mixed $format)
Returns a new Time object after parsing the provided $date string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
When no $format is provided, the wordFormat format will be used.
If it was impossible to parse the provided time, null will be returned.
Example:
$time = Time::parseDate('10/13/2013');
$time = Time::parseDate('13 Oct, 2013', 'dd MMM, y');
$time = Time::parseDate('13 Oct, 2013', IntlDateFormatter::SHORT); string $date The date string to parse.
string|int|array|null $format optional Any format accepted by IntlDateFormatter.
static|nullparseDateTime(string $time, mixed $format, mixed $tz)
Returns a new Time object after parsing the provided time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
When no $format is provided, the toString format will be used.
Unlike DateTime, the time zone of the returned instance is always converted to $tz (default time zone if null) even if the $time string specified a time zone. This is a limitation of IntlDateFormatter.
If it was impossible to parse the provided time, null will be returned.
Example:
$time = Time::parseDateTime('10/13/2013 12:54am');
$time = Time::parseDateTime('13 Oct, 2013 13:54', 'dd MMM, y H:mm');
$time = Time::parseDateTime('10/10/2015', [IntlDateFormatter::SHORT, IntlDateFormatter::NONE]); string $time The time string to parse.
string|int|int[]|null $format optional Any format accepted by IntlDateFormatter.
\DateTimeZone|string|null $tz optional The timezone for the instance
static|nullparseTime(string $time, mixed $format)
Returns a new Time object after parsing the provided $time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
When no $format is provided, the IntlDateFormatter::SHORT format will be used.
If it was impossible to parse the provided time, null will be returned.
Example:
$time = Time::parseTime('11:23pm'); string $time The time string to parse.
string|int|null $format optional Any format accepted by IntlDateFormatter.
static|nullprevious(?int $dayOfWeek)
Modify to the previous occurrence of a given day of the week.
If no dayOfWeek is provided, modify to the previous occurrence of the current day of the week. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
int|null $dayOfWeek optional The day of the week to move to.
mixedresetToStringFormat()
Resets the format used to the default when converting an instance of this type to a string
safeCreateDateTimeZone(mixed $object)
Creates a DateTimeZone from a string or a DateTimeZone
\DateTimeZone|string|null $object The value to convert.
\DateTimeZoneInvalidArgumentExceptionsecond(int $value)
Set the instance's second
int $value The seconds value.
staticsecondsSinceMidnight()
The number of seconds since midnight.
intsecondsUntilEndOfDay()
The number of seconds until 23:59:59.
intsetDate(mixed $year, mixed $month, mixed $day)
Set the date to a different date.
Workaround for a PHP bug related to the first day of a month
int $year The year to set.
int $month The month to set.
int $day The day to set.
staticsetDateTime(int $year, int $month, int $day, int $hour, int $minute, int $second)
Set the date and time all together
int $year The year to set.
int $month The month to set.
int $day The day to set.
int $hour The hour to set.
int $minute The minute to set.
int $second optional The second to set.
staticsetDefaultLocale(?string $locale)
Sets the default locale.
Set to null to use IntlDateFormatter default.
string|null $locale optional The default locale string to be used.
setDiffFormatter(\Cake\Chronos\DifferenceFormatterInterface $formatter)
Set the difference formatter instance.
\Cake\Chronos\DifferenceFormatterInterface $formatter The formatter instance when setting.
setJsonEncodeFormat(mixed $format)
Sets the default format used when converting this object to JSON
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
Alternatively, the format can provide a callback. In this case, the callback can receive this datetime object and return a formatted string.
string|array|int|\Closure $format Format.
setTestNow(mixed $testNow)
Set a ChronosInterface instance (real or mock) to be returned when a "now" instance is created. The provided instance will be returned specifically under the following conditions:
Note the timezone parameter was left out of the examples above and has no affect as the mock value will be returned regardless of its value.
To clear the test instance call this method using the default parameter of null.
\Cake\Chronos\ChronosInterface|string|null $testNow optional The instance to use for all future instances.
setTimeFromTimeString(string $time)
Set the time by time string
string $time Time as string.
staticsetTimezone(mixed $value)
Set the instance's timezone from a string or object
\DateTimeZone|string $value The DateTimeZone object or timezone name to use.
staticsetToStringFormat(mixed $format)
Sets the default format used when type converting instances of this type to string
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
string|int|int[] $format Format.
setWeekEndsAt(int $day)
Set the last day of week
int $day The day the week ends with.
setWeekStartsAt(int $day)
Set the first day of week
int $day The day the week starts with.
setWeekendDays(array $days)
Set weekend days
array $days Which days are 'weekends'.
startOfCentury()
Resets the date to the first day of the century and the time to 00:00:00
staticstartOfDay()
Resets the time to 00:00:00
staticstartOfDecade()
Resets the date to the first day of the decade and the time to 00:00:00
staticstartOfMonth()
Resets the date to the first day of the month and the time to 00:00:00
staticstartOfWeek()
Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
staticstartOfYear()
Resets the date to the first day of the year and the time to 00:00:00
staticsubDay(int $value)
Remove a day from the instance
int $value optional The number of days to remove.
staticsubDays(int $value)
Remove days from the instance
int $value The number of days to remove.
staticsubHour(int $value)
Remove an hour from the instance
int $value optional The number of hours to remove.
staticsubHours(int $value)
Remove hours from the instance
int $value The number of hours to remove.
staticsubMinute(int $value)
Remove a minute from the instance
int $value optional The number of minutes to remove.
staticsubMinutes(int $value)
Remove minutes from the instance
int $value The number of minutes to remove.
staticsubMonth(int $value)
Remove a month from the instance
Has the same behavior as addMonths().
int $value optional The number of months to remove.
staticsubMonthWithOverflow(int $value)
Remove a month with overflow from the instance.
Has the same behavior as addMonthsWithOverflow().
int $value optional The number of months to remove.
staticsubMonths(int $value)
Remove months from the instance.
Has the same behavior as addMonths().
int $value The number of months to remove.
staticsubMonthsWithOverflow(int $value)
Remove months with overflow from the instance.
Has the same behavior as addMonthsWithOverflow().
int $value The number of months to remove.
staticsubSecond(int $value)
Remove a second from the instance
int $value optional The number of seconds to remove.
staticsubSeconds(int $value)
Remove seconds from the instance
int $value The number of seconds to remove.
staticsubWeek(int $value)
Remove a week from the instance
int $value optional The number of weeks to remove.
staticsubWeekday(int $value)
Remove a weekday from the instance
int $value optional The number of weekdays to remove.
staticsubWeekdays(int $value)
Remove weekdays from the instance
int $value The number of weekdays to remove.
staticsubWeeks(int $value)
Remove weeks to the instance
int $value The number of weeks to remove.
staticsubYear(int $value)
Remove a year from the instance.
Has the same behavior as addYears().
int $value optional The number of years to remove.
staticsubYearWithOverflow(int $value)
Remove a year with overflow from the instance
Has the same behavior as addYearsWithOverflow().
int $value optional The number of years to remove.
staticsubYears(int $value)
Remove years from the instance.
Has the same behavior as addYears().
int $value The number of years to remove.
staticsubYearsWithOverflow(int $value)
Remove years with overflow from the instance
Has the same behavior as addYearsWithOverflow().
int $value The number of years to remove.
statictimeAgoInWords(array $options)
Returns either a relative or a formatted absolute date depending on the difference between the current time and this object.
from => another Time object representing the "now" timeformat => a fall back format if the relative time is longer than the duration specified by endaccuracy => Specifies how accurate the date should be described (array) end => The end of relative time tellingrelativeString => The printf compatible string when outputting relative timeabsoluteString => The printf compatible string when outputting absolute timetimezone => The user timezone the timestamp should be formatted in.Relative dates look something like this:
Default date formatting is d/M/YY e.g: on 18/2/09. Formatting is done internally using i18nFormat, see the method for the valid formatting strings
The returned string includes 'ago' or 'on' and assumes you'll properly add a word like 'Posted ' before the function output.
NOTE: If the difference is one week or more, the lowest level of accuracy is day
array $options optional Array of options.
stringRelative time string.
timestamp(int $value)
Set the instance's timestamp
int $value The timestamp value to set.
statictimezone(mixed $value)
Alias for setTimezone()
\DateTimeZone|string $value The DateTimeZone object or timezone name to use.
statictoAtomString()
Format the instance as ATOM
stringtoCookieString()
Format the instance as COOKIE
stringtoDateString()
Format the instance as date
stringtoDateTimeString()
Format the instance as date and time
stringtoDayDateTimeString()
Format the instance with day, date and time
stringtoFormattedDateString()
Format the instance as a readable date
stringtoIso8601String()
Format the instance as ISO8601
stringtoMutable()
Create a new mutable instance from current immutable instance.
\Cake\Chronos\MutableDateTimetoQuarter(bool $range)
Returns the quarter
bool $range optional Range.
int|array1, 2, 3, or 4 quarter of year or array if $range true
toRfc1036String()
Format the instance as RFC1036
stringtoRfc1123String()
Format the instance as RFC1123
stringtoRfc2822String()
Format the instance as RFC2822
stringtoRfc3339String()
Format the instance as RFC3339
stringtoRfc822String()
Format the instance as RFC822
stringtoRfc850String()
Format the instance as RFC850
stringtoRssString()
Format the instance as RSS
stringtoTimeString()
Format the instance as time
stringtoUnixString()
Returns a UNIX timestamp.
stringUNIX timestamp
toW3cString()
Format the instance as W3C
stringtoWeek()
today(mixed $tz)
Create a ChronosInterface instance for today
\DateTimeZone|string|null $tz optional The timezone to use.
statictomorrow(mixed $tz)
Create a ChronosInterface instance for tomorrow
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
statictz(mixed $value)
Alias for setTimezone()
\DateTimeZone|string $value The DateTimeZone object or timezone name to use.
staticwasWithinLast(mixed $timeInterval)
Returns true this instance happened within the specified interval
string|int $timeInterval the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
boolyear(int $value)
Set the instance's year
int $value The year value.
staticyesterday(mixed $tz)
Create a ChronosInterface instance for yesterday
\DateTimeZone|string|null $tz optional The DateTimeZone object or timezone name the new instance should use.
staticIn-memory cache of date formatters
\IntlDateFormatter[]The format to use when converting this object to JSON.
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
string|int|int[]|\ClosureHolds the last error generated by createFromFormat
arrayThe format to use when formatting a time using Cake\I18n\FrozenTime::i18nFormat() and __toString. This format is also used by parseDateTime().
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
string|int|int[]Names of days of the week.
arrayThe default locale to be used for displaying formatted date strings.
Use static::setDefaultLocale() and static::getDefaultLocale() instead.
string|nullInstance of the diff formatting object.
\Cake\Chronos\DifferenceFormatterInterfaceWhether lenient parsing is enabled for IntlDateFormatter.
Defaults to true which is the default for IntlDateFormatter.
boolThe format to use when formatting a time using Cake\I18n\FrozenTime::nice()
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
string|int|int[]Regex for relative period.
stringA test ChronosInterface instance to be returned when now instances are created
There is a single test now for all date/time classes provided by Chronos. This aims to emulate stubbing out 'now' which is a single global fact.
\Cake\Chronos\ChronosInterface|nullFormat to use for __toString method when type juggling occurs.
stringLast day of week
intFirst day of week
intDays of weekend
arrayThe format to use when formatting a time using Time::timeAgoInWords() and the difference is less than Time::$wordEnd
string[]The end of relative time telling
stringThe format to use when formatting a time using Cake\I18n\FrozenTime::timeAgoInWords() and the difference is more than Cake\I18n\FrozenTime::$wordEnd
string|int|int[]
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.I18n.FrozenTime.html