Properties

$days

$days : array

Names of days of the week.

Type

array

$weekStartsAt

$weekStartsAt : integer

First day of week

Type

integer

$weekEndsAt

$weekEndsAt : integer

Last day of week

Type

integer

Methods

getWeekStartsAt()

getWeekStartsAt() : integer

Get the first day of week

Returns

integer

setWeekStartsAt()

setWeekStartsAt(integer  $day) : void

Set the first day of week

Parameters

integer $day

The day the week starts with.

getWeekEndsAt()

getWeekEndsAt() : integer

Get the last day of week

Returns

integer

setWeekEndsAt()

setWeekEndsAt(integer  $day) : void

Set the last day of week

Parameters

integer $day

The day the week ends with.

setDate()

setDate(integer  $year, integer  $month, integer  $day) : static

Set the date to a different date.

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

Parameters

integer $year

The year to set.

integer $month

The month to set.

integer $day

The day to set.

Returns

static

setDateTime()

setDateTime(integer  $year, integer  $month, integer  $day, integer  $hour, integer  $minute, integer  $second) : static

Set the date and time all together

Parameters

integer $year

The year to set.

integer $month

The month to set.

integer $day

The day to set.

integer $hour

The hour to set.

integer $minute

The minute to set.

integer $second

The second to set.

Returns

static

setTimeFromTimeString()

setTimeFromTimeString(string  $time) : static

Set the time by time string

Parameters

string $time

Time as string.

Returns

static

timestamp()

timestamp(integer  $value) : static

Set the instance's timestamp

Parameters

integer $value

The timestamp value to set.

Returns

static

year()

year(integer  $value) : static

Set the instance's year

Parameters

integer $value

The year value.

Returns

static

month()

month(integer  $value) : static

Set the instance's month

Parameters

integer $value

The month value.

Returns

static

day()

day(integer  $value) : static

Set the instance's day

Parameters

integer $value

The day value.

Returns

static

hour()

hour(integer  $value) : static

Set the instance's hour

Parameters

integer $value

The hour value.

Returns

static

minute()

minute(integer  $value) : static

Set the instance's minute

Parameters

integer $value

The minute value.

Returns

static

second()

second(integer  $value) : static

Set the instance's second

Parameters

integer $value

The seconds value.

Returns

static

addYears()

addYears(integer  $value) : static

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

Parameters

integer $value

The number of years to add.

Returns

static

addYear()

addYear(integer  $value = 1) : static

Add a year to the instance

Parameters

integer $value

The number of years to add.

Returns

static

subYear()

subYear(integer  $value = 1) : static

Remove a year from the instance

Parameters

integer $value

The number of years to remove.

Returns

static

subYears()

subYears(integer  $value) : static

Remove years from the instance.

Parameters

integer $value

The number of years to remove.

Returns

static

addMonths()

addMonths(integer  $value) : static

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

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

integer $value

The number of months to add.

Returns

static

addMonth()

addMonth(integer  $value = 1) : static

Add a month to the instance

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'))->addMonth(); // Results in 2015-02-03

 (new Chronos('2015-01-31'))->addMonth(); // Results in 2015-02-28

Parameters

integer $value

The number of months to add.

Returns

static

subMonth()

subMonth(integer  $value = 1) : static

Remove a month from the instance

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-03-01'))->subMonth(); // Results in 2015-02-01

 (new Chronos('2015-03-31'))->subMonth(); // Results in 2015-02-28

Parameters

integer $value

The number of months to remove.

Returns

static

subMonths()

subMonths(integer  $value) : static

Remove months from the instance

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-03-01'))->subMonths(1); // Results in 2015-02-01

 (new Chronos('2015-03-31'))->subMonths(1); // Results in 2015-02-28

Parameters

integer $value

The number of months to remove.

Returns

static

addMonthsWithOverflow()

addMonthsWithOverflow(integer  $value) : static

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

Parameters

integer $value

The number of months to add.

Returns

static

addMonthWithOverflow()

addMonthWithOverflow(integer  $value = 1) : static

Add a month with overflow to the instance

Parameters

integer $value

The number of months to add.

Returns

static

subMonthWithOverflow()

subMonthWithOverflow(integer  $value = 1) : static

Remove a month with overflow from the instance

Parameters

integer $value

The number of months to remove.

Returns

static

subMonthsWithOverflow()

subMonthsWithOverflow(integer  $value) : static

Remove months with overflow from the instance

Parameters

integer $value

The number of months to remove.

Returns

static

addDays()

addDays(integer  $value) : static

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

Parameters

integer $value

The number of days to add.

Returns

static

addDay()

addDay(integer  $value = 1) : static

Add a day to the instance

Parameters

integer $value

The number of days to add.

Returns

static

subDay()

subDay(integer  $value = 1) : static

Remove a day from the instance

Parameters

integer $value

The number of days to remove.

Returns

static

subDays()

subDays(integer  $value) : static

Remove days from the instance

Parameters

integer $value

The number of days to remove.

Returns

static

addWeekdays()

addWeekdays(integer  $value) : static

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

Parameters

integer $value

The number of weekdays to add.

Returns

static

addWeekday()

addWeekday(integer  $value = 1) : static

Add a weekday to the instance

Parameters

integer $value

The number of weekdays to add.

Returns

static

subWeekdays()

subWeekdays(integer  $value) : static

Remove weekdays from the instance

Parameters

integer $value

The number of weekdays to remove.

Returns

static

subWeekday()

subWeekday(integer  $value = 1) : static

Remove a weekday from the instance

Parameters

integer $value

The number of weekdays to remove.

Returns

static

addWeeks()

addWeeks(integer  $value) : static

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

Parameters

integer $value

The number of weeks to add.

Returns

static

addWeek()

addWeek(integer  $value = 1) : static

Add a week to the instance

Parameters

integer $value

The number of weeks to add.

Returns

static

subWeek()

subWeek(integer  $value = 1) : static

Remove a week from the instance

Parameters

integer $value

The number of weeks to remove.

Returns

static

subWeeks()

subWeeks(integer  $value) : static

Remove weeks to the instance

Parameters

integer $value

The number of weeks to remove.

Returns

static

addHours()

addHours(integer  $value) : static

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

Parameters

integer $value

The number of hours to add.

Returns

static

addHour()

addHour(integer  $value = 1) : static

Add an hour to the instance

Parameters

integer $value

The number of hours to add.

Returns

static

subHour()

subHour(integer  $value = 1) : static

Remove an hour from the instance

Parameters

integer $value

The number of hours to remove.

Returns

static

subHours()

subHours(integer  $value) : static

Remove hours from the instance

Parameters

integer $value

The number of hours to remove.

Returns

static

addMinutes()

addMinutes(integer  $value) : static

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

Parameters

integer $value

The number of minutes to add.

Returns

static

addMinute()

addMinute(integer  $value = 1) : static

Add a minute to the instance

Parameters

integer $value

The number of minutes to add.

Returns

static

subMinute()

subMinute(integer  $value = 1) : static

Remove a minute from the instance

Parameters

integer $value

The number of minutes to remove.

Returns

static

subMinutes()

subMinutes(integer  $value) : static

Remove minutes from the instance

Parameters

integer $value

The number of minutes to remove.

Returns

static

addSeconds()

addSeconds(integer  $value) : static

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

Parameters

integer $value

The number of seconds to add.

Returns

static

addSecond()

addSecond(integer  $value = 1) : static

Add a second to the instance

Parameters

integer $value

The number of seconds to add.

Returns

static

subSecond()

subSecond(integer  $value = 1) : static

Remove a second from the instance

Parameters

integer $value

The number of seconds to remove.

Returns

static

subSeconds()

subSeconds(integer  $value) : static

Remove seconds from the instance

Parameters

integer $value

The number of seconds to remove.

Returns

static

startOfDay()

startOfDay() : static

Resets the time to 00:00:00

Returns

static

endOfDay()

endOfDay() : static

Resets the time to 23:59:59

Returns

static

startOfMonth()

startOfMonth() : static

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

Returns

static

endOfMonth()

endOfMonth() : static

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

Returns

static

startOfYear()

startOfYear() : static

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

Returns

static

endOfYear()

endOfYear() : static

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

Returns

static

startOfDecade()

startOfDecade() : static

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

Returns

static

endOfDecade()

endOfDecade() : static

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

Returns

static

startOfCentury()

startOfCentury() : static

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

Returns

static

endOfCentury()

endOfCentury() : static

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

Returns

static

startOfWeek()

startOfWeek() : static

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

Returns

static

endOfWeek()

endOfWeek() : static

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

Returns

static

next()

next(integer|null  $dayOfWeek = null) : mixed

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

If no dayOfWeek is provided, modify to the next occurrence of the current day of the week. Use the supplied consts to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

previous()

previous(integer|null  $dayOfWeek = null) : mixed

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

If no dayOfWeek is provided, modify to the previous occurrence of the current day of the week. Use the supplied consts to indicate the desired dayOfWeek, ex. ChronosInterface::MONDAY.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

firstOfMonth()

firstOfMonth(integer|null  $dayOfWeek = null) : mixed

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.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

lastOfMonth()

lastOfMonth(integer|null  $dayOfWeek = null) : mixed

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.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

nthOfMonth()

nthOfMonth(integer  $nth, integer  $dayOfWeek) : mixed

Modify to the given occurrence of a given day of the week in the current month. If the calculated occurrence is outside the scope of the current month, then return false and no modifications are made.

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

Parameters

integer $nth

The offset to use.

integer $dayOfWeek

The day of the week to move to.

Returns

mixed

firstOfQuarter()

firstOfQuarter(integer|null  $dayOfWeek = null) : mixed

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.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

lastOfQuarter()

lastOfQuarter(integer|null  $dayOfWeek = null) : mixed

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.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

nthOfQuarter()

nthOfQuarter(integer  $nth, integer  $dayOfWeek) : mixed

Modify to the given occurrence of a given day of the week in the current quarter. If the calculated occurrence is outside the scope of the current quarter, then return false and no modifications are made.

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

Parameters

integer $nth

The offset to use.

integer $dayOfWeek

The day of the week to move to.

Returns

mixed

firstOfYear()

firstOfYear(integer|null  $dayOfWeek = null) : mixed

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.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

lastOfYear()

lastOfYear(integer|null  $dayOfWeek = null) : mixed

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.

Parameters

integer|null $dayOfWeek

The day of the week to move to.

Returns

mixed

nthOfYear()

nthOfYear(integer  $nth, integer  $dayOfWeek) : mixed

Modify to the given occurrence of a given day of the week in the current year. If the calculated occurrence is outside the scope of the current year, then return false and no modifications are made.

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

Parameters

integer $nth

The offset to use.

integer $dayOfWeek

The day of the week to move to.

Returns

mixed

average()

average(\Cake\Chronos\ChronosInterface|null  $dt = null) : static

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

Parameters

\Cake\Chronos\ChronosInterface|null $dt

The instance to compare with.

Returns

static

setDateParent()

setDateParent(integer  $year, integer  $month, integer  $day) : static

Just calling to parent setDate It used in overwritten setDate

Parameters

integer $year

The year to set.

integer $month

The month to set.

integer $day

The day to set.

Returns

static