PHP Interface Cake\Chronos\ChronosInterface

Inheritance: extends DateTimeInterfac\DateTimeInterface
Afficher le fichier Open project: cakephp/chronos Interface Usage Examples

Méthodes publiques

Méthode Description
addDay ( integer $value = 1 ) : static Add a day to the instance
addDays ( integer $value ) : static Add days to the instance. Positive $value travels forward while negative $value travels into the past.
addHour ( integer $value = 1 ) : static Add an hour to the instance
addHours ( integer $value ) : static Add hours to the instance. Positive $value travels forward while negative $value travels into the past.
addMinute ( integer $value = 1 ) : static Add a minute to the instance
addMinutes ( integer $value ) : static Add minutes to the instance. Positive $value travels forward while negative $value travels into the past.
addMonth ( integer $value = 1 ) : static Add a month to the instance
addMonthWithOverflow ( integer $value = 1 ) : static Add a month with overflow to the instance
addMonths ( integer $value ) : static Add months to the instance. Positive $value travels forward while negative $value travels into the past.
addMonthsWithOverflow ( integer $value ) : static Add months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
addSecond ( integer $value = 1 ) : static Add a second to the instance
addSeconds ( integer $value ) : static Add seconds to the instance. Positive $value travels forward while negative $value travels into the past.
addWeek ( integer $value = 1 ) : static Add a week to the instance
addWeekday ( integer $value = 1 ) : static Add a weekday to the instance
addWeekdays ( integer $value ) : static Add weekdays to the instance. Positive $value travels forward while negative $value travels into the past.
addWeeks ( integer $value ) : static Add weeks to the instance. Positive $value travels forward while negative $value travels into the past.
addYear ( integer $value = 1 ) : static Add a year to the instance
addYears ( integer $value ) : static Add years to the instance. Positive $value travel forward while negative $value travel into the past.
average ( Cake\Chronos\ChronosInterface $dt = null ) : static Modify the current instance to the average of a given instance (default now) and the current instance.
between ( Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2, boolean $equal = true ) : boolean Determines if the instance is between two others
closest ( Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2 ) : static Get the closest date from the instance.
copy ( ) : static Get a copy of the instance
day ( integer $value ) : static Set the instance's day
diffFiltered ( ChronosInterval $ci, callable $callback, Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference by the given interval using a filter callable
diffForHumans ( Cake\Chronos\ChronosInterface $other = null, boolean $absolute = false ) : string Get the difference in a human readable format in the current locale.
diffInDays ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in days
diffInDaysFiltered ( callable $callback, Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in days using a filter callable
diffInHours ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in hours
diffInHoursFiltered ( callable $callback, Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in hours using a filter callable
diffInMinutes ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in minutes
diffInMonths ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in months
diffInSeconds ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in seconds
diffInWeekdays ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in weekdays
diffInWeekendDays ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in weekend days using a filter
diffInWeeks ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in weeks
diffInYears ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer Get the difference in years
endOfCentury ( ) : static Resets the date to end of the century and time to 23:59:59
endOfDay ( ) : static Resets the time to 23:59:59
endOfDecade ( ) : static Resets the date to end of the decade and time to 23:59:59
endOfMonth ( ) : static Resets the date to end of the month and time to 23:59:59
endOfWeek ( ) : static Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59
endOfYear ( ) : static Resets the date to end of the year and time to 23:59:59
eq ( Cake\Chronos\ChronosInterface $dt ) : boolean Determines if the instance is equal to another
farthest ( Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2 ) : static Get the farthest date from the instance.
firstOfMonth ( integer $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. static::MONDAY.
firstOfQuarter ( integer $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. static::MONDAY.
firstOfYear ( integer $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. static::MONDAY.
gt ( Cake\Chronos\ChronosInterface $dt ) : boolean Determines if the instance is greater (after) than another
gte ( Cake\Chronos\ChronosInterface $dt ) : boolean Determines if the instance is greater (after) than or equal to another
hour ( integer $value ) : static Set the instance's hour
isBirthday ( Cake\Chronos\ChronosInterface $dt ) : boolean Check if its the birthday. Compares the date/month values of the two dates.
isFriday ( ) : boolean Checks if this day is a Friday.
isFuture ( ) : boolean Determines if the instance is in the future, ie. greater (after) than now
isLeapYear ( ) : boolean Determines if the instance is a leap year
isMonday ( ) : boolean Checks if this day is a Monday.
isMutable ( ) : boolean Check if instance of ChronosInterface is mutable.
isPast ( ) : boolean Determines if the instance is in the past, ie. less (before) than now
isSameDay ( Cake\Chronos\ChronosInterface $dt ) : boolean Checks if the passed in date is the same day as the instance current day.
isSaturday ( ) : boolean Checks if this day is a Saturday.
isSunday ( ) : boolean Checks if this day is a Sunday.
isThisMonth ( ) : boolean Returns true if this object represents a date within the current month
isThisWeek ( ) : boolean Returns true if this object represents a date within the current week
isThisYear ( ) : boolean Returns true if this object represents a date within the current year
isThursday ( ) : boolean Checks if this day is a Thursday.
isToday ( ) : boolean Determines if the instance is today
isTomorrow ( ) : boolean Determines if the instance is tomorrow
isTuesday ( ) : boolean Checks if this day is a Tuesday.
isWednesday ( ) : boolean Checks if this day is a Wednesday.
isWeekday ( ) : boolean Determines if the instance is a weekday
isWeekend ( ) : boolean Determines if the instance is a weekend day
isWithinNext ( string | integer $timeInterval ) : boolean Returns true this instance will happen within the specified interval
isYesterday ( ) : boolean Determines if the instance is yesterday
lastOfMonth ( integer $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. static::MONDAY.
lastOfQuarter ( integer $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. static::MONDAY.
lastOfYear ( integer $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. static::MONDAY.
lt ( Cake\Chronos\ChronosInterface $dt ) : boolean Determines if the instance is less (before) than another
lte ( Cake\Chronos\ChronosInterface $dt ) : boolean Determines if the instance is less (before) or equal to another
max ( Cake\Chronos\ChronosInterface $dt = null ) : static Get the maximum instance between a given instance (default now) and the current instance.
min ( Cake\Chronos\ChronosInterface $dt = null ) : static Get the minimum instance between a given instance (default now) and the current instance.
minute ( integer $value ) : static Set the instance's minute
month ( integer $value ) : static Set the instance's month
ne ( Cake\Chronos\ChronosInterface $dt ) : boolean Determines if the instance is not equal to another
next ( integer $dayOfWeek = null ) : mixed Modify to the next occurrence of a given day of the week.
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.
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.
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.
previous ( integer $dayOfWeek = null ) : mixed Modify to the previous occurrence of a given day of the week.
second ( integer $value ) : static Set the instance's second
secondsSinceMidnight ( ) : integer The number of seconds since midnight.
secondsUntilEndOfDay ( ) : integer The number of seconds until 23:23:59.
setDateTime ( integer $year, integer $month, integer $day, integer $hour, integer $minute, integer $second ) : static Set the date and time all together
setTimeFromTimeString ( string $time ) : static Set the time by time string
setTimezone ( DateTimeZon\DateTimeZone | string $value ) : static Set the instance's timezone from a string or object
startOfCentury ( ) : static Resets the date to the first day of the century and the time to 00:00:00
startOfDay ( ) : static Resets the time to 00:00:00
startOfDecade ( ) : static Resets the date to the first day of the decade and the time to 00:00:00
startOfMonth ( ) : static Resets the date to the first day of the month and the time to 00:00:00
startOfWeek ( ) : static Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
startOfYear ( ) : static Resets the date to the first day of the year and the time to 00:00:00
subDay ( integer $value = 1 ) : static Remove a day from the instance
subDays ( integer $value ) : static Remove days from the instance
subHour ( integer $value = 1 ) : static Remove an hour from the instance
subHours ( integer $value ) : static Remove hours from the instance
subMinute ( integer $value = 1 ) : static Remove a minute from the instance
subMinutes ( integer $value ) : static Remove minutes from the instance
subMonth ( integer $value = 1 ) : static Remove a month from the instance
subMonthWithOverflow ( integer $value = 1 ) : static Remove a month with overflow from the instance
subMonths ( integer $value ) : static Remove months from the instance
subMonthsWithOverflow ( integer $value ) : static Remove months with overflow from the instance
subSecond ( integer $value = 1 ) : static Remove a second from the instance
subSeconds ( integer $value ) : static Remove seconds from the instance
subWeek ( integer $value = 1 ) : static Remove a week from the instance
subWeekday ( integer $value = 1 ) : static Remove a weekday from the instance
subWeekdays ( integer $value ) : static Remove weekdays from the instance
subWeeks ( integer $value ) : static Remove weeks to the instance
subYear ( integer $value = 1 ) : static Remove a year from the instance
subYears ( integer $value ) : static Remove years from the instance.
timestamp ( integer $value ) : static Set the instance's timestamp
timezone ( DateTimeZon\DateTimeZone | string $value ) : 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
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
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
toW3cString ( ) : string Format the instance as W3C
tz ( DateTimeZon\DateTimeZone | string $value ) : static Alias for setTimezone()
wasWithinLast ( string | integer $timeInterval ) : boolean Returns true this instance happened within the specified interval
year ( integer $value ) : static Set the instance's year

Method Details

addDay() public méthode

Add a day to the instance
public addDay ( integer $value = 1 ) : static
$value integer The number of days to add.
Résultat static

addDays() public méthode

Add days to the instance. Positive $value travels forward while negative $value travels into the past.
public addDays ( integer $value ) : static
$value integer The number of days to add.
Résultat static

addHour() public méthode

Add an hour to the instance
public addHour ( integer $value = 1 ) : static
$value integer The number of hours to add.
Résultat static

addHours() public méthode

Add hours to the instance. Positive $value travels forward while negative $value travels into the past.
public addHours ( integer $value ) : static
$value integer The number of hours to add.
Résultat static

addMinute() public méthode

Add a minute to the instance
public addMinute ( integer $value = 1 ) : static
$value integer The number of minutes to add.
Résultat static

addMinutes() public méthode

Add minutes to the instance. Positive $value travels forward while negative $value travels into the past.
public addMinutes ( integer $value ) : static
$value integer The number of minutes to add.
Résultat static

addMonth() public méthode

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
public addMonth ( integer $value = 1 ) : static
$value integer The number of months to add.
Résultat static

addMonthWithOverflow() public méthode

Add a month with overflow to the instance
public addMonthWithOverflow ( integer $value = 1 ) : static
$value integer The number of months to add.
Résultat static

addMonths() public méthode

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
public addMonths ( integer $value ) : static
$value integer The number of months to add.
Résultat static

addMonthsWithOverflow() public méthode

Add months with overflowing to the instance. Positive $value travels forward while negative $value travels into the past.
public addMonthsWithOverflow ( integer $value ) : static
$value integer The number of months to add.
Résultat static

addSecond() public méthode

Add a second to the instance
public addSecond ( integer $value = 1 ) : static
$value integer The number of seconds to add.
Résultat static

addSeconds() public méthode

Add seconds to the instance. Positive $value travels forward while negative $value travels into the past.
public addSeconds ( integer $value ) : static
$value integer The number of seconds to add.
Résultat static

addWeek() public méthode

Add a week to the instance
public addWeek ( integer $value = 1 ) : static
$value integer The number of weeks to add.
Résultat static

addWeekday() public méthode

Add a weekday to the instance
public addWeekday ( integer $value = 1 ) : static
$value integer The number of weekdays to add.
Résultat static

addWeekdays() public méthode

Add weekdays to the instance. Positive $value travels forward while negative $value travels into the past.
public addWeekdays ( integer $value ) : static
$value integer The number of weekdays to add.
Résultat static

addWeeks() public méthode

Add weeks to the instance. Positive $value travels forward while negative $value travels into the past.
public addWeeks ( integer $value ) : static
$value integer The number of weeks to add.
Résultat static

addYear() public méthode

Add a year to the instance
public addYear ( integer $value = 1 ) : static
$value integer The number of years to add.
Résultat static

addYears() public méthode

Add years to the instance. Positive $value travel forward while negative $value travel into the past.
public addYears ( integer $value ) : static
$value integer The number of years to add.
Résultat static

average() public méthode

Modify the current instance to the average of a given instance (default now) and the current instance.
public average ( Cake\Chronos\ChronosInterface $dt = null ) : static
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat static

between() public méthode

Determines if the instance is between two others
public between ( Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2, boolean $equal = true ) : boolean
$dt1 Cake\Chronos\ChronosInterface The instance to compare with.
$dt2 Cake\Chronos\ChronosInterface The instance to compare with.
$equal boolean Indicates if a > and < comparison should be used or <= or >=
Résultat boolean

closest() public méthode

Get the closest date from the instance.
public closest ( Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2 ) : static
$dt1 Cake\Chronos\ChronosInterface The instance to compare with.
$dt2 Cake\Chronos\ChronosInterface The instance to compare with.
Résultat static

copy() public méthode

Get a copy of the instance
public copy ( ) : static
Résultat static

day() public méthode

Set the instance's day
public day ( integer $value ) : static
$value integer The day value.
Résultat static

diffFiltered() public méthode

Get the difference by the given interval using a filter callable
public diffFiltered ( ChronosInterval $ci, callable $callback, Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$ci ChronosInterval An interval to traverse by
$callback callable The callback to use for filtering.
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffForHumans() public méthode

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
public diffForHumans ( Cake\Chronos\ChronosInterface $other = null, boolean $absolute = false ) : string
$other Cake\Chronos\ChronosInterface The datetime to compare with.
$absolute boolean Removes time difference modifiers ago, after, etc
Résultat string

diffInDays() public méthode

Get the difference in days
public diffInDays ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInDaysFiltered() public méthode

Get the difference in days using a filter callable
public diffInDaysFiltered ( callable $callback, Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$callback callable The callback to use for filtering.
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInHours() public méthode

Get the difference in hours
public diffInHours ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInHoursFiltered() public méthode

Get the difference in hours using a filter callable
public diffInHoursFiltered ( callable $callback, Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$callback callable The callback to use for filtering.
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInMinutes() public méthode

Get the difference in minutes
public diffInMinutes ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInMonths() public méthode

Get the difference in months
public diffInMonths ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInSeconds() public méthode

Get the difference in seconds
public diffInSeconds ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInWeekdays() public méthode

Get the difference in weekdays
public diffInWeekdays ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInWeekendDays() public méthode

Get the difference in weekend days using a filter
public diffInWeekendDays ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInWeeks() public méthode

Get the difference in weeks
public diffInWeeks ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

diffInYears() public méthode

Get the difference in years
public diffInYears ( Cake\Chronos\ChronosInterface $dt = null, boolean $abs = true ) : integer
$dt Cake\Chronos\ChronosInterface The instance to difference from.
$abs boolean Get the absolute of the difference
Résultat integer

endOfCentury() public méthode

Resets the date to end of the century and time to 23:59:59
public endOfCentury ( ) : static
Résultat static

endOfDay() public méthode

Resets the time to 23:59:59
public endOfDay ( ) : static
Résultat static

endOfDecade() public méthode

Resets the date to end of the decade and time to 23:59:59
public endOfDecade ( ) : static
Résultat static

endOfMonth() public méthode

Resets the date to end of the month and time to 23:59:59
public endOfMonth ( ) : static
Résultat static

endOfWeek() public méthode

Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59
public endOfWeek ( ) : static
Résultat static

endOfYear() public méthode

Resets the date to end of the year and time to 23:59:59
public endOfYear ( ) : static
Résultat static

eq() public méthode

Determines if the instance is equal to another
public eq ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

farthest() public méthode

Get the farthest date from the instance.
public farthest ( Cake\Chronos\ChronosInterface $dt1, Cake\Chronos\ChronosInterface $dt2 ) : static
$dt1 Cake\Chronos\ChronosInterface The instance to compare with.
$dt2 Cake\Chronos\ChronosInterface The instance to compare with.
Résultat static

firstOfMonth() public méthode

Modify to the first occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the first day of the current month. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public firstOfMonth ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

firstOfQuarter() public méthode

Modify to the first occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the first day of the current quarter. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public firstOfQuarter ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

firstOfYear() public méthode

Modify to the first occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the first day of the current year. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public firstOfYear ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

gt() public méthode

Determines if the instance is greater (after) than another
public gt ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

gte() public méthode

Determines if the instance is greater (after) than or equal to another
public gte ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

hour() public méthode

Set the instance's hour
public hour ( integer $value ) : static
$value integer The hour value.
Résultat static

isBirthday() public méthode

Check if its the birthday. Compares the date/month values of the two dates.
public isBirthday ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

isFriday() public méthode

Checks if this day is a Friday.
public isFriday ( ) : boolean
Résultat boolean

isFuture() public méthode

Determines if the instance is in the future, ie. greater (after) than now
public isFuture ( ) : boolean
Résultat boolean

isLeapYear() public méthode

Determines if the instance is a leap year
public isLeapYear ( ) : boolean
Résultat boolean

isMonday() public méthode

Checks if this day is a Monday.
public isMonday ( ) : boolean
Résultat boolean

isMutable() public méthode

Check if instance of ChronosInterface is mutable.
public isMutable ( ) : boolean
Résultat boolean

isPast() public méthode

Determines if the instance is in the past, ie. less (before) than now
public isPast ( ) : boolean
Résultat boolean

isSameDay() public méthode

Checks if the passed in date is the same day as the instance current day.
public isSameDay ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to check against.
Résultat boolean

isSaturday() public méthode

Checks if this day is a Saturday.
public isSaturday ( ) : boolean
Résultat boolean

isSunday() public méthode

Checks if this day is a Sunday.
public isSunday ( ) : boolean
Résultat boolean

isThisMonth() public méthode

Returns true if this object represents a date within the current month
public isThisMonth ( ) : boolean
Résultat boolean

isThisWeek() public méthode

Returns true if this object represents a date within the current week
public isThisWeek ( ) : boolean
Résultat boolean

isThisYear() public méthode

Returns true if this object represents a date within the current year
public isThisYear ( ) : boolean
Résultat boolean

isThursday() public méthode

Checks if this day is a Thursday.
public isThursday ( ) : boolean
Résultat boolean

isToday() public méthode

Determines if the instance is today
public isToday ( ) : boolean
Résultat boolean

isTomorrow() public méthode

Determines if the instance is tomorrow
public isTomorrow ( ) : boolean
Résultat boolean

isTuesday() public méthode

Checks if this day is a Tuesday.
public isTuesday ( ) : boolean
Résultat boolean

isWednesday() public méthode

Checks if this day is a Wednesday.
public isWednesday ( ) : boolean
Résultat boolean

isWeekday() public méthode

Determines if the instance is a weekday
public isWeekday ( ) : boolean
Résultat boolean

isWeekend() public méthode

Determines if the instance is a weekend day
public isWeekend ( ) : boolean
Résultat boolean

isWithinNext() public méthode

Returns true this instance will happen within the specified interval
public isWithinNext ( string | integer $timeInterval ) : boolean
$timeInterval string | integer the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
Résultat boolean

isYesterday() public méthode

Determines if the instance is yesterday
public isYesterday ( ) : boolean
Résultat boolean

lastOfMonth() public méthode

Modify to the last occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the last day of the current month. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public lastOfMonth ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

lastOfQuarter() public méthode

Modify to the last occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the last day of the current quarter. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public lastOfQuarter ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

lastOfYear() public méthode

Modify to the last occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the last day of the current year. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public lastOfYear ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

lt() public méthode

Determines if the instance is less (before) than another
public lt ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

lte() public méthode

Determines if the instance is less (before) or equal to another
public lte ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

max() public méthode

Get the maximum instance between a given instance (default now) and the current instance.
public max ( Cake\Chronos\ChronosInterface $dt = null ) : static
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat static

min() public méthode

Get the minimum instance between a given instance (default now) and the current instance.
public min ( Cake\Chronos\ChronosInterface $dt = null ) : static
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat static

minute() public méthode

Set the instance's minute
public minute ( integer $value ) : static
$value integer The minute value.
Résultat static

month() public méthode

Set the instance's month
public month ( integer $value ) : static
$value integer The month value.
Résultat static

ne() public méthode

Determines if the instance is not equal to another
public ne ( Cake\Chronos\ChronosInterface $dt ) : boolean
$dt Cake\Chronos\ChronosInterface The instance to compare with.
Résultat boolean

next() public méthode

If no dayOfWeek is provided, modify to the next occurrence of the current day of the week. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public next ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

nthOfMonth() public méthode

Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public nthOfMonth ( integer $nth, integer $dayOfWeek ) : mixed
$nth integer The offset to use.
$dayOfWeek integer The day of the week to move to.
Résultat mixed

nthOfQuarter() public méthode

Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public nthOfQuarter ( integer $nth, integer $dayOfWeek ) : mixed
$nth integer The offset to use.
$dayOfWeek integer The day of the week to move to.
Résultat mixed

nthOfYear() public méthode

Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public nthOfYear ( integer $nth, integer $dayOfWeek ) : mixed
$nth integer The offset to use.
$dayOfWeek integer The day of the week to move to.
Résultat mixed

previous() public méthode

If no dayOfWeek is provided, modify to the previous occurrence of the current day of the week. Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
public previous ( integer $dayOfWeek = null ) : mixed
$dayOfWeek integer The day of the week to move to.
Résultat mixed

second() public méthode

Set the instance's second
public second ( integer $value ) : static
$value integer The seconds value.
Résultat static

secondsSinceMidnight() public méthode

The number of seconds since midnight.
public secondsSinceMidnight ( ) : integer
Résultat integer

secondsUntilEndOfDay() public méthode

The number of seconds until 23:23:59.
public secondsUntilEndOfDay ( ) : integer
Résultat integer

setDateTime() public méthode

Set the date and time all together
public setDateTime ( integer $year, integer $month, integer $day, integer $hour, integer $minute, integer $second ) : static
$year integer The year to set.
$month integer The month to set.
$day integer The day to set.
$hour integer The hour to set.
$minute integer The minute to set.
$second integer The second to set.
Résultat static

setTimeFromTimeString() public méthode

Set the time by time string
public setTimeFromTimeString ( string $time ) : static
$time string Time as string.
Résultat static

setTimezone() public méthode

Set the instance's timezone from a string or object
public setTimezone ( DateTimeZon\DateTimeZone | string $value ) : static
$value DateTimeZon\DateTimeZone | string The DateTimeZone object or timezone name to use.
Résultat static

startOfCentury() public méthode

Resets the date to the first day of the century and the time to 00:00:00
public startOfCentury ( ) : static
Résultat static

startOfDay() public méthode

Resets the time to 00:00:00
public startOfDay ( ) : static
Résultat static

startOfDecade() public méthode

Resets the date to the first day of the decade and the time to 00:00:00
public startOfDecade ( ) : static
Résultat static

startOfMonth() public méthode

Resets the date to the first day of the month and the time to 00:00:00
public startOfMonth ( ) : static
Résultat static

startOfWeek() public méthode

Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
public startOfWeek ( ) : static
Résultat static

startOfYear() public méthode

Resets the date to the first day of the year and the time to 00:00:00
public startOfYear ( ) : static
Résultat static

subDay() public méthode

Remove a day from the instance
public subDay ( integer $value = 1 ) : static
$value integer The number of days to remove.
Résultat static

subDays() public méthode

Remove days from the instance
public subDays ( integer $value ) : static
$value integer The number of days to remove.
Résultat static

subHour() public méthode

Remove an hour from the instance
public subHour ( integer $value = 1 ) : static
$value integer The number of hours to remove.
Résultat static

subHours() public méthode

Remove hours from the instance
public subHours ( integer $value ) : static
$value integer The number of hours to remove.
Résultat static

subMinute() public méthode

Remove a minute from the instance
public subMinute ( integer $value = 1 ) : static
$value integer The number of minutes to remove.
Résultat static

subMinutes() public méthode

Remove minutes from the instance
public subMinutes ( integer $value ) : static
$value integer The number of minutes to remove.
Résultat static

subMonth() public méthode

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
public subMonth ( integer $value = 1 ) : static
$value integer The number of months to remove.
Résultat static

subMonthWithOverflow() public méthode

Remove a month with overflow from the instance
public subMonthWithOverflow ( integer $value = 1 ) : static
$value integer The number of months to remove.
Résultat static

subMonths() public méthode

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
public subMonths ( integer $value ) : static
$value integer The number of months to remove.
Résultat static

subMonthsWithOverflow() public méthode

Remove months with overflow from the instance
public subMonthsWithOverflow ( integer $value ) : static
$value integer The number of months to remove.
Résultat static

subSecond() public méthode

Remove a second from the instance
public subSecond ( integer $value = 1 ) : static
$value integer The number of seconds to remove.
Résultat static

subSeconds() public méthode

Remove seconds from the instance
public subSeconds ( integer $value ) : static
$value integer The number of seconds to remove.
Résultat static

subWeek() public méthode

Remove a week from the instance
public subWeek ( integer $value = 1 ) : static
$value integer The number of weeks to remove.
Résultat static

subWeekday() public méthode

Remove a weekday from the instance
public subWeekday ( integer $value = 1 ) : static
$value integer The number of weekdays to remove.
Résultat static

subWeekdays() public méthode

Remove weekdays from the instance
public subWeekdays ( integer $value ) : static
$value integer The number of weekdays to remove.
Résultat static

subWeeks() public méthode

Remove weeks to the instance
public subWeeks ( integer $value ) : static
$value integer The number of weeks to remove.
Résultat static

subYear() public méthode

Remove a year from the instance
public subYear ( integer $value = 1 ) : static
$value integer The number of years to remove.
Résultat static

subYears() public méthode

Remove years from the instance.
public subYears ( integer $value ) : static
$value integer The number of years to remove.
Résultat static

timestamp() public méthode

Set the instance's timestamp
public timestamp ( integer $value ) : static
$value integer The timestamp value to set.
Résultat static

timezone() public méthode

Alias for setTimezone()
public timezone ( DateTimeZon\DateTimeZone | string $value ) : static
$value DateTimeZon\DateTimeZone | string The DateTimeZone object or timezone name to use.
Résultat static

toAtomString() public méthode

Format the instance as ATOM
public toAtomString ( ) : string
Résultat string

toCookieString() public méthode

Format the instance as COOKIE
public toCookieString ( ) : string
Résultat string

toDateString() public méthode

Format the instance as date
public toDateString ( ) : string
Résultat string

toDateTimeString() public méthode

Format the instance as date and time
public toDateTimeString ( ) : string
Résultat string

toDayDateTimeString() public méthode

Format the instance with day, date and time
public toDayDateTimeString ( ) : string
Résultat string

toFormattedDateString() public méthode

Format the instance as a readable date
public toFormattedDateString ( ) : string
Résultat string

toIso8601String() public méthode

Format the instance as ISO8601
public toIso8601String ( ) : string
Résultat string

toRfc1036String() public méthode

Format the instance as RFC1036
public toRfc1036String ( ) : string
Résultat string

toRfc1123String() public méthode

Format the instance as RFC1123
public toRfc1123String ( ) : string
Résultat string

toRfc2822String() public méthode

Format the instance as RFC2822
public toRfc2822String ( ) : string
Résultat string

toRfc3339String() public méthode

Format the instance as RFC3339
public toRfc3339String ( ) : string
Résultat string

toRfc822String() public méthode

Format the instance as RFC822
public toRfc822String ( ) : string
Résultat string

toRfc850String() public méthode

Format the instance as RFC850
public toRfc850String ( ) : string
Résultat string

toRssString() public méthode

Format the instance as RSS
public toRssString ( ) : string
Résultat string

toTimeString() public méthode

Format the instance as time
public toTimeString ( ) : string
Résultat string

toW3cString() public méthode

Format the instance as W3C
public toW3cString ( ) : string
Résultat string

tz() public méthode

Alias for setTimezone()
public tz ( DateTimeZon\DateTimeZone | string $value ) : static
$value DateTimeZon\DateTimeZone | string The DateTimeZone object or timezone name to use.
Résultat static

wasWithinLast() public méthode

Returns true this instance happened within the specified interval
public wasWithinLast ( string | integer $timeInterval ) : boolean
$timeInterval string | integer the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
Résultat boolean

year() public méthode

Set the instance's year
public year ( integer $value ) : static
$value integer The year value.
Résultat static