Interface I18nDateTimeInterface
Interface for date formatting methods shared by both Time & Date.
Constants
- 
          
          intDAYS_PER_WEEK ¶7
- 
          
          stringDEFAULT_TO_STRING_FORMAT ¶'Y-m-d H:i:s'Default format to use for __toString method when type juggling occurs. 
- 
          
          intFRIDAY ¶5
- 
          
          intHOURS_PER_DAY ¶24
- 
          
          intMINUTES_PER_HOUR ¶60
- 
          
          intMONDAY ¶1
- 
          
          intMONTHS_PER_QUARTER ¶3
- 
          
          intMONTHS_PER_YEAR ¶12
- 
          
          intSATURDAY ¶6
- 
          
          intSECONDS_PER_MINUTE ¶60
- 
          
          intSUNDAY ¶7
- 
          
          intTHURSDAY ¶4
- 
          
          intTUESDAY ¶2
- 
          
          intWEDNESDAY ¶3
- 
          
          intWEEKS_PER_YEAR ¶52
- 
          
          intYEARS_PER_CENTURY ¶100
- 
          
          intYEARS_PER_DECADE ¶10
Method Summary
- 
          addDay() publicAdd a day to the instance 
- 
          addDays() publicAdd days to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addHour() publicAdd an hour to the instance 
- 
          addHours() publicAdd hours to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addMinute() publicAdd a minute to the instance 
- 
          addMinutes() publicAdd minutes to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addMonth() publicAdd a month to the instance. 
- 
          addMonthWithOverflow() publicAdd a month with overflow to the instance. 
- 
          addMonths() publicAdd months to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addMonthsWithOverflow() publicAdd months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addSecond() publicAdd a second to the instance 
- 
          addSeconds() publicAdd seconds to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addWeek() publicAdd a week to the instance 
- 
          addWeekday() publicAdd a weekday to the instance 
- 
          addWeekdays() publicAdd weekdays to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addWeeks() publicAdd weeks to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          addYear() publicAdd a year to the instance 
- 
          addYearWithOverflow() publicAdd a year with overflow to the instance 
- 
          addYears() publicAdd years to the instance. Positive $value travel forward while negative $value travel into the past. 
- 
          addYearsWithOverflow() publicAdd years with overflowing to the instance. Positive $value travels forward while negative $value travels into the past. 
- 
          average() publicModify the current instance to the average of a given instance (default now) and the current instance. 
- 
          between() publicDetermines if the instance is between two others 
- 
          closest() publicGet the closest date from the instance. 
- 
          copy() publicGet a copy of the instance 
- 
          day() publicSet the instance's day 
- 
          diffFiltered() publicGet the difference by the given interval using a filter callable 
- 
          diffForHumans() publicGet the difference in a human readable format in the current locale. 
- 
          diffInDays() publicGet the difference in days 
- 
          diffInDaysFiltered() publicGet the difference in days using a filter callable 
- 
          diffInHours() publicGet the difference in hours 
- 
          diffInHoursFiltered() publicGet the difference in hours using a filter callable 
- 
          diffInMinutes() publicGet the difference in minutes 
- 
          diffInMonths() publicGet the difference in months 
- 
          diffInSeconds() publicGet the difference in seconds 
- 
          diffInWeekdays() publicGet the difference in weekdays 
- 
          diffInWeekendDays() publicGet the difference in weekend days using a filter 
- 
          diffInWeeks() publicGet the difference in weeks 
- 
          diffInYears() publicGet the difference in years 
- 
          endOfCentury() publicSets the date to end of the century and time to 23:59:59 
- 
          endOfDay() publicSets the time to 23:59:59 or 23:59:59.999999 if $microsecondsis true.
- 
          endOfDecade() publicSets the date to end of the decade and time to 23:59:59 
- 
          endOfMonth() publicSets the date to end of the month and time to 23:59:59 
- 
          endOfWeek() publicSets the date to end of week (defined in $weekEndsAt) and time to 23:59:59 
- 
          endOfYear() publicSets the date to end of the year and time to 23:59:59 
- 
          eq() publicDetermines if the instance is equal to another 
- 
          equals() publicDetermines if the instance is equal to another 
- 
          farthest() publicGet the farthest date from the instance. 
- 
          firstOfMonth() publicModify 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. 
- 
          firstOfQuarter() publicModify 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. 
- 
          firstOfYear() publicModify 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. 
- 
          getDefaultLocale() public staticGets the default locale. 
- 
          getDiffFormatter() public staticGet the difference formatter instance. 
- 
          greaterThan() publicDetermines if the instance is greater (after) than another 
- 
          greaterThanOrEquals() publicDetermines if the instance is greater (after) than or equal to another 
- 
          gt() publicDetermines if the instance is greater (after) than another 
- 
          gte() publicDetermines if the instance is greater (after) than or equal to another 
- 
          hour() publicSet the instance's hour 
- 
          i18nFormat() publicReturns a formatted string for this time object using the preferred format and language for the specified locale. 
- 
          isBirthday() publicCheck if its the birthday. Compares the date/month values of the two dates. 
- 
          isFriday() publicChecks if this day is a Friday. 
- 
          isFuture() publicDetermines if the instance is in the future, ie. greater (after) than now 
- 
          isLeapYear() publicDetermines if the instance is a leap year 
- 
          isMonday() publicChecks if this day is a Monday. 
- 
          isMutable() publicCheck if instance of ChronosInterface is mutable. 
- 
          isPast() publicDetermines if the instance is in the past, ie. less (before) than now 
- 
          isSameDay() publicChecks if the passed in date is the same day as the instance current day. 
- 
          isSaturday() publicChecks if this day is a Saturday. 
- 
          isSunday() publicChecks if this day is a Sunday. 
- 
          isThisMonth() publicReturns true if this object represents a date within the current month 
- 
          isThisWeek() publicReturns true if this object represents a date within the current week 
- 
          isThisYear() publicReturns true if this object represents a date within the current year 
- 
          isThursday() publicChecks if this day is a Thursday. 
- 
          isToday() publicDetermines if the instance is today 
- 
          isTomorrow() publicDetermines if the instance is tomorrow 
- 
          isTuesday() publicChecks if this day is a Tuesday. 
- 
          isWednesday() publicChecks if this day is a Wednesday. 
- 
          isWeekday() publicDetermines if the instance is a weekday 
- 
          isWeekend() publicDetermines if the instance is a weekend day 
- 
          isWithinNext() publicReturns true this instance will happen within the specified interval 
- 
          isYesterday() publicDetermines if the instance is yesterday 
- 
          lastOfMonth() publicModify 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. 
- 
          lastOfQuarter() publicModify 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. 
- 
          lastOfYear() publicModify 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. 
- 
          lessThan() publicDetermines if the instance is less (before) than another 
- 
          lessThanOrEquals() publicDetermines if the instance is less (before) or equal to another 
- 
          lt() publicDetermines if the instance is less (before) than another 
- 
          lte() publicDetermines if the instance is less (before) or equal to another 
- 
          max() publicGet the maximum instance between a given instance (default now) and the current instance. 
- 
          min() publicGet the minimum instance between a given instance (default now) and the current instance. 
- 
          minute() publicSet the instance's minute 
- 
          modify() public @method
- 
          month() publicSet the instance's month 
- 
          ne() publicDetermines if the instance is not equal to another 
- 
          next() publicModify 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. 
- 
          nice() publicReturns a nicely formatted date string for this object. 
- 
          notEquals() publicDetermines if the instance is not equal to another 
- 
          now() public staticGet a ChronosInterface instance for the current date and time 
- 
          nthOfMonth() publicModify 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. 
- 
          nthOfQuarter() publicModify 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. 
- 
          nthOfYear() publicModify 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. 
- 
          parseDate() public staticReturns 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. 
- 
          parseDateTime() public staticReturns 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. 
- 
          parseTime() public staticReturns 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. 
- 
          previous() publicModify 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. 
- 
          resetToStringFormat() public staticResets the format used to the default when converting an instance of this type to a string 
- 
          second() publicSet the instance's second 
- 
          secondsSinceMidnight() publicThe number of seconds since midnight. 
- 
          secondsUntilEndOfDay() publicThe number of seconds until 23:59:59. 
- 
          setDateTime() publicSet the date and time all together 
- 
          setDefaultLocale() public staticSets the default locale. 
- 
          setDiffFormatter() public staticSet the difference formatter instance. 
- 
          setJsonEncodeFormat() public staticSets the default format used when converting this object to JSON 
- 
          setTimeFromTimeString() publicSet the time by time string 
- 
          setTimezone() publicSet the instance's timezone from a string or object 
- 
          setToStringFormat() public staticSets the default format used when type converting instances of this type to string 
- 
          startOfCentury() publicSets the date to the first day of the century and the time to 00:00:00 
- 
          startOfDay() publicSets the time to 00:00:00 
- 
          startOfDecade() publicSets the date to the first day of the decade and the time to 00:00:00 
- 
          startOfMonth() publicSets the date to the first day of the month and the time to 00:00:00 
- 
          startOfWeek() publicSets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00 
- 
          startOfYear() publicSets the date to the first day of the year and the time to 00:00:00 
- 
          subDay() publicRemove a day from the instance 
- 
          subDays() publicRemove days from the instance 
- 
          subHour() publicRemove an hour from the instance 
- 
          subHours() publicRemove hours from the instance 
- 
          subMinute() publicRemove a minute from the instance 
- 
          subMinutes() publicRemove minutes from the instance 
- 
          subMonth() publicRemove a month from the instance 
- 
          subMonthWithOverflow() publicRemove a month with overflow from the instance. 
- 
          subMonths() publicRemove months from the instance. 
- 
          subMonthsWithOverflow() publicRemove months with overflow from the instance. 
- 
          subSecond() publicRemove a second from the instance 
- 
          subSeconds() publicRemove seconds from the instance 
- 
          subWeek() publicRemove a week from the instance 
- 
          subWeekday() publicRemove a weekday from the instance 
- 
          subWeekdays() publicRemove weekdays from the instance 
- 
          subWeeks() publicRemove weeks to the instance 
- 
          subYear() publicRemove a year from the instance. 
- 
          subYearWithOverflow() publicRemove a year with overflow from the instance 
- 
          subYears() publicRemove years from the instance. 
- 
          subYearsWithOverflow() publicRemove years with overflow from the instance 
- 
          timestamp() publicSet the instance's timestamp 
- 
          timezone() publicAlias for setTimezone() 
- 
          toAtomString() publicFormat the instance as ATOM 
- 
          toCookieString() publicFormat the instance as COOKIE 
- 
          toDateString() publicFormat the instance as date 
- 
          toDateTimeString() publicFormat the instance as date and time 
- 
          toDayDateTimeString() publicFormat the instance with day, date and time 
- 
          toFormattedDateString() publicFormat the instance as a readable date 
- 
          toIso8601String() publicFormat the instance as ISO8601 
- 
          toRfc1036String() publicFormat the instance as RFC1036 
- 
          toRfc1123String() publicFormat the instance as RFC1123 
- 
          toRfc2822String() publicFormat the instance as RFC2822 
- 
          toRfc3339String() publicFormat the instance as RFC3339 
- 
          toRfc822String() publicFormat the instance as RFC822 
- 
          toRfc850String() publicFormat the instance as RFC850 
- 
          toRssString() publicFormat the instance as RSS 
- 
          toTimeString() publicFormat the instance as time 
- 
          toW3cString() publicFormat the instance as W3C 
- 
          tz() publicAlias for setTimezone() 
- 
          wasWithinLast() publicReturns true this instance happened within the specified interval 
- 
          year() publicSet the instance's year 
Method Detail
addDay() ¶ public
addDay(int $value = 1): staticAdd a day to the instance
Parameters
- 
                int$value optional
- The number of days to add. 
Returns
staticaddDays() ¶ public
addDays(int $value): staticAdd days to the instance. Positive $value travels forward while negative $value travels into the past.
Parameters
- 
                int$value
- The number of days to add. 
Returns
staticaddHour() ¶ public
addHour(int $value = 1): staticAdd an hour to the instance
Parameters
- 
                int$value optional
- The number of hours to add. 
Returns
staticaddHours() ¶ public
addHours(int $value): staticAdd hours to the instance. Positive $value travels forward while negative $value travels into the past.
Parameters
- 
                int$value
- The number of hours to add. 
Returns
staticaddMinute() ¶ public
addMinute(int $value = 1): staticAdd a minute to the instance
Parameters
- 
                int$value optional
- The number of minutes to add. 
Returns
staticaddMinutes() ¶ public
addMinutes(int $value): staticAdd minutes to the instance. Positive $value travels forward while negative $value travels into the past.
Parameters
- 
                int$value
- The number of minutes to add. 
Returns
staticaddMonth() ¶ public
addMonth(int $value = 1): staticAdd a month to the instance.
Has the same behavior as addMonths().
Parameters
- 
                int$value optional
- The number of months to add. 
Returns
staticaddMonthWithOverflow() ¶ public
addMonthWithOverflow(int $value = 1): staticAdd a month with overflow to the instance.
Has the same behavior as addMonthsWithOverflow().
Parameters
- 
                int$value optional
- The number of months to add. 
Returns
staticaddMonths() ¶ public
addMonths(int $value): staticAdd 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.
Example:
 (new Chronos('2015-01-03'))->addMonths(1); // Results in 2015-02-03
(new Chronos('2015-01-31'))->addMonths(1); // Results in 2015-02-28Parameters
- 
                int$value
- The number of months to add. 
Returns
staticaddMonthsWithOverflow() ¶ public
addMonthsWithOverflow(int $value): staticAdd 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.
Example:
 (new Chronos('2012-01-30'))->addMonthsWithOverflow(1); // Results in 2013-03-01Parameters
- 
                int$value
- The number of months to add. 
Returns
staticaddSecond() ¶ public
addSecond(int $value = 1): staticAdd a second to the instance
Parameters
- 
                int$value optional
- The number of seconds to add. 
Returns
staticaddSeconds() ¶ public
addSeconds(int $value): staticAdd seconds to the instance. Positive $value travels forward while negative $value travels into the past.
Parameters
- 
                int$value
- The number of seconds to add. 
Returns
staticaddWeek() ¶ public
addWeek(int $value = 1): staticAdd a week to the instance
Parameters
- 
                int$value optional
- The number of weeks to add. 
Returns
staticaddWeekday() ¶ public
addWeekday(int $value = 1): staticAdd a weekday to the instance
Parameters
- 
                int$value optional
- The number of weekdays to add. 
Returns
staticaddWeekdays() ¶ public
addWeekdays(int $value): staticAdd weekdays to the instance. Positive $value travels forward while negative $value travels into the past.
Parameters
- 
                int$value
- The number of weekdays to add. 
Returns
staticaddWeeks() ¶ public
addWeeks(int $value): staticAdd weeks to the instance. Positive $value travels forward while negative $value travels into the past.
Parameters
- 
                int$value
- The number of weeks to add. 
Returns
staticaddYear() ¶ public
addYear(int $value = 1): staticAdd a year to the instance
Has the same behavior as addYears().
Parameters
- 
                int$value optional
- The number of years to add. 
Returns
staticaddYearWithOverflow() ¶ public
addYearWithOverflow(int $value = 1): staticAdd a year with overflow to the instance
Has the same behavior as addYearsWithOverflow().
Parameters
- 
                int$value optional
- The number of years to add. 
Returns
staticaddYears() ¶ public
addYears(int $value): staticAdd 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.
Example:
 (new Chronos('2015-01-03'))->addYears(1); // Results in 2016-01-03
(new Chronos('2012-02-29'))->addYears(1); // Results in 2013-02-28Parameters
- 
                int$value
- The number of years to add. 
Returns
staticaddYearsWithOverflow() ¶ public
addYearsWithOverflow(int $value): staticAdd 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.
Example:
 (new Chronos('2012-02-29'))->addYearsWithOverflow(1); // Results in 2013-03-01Parameters
- 
                int$value
- The number of years to add. 
Returns
staticaverage() ¶ public
average(Cake\Chronos\ChronosInterface $dt = null): staticModify the current instance to the average of a given instance (default now) and the current instance.
Parameters
- 
                Cake\Chronos\ChronosInterface$dt optional
- The instance to compare with. 
Returns
staticbetween() ¶ public
between(Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2, bool $equal = true): boolDetermines if the instance is between two others
Parameters
- 
                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 >= 
Returns
boolclosest() ¶ public
closest(Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2): staticGet the closest date from the instance.
Parameters
- 
                Cake\Chronos\ChronosInterface$dt1
- The instance to compare with. 
- 
                Cake\Chronos\ChronosInterface$dt2
- The instance to compare with. 
Returns
staticday() ¶ public
day(int $value): staticSet the instance's day
Parameters
- 
                int$value
- The day value. 
Returns
staticdiffFiltered() ¶ public
diffFiltered(Cake\Chronos\ChronosInterval $ci, callable $callback, Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference by the given interval using a filter callable
Parameters
- 
                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 
Returns
intdiffForHumans() ¶ public
diffForHumans(Cake\Chronos\ChronosInterface|null $other = null, bool $absolute = false): stringGet 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
Parameters
- 
                Cake\Chronos\ChronosInterface|null$other optional
- The datetime to compare with. 
- 
                bool$absolute optional
- Removes time difference modifiers ago, after, etc 
Returns
stringdiffInDays() ¶ public
diffInDays(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in days
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInDaysFiltered() ¶ public
diffInDaysFiltered(callable $callback, Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in days using a filter callable
Parameters
- 
                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 
Returns
intdiffInHours() ¶ public
diffInHours(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in hours
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInHoursFiltered() ¶ public
diffInHoursFiltered(callable $callback, Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in hours using a filter callable
Parameters
- 
                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 
Returns
intdiffInMinutes() ¶ public
diffInMinutes(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in minutes
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInMonths() ¶ public
diffInMonths(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in months
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInSeconds() ¶ public
diffInSeconds(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in seconds
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInWeekdays() ¶ public
diffInWeekdays(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in weekdays
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInWeekendDays() ¶ public
diffInWeekendDays(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in weekend days using a filter
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInWeeks() ¶ public
diffInWeeks(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in weeks
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intdiffInYears() ¶ public
diffInYears(Cake\Chronos\ChronosInterface|null $dt = null, bool $abs = true): intGet the difference in years
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to difference from. 
- 
                bool$abs optional
- Get the absolute of the difference 
Returns
intendOfCentury() ¶ public
endOfCentury(): staticSets the date to end of the century and time to 23:59:59
Returns
staticendOfDay() ¶ public
endOfDay(bool $microseconds = false): staticSets the time to 23:59:59 or 23:59:59.999999
if $microseconds is true.
Parameters
- 
                bool$microseconds optional
- Whether to set microseconds 
Returns
staticendOfDecade() ¶ public
endOfDecade(): staticSets the date to end of the decade and time to 23:59:59
Returns
staticendOfMonth() ¶ public
endOfMonth(): staticSets the date to end of the month and time to 23:59:59
Returns
staticendOfWeek() ¶ public
endOfWeek(): staticSets the date to end of week (defined in $weekEndsAt) and time to 23:59:59
Returns
staticendOfYear() ¶ public
endOfYear(): staticSets the date to end of the year and time to 23:59:59
Returns
staticeq() ¶ public
eq(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolSee Also
equals() ¶ public
equals(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolfarthest() ¶ public
farthest(Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2): staticGet the farthest date from the instance.
Parameters
- 
                Cake\Chronos\ChronosInterface$dt1
- The instance to compare with. 
- 
                Cake\Chronos\ChronosInterface$dt2
- The instance to compare with. 
Returns
staticfirstOfMonth() ¶ public
firstOfMonth(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticfirstOfQuarter() ¶ public
firstOfQuarter(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticfirstOfYear() ¶ public
firstOfYear(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticgetDefaultLocale() ¶ public static
getDefaultLocale(): string|nullGets the default locale.
Returns
string|nullThe default locale string to be used or null.
getDiffFormatter() ¶ public static
getDiffFormatter(): Cake\Chronos\DifferenceFormatterInterfaceGet the difference formatter instance.
Returns
Cake\Chronos\DifferenceFormatterInterfaceThe formatter instance.
greaterThan() ¶ public
greaterThan(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is greater (after) than another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolgreaterThanOrEquals() ¶ public
greaterThanOrEquals(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is greater (after) than or equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolgt() ¶ public
gt(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is greater (after) than another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolSee Also
gte() ¶ public
gte(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is greater (after) than or equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolSee Also
hour() ¶ public
hour(int $value): staticSet the instance's hour
Parameters
- 
                int$value
- The hour value. 
Returns
statici18nFormat() ¶ public
i18nFormat(string|int|null $format = null, DateTimeZone|string|null $timezone = null, string|null $locale = null): string|intReturns 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: https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classSimpleDateFormat.html#details.
Additional to IntlDateFormatter constants and date formatting string you can use
Time::UNIX_TIMESTAMP_FORMAT to get a unix timestamp
Examples
$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'If you wish to control the default format to be used for this method, you can alter
the value of the static Time::$defaultLocale variable and set it to one of the
possible formats accepted by this function.
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.
Examples
$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 to be used by setting the static variable
Time::$defaultLocale to a valid locale string. If empty, the default will be
taken from the intl.default_locale ini config.
Parameters
- 
                string|int|null$format optional
- Format string. 
- 
                DateTimeZone|string|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) 
Returns
string|intFormatted and translated date string
isBirthday() ¶ public
isBirthday(Cake\Chronos\ChronosInterface $dt): boolCheck if its the birthday. Compares the date/month values of the two dates.
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolisFuture() ¶ public
isFuture(): boolDetermines if the instance is in the future, ie. greater (after) than now
Returns
boolisMutable() ¶ public
isMutable(): boolCheck if instance of ChronosInterface is mutable.
Returns
boolisPast() ¶ public
isPast(): boolDetermines if the instance is in the past, ie. less (before) than now
Returns
boolisSameDay() ¶ public
isSameDay(Cake\Chronos\ChronosInterface $dt): boolChecks if the passed in date is the same day as the instance current day.
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to check against. 
Returns
boolisThisMonth() ¶ public
isThisMonth(): boolReturns true if this object represents a date within the current month
Returns
boolisThisWeek() ¶ public
isThisWeek(): boolReturns true if this object represents a date within the current week
Returns
boolisThisYear() ¶ public
isThisYear(): boolReturns true if this object represents a date within the current year
Returns
boolisWithinNext() ¶ public
isWithinNext(string|int $timeInterval): boolReturns true this instance will happen within the specified interval
Parameters
- 
                string|int$timeInterval
- the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute. 
Returns
boollastOfMonth() ¶ public
lastOfMonth(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticlastOfQuarter() ¶ public
lastOfQuarter(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticlastOfYear() ¶ public
lastOfYear(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticlessThan() ¶ public
lessThan(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is less (before) than another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boollessThanOrEquals() ¶ public
lessThanOrEquals(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is less (before) or equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boollt() ¶ public
lt(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is less (before) than another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolSee Also
lte() ¶ public
lte(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is less (before) or equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolSee Also
max() ¶ public
max(Cake\Chronos\ChronosInterface|null $dt = null): staticGet the maximum instance between a given instance (default now) and the current instance.
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to compare with. 
Returns
staticmin() ¶ public
min(Cake\Chronos\ChronosInterface|null $dt = null): staticGet the minimum instance between a given instance (default now) and the current instance.
Parameters
- 
                Cake\Chronos\ChronosInterface|null$dt optional
- The instance to compare with. 
Returns
staticminute() ¶ public
minute(int $value): staticSet the instance's minute
Parameters
- 
                int$value
- The minute value. 
Returns
staticmodify() ¶ public @method
modify(string $relative): Cake\Chronos\ChronosInterfaceParameters
- 
                string$relative
Returns
Cake\Chronos\ChronosInterfacemonth() ¶ public
month(int $value): staticSet the instance's month
Parameters
- 
                int$value
- The month value. 
Returns
staticne() ¶ public
ne(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is not equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolSee Also
next() ¶ public
next(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticnice() ¶ public
nice(DateTimeZone|string|null $timezone = null, string|null $locale = null): stringReturns a nicely formatted date string for this object.
The format to be used is stored in the static property Time::niceFormat.
Parameters
- 
                DateTimeZone|string|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) 
Returns
stringFormatted date string
notEquals() ¶ public
notEquals(Cake\Chronos\ChronosInterface $dt): boolDetermines if the instance is not equal to another
Parameters
- 
                Cake\Chronos\ChronosInterface$dt
- The instance to compare with. 
Returns
boolnow() ¶ public static
now(DateTimeZone|string|null $tz = null): staticGet a ChronosInterface instance for the current date and time
Parameters
- 
                DateTimeZone|string|null$tz optional
- The DateTimeZone object or timezone name. 
Returns
staticnthOfMonth() ¶ public
nthOfMonth(int $nth, int $dayOfWeek): static|falseModify 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.
Parameters
- 
                int$nth
- The offset to use. 
- 
                int$dayOfWeek
- The day of the week to move to. 
Returns
static|falsenthOfQuarter() ¶ public
nthOfQuarter(int $nth, int $dayOfWeek): static|falseModify 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.
Parameters
- 
                int$nth
- The offset to use. 
- 
                int$dayOfWeek
- The day of the week to move to. 
Returns
static|falsenthOfYear() ¶ public
nthOfYear(int $nth, int $dayOfWeek): static|falseModify 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.
Parameters
- 
                int$nth
- The offset to use. 
- 
                int$dayOfWeek
- The day of the week to move to. 
Returns
static|falseparseDate() ¶ public static
parseDate(string $date, array|string|int|null $format = null): static|nullReturns 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);Parameters
- 
                string$date
- The date string to parse. 
- 
                array|string|int|null$format optional
- Any format accepted by IntlDateFormatter. 
Returns
static|nullparseDateTime() ¶ public static
parseDateTime(string $time, array<int>|string|null $format = null, DateTimeZone|string|null $tz = null): static|nullReturns 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.
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, -1]);Parameters
- 
                string$time
- The time string to parse. 
- 
                array<int>|string|null$format optional
- Any format accepted by IntlDateFormatter. 
- 
                DateTimeZone|string|null$tz optional
- The timezone for the instance 
Returns
static|nullThrows
InvalidArgumentExceptionIf $format is a single int instead of array of constants
parseTime() ¶ public static
parseTime(string $time, string|int|null $format = null): static|nullReturns 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');Parameters
- 
                string$time
- The time string to parse. 
- 
                string|int|null$format optional
- Any format accepted by IntlDateFormatter. 
Returns
static|nullprevious() ¶ public
previous(int|null $dayOfWeek = null): staticModify 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.
Parameters
- 
                int|null$dayOfWeek optional
- The day of the week to move to. 
Returns
staticresetToStringFormat() ¶ public static
resetToStringFormat(): voidResets the format used to the default when converting an instance of this type to a string
Returns
voidsecond() ¶ public
second(int $value): staticSet the instance's second
Parameters
- 
                int$value
- The seconds value. 
Returns
staticsecondsSinceMidnight() ¶ public
secondsSinceMidnight(): intThe number of seconds since midnight.
Returns
intsecondsUntilEndOfDay() ¶ public
secondsUntilEndOfDay(): intThe number of seconds until 23:59:59.
Returns
intsetDateTime() ¶ public
setDateTime(int $year, int $month, int $day, int $hour, int $minute, int $second = 0): staticSet the date and time all together
Parameters
- 
                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. 
Returns
staticsetDefaultLocale() ¶ public static
setDefaultLocale(string|null $locale = null): voidSets the default locale.
Parameters
- 
                string|null$locale optional
- The default locale string to be used or null. 
Returns
voidsetDiffFormatter() ¶ public static
setDiffFormatter(Cake\Chronos\DifferenceFormatterInterface $formatter): voidSet the difference formatter instance.
Parameters
- 
                Cake\Chronos\DifferenceFormatterInterface$formatter
- The formatter instance when setting. 
Returns
voidsetJsonEncodeFormat() ¶ public static
setJsonEncodeFormat(Closure|array|string|int $format): voidSets 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 (https://unicode-org.github.io/icu-docs/apidoc/released/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.
Parameters
- 
                Closure|array|string|int$format
- Format. 
Returns
voidSee Also
setTimeFromTimeString() ¶ public
setTimeFromTimeString(string $time): staticSet the time by time string
Parameters
- 
                string$time
- Time as string. 
Returns
staticsetTimezone() ¶ public
setTimezone(DateTimeZone|string $value): staticSet the instance's timezone from a string or object
Parameters
- 
                DateTimeZone|string$value
- The DateTimeZone object or timezone name to use. 
Returns
staticsetToStringFormat() ¶ public static
setToStringFormat(array<int>|string|int $format): voidSets the default format used when type converting instances of this type to string
Parameters
- 
                array<int>|string|int$format
- Format. 
Returns
voidstartOfCentury() ¶ public
startOfCentury(): staticSets the date to the first day of the century and the time to 00:00:00
Returns
staticstartOfDecade() ¶ public
startOfDecade(): staticSets the date to the first day of the decade and the time to 00:00:00
Returns
staticstartOfMonth() ¶ public
startOfMonth(): staticSets the date to the first day of the month and the time to 00:00:00
Returns
staticstartOfWeek() ¶ public
startOfWeek(): staticSets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
Returns
staticstartOfYear() ¶ public
startOfYear(): staticSets the date to the first day of the year and the time to 00:00:00
Returns
staticsubDay() ¶ public
subDay(int $value = 1): staticRemove a day from the instance
Parameters
- 
                int$value optional
- The number of days to remove. 
Returns
staticsubDays() ¶ public
subDays(int $value): staticRemove days from the instance
Parameters
- 
                int$value
- The number of days to remove. 
Returns
staticsubHour() ¶ public
subHour(int $value = 1): staticRemove an hour from the instance
Parameters
- 
                int$value optional
- The number of hours to remove. 
Returns
staticsubHours() ¶ public
subHours(int $value): staticRemove hours from the instance
Parameters
- 
                int$value
- The number of hours to remove. 
Returns
staticsubMinute() ¶ public
subMinute(int $value = 1): staticRemove a minute from the instance
Parameters
- 
                int$value optional
- The number of minutes to remove. 
Returns
staticsubMinutes() ¶ public
subMinutes(int $value): staticRemove minutes from the instance
Parameters
- 
                int$value
- The number of minutes to remove. 
Returns
staticsubMonth() ¶ public
subMonth(int $value = 1): staticRemove a month from the instance
Has the same behavior as addMonths().
Parameters
- 
                int$value optional
- The number of months to remove. 
Returns
staticsubMonthWithOverflow() ¶ public
subMonthWithOverflow(int $value = 1): staticRemove a month with overflow from the instance.
Has the same behavior as addMonthsWithOverflow().
Parameters
- 
                int$value optional
- The number of months to remove. 
Returns
staticsubMonths() ¶ public
subMonths(int $value): staticRemove months from the instance.
Has the same behavior as addMonths().
Parameters
- 
                int$value
- The number of months to remove. 
Returns
staticsubMonthsWithOverflow() ¶ public
subMonthsWithOverflow(int $value): staticRemove months with overflow from the instance.
Has the same behavior as addMonthsWithOverflow().
Parameters
- 
                int$value
- The number of months to remove. 
Returns
staticsubSecond() ¶ public
subSecond(int $value = 1): staticRemove a second from the instance
Parameters
- 
                int$value optional
- The number of seconds to remove. 
Returns
staticsubSeconds() ¶ public
subSeconds(int $value): staticRemove seconds from the instance
Parameters
- 
                int$value
- The number of seconds to remove. 
Returns
staticsubWeek() ¶ public
subWeek(int $value = 1): staticRemove a week from the instance
Parameters
- 
                int$value optional
- The number of weeks to remove. 
Returns
staticsubWeekday() ¶ public
subWeekday(int $value = 1): staticRemove a weekday from the instance
Parameters
- 
                int$value optional
- The number of weekdays to remove. 
Returns
staticsubWeekdays() ¶ public
subWeekdays(int $value): staticRemove weekdays from the instance
Parameters
- 
                int$value
- The number of weekdays to remove. 
Returns
staticsubWeeks() ¶ public
subWeeks(int $value): staticRemove weeks to the instance
Parameters
- 
                int$value
- The number of weeks to remove. 
Returns
staticsubYear() ¶ public
subYear(int $value = 1): staticRemove a year from the instance.
Has the same behavior as addYears().
Parameters
- 
                int$value optional
- The number of years to remove. 
Returns
staticsubYearWithOverflow() ¶ public
subYearWithOverflow(int $value = 1): staticRemove a year with overflow from the instance
Has the same behavior as addYearsWithOverflow().
Parameters
- 
                int$value optional
- The number of years to remove. 
Returns
staticsubYears() ¶ public
subYears(int $value): staticRemove years from the instance.
Has the same behavior as addYears().
Parameters
- 
                int$value
- The number of years to remove. 
Returns
staticsubYearsWithOverflow() ¶ public
subYearsWithOverflow(int $value): staticRemove years with overflow from the instance
Has the same behavior as addYearsWithOverflow().
Parameters
- 
                int$value
- The number of years to remove. 
Returns
statictimestamp() ¶ public
timestamp(int $value): staticSet the instance's timestamp
Parameters
- 
                int$value
- The timestamp value to set. 
Returns
statictimezone() ¶ public
timezone(DateTimeZone|string $value): staticAlias for setTimezone()
Parameters
- 
                DateTimeZone|string$value
- The DateTimeZone object or timezone name to use. 
Returns
statictoDateTimeString() ¶ public
toDateTimeString(): stringFormat the instance as date and time
Returns
stringtoDayDateTimeString() ¶ public
toDayDateTimeString(): stringFormat the instance with day, date and time
Returns
stringtoFormattedDateString() ¶ public
toFormattedDateString(): stringFormat the instance as a readable date
Returns
stringtz() ¶ public
tz(DateTimeZone|string $value): staticAlias for setTimezone()
Parameters
- 
                DateTimeZone|string$value
- The DateTimeZone object or timezone name to use. 
Returns
staticwasWithinLast() ¶ public
wasWithinLast(string|int $timeInterval): boolReturns true this instance happened within the specified interval
Parameters
- 
                string|int$timeInterval
- the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute. 
Returns
boolyear() ¶ public
year(int $value): staticSet the instance's year
Parameters
- 
                int$value
- The year value. 
Returns
static