scandir — Получает список файлов и каталогов, расположенных по указанному пути

Назначение scandir

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

Чем отличается scandir

Это процедурная функция раздела «dir». Её отличают имя scandir, контракт «обязательные $directory; необязательные $sorting_order, $context» и объявленный результат array|false; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление scandir

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

Сигнатура scandir

Структурная запись: array|false scandir(string $directory, int $sorting_order = SCANDIR_SORT_ASCENDING, resource|null $context = null). В ней 3 параметра: обязательные $directory; необязательные $sorting_order, $context. Результат объявлен как array|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры scandir

Порядок и роли аргументов по сигнатуре: 1. $directory — string, обязателен; 2. $sorting_order — int, необязателен, default SCANDIR_SORT_ASCENDING; 3. $context — resource|null, необязателен, default null.

Контроль входных данных для scandir

1) string $directory — обязательный: нормализуйте представление, проверьте допустимую схему или базовый каталог и отдельно испытайте отсутствующую цель. 2) int $sorting_order — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки. 3) resource|null $context — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию.

Результат scandir

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

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

Убедитесь, что раздел «dir» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $directory. Затем отдельно добавьте необязательные параметры int $sorting_order=SCANDIR_SORT_ASCENDING, resource|null $context=null, чтобы увидеть влияние значений по умолчанию. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

Интеграция scandir в проект

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

Диагностика scandir

Сначала запишите точную сигнатуру array|false scandir(string $directory, int $sorting_order = SCANDIR_SORT_ASCENDING, resource|null $context = null) и фактические типы переданных значений. Затем подтвердите загрузку расширения «dir» в той же среде, где выполняется scandir. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для scandir предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

Когда выбирать scandir

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

Сравнение scandir с соседними API

Для scandir базовый ориентир: получает список файлов и каталогов, расположенных по указанному пути; обязательные $directory; необязательные $sorting_order, $context; результат array|false. Сопоставление с опубликованными соседями: opendir: открывает дескриптор каталога; вход — обязательные $directory; необязательные $context; результат — resource|false. readdir: получает элемент каталога по его дескриптору; вход — необязательные $dir_handle; результат — string|false. glob: находит файловые пути, которые совпадают с шаблоном; вход — обязательные $pattern; необязательные $flags; результат — array|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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