DateTimeImmutable::modify — Создаёт новый объект с изменённой временной меткой

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

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

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

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

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

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

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

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

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

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

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

1) string $modifier — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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