CalendarComparisonsTrait
Предикаты и разницы календарной даты: день недели, относительные проверки (сегодня/вчера/завтра от часов приложения), сравнения с другим моментом и целочисленные разницы. Вынесены из {@see CalendarDate} отдельным трейтом, чтобы удержать число публичных методов класса в пределах анализатора — поведение и покрытие тестами не меняются.
Tags
Table of Contents
Methods
- age() : int
- Возраст в полных годах относительно часов приложения.
- diffInDays() : int
- Абсолютная разница в целых сутках.
- diffInHours() : int
- Абсолютная разница в целых часах.
- diffInMinutes() : int
- Абсолютная разница в целых минутах.
- diffInMonths() : int
- Абсолютная календарная разница в целых месяцах.
- diffInSeconds() : int
- Абсолютная разница в целых секундах.
- diffInWeeks() : int
- Абсолютная разница в целых неделях.
- diffInYears() : int
- Абсолютная календарная разница в целых годах.
- isAfter() : bool
- Строго позже ли другого момента.
- isBefore() : bool
- Строго раньше ли другого момента.
- isBetween() : bool
- Попадает ли момент в интервал между двумя границами (порядок границ любой).
- isFriday() : bool
- Пятница ли это.
- isFuture() : bool
- В будущем ли дата относительно «сейчас» глобальных часов.
- isMonday() : bool
- Понедельник ли это.
- isoWeekday() : int
- День недели по ISO-8601 (1=понедельник … 7=воскресенье). Реализуется {@see CalendarDate}; объявлен здесь, чтобы анализатор видел сигнатуру.
- isPast() : bool
- В прошлом ли дата относительно «сейчас» глобальных часов.
- isSameDay() : bool
- Один ли календарный день с другим моментом (в собственных зонах).
- isSameMonth() : bool
- Один ли календарный месяц (год + месяц) с другим моментом.
- isSameQuarter() : bool
- Один ли квартал (год + квартал) с другим моментом.
- isSameYear() : bool
- Один ли календарный год с другим моментом.
- isSaturday() : bool
- Суббота ли это.
- isSunday() : bool
- Воскресенье ли это.
- isThursday() : bool
- Четверг ли это.
- isToday() : bool
- Сегодня ли это относительно часов приложения.
- isTomorrow() : bool
- Завтра ли это относительно часов приложения.
- isTuesday() : bool
- Вторник ли это.
- isWednesday() : bool
- Среда ли это.
- isWeekday() : bool
- Будний ли это день (понедельник–пятница).
- isWeekend() : bool
- Выходной ли это (суббота или воскресенье).
- isYesterday() : bool
- Вчера ли это относительно часов приложения.
- max() : static
- Более поздний из двух моментов.
- min() : static
- Более ранний из двух моментов.
- quarter() : int
- Квартал (1–4). Реализуется {@see CalendarDate}.
Methods
age()
Возраст в полных годах относительно часов приложения.
public
age() : int
Return values
int —число полных лет между датой и текущим моментом
diffInDays()
Абсолютная разница в целых сутках.
public
diffInDays(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число полных суток
diffInHours()
Абсолютная разница в целых часах.
public
diffInHours(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число полных часов
diffInMinutes()
Абсолютная разница в целых минутах.
public
diffInMinutes(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число полных минут
diffInMonths()
Абсолютная календарная разница в целых месяцах.
public
diffInMonths(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число полных календарных месяцев
diffInSeconds()
Абсолютная разница в целых секундах.
public
diffInSeconds(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число секунд
diffInWeeks()
Абсолютная разница в целых неделях.
public
diffInWeeks(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число полных недель
diffInYears()
Абсолютная календарная разница в целых годах.
public
diffInYears(DateTimeInterface $other) : int
Parameters
- $other : DateTimeInterface
-
второй момент
Return values
int —неотрицательное число полных календарных лет
isAfter()
Строго позже ли другого момента.
public
isAfter(DateTimeInterface $other) : bool
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
bool —true, если этот момент позже
isBefore()
Строго раньше ли другого момента.
public
isBefore(DateTimeInterface $other) : bool
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
bool —true, если этот момент раньше
isBetween()
Попадает ли момент в интервал между двумя границами (порядок границ любой).
public
isBetween(DateTimeInterface $from, DateTimeInterface $to[, bool $inclusive = true ]) : bool
Parameters
- $from : DateTimeInterface
-
одна граница интервала
- $to : DateTimeInterface
-
другая граница интервала
- $inclusive : bool = true
-
включать ли сами границы
Return values
bool —true, если момент внутри интервала
isFriday()
Пятница ли это.
public
isFriday() : bool
Return values
bool —true, если день недели — пятница
isFuture()
В будущем ли дата относительно «сейчас» глобальных часов.
public
isFuture() : bool
Return values
bool —true, если момент строго позже текущего
isMonday()
Понедельник ли это.
public
isMonday() : bool
Return values
bool —true, если день недели — понедельник
isoWeekday()
День недели по ISO-8601 (1=понедельник … 7=воскресенье). Реализуется {@see CalendarDate}; объявлен здесь, чтобы анализатор видел сигнатуру.
public
abstract isoWeekday() : int
Return values
int —день недели ISO
isPast()
В прошлом ли дата относительно «сейчас» глобальных часов.
public
isPast() : bool
Return values
bool —true, если момент строго раньше текущего
isSameDay()
Один ли календарный день с другим моментом (в собственных зонах).
public
isSameDay(DateTimeInterface $other) : bool
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
bool —true, если совпадают год, месяц и день
isSameMonth()
Один ли календарный месяц (год + месяц) с другим моментом.
public
isSameMonth(DateTimeInterface $other) : bool
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
bool —true, если совпадают год и месяц
isSameQuarter()
Один ли квартал (год + квартал) с другим моментом.
public
isSameQuarter(DateTimeInterface $other) : bool
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
bool —true, если совпадают год и квартал
isSameYear()
Один ли календарный год с другим моментом.
public
isSameYear(DateTimeInterface $other) : bool
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
bool —true, если совпадает год
isSaturday()
Суббота ли это.
public
isSaturday() : bool
Return values
bool —true, если день недели — суббота
isSunday()
Воскресенье ли это.
public
isSunday() : bool
Return values
bool —true, если день недели — воскресенье
isThursday()
Четверг ли это.
public
isThursday() : bool
Return values
bool —true, если день недели — четверг
isToday()
Сегодня ли это относительно часов приложения.
public
isToday() : bool
Return values
bool —true, если календарный день совпадает с текущим
isTomorrow()
Завтра ли это относительно часов приложения.
public
isTomorrow() : bool
Return values
bool —true, если это следующий календарный день
isTuesday()
Вторник ли это.
public
isTuesday() : bool
Return values
bool —true, если день недели — вторник
isWednesday()
Среда ли это.
public
isWednesday() : bool
Return values
bool —true, если день недели — среда
isWeekday()
Будний ли это день (понедельник–пятница).
public
isWeekday() : bool
Return values
bool —true для понедельника–пятницы
isWeekend()
Выходной ли это (суббота или воскресенье).
public
isWeekend() : bool
Return values
bool —true для субботы и воскресенья
isYesterday()
Вчера ли это относительно часов приложения.
public
isYesterday() : bool
Return values
bool —true, если это предыдущий календарный день
max()
Более поздний из двух моментов.
public
max(DateTimeInterface $other) : static
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
static —этот момент либо $other, смотря какой позже
min()
Более ранний из двух моментов.
public
min(DateTimeInterface $other) : static
Parameters
- $other : DateTimeInterface
-
сравниваемый момент
Return values
static —этот момент либо $other, смотря какой раньше
quarter()
Квартал (1–4). Реализуется {@see CalendarDate}.
public
abstract quarter() : int
Return values
int —квартал