DateTimeImmutable::createFromFormat — Разбирает строку времени по заданному формату

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

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

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

Эта страница описывает член createFromFormat класса DateTimeImmutable, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public, static. Входной контракт: обязательные $format, $datetime; необязательные $timezone; объявленный результат — DateTimeImmutable|false.

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

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

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

Структурная запись: public static DateTimeImmutable|false DateTimeImmutable::createFromFormat(string $format, string $datetime, DateTimeZone|null $timezone = null). В ней 3 параметра: обязательные $format, $datetime; необязательные $timezone. Результат объявлен как DateTimeImmutable|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

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

Порядок и роли аргументов по сигнатуре: 1. $format — string, обязателен; 2. $datetime — string, обязателен; 3. $timezone — DateTimeZone|null, необязателен, default null.

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

1) string $format — обязательный: испытайте корректный, пустой и синтаксически ошибочный шаблон или формат. 2) string $datetime — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) DateTimeZone|null $timezone — необязательный: передавайте значение точного объявленного типа и добавьте отдельный тест для доменной границы.

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

DateTimeImmutable::createFromFormat объявляет результат типа DateTimeImmutable|false. Контракт DateTimeImmutable::createFromFormat допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

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

Подготовьте объект DateTimeImmutable в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором string $format, string $datetime. Затем отдельно добавьте необязательные параметры DateTimeZone|null $timezone=null, чтобы увидеть влияние значений по умолчанию. Для профиля «дата и время» важно фиксировать часовой пояс и формат на границе системы; негативный сценарий должен проверить переход суток, високосную дату и неоднозначное локальное время.

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

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

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

Сначала запишите точную сигнатуру public static DateTimeImmutable|false DateTimeImmutable::createFromFormat(string $format, string $datetime, DateTimeZone|null $timezone = null) и фактические типы переданных значений. Затем проверьте состояние экземпляра DateTimeImmutable непосредственно перед методом DateTimeImmutable::createFromFormat. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для DateTimeImmutable::createFromFormat предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

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

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

Для DateTimeImmutable::createFromFormat базовый ориентир: разбирает строку времени по заданному формату; обязательные $format, $datetime; необязательные $timezone; результат DateTimeImmutable|false. Совпадение имени createFromFormat не делает методы взаимозаменяемыми: DateTimeImmutable::createFromFormat принадлежит DateTimeImmutable, а DateTime::createFromFormat — DateTime. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: DateTime::createFromFormat: разбирает строку времени по заданному формату; вход — обязательные $format, $datetime; необязательные $timezone; результат — DateTime|false. DateTimeImmutable::__construct: возвращает новый объект datetimeimmutable; вход — необязательные $datetime, $timezone; результат — void. DateTimeImmutable::getLastErrors: возвращает предупреждения и ошибки; вход — аргументов нет; результат — array|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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