Fr3nch13/CakePHP Utilities

Chronos extends DateTimeImmutable
in package

Application

implements ChronosInterface uses ComparisonTrait, DifferenceTrait, FactoryTrait, FormattingTrait, MagicPropertyTrait, ModifierTrait, RelativeKeywordTrait, TimezoneTrait

An Immutable extension on the native DateTime object.

Adds a number of convenience APIs methods and the ability to easily convert into a mutable object.

Interfaces

ChronosInterface: An extension to the DateTimeInterface for a friendlier API

Properties

$age : int
$day : int
$dayOfWeek : int
$dayOfYear : int
$daysInMonth : int
$dst : bool
$hour : int
$local : bool
$micro : int
$microsecond : int
$minute : int
$month : int
$offset : int
$offsetHours : int
$quarter : int
$second : int
$timestamp : int
$timezone : DateTimeZone
$timezoneName : string
$tz : DateTimeZone
$tzName : string
$utc : bool
$weekOfMonth : int
$weekOfYear : int
$year : int
$yearIso : int
$_lastErrors : array<string|int, mixed>: Holds the last error generated by createFromFormat
$days : array<string|int, mixed>: Names of days of the week.
$diffFormatter : DifferenceFormatterInterface|null: Instance of the diff formatting object.
$relativePattern : string: Regex for relative period.
$testNow : ChronosInterface|null: A test ChronosInterface instance to be returned when now instances are created
$toStringFormat : string: Format to use for __toString method when type juggling occurs.
$weekendDays : array<string|int, mixed>: Days of weekend
$weekEndsAt : int: Last day of week
$weekStartsAt : int: First day of week

Methods

__construct() : mixed: Create a new Chronos instance.
__debugInfo() : array<string|int, mixed>: Return properties for debugging.
__get() : string|int|bool|DateTimeZone: Get a part of the ChronosInterface object
__isset() : bool: Check if an attribute exists on the object
__toString() : string: Format the instance as a string using the set format
addDay() : static: Add a day to the instance
addDays() : static: Add days to the instance. Positive $value travels forward while negative $value travels into the past.
addHour() : static: Add an hour to the instance
addHours() : static: Add hours to the instance. Positive $value travels forward while negative $value travels into the past.
addMinute() : static: Add a minute to the instance
addMinutes() : static: Add minutes to the instance. Positive $value travels forward while negative $value travels into the past.
addMonth() : static: Add a month to the instance
addMonths() : static: Add months to the instance. Positive $value travels forward while negative $value travels into the past.
addMonthsWithOverflow() : static: Add months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
addMonthWithOverflow() : static: Add a month with overflow to the instance.
addSecond() : static: Add a second to the instance
addSeconds() : static: Add seconds to the instance. Positive $value travels forward while negative $value travels into the past.
addWeek() : static: Add a week to the instance
addWeekday() : static: Add a weekday to the instance
addWeekdays() : static: Add weekdays to the instance. Positive $value travels forward while negative $value travels into the past.
addWeeks() : static: Add weeks to the instance. Positive $value travels forward while negative $value travels into the past.
addYear() : static: Add a year to the instance.
addYears() : static: Add years to the instance. Positive $value travel forward while negative $value travel into the past.
addYearsWithOverflow() : static: Add years with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
addYearWithOverflow() : static: Add a year with overflow to the instance.
average() : static: Modify the current instance to the average of a given instance (default now) and the current instance.
between() : bool: Determines if the instance is between two others
closest() : ChronosInterface: Get the closest date from the instance.
copy() : static: Get a copy of the instance
create() : static: Create a new ChronosInterface instance from a specific date and time.
createFromArray() : static: Creates a ChronosInterface instance from an array of date and time values.
createFromDate() : static: Create a ChronosInterface instance from just a date. The time portion is set to now.
createFromFormat() : static: Create a ChronosInterface instance from a specific format
createFromTime() : static: Create a ChronosInterface instance from just a time. The date portion is set to today.
createFromTimestamp() : static: Create a ChronosInterface instance from a timestamp
createFromTimestampUTC() : static: Create a ChronosInterface instance from an UTC timestamp
createInterval() : DateInterval: Create a new DateInterval instance from specified values.
day() : static: Set the instance's day
diffFiltered() : int: Get the difference by the given interval using a filter callable
diffForHumans() : string: Get the difference in a human readable format.
diffFormatter() : DifferenceFormatterInterface: Get the difference formatter instance or overwrite the current one.
diffInDays() : int: Get the difference in days
diffInDaysFiltered() : int: Get the difference in days using a filter callable
diffInHours() : int: Get the difference in hours
diffInHoursFiltered() : int: Get the difference in hours using a filter callable
diffInMinutes() : int: Get the difference in minutes
diffInMonths() : int: Get the difference in months
diffInMonthsIgnoreTimezone() : int: Get the difference in months ignoring the timezone. This means the months are calculated in the specified timezone without converting to UTC first. This prevents the day from changing which can change the month.
diffInSeconds() : int: Get the difference in seconds
diffInWeekdays() : int: Get the difference in weekdays
diffInWeekendDays() : int: Get the difference in weekend days using a filter
diffInWeeks() : int: Get the difference in weeks
diffInYears() : int: Get the difference in years
endOfCentury() : static: Sets the date to end of the century and time to 23:59:59
endOfDay() : static: Sets the time to 23:59:59 or 23:59:59.999999 if `$microseconds` is true.
endOfDecade() : static: Sets the date to end of the decade and time to 23:59:59
endOfMonth() : static: Sets the date to end of the month and time to 23:59:59
endOfWeek() : static: Sets the date to end of week (defined in $weekEndsAt) and time to 23:59:59
endOfYear() : static: Sets the date to end of the year and time to 23:59:59
eq() : bool: Determines if the instance is equal to another
equals() : bool: Determines if the instance is equal to another
farthest() : ChronosInterface: Get the farthest date from the instance.
firstOfMonth() : static: 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. ChronosInterface::MONDAY.
firstOfQuarter() : static: 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. ChronosInterface::MONDAY.
firstOfYear() : static: 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. ChronosInterface::MONDAY.
fromNow() : DateInterval|bool: Convenience method for getting the remaining time from a given time.
getLastErrors() : array<string|int, mixed>: Returns any errors or warnings that were found during the parsing of the last object created by this class.
getTestNow() : ChronosInterface|null: Get the ChronosInterface instance (real or mock) to be returned when a "now" instance is created.
getWeekendDays() : array<string|int, mixed>: Get weekend days
getWeekEndsAt() : int: Get the last day of week
getWeekStartsAt() : int: Get the first day of week
greaterThan() : bool: Determines if the instance is greater (after) than another
greaterThanOrEquals() : bool: Determines if the instance is greater (after) than or equal to another
gt() : bool: Determines if the instance is greater (after) than another
gte() : bool: Determines if the instance is greater (after) than or equal to another
hasRelativeKeywords() : bool: 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
hasTestNow() : bool: Determine if there is a valid test instance set. A valid test instance is anything that is not null.
hour() : static: Set the instance's hour
instance() : static: Create a ChronosInterface instance from a DateTimeInterface one
isBirthday() : bool: Check if its the birthday. Compares the date/month values of the two dates.
isFriday() : bool: Checks if this day is a Friday.
isFuture() : bool: Determines if the instance is in the future, ie. greater (after) than now
isLastMonth() : bool: Determines if the instance is within the last month
isLastWeek() : bool: Determines if the instance is within the last week
isLastYear() : bool: Determines if the instance is within the last year
isLeapYear() : bool: Determines if the instance is a leap year
isMonday() : bool: Checks if this day is a Monday.
isMutable() : bool: Check if instance of ChronosInterface is mutable.
isNextMonth() : bool: Determines if the instance is within the next month
isNextWeek() : bool: Determines if the instance is within the next week
isNextYear() : bool: Determines if the instance is within the next year
isPast() : bool: Determines if the instance is in the past, ie. less (before) than now
isSameDay() : bool: Checks if the passed in date is the same day as the instance current day.
isSaturday() : bool: Checks if this day is a Saturday.
isSunday() : bool: Checks if this day is a Sunday.
isThisMonth() : bool: Returns true if this object represents a date within the current month
isThisWeek() : bool: Returns true if this object represents a date within the current week
isThisYear() : bool: Returns true if this object represents a date within the current year
isThursday() : bool: Checks if this day is a Thursday.
isToday() : bool: Determines if the instance is today
isTomorrow() : bool: Determines if the instance is tomorrow
isTuesday() : bool: Checks if this day is a Tuesday.
isWednesday() : bool: Checks if this day is a Wednesday.
isWeekday() : bool: Determines if the instance is a weekday
isWeekend() : bool: Determines if the instance is a weekend day
isWithinNext() : bool: Returns true this instance will happen within the specified interval
isYesterday() : bool: Determines if the instance is yesterday
lastOfMonth() : static: 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. ChronosInterface::MONDAY.
lastOfQuarter() : static: 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. ChronosInterface::MONDAY.
lastOfYear() : static: 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. ChronosInterface::MONDAY.
lessThan() : bool: Determines if the instance is less (before) than another
lessThanOrEquals() : bool: Determines if the instance is less (before) or equal to another
lt() : bool: Determines if the instance is less (before) than another
lte() : bool: Determines if the instance is less (before) or equal to another
max() : ChronosInterface: Get the maximum instance between a given instance (default now) and the current instance.
maxValue() : ChronosInterface: Create a ChronosInterface instance for the greatest supported date.
microsecond() : static: Set the instance's microsecond
min() : ChronosInterface: Get the minimum instance between a given instance (default now) and the current instance.
minute() : static: Set the instance's minute
minValue() : ChronosInterface: Create a ChronosInterface instance for the lowest supported date.
month() : static: Set the instance's month
ne() : bool: Determines if the instance is not equal to another
next() : static: Modify to the next occurrence of a given day of the week.
notEquals() : bool: Determines if the instance is not equal to another
now() : static: Get a ChronosInterface instance for the current date and time
nthOfMonth() : static|false: 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.
nthOfQuarter() : static|false: 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.
nthOfYear() : static|false: 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.
parse() : static: 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()
previous() : static: Modify to the previous occurrence of a given day of the week.
resetToStringFormat() : void: Reset the format used to the default when type juggling a ChronosInterface instance to a string
second() : static: Set the instance's second
secondsSinceMidnight() : int: The number of seconds since midnight.
secondsUntilEndOfDay() : int: The number of seconds until 23:59:59.
setDate() : static: Set the date to a different date.
setDateTime() : static: Set the date and time all together
setTestNow() : void: 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: - A call to the static now() method, ex. ChronosInterface::now() - When a null (or blank string) is passed to the constructor or parse(), ex. new Chronos(null) - When the string "now" is passed to the constructor or parse(), ex. new Chronos('now') - When a string containing the desired time is passed to ChronosInterface::parse()
setTimeFromTimeString() : static: Set the time by time string
setTimezone() : static: Set the instance's timezone from a string or object
setToStringFormat() : void: Set the default format used when type juggling a ChronosInterface instance to a string
setWeekendDays() : void: Set weekend days
setWeekEndsAt() : void: Set the last day of week
setWeekStartsAt() : void: Set the first day of week
startOfCentury() : static: Sets the date to the first day of the century and the time to 00:00:00
startOfDay() : static: Sets the time to 00:00:00
startOfDecade() : static: Sets the date to the first day of the decade and the time to 00:00:00
startOfMonth() : static: Sets the date to the first day of the month and the time to 00:00:00
startOfWeek() : static: Sets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
startOfYear() : static: Sets the date to the first day of the year and the time to 00:00:00
subDay() : static: Remove a day from the instance
subDays() : static: Remove days from the instance
subHour() : static: Remove an hour from the instance
subHours() : static: Remove hours from the instance
subMinute() : static: Remove a minute from the instance
subMinutes() : static: Remove minutes from the instance
subMonth() : static: Remove a month from the instance
subMonths() : static: Remove months from the instance
subMonthsWithOverflow() : static: Remove months with overflow from the instance.
subMonthWithOverflow() : static: Remove a month with overflow from the instance.
subSecond() : static: Remove a second from the instance
subSeconds() : static: Remove seconds from the instance
subWeek() : static: Remove a week from the instance
subWeekday() : static: Remove a weekday from the instance
subWeekdays() : static: Remove weekdays from the instance
subWeeks() : static: Remove weeks to the instance
subYear() : static: Remove a year from the instance
subYears() : static: Remove years from the instance.
subYearsWithOverflow() : static: Remove years with overflow from the instance
subYearWithOverflow() : static: Remove a year with overflow from the instance.
timestamp() : static: Set the instance's timestamp
timezone() : static: Alias for setTimezone()
toAtomString() : string: Format the instance as ATOM
toCookieString() : string: Format the instance as COOKIE
toDateString() : string: Format the instance as date
toDateTimeString() : string: Format the instance as date and time
today() : static: Create a ChronosInterface instance for today
toDayDateTimeString() : string: Format the instance with day, date and time
toFormattedDateString() : string: Format the instance as a readable date
toIso8601String() : string: Format the instance as ISO8601
tomorrow() : static: Create a ChronosInterface instance for tomorrow
toMutable() : MutableDateTime: Create a new mutable instance from current immutable instance.
toQuarter() : int|array<string|int, mixed>: Returns the quarter
toRfc1036String() : string: Format the instance as RFC1036
toRfc1123String() : string: Format the instance as RFC1123
toRfc2822String() : string: Format the instance as RFC2822
toRfc3339String() : string: Format the instance as RFC3339
toRfc822String() : string: Format the instance as RFC822
toRfc850String() : string: Format the instance as RFC850
toRssString() : string: Format the instance as RSS
toTimeString() : string: Format the instance as time
toUnixString() : string: Returns a UNIX timestamp.
toW3cString() : string: Format the instance as W3C
toWeek() : int
tz() : static: Alias for setTimezone()
wasWithinLast() : bool: Returns true this instance happened within the specified interval
year() : static: Set the instance's year
yesterday() : static: Create a ChronosInterface instance for yesterday
safeCreateDateTimeZone() : DateTimeZone: Creates a DateTimeZone from a string or a DateTimeZone
isRelativeOnly() : bool: Determines if there is no fixed date in the time string.
isTimeExpression() : bool: Determine if there is just a time in the time string
setDateParent() : static: Just calling to parent setDate It used in overwritten setDate

$age read-only


    public
        int
    $age

does a diffInYears() with default parameters

$day read-only


    public
        int
    $day

$dayOfWeek read-only


    public
        int
    $dayOfWeek

1 (for Monday) through 7 (for Sunday)

$dayOfYear read-only


    public
        int
    $dayOfYear

0 through 365

$daysInMonth read-only


    public
        int
    $daysInMonth

number of days in the given month

$dst read-only


    public
        bool
    $dst

daylight savings time indicator, true if DST, false otherwise

$hour read-only


    public
        int
    $hour

$local read-only


    public
        bool
    $local

checks if the timezone is local, true if local, false otherwise

$micro read-only


    public
        int
    $micro

$microsecond read-only


    public
        int
    $microsecond

$minute read-only


    public
        int
    $minute

$month read-only


    public
        int
    $month

$offset read-only


    public
        int
    $offset

the timezone offset in seconds from UTC

$offsetHours read-only


    public
        int
    $offsetHours

the timezone offset in hours from UTC

$quarter read-only


    public
        int
    $quarter

the quarter of this instance, 1 - 4

$second read-only


    public
        int
    $second

$timestamp read-only


    public
        int
    $timestamp

seconds since the Unix Epoch

$timezone read-only


    public
        DateTimeZone
    $timezone

the current timezone

$timezoneName read-only


    public
        string
    $timezoneName

$tz read-only


    public
        DateTimeZone
    $tz

alias of timezone

$tzName read-only


    public
        string
    $tzName

$utc read-only


    public
        bool
    $utc

checks if the timezone is UTC, true if UTC, false otherwise

$weekOfMonth read-only


    public
        int
    $weekOfMonth

1 through 5

$weekOfYear read-only


    public
        int
    $weekOfYear

ISO-8601 week number of year, weeks starting on Monday

$year read-only


    public
        int
    $year

$yearIso read-only


    public
        int
    $yearIso

$_lastErrors

Holds the last error generated by createFromFormat


    protected
    static    array<string|int, mixed>
    $_lastErrors
     = []

$days

Names of days of the week.


    protected
    static    array<string|int, mixed>
    $days
     = [\Cake\Chronos\ChronosInterface::MONDAY => 'Monday', \Cake\Chronos\ChronosInterface::TUESDAY => 'Tuesday', \Cake\Chronos\ChronosInterface::WEDNESDAY => 'Wednesday', \Cake\Chronos\ChronosInterface::THURSDAY => 'Thursday', \Cake\Chronos\ChronosInterface::FRIDAY => 'Friday', \Cake\Chronos\ChronosInterface::SATURDAY => 'Saturday', \Cake\Chronos\ChronosInterface::SUNDAY => 'Sunday']

$diffFormatter

Instance of the diff formatting object.


    protected
    static    DifferenceFormatterInterface|null
    $diffFormatter

$relativePattern

Regex for relative period.


    protected
    static    string
    $relativePattern
     = '/this|next|last|tomorrow|yesterday|midnight|today|[+-]|first|last|ago/i'

$testNow

A test ChronosInterface instance to be returned when now instances are created


    protected
    static    ChronosInterface|null
    $testNow

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.

$toStringFormat

Format to use for __toString method when type juggling occurs.


    protected
    static    string
    $toStringFormat
     = \Cake\Chronos\ChronosInterface::DEFAULT_TO_STRING_FORMAT

$weekendDays

Days of weekend


    protected
    static    array<string|int, mixed>
    $weekendDays
     = [\Cake\Chronos\ChronosInterface::SATURDAY, \Cake\Chronos\ChronosInterface::SUNDAY]

$weekEndsAt

Last day of week


    protected
    static    int
    $weekEndsAt
     = \Cake\Chronos\ChronosInterface::SUNDAY

$weekStartsAt

First day of week


    protected
    static    int
    $weekStartsAt
     = \Cake\Chronos\ChronosInterface::MONDAY

__construct()

Create a new Chronos instance.


    public
                    __construct([DateTimeInterface|string|int|null $time = 'now' ][, DateTimeZone|string|null $tz = null ]) : mixed

Please see the testing aids section (specifically static::setTestNow()) for more on the possibility of this constructor returning a test instance.

Parameters

$time : DateTimeInterface|string|int|null = 'now': Fixed or relative time
$tz : DateTimeZone|string|null = null: The timezone for the instance

__debugInfo()

Return properties for debugging.


    public
                    __debugInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

__get()

Get a part of the ChronosInterface object


    public
                    __get(string $name) : string|int|bool|DateTimeZone

Parameters

$name : string: The property name to read.

Return values

string|int|bool|DateTimeZone —

The property value.

__isset()

Check if an attribute exists on the object


    public
                    __isset(string $name) : bool

Parameters

$name : string: The property name to check.

Return values

bool —

Whether or not the property exists.

__toString()

Format the instance as a string using the set format


    public
                    __toString() : string

Return values

string

addDay()

Add a day to the instance


    public
                    addDay([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of days to add.

Return values

static

addDays()

Add days to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addDays(int $value) : static

Parameters

$value : int: The number of days to add.

Return values

static

addHour()

Add an hour to the instance


    public
                    addHour([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of hours to add.

Return values

static

addHours()

Add hours to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addHours(int $value) : static

Parameters

$value : int: The number of hours to add.

Return values

static

addMinute()

Add a minute to the instance


    public
                    addMinute([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of minutes to add.

Return values

static

addMinutes()

Add minutes to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addMinutes(int $value) : static

Parameters

$value : int: The number of minutes to add.

Return values

static

addMonth()

Add a month to the instance


    public
                    addMonth([int $value = 1 ]) : static

Has the same behavior as addMonths().

Parameters

$value : int = 1: The number of months to add.

Return values

static

addMonths()

Add months to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addMonths(int $value) : static

When adding or subtracting months, if the resulting time is a date that does not exist, the result of this operation will always be the last day of the intended 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-28

Parameters

$value : int: The number of months to add.

Return values

static

addMonthsWithOverflow()

Add months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addMonthsWithOverflow(int $value) : static

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-01

Parameters

$value : int: The number of months to add.

Return values

static

addMonthWithOverflow()

Add a month with overflow to the instance.


    public
                    addMonthWithOverflow([int $value = 1 ]) : static

Has the same behavior as addMonthsWithOverflow().

Parameters

$value : int = 1: The number of months to add.

Return values

static

addSecond()

Add a second to the instance


    public
                    addSecond([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of seconds to add.

Return values

static

addSeconds()

Add seconds to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addSeconds(int $value) : static

Parameters

$value : int: The number of seconds to add.

Return values

static

addWeek()

Add a week to the instance


    public
                    addWeek([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of weeks to add.

Return values

static

addWeekday()

Add a weekday to the instance


    public
                    addWeekday([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of weekdays to add.

Return values

static

addWeekdays()

Add weekdays to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addWeekdays(int $value) : static

Parameters

$value : int: The number of weekdays to add.

Return values

static

addWeeks()

Add weeks to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addWeeks(int $value) : static

Parameters

$value : int: The number of weeks to add.

Return values

static

addYear()

Add a year to the instance.


    public
                    addYear([int $value = 1 ]) : static

Has the same behavior as addYears().

Parameters

$value : int = 1: The number of years to add.

Return values

static

addYears()

Add years to the instance. Positive $value travel forward while negative $value travel into the past.


    public
                    addYears(int $value) : static

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-28

Parameters

$value : int: The number of years to add.

Return values

static

addYearsWithOverflow()

Add years with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.


    public
                    addYearsWithOverflow(int $value) : static

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-01

Parameters

$value : int: The number of years to add.

Return values

static

addYearWithOverflow()

Add a year with overflow to the instance.


    public
                    addYearWithOverflow([int $value = 1 ]) : static

Has the same behavior as addYearsWithOverflow().

Parameters

$value : int = 1: The number of years to add.

Return values

static

average()

Modify the current instance to the average of a given instance (default now) and the current instance.


    public
                    average([ChronosInterface|null $dt = null ]) : static

Parameters

$dt : ChronosInterface|null = null: The instance to compare with.

Return values

static

between()

Determines if the instance is between two others


    public
                    between(ChronosInterface $dt1, ChronosInterface $dt2[, bool $equal = true ]) : bool

Parameters

$dt1 : ChronosInterface: The instance to compare with.
$dt2 : ChronosInterface: The instance to compare with.
$equal : bool = true: Indicates if a > and < comparison should be used or <= or >=

Return values

bool

closest()

Get the closest date from the instance.


    public
                    closest(ChronosInterface $dt1, ChronosInterface $dt2) : ChronosInterface

Parameters

$dt1 : ChronosInterface: The instance to compare with.
$dt2 : ChronosInterface: The instance to compare with.

Return values

ChronosInterface

copy()

Get a copy of the instance


    public
                    copy() : static

Return values

static

create()

Create a new ChronosInterface instance from a specific date and time.


    public
            static        create([int|null $year = null ][, int|null $month = null ][, int|null $day = null ][, int|null $hour = null ][, int|null $minute = null ][, int|null $second = null ][, int|null $microsecond = null ][, DateTimeZone|string|null $tz = null ]) : static

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.

Parameters

$year : int|null = null: The year to create an instance with.
$month : int|null = null: The month to create an instance with.
$day : int|null = null: The day to create an instance with.
$hour : int|null = null: The hour to create an instance with.
$minute : int|null = null: The minute to create an instance with.
$second : int|null = null: The second to create an instance with.
$microsecond : int|null = null: The microsecond to create an instance with.
$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

createFromArray()

Creates a ChronosInterface instance from an array of date and time values.


    public
            static        createFromArray(array<string|int, int|string> $values) : static

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:

year
month
day
hour
minute
second
microsecond
meridian ('am' or 'pm')
timezone

Parameters

$values : array<string|int, int|string>: Array of date and time values.

Return values

static

createFromDate()

Create a ChronosInterface instance from just a date. The time portion is set to now.


    public
            static        createFromDate([int|null $year = null ][, int|null $month = null ][, int|null $day = null ][, DateTimeZone|string|null $tz = null ]) : static

Parameters

$year : int|null = null: The year to create an instance with.
$month : int|null = null: The month to create an instance with.
$day : int|null = null: The day to create an instance with.
$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

createFromFormat()

Create a ChronosInterface instance from a specific format


    public
            static        createFromFormat(string $format, string $time[, DateTimeZone|string|null $tz = null ]) : static

Parameters

$format : string: The date() compatible format string.
$time : string: The formatted date string to interpret.
$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

createFromTime()

Create a ChronosInterface instance from just a time. The date portion is set to today.


    public
            static        createFromTime([int|null $hour = null ][, int|null $minute = null ][, int|null $second = null ][, int|null $microsecond = null ][, DateTimeZone|string|null $tz = null ]) : static

Parameters

$hour : int|null = null: The hour to create an instance with.
$minute : int|null = null: The minute to create an instance with.
$second : int|null = null: The second to create an instance with.
$microsecond : int|null = null: The microsecond to create an instance with.
$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

createFromTimestamp()

Create a ChronosInterface instance from a timestamp


    public
            static        createFromTimestamp(int $timestamp[, DateTimeZone|string|null $tz = null ]) : static

Parameters

$timestamp : int: The timestamp to create an instance from.
$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

createFromTimestampUTC()

Create a ChronosInterface instance from an UTC timestamp


    public
            static        createFromTimestampUTC(int $timestamp) : static

Parameters

$timestamp : int: The UTC timestamp to create an instance from.

Return values

static

createInterval()

Create a new DateInterval instance from specified values.


    public
            static        createInterval([int|null $years = null ][, int|null $months = null ][, int|null $weeks = null ][, int|null $days = null ][, int|null $hours = null ][, int|null $minutes = null ][, int|null $seconds = null ][, int|null $microseconds = null ]) : DateInterval

Parameters

$years : int|null = null: The year to use.
$months : int|null = null: The month to use.
$weeks : int|null = null: The week to use.
$days : int|null = null: The day to use.
$hours : int|null = null: The hours to use.
$minutes : int|null = null: The minutes to use.
$seconds : int|null = null: The seconds to use.
$microseconds : int|null = null: The microseconds to use.

Return values

DateInterval

day()

Set the instance's day


    public
                    day(int $value) : static

Parameters

$value : int: The day value.

Return values

static

diffFiltered()

Get the difference by the given interval using a filter callable


    public
                    diffFiltered(ChronosInterval|DateInterval $ci, callable $callback[, ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$ci : ChronosInterval|DateInterval: An interval to traverse by
$callback : callable: The callback to use for filtering.
$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffForHumans()

Get the difference in a human readable format.


    public
                    diffForHumans([ChronosInterface|null $other = null ][, bool $absolute = false ]) : string

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

$other : ChronosInterface|null = null: The datetime to compare with.
$absolute : bool = false: removes time difference modifiers ago, after, etc

Return values

string

diffFormatter()

Get the difference formatter instance or overwrite the current one.


    public
            static        diffFormatter([DifferenceFormatterInterface|null $formatter = null ]) : DifferenceFormatterInterface

Parameters

$formatter : DifferenceFormatterInterface|null = null: The formatter instance when setting.

Return values

DifferenceFormatterInterface —

The formatter instance.

diffInDays()

Get the difference in days


    public
                    diffInDays([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInDaysFiltered()

Get the difference in days using a filter callable


    public
                    diffInDaysFiltered(callable $callback[, ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$callback : callable: The callback to use for filtering.
$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInHours()

Get the difference in hours


    public
                    diffInHours([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInHoursFiltered()

Get the difference in hours using a filter callable


    public
                    diffInHoursFiltered(callable $callback[, ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$callback : callable: The callback to use for filtering.
$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInMinutes()

Get the difference in minutes


    public
                    diffInMinutes([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInMonths()

Get the difference in months


    public
                    diffInMonths([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInMonthsIgnoreTimezone()

Get the difference in months ignoring the timezone. This means the months are calculated in the specified timezone without converting to UTC first. This prevents the day from changing which can change the month.


    public
                    diffInMonthsIgnoreTimezone([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

For example, if comparing 2019-06-01 Asia/Tokyo and 2019-10-01 Asia/Tokyo, the result would be 4 months instead of 3 when using normal DateTime::diff().

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInSeconds()

Get the difference in seconds


    public
                    diffInSeconds([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInWeekdays()

Get the difference in weekdays


    public
                    diffInWeekdays([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInWeekendDays()

Get the difference in weekend days using a filter


    public
                    diffInWeekendDays([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInWeeks()

Get the difference in weeks


    public
                    diffInWeeks([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

diffInYears()

Get the difference in years


    public
                    diffInYears([ChronosInterface|null $dt = null ][, bool $abs = true ]) : int

Parameters

$dt : ChronosInterface|null = null: The instance to difference from.
$abs : bool = true: Get the absolute of the difference

Return values

int

endOfCentury()

Sets the date to end of the century and time to 23:59:59


    public
                    endOfCentury() : static

Return values

static

endOfDay()

Sets the time to 23:59:59 or 23:59:59.999999 if `$microseconds` is true.


    public
                    endOfDay([bool $microseconds = false ]) : static

Parameters

$microseconds : bool = false: Whether to set microseconds

Return values

static

endOfDecade()

Sets the date to end of the decade and time to 23:59:59


    public
                    endOfDecade() : static

Return values

static

endOfMonth()

Sets the date to end of the month and time to 23:59:59


    public
                    endOfMonth() : static

Return values

static

endOfWeek()

Sets the date to end of week (defined in $weekEndsAt) and time to 23:59:59


    public
                    endOfWeek() : static

Return values

static

endOfYear()

Sets the date to end of the year and time to 23:59:59


    public
                    endOfYear() : static

Return values

static

eq()

Determines if the instance is equal to another


    public
                    eq(ChronosInterface $dt) : bool

eq() is deprecated. Use equals() instead.

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

equals()

Determines if the instance is equal to another


    public
                    equals(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

farthest()

Get the farthest date from the instance.


    public
                    farthest(ChronosInterface $dt1, ChronosInterface $dt2) : ChronosInterface

Parameters

$dt1 : ChronosInterface: The instance to compare with.
$dt2 : ChronosInterface: The instance to compare with.

Return values

ChronosInterface

firstOfMonth()

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. ChronosInterface::MONDAY.


    public
                    firstOfMonth([int|null $dayOfWeek = null ]) : static

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

firstOfQuarter()

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. ChronosInterface::MONDAY.


    public
                    firstOfQuarter([int|null $dayOfWeek = null ]) : static

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

firstOfYear()

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. ChronosInterface::MONDAY.


    public
                    firstOfYear([int|null $dayOfWeek = null ]) : static

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

fromNow()

Convenience method for getting the remaining time from a given time.


    public
            static        fromNow(DateTime|DateTimeImmutable $datetime) : DateInterval|bool

Parameters

$datetime : DateTime|DateTimeImmutable: The date to get the remaining time from.

Return values

DateInterval|bool —

The DateInterval object representing the difference between the two dates or FALSE on failure.

getLastErrors()

Returns any errors or warnings that were found during the parsing of the last object created by this class.


    public
            static        getLastErrors() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTestNow()

Get the ChronosInterface instance (real or mock) to be returned when a "now" instance is created.


    public
            static        getTestNow() : ChronosInterface|null

Return values

ChronosInterface|null —

The current instance used for testing

getWeekendDays()

Get weekend days


    public
            static        getWeekendDays() : array<string|int, mixed>

Return values

array<string|int, mixed>

getWeekEndsAt()

Get the last day of week


    public
            static        getWeekEndsAt() : int

Return values

int

getWeekStartsAt()

Get the first day of week


    public
            static        getWeekStartsAt() : int

Return values

int

greaterThan()

Determines if the instance is greater (after) than another


    public
                    greaterThan(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

greaterThanOrEquals()

Determines if the instance is greater (after) than or equal to another


    public
                    greaterThanOrEquals(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

gt()

Determines if the instance is greater (after) than another


    public
                    gt(ChronosInterface $dt) : bool

gt() is deprecated. Use greaterThan() instead.

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

gte()

Determines if the instance is greater (after) than or equal to another


    public
                    gte(ChronosInterface $dt) : bool

gte() is deprecated. Use greaterThanOrEquals() instead.

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

hasRelativeKeywords()

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


    public
            static        hasRelativeKeywords(string|null $time) : bool

Parameters

$time : string|null: The time string to check.

Return values

bool —

true 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.


    public
            static        hasTestNow() : bool

Return values

bool —

True if there is a test instance, otherwise false

hour()

Set the instance's hour


    public
                    hour(int $value) : static

Parameters

$value : int: The hour value.

Return values

static

instance()

Create a ChronosInterface instance from a DateTimeInterface one


    public
            static        instance(DateTimeInterface $dt) : static

Parameters

$dt : DateTimeInterface: The datetime instance to convert.

Return values

static

isBirthday()

Check if its the birthday. Compares the date/month values of the two dates.


    public
                    isBirthday([ChronosInterface|null $dt = null ]) : bool

Parameters

$dt : ChronosInterface|null = null: The instance to compare with or null to use current day.

Return values

bool

isFriday()

Checks if this day is a Friday.


    public
                    isFriday() : bool

Return values

bool

isFuture()

Determines if the instance is in the future, ie. greater (after) than now


    public
                    isFuture() : bool

Return values

bool

isLastMonth()

Determines if the instance is within the last month


    public
                    isLastMonth() : bool

Return values

bool

isLastWeek()

Determines if the instance is within the last week


    public
                    isLastWeek() : bool

Return values

bool

isLastYear()

Determines if the instance is within the last year


    public
                    isLastYear() : bool

Return values

bool

isLeapYear()

Determines if the instance is a leap year


    public
                    isLeapYear() : bool

Return values

bool

isMonday()

Checks if this day is a Monday.


    public
                    isMonday() : bool

Return values

bool

isMutable()

Check if instance of ChronosInterface is mutable.


    public
                    isMutable() : bool

Return values

bool

isNextMonth()

Determines if the instance is within the next month


    public
                    isNextMonth() : bool

Return values

bool

isNextWeek()

Determines if the instance is within the next week


    public
                    isNextWeek() : bool

Return values

bool

isNextYear()

Determines if the instance is within the next year


    public
                    isNextYear() : bool

Return values

bool

isPast()

Determines if the instance is in the past, ie. less (before) than now


    public
                    isPast() : bool

Return values

bool

isSameDay()

Checks if the passed in date is the same day as the instance current day.


    public
                    isSameDay(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to check against.

Return values

bool

isSaturday()

Checks if this day is a Saturday.


    public
                    isSaturday() : bool

Return values

bool

isSunday()

Checks if this day is a Sunday.


    public
                    isSunday() : bool

Return values

bool

isThisMonth()

Returns true if this object represents a date within the current month


    public
                    isThisMonth() : bool

Return values

bool

isThisWeek()

Returns true if this object represents a date within the current week


    public
                    isThisWeek() : bool

Return values

bool

isThisYear()

Returns true if this object represents a date within the current year


    public
                    isThisYear() : bool

Return values

bool

isThursday()

Checks if this day is a Thursday.


    public
                    isThursday() : bool

Return values

bool

isToday()

Determines if the instance is today


    public
                    isToday() : bool

Return values

bool

isTomorrow()

Determines if the instance is tomorrow


    public
                    isTomorrow() : bool

Return values

bool

isTuesday()

Checks if this day is a Tuesday.


    public
                    isTuesday() : bool

Return values

bool

isWednesday()

Checks if this day is a Wednesday.


    public
                    isWednesday() : bool

Return values

bool

isWeekday()

Determines if the instance is a weekday


    public
                    isWeekday() : bool

Return values

bool

isWeekend()

Determines if the instance is a weekend day


    public
                    isWeekend() : bool

Return values

bool

isWithinNext()

Returns true this instance will happen within the specified interval


    public
                    isWithinNext(string|int $timeInterval) : bool

Parameters

$timeInterval : string|int: the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

Return values

bool

isYesterday()

Determines if the instance is yesterday


    public
                    isYesterday() : bool

Return values

bool

lastOfMonth()

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. ChronosInterface::MONDAY.


    public
                    lastOfMonth([int|null $dayOfWeek = null ]) : static

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

lastOfQuarter()

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. ChronosInterface::MONDAY.


    public
                    lastOfQuarter([int|null $dayOfWeek = null ]) : static

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

lastOfYear()

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. ChronosInterface::MONDAY.


    public
                    lastOfYear([int|null $dayOfWeek = null ]) : static

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

lessThan()

Determines if the instance is less (before) than another


    public
                    lessThan(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

lessThanOrEquals()

Determines if the instance is less (before) or equal to another


    public
                    lessThanOrEquals(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

lt()

Determines if the instance is less (before) than another


    public
                    lt(ChronosInterface $dt) : bool

lt() is deprecated. Use lessThan instead.

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

lte()

Determines if the instance is less (before) or equal to another


    public
                    lte(ChronosInterface $dt) : bool

lte() is deprecated. Use lessThanOrEquals() instead.

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

max()

Get the maximum instance between a given instance (default now) and the current instance.


    public
                    max([ChronosInterface|null $dt = null ]) : ChronosInterface

Parameters

$dt : ChronosInterface|null = null: The instance to compare with.

Return values

ChronosInterface

maxValue()

Create a ChronosInterface instance for the greatest supported date.


    public
            static        maxValue() : ChronosInterface

Return values

ChronosInterface

microsecond()

Set the instance's microsecond


    public
                    microsecond(int $value) : static

Parameters

$value : int: The microsecond value.

Return values

static

min()

Get the minimum instance between a given instance (default now) and the current instance.


    public
                    min([ChronosInterface|null $dt = null ]) : ChronosInterface

Parameters

$dt : ChronosInterface|null = null: The instance to compare with.

Return values

ChronosInterface

minute()

Set the instance's minute


    public
                    minute(int $value) : static

Parameters

$value : int: The minute value.

Return values

static

minValue()

Create a ChronosInterface instance for the lowest supported date.


    public
            static        minValue() : ChronosInterface

Return values

ChronosInterface

month()

Set the instance's month


    public
                    month(int $value) : static

Parameters

$value : int: The month value.

Return values

static

ne()

Determines if the instance is not equal to another


    public
                    ne(ChronosInterface $dt) : bool

ne() is deprecated. Use notEquals() instead.

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

next()

Modify to the next occurrence of a given day of the week.


    public
                    next([int|null $dayOfWeek = null ]) : static

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. ChronosInterface::MONDAY.

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

notEquals()

Determines if the instance is not equal to another


    public
                    notEquals(ChronosInterface $dt) : bool

Parameters

$dt : ChronosInterface: The instance to compare with.

Return values

bool

now()

Get a ChronosInterface instance for the current date and time


    public
            static        now([DateTimeZone|string|null $tz = null ]) : static

Parameters

$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name.

Return values

static

nthOfMonth()

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.


    public
                    nthOfMonth(int $nth, int $dayOfWeek) : static|false

Use the supplied consts to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.

Parameters

$nth : int: The offset to use.
$dayOfWeek : int: The day of the week to move to.

Return values

static|false

nthOfQuarter()

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.


    public
                    nthOfQuarter(int $nth, int $dayOfWeek) : static|false

Use the supplied consts to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.

Parameters

$nth : int: The offset to use.
$dayOfWeek : int: The day of the week to move to.

Return values

static|false

nthOfYear()

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.


    public
                    nthOfYear(int $nth, int $dayOfWeek) : static|false

Use the supplied consts to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.

Parameters

$nth : int: The offset to use.
$dayOfWeek : int: The day of the week to move to.

Return values

static|false

parse()

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()


    public
            static        parse([DateTimeInterface|string|int $time = 'now' ][, DateTimeZone|string|null $tz = null ]) : static

Parameters

$time : DateTimeInterface|string|int = 'now': The strtotime compatible string to parse
$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name.

Return values

static

previous()

Modify to the previous occurrence of a given day of the week.


    public
                    previous([int|null $dayOfWeek = null ]) : static

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. ChronosInterface::MONDAY.

Parameters

$dayOfWeek : int|null = null: The day of the week to move to.

Return values

static

resetToStringFormat()

Reset the format used to the default when type juggling a ChronosInterface instance to a string


    public
            static        resetToStringFormat() : void

second()

Set the instance's second


    public
                    second(int $value) : static

Parameters

$value : int: The seconds value.

Return values

static

secondsSinceMidnight()

The number of seconds since midnight.


    public
                    secondsSinceMidnight() : int

Return values

int

secondsUntilEndOfDay()

The number of seconds until 23:59:59.


    public
                    secondsUntilEndOfDay() : int

Return values

int

setDate()

Set the date to a different date.


    public
                    setDate(int $year, int $month, int $day) : static

Workaround for a PHP bug related to the first day of a month

Parameters

$year : int: The year to set.
$month : int: The month to set.
$day : int: The day to set.

#[ReturnTypeWillChange]

Return values

static

setDateTime()

Set the date and time all together


    public
                    setDateTime(int $year, int $month, int $day, int $hour, int $minute[, int $second = 0 ]) : static

Parameters

$year : int: The year to set.
$month : int: The month to set.
$day : int: The day to set.
$hour : int: The hour to set.
$minute : int: The minute to set.
$second : int = 0: The second to set.

Return values

static

setTestNow()

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: - A call to the static now() method, ex. ChronosInterface::now() - When a null (or blank string) is passed to the constructor or parse(), ex. new Chronos(null) - When the string "now" is passed to the constructor or parse(), ex. new Chronos('now') - When a string containing the desired time is passed to ChronosInterface::parse()


    public
            static        setTestNow([ChronosInterface|string|null $testNow = null ]) : void

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.

Parameters

$testNow : ChronosInterface|string|null = null: The instance to use for all future instances.

setTimeFromTimeString()

Set the time by time string


    public
                    setTimeFromTimeString(string $time) : static

Parameters

$time : string: Time as string.

Return values

static

setTimezone()

Set the instance's timezone from a string or object


    public
                    setTimezone(DateTimeZone|string $value) : static

Parameters

$value : DateTimeZone|string: The DateTimeZone object or timezone name to use.

#[ReturnTypeWillChange]

Return values

static

setToStringFormat()

Set the default format used when type juggling a ChronosInterface instance to a string


    public
            static        setToStringFormat(string $format) : void

Parameters

$format : string: The format to use in future __toString() calls.

setWeekendDays()

Set weekend days


    public
            static        setWeekendDays(array<string|int, mixed> $days) : void

Parameters

$days : array<string|int, mixed>: Which days are 'weekends'.

setWeekEndsAt()

Set the last day of week


    public
            static        setWeekEndsAt(int $day) : void

Parameters

$day : int: The day the week ends with.

setWeekStartsAt()

Set the first day of week


    public
            static        setWeekStartsAt(int $day) : void

Parameters

$day : int: The day the week starts with.

startOfCentury()

Sets the date to the first day of the century and the time to 00:00:00


    public
                    startOfCentury() : static

Return values

static

startOfDay()

Sets the time to 00:00:00


    public
                    startOfDay() : static

Return values

static

startOfDecade()

Sets the date to the first day of the decade and the time to 00:00:00


    public
                    startOfDecade() : static

Return values

static

startOfMonth()

Sets the date to the first day of the month and the time to 00:00:00


    public
                    startOfMonth() : static

Return values

static

startOfWeek()

Sets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00


    public
                    startOfWeek() : static

Return values

static

startOfYear()

Sets the date to the first day of the year and the time to 00:00:00


    public
                    startOfYear() : static

Return values

static

subDay()

Remove a day from the instance


    public
                    subDay([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of days to remove.

Return values

static

subDays()

Remove days from the instance


    public
                    subDays(int $value) : static

Parameters

$value : int: The number of days to remove.

Return values

static

subHour()

Remove an hour from the instance


    public
                    subHour([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of hours to remove.

Return values

static

subHours()

Remove hours from the instance


    public
                    subHours(int $value) : static

Parameters

$value : int: The number of hours to remove.

Return values

static

subMinute()

Remove a minute from the instance


    public
                    subMinute([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of minutes to remove.

Return values

static

subMinutes()

Remove minutes from the instance


    public
                    subMinutes(int $value) : static

Parameters

$value : int: The number of minutes to remove.

Return values

static

subMonth()

Remove a month from the instance


    public
                    subMonth([int $value = 1 ]) : static

Has the same behavior as addMonths().

Parameters

$value : int = 1: The number of months to remove.

Return values

static

subMonths()

Remove months from the instance


    public
                    subMonths(int $value) : static

Has the same behavior as addMonths().

Parameters

$value : int: The number of months to remove.

Return values

static

subMonthsWithOverflow()

Remove months with overflow from the instance.


    public
                    subMonthsWithOverflow(int $value) : static

Has the same behavior as addMonthsWithOverflow().

Parameters

$value : int: The number of months to remove.

Return values

static

subMonthWithOverflow()

Remove a month with overflow from the instance.


    public
                    subMonthWithOverflow([int $value = 1 ]) : static

Has the same behavior as addMonthsWithOverflow().

Parameters

$value : int = 1: The number of months to remove.

Return values

static

subSecond()

Remove a second from the instance


    public
                    subSecond([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of seconds to remove.

Return values

static

subSeconds()

Remove seconds from the instance


    public
                    subSeconds(int $value) : static

Parameters

$value : int: The number of seconds to remove.

Return values

static

subWeek()

Remove a week from the instance


    public
                    subWeek([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of weeks to remove.

Return values

static

subWeekday()

Remove a weekday from the instance


    public
                    subWeekday([int $value = 1 ]) : static

Parameters

$value : int = 1: The number of weekdays to remove.

Return values

static

subWeekdays()

Remove weekdays from the instance


    public
                    subWeekdays(int $value) : static

Parameters

$value : int: The number of weekdays to remove.

Return values

static

subWeeks()

Remove weeks to the instance


    public
                    subWeeks(int $value) : static

Parameters

$value : int: The number of weeks to remove.

Return values

static

subYear()

Remove a year from the instance


    public
                    subYear([int $value = 1 ]) : static

Has the same behavior as addYears().

Parameters

$value : int = 1: The number of years to remove.

Return values

static

subYears()

Remove years from the instance.


    public
                    subYears(int $value) : static

Has the same behavior as addYears().

Parameters

$value : int: The number of years to remove.

Return values

static

subYearsWithOverflow()

Remove years with overflow from the instance


    public
                    subYearsWithOverflow(int $value) : static

Has the same behavior as addYeasrWithOverflow().

Parameters

$value : int: The number of years to remove.

Return values

static

subYearWithOverflow()

Remove a year with overflow from the instance.


    public
                    subYearWithOverflow([int $value = 1 ]) : static

Has the same behavior as addYearsWithOverflow().

Parameters

$value : int = 1: The number of years to remove.

Return values

static

timestamp()

Set the instance's timestamp


    public
                    timestamp(int $value) : static

Parameters

$value : int: The timestamp value to set.

Return values

static

timezone()

Alias for setTimezone()


    public
                    timezone(DateTimeZone|string $value) : static

Parameters

$value : DateTimeZone|string: The DateTimeZone object or timezone name to use.

Return values

static

toAtomString()

Format the instance as ATOM


    public
                    toAtomString() : string

Return values

string

toCookieString()

Format the instance as COOKIE


    public
                    toCookieString() : string

Return values

string

toDateString()

Format the instance as date


    public
                    toDateString() : string

Return values

string

toDateTimeString()

Format the instance as date and time


    public
                    toDateTimeString() : string

Return values

string

today()

Create a ChronosInterface instance for today


    public
            static        today([DateTimeZone|string|null $tz = null ]) : static

Parameters

$tz : DateTimeZone|string|null = null: The timezone to use.

Return values

static

toDayDateTimeString()

Format the instance with day, date and time


    public
                    toDayDateTimeString() : string

Return values

string

toFormattedDateString()

Format the instance as a readable date


    public
                    toFormattedDateString() : string

Return values

string

toIso8601String()

Format the instance as ISO8601


    public
                    toIso8601String() : string

Return values

string

tomorrow()

Create a ChronosInterface instance for tomorrow


    public
            static        tomorrow([DateTimeZone|string|null $tz = null ]) : static

Parameters

$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

toMutable()

Create a new mutable instance from current immutable instance.


    public
                    toMutable() : MutableDateTime

Return values

MutableDateTime

toQuarter()

Returns the quarter


    public
                    toQuarter([bool $range = false ]) : int|array<string|int, mixed>

Parameters

$range : bool = false: Range.

Return values

int|array<string|int, mixed> —

1, 2, 3, or 4 quarter of year or array if $range true

toRfc1036String()

Format the instance as RFC1036


    public
                    toRfc1036String() : string

Return values

string

toRfc1123String()

Format the instance as RFC1123


    public
                    toRfc1123String() : string

Return values

string

toRfc2822String()

Format the instance as RFC2822


    public
                    toRfc2822String() : string

Return values

string

toRfc3339String()

Format the instance as RFC3339


    public
                    toRfc3339String() : string

Return values

string

toRfc822String()

Format the instance as RFC822


    public
                    toRfc822String() : string

Return values

string

toRfc850String()

Format the instance as RFC850


    public
                    toRfc850String() : string

Return values

string

toRssString()

Format the instance as RSS


    public
                    toRssString() : string

Return values

string

toTimeString()

Format the instance as time


    public
                    toTimeString() : string

Return values

string

toUnixString()

Returns a UNIX timestamp.


    public
                    toUnixString() : string

Return values

string —

UNIX timestamp

toW3cString()

Format the instance as W3C


    public
                    toW3cString() : string

Return values

string

toWeek()


    public
                    toWeek() : int

Return values

int

tz()

Alias for setTimezone()


    public
                    tz(DateTimeZone|string $value) : static

Parameters

$value : DateTimeZone|string: The DateTimeZone object or timezone name to use.

Return values

static

wasWithinLast()

Returns true this instance happened within the specified interval


    public
                    wasWithinLast(string|int $timeInterval) : bool

Parameters

$timeInterval : string|int: the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

Return values

bool

year()

Set the instance's year


    public
                    year(int $value) : static

Parameters

$value : int: The year value.

Return values

static

yesterday()

Create a ChronosInterface instance for yesterday


    public
            static        yesterday([DateTimeZone|string|null $tz = null ]) : static

Parameters

$tz : DateTimeZone|string|null = null: The DateTimeZone object or timezone name the new instance should use.

Return values

static

safeCreateDateTimeZone()

Creates a DateTimeZone from a string or a DateTimeZone


    protected
            static        safeCreateDateTimeZone(DateTimeZone|string|null $object) : DateTimeZone

Parameters

$object : DateTimeZone|string|null: The value to convert.

Return values

DateTimeZone

isRelativeOnly()

Determines if there is no fixed date in the time string.


    private
            static        isRelativeOnly(DateTimeInterface|string|null $time) : bool

Parameters

$time : DateTimeInterface|string|null: The time string to check

Return values

bool —

true if doesn't contain a fixed date

isTimeExpression()

Determine if there is just a time in the time string


    private
            static        isTimeExpression(string $time) : bool

Parameters

$time : string: The time string to check.

Return values

bool —

true if there is a keyword, otherwise false

setDateParent()

Just calling to parent setDate It used in overwritten setDate


    private
                    setDateParent(int $year, int $month, int $day) : static

Parameters

$year : int: The year to set.
$month : int: The month to set.
$day : int: The day to set.

Return values

static

Chronos extends DateTimeImmutable in package Application implements ChronosInterface uses ComparisonTrait, DifferenceTrait, FactoryTrait, FormattingTrait, MagicPropertyTrait, ModifierTrait, RelativeKeywordTrait, TimezoneTrait

Table of Contents

Interfaces

Properties

Methods

Properties

$age read-only

$day read-only

$dayOfWeek read-only

$dayOfYear read-only

$daysInMonth read-only

$dst read-only

$hour read-only

$local read-only

$micro read-only

$microsecond read-only

$minute read-only

$month read-only

$offset read-only

$offsetHours read-only

$quarter read-only

$second read-only

$timestamp read-only

$timezone read-only

$timezoneName read-only

$tz read-only

$tzName read-only

$utc read-only

$weekOfMonth read-only

$weekOfYear read-only

$year read-only

$yearIso read-only

$_lastErrors

$days

$diffFormatter

$relativePattern

$testNow

$toStringFormat

$weekendDays

$weekEndsAt

$weekStartsAt

Methods

__construct()

Parameters

__debugInfo()

Return values

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__toString()

Return values

addDay()

Parameters

Return values

addDays()

Parameters

Return values

addHour()

Parameters

Return values

addHours()

Parameters

Return values

addMinute()

Parameters

Return values

addMinutes()

Parameters

Return values

addMonth()

Parameters

Return values

addMonths()

Example:

Parameters

Return values

Chronos extends DateTimeImmutable
in package

Application

implements ChronosInterface uses ComparisonTrait, DifferenceTrait, FactoryTrait, FormattingTrait, MagicPropertyTrait, ModifierTrait, RelativeKeywordTrait, TimezoneTrait