PhpToken::is — Проверяет, соответствует ли токен указанному типу

Назначение PhpToken::is

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

Чем отличается PhpToken::is

Эта страница описывает член is класса PhpToken, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $kind; объявленный результат — bool.

Смысловое направление PhpToken::is

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

Сигнатура PhpToken::is

Структурная запись: public bool PhpToken::is(int|string|array $kind). В ней 1 параметр: обязательные $kind. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры PhpToken::is

Порядок и роли аргументов по сигнатуре: 1. $kind — int|string|array, обязателен. Для PhpToken::is фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для PhpToken::is

1) int|string|array $kind — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений.

Результат PhpToken::is

PhpToken::is объявляет результат типа bool. PhpToken::is возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

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

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

Интеграция PhpToken::is в проект

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

Диагностика PhpToken::is

Сначала запишите точную сигнатуру public bool PhpToken::is(int|string|array $kind) и фактические типы переданных значений. Затем проверьте состояние экземпляра PhpToken непосредственно перед методом PhpToken::is. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать PhpToken::is

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

Сравнение PhpToken::is с соседними API

Для PhpToken::is базовый ориентир: проверяет, соответствует ли токен указанному типу; обязательные $kind; результат bool. Сопоставление с опубликованными соседями: token_name: получает символическое название php-лексемы; вход — обязательные $id; результат — string. PhpToken::isIgnorable: сообщает, будет ли токен игнорироваться парсером php; вход — аргументов нет; результат — bool. PhpToken::__toString: возвращает текстовое содержимое токена; вход — аргументов нет; результат — string. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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