Path — операции с путями

Пространство имен: Bitrix\Main\IO

Модуль: main — подключать отдельно не нужно

Доступно с версии: 12.0.7

Когда использовать

Класс Path содержит статические методы для работы со строкой пути. Методы не проверяют, существует ли путь. Объект класса создавать не нужно.

Основные методы класса:

  • combine — собирает путь из частей и нормализует его,
  • normalize — убирает повторные косые черты, . и ..,
  • getName, getDirectory и getExtension — выделяют части пути,
  • validateFilename — проверяет имя файла, которое пришло от пользователя.

Класс работает с разделителем /. Методы не считают обратную косую черту разделителем. Исключение — Windows, там метод normalize и методы, которые его вызывают, например combine, заменяют обратную косую черту на /.

Для операций с файлами используйте класс File.

Методы класса

Метод Описание С версии
combine Собирает путь из частей и нормализует его
normalize Приводит путь к каноническому виду
getName Возвращает имя файла или каталога из пути
getDirectory Возвращает путь к родительскому каталогу
getExtension Возвращает расширение файла
isAbsolute Проверяет, абсолютный ли путь
convertRelativeToAbsolute Переводит путь от корня сайта в абсолютный путь
convertSiteRelativeToAbsolute Переводит путь от корня указанного сайта в абсолютный путь
validate Проверяет абсолютный путь на недопустимые символы
validateFilename Проверяет имя файла на недопустимые символы
replaceInvalidFilename Заменяет недопустимые символы имени файла
randomizeInvalidFilename Заменяет недопустимые символы имени файла случайными буквами
convertLogicalToUri Переводит путь в URI
convertPhysicalToUri Переводит путь из кодировки файловой системы в URI
convertUriToPhysical Переводит URI в путь в кодировке файловой системы
convertLogicalToPhysical Переводит путь в кодировку файловой системы
convertPhysicalToLogical Переводит путь из кодировки файловой системы в UTF-8

Константы

Константа Значение Назначение
DIRECTORY_SEPARATOR / Разделитель частей пути
INVALID_FILENAME_CHARS Обратная и прямая косые черты, :, *, ?, двойная и одинарная кавычки, <, >, вертикальная черта, ~, #, &, ; Символы, недопустимые в имени файла. Метод validate допускает в пути символ /
INVALID_FILENAME_BYTES Байты символа U+202E Символ смены направления текста, недопустимый в имени файла и пути

Методы проверки имени и пути также запрещают управляющие символы с кодами от 1 до 31 и нулевой байт.

Смотрите также