DateTimeImmutable::sub — Вычитает заданное количество дней, месяцев, лет, часов, минут и секунд

Назначение DateTimeImmutable::sub

DateTimeImmutable::sub: Вычитает заданное количество дней, месяцев, лет, часов, минут и секунд. Справочная сущность относится к разделу «Дата и время». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается DateTimeImmutable::sub

Эта страница описывает член sub класса DateTimeImmutable, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: #[\NoDiscard(message: "as DateTimeImmutable::sub() does not modify the object itself")], public. Входной контракт: обязательные $interval; объявленный результат — DateTimeImmutable.

Смысловое направление DateTimeImmutable::sub

Смысловое направление DateTimeImmutable::sub — «получение данных». В прикладном коде различайте отсутствие данных, пустое значение и технический отказ источника. Контрольный набор для этой операции: проверьте пустой источник, один результат и недоступное окружение. Такой акцент отделяет DateTimeImmutable::sub от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура DateTimeImmutable::sub

Структурная запись: #[\NoDiscard(message: "as DateTimeImmutable::sub() does not modify the object itself")] public DateTimeImmutable DateTimeImmutable::sub(DateInterval $interval). В ней 1 параметр: обязательные $interval. Результат объявлен как DateTimeImmutable; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры DateTimeImmutable::sub

Порядок и роли аргументов по сигнатуре: 1. $interval — DateInterval, обязателен. Для DateTimeImmutable::sub фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для DateTimeImmutable::sub

1) DateInterval $interval — обязательный: зафиксируйте единицу измерения и поведение для нуля, отрицательного и предельного значения.

Результат DateTimeImmutable::sub

DateTimeImmutable::sub объявляет результат типа DateTimeImmutable. Результат DateTimeImmutable::sub имеет объявленный тип DateTimeImmutable. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

Проверочный сценарий для DateTimeImmutable::sub

Подготовьте объект DateTimeImmutable в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором DateInterval $interval. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «дата и время» важно фиксировать часовой пояс и формат на границе системы; негативный сценарий должен проверить переход суток, високосную дату и неоднозначное локальное время.

Интеграция DateTimeImmutable::sub в проект

Храните подготовку DateTimeImmutable и вызов DateTimeImmutable::sub в одном понятном жизненном цикле; не скрывайте обязательное состояние объекта в глобальной переменной. Для профиля «дата и время» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция DateTimeImmutable::sub не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика DateTimeImmutable::sub

Сначала запишите точную сигнатуру #[\NoDiscard(message: "as DateTimeImmutable::sub() does not modify the object itself")] public DateTimeImmutable DateTimeImmutable::sub(DateInterval $interval) и фактические типы переданных значений. Затем проверьте состояние экземпляра DateTimeImmutable непосредственно перед методом DateTimeImmutable::sub. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «дата и время» применяйте отдельный негативный тест: проверить переход суток, високосную дату и неоднозначное локальное время. В production-коде важно фиксировать часовой пояс и формат на границе системы. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать DateTimeImmutable::sub

Выбор DateTimeImmutable::sub оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к DateTimeImmutable; 2) сигнатура содержит 1 аргумент: обязательных 1, необязательных 0; 3) вызывающему коду нужен результат DateTimeImmutable и действие «получение данных». Для профиля «дата и время» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с DateTime::sub: у него другое назначение, владелец или набор входных данных.

Сравнение DateTimeImmutable::sub с соседними API

Для DateTimeImmutable::sub базовый ориентир: вычитает заданное количество дней, месяцев, лет, часов, минут и секунд; обязательные $interval; результат DateTimeImmutable. Совпадение имени sub не делает методы взаимозаменяемыми: DateTimeImmutable::sub принадлежит DateTimeImmutable, а DateTime::sub — DateTime. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: DateTime::sub: вычитает дни, месяцы, годы, часы, минуты и секунды из объекта datetime; вход — обязательные $interval; результат — DateTime. DateTimeImmutable::add: возвращает новый объект с добавленным количеством дней, месяцев, лет, часов, минут и секунд; вход — обязательные $interval; результат — DateTimeImmutable. DateTimeImmutable::modify: создаёт новый объект с изменённой временной меткой; вход — обязательные $modifier; результат — DateTimeImmutable. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

В структурной истории исходной записи отмечены версии: 8.3.0. DateTimeImmutable::sub сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для DateTimeImmutable::sub.

Связанные материалы