Документация для разработчиков
Темная тема

BFile

\Bitrix\Main\Engine\Response\BFile - методы работы с файлами. Когда нужно отдать на скачивание файл, который хранится в b_file, то достаточно использовать \Bitrix\Main\Engine\Response\BFile.

Методы

Метод Описание С версии
__construct(
	array $file,
	$name = null)
Конструирует объект BFile, используя заранее сформированный $file. Параметры:
  • $file {array} - массив, описывающий файл, см. \CFile::getFileArray().
  • $name {string} - имя, с которым будет отдан файл на скачивание.
createByFileData(
	array $file,
	$name = null
)
Создаёт объект BFile, используя заранее сформированный $file. Параметры
  • $file {array} - массив, описывающий файл, см. \CFile::getFileArray().
  • $name {string} - имя, с которым будет отдан файл на скачивание.
createByFileId(
	$fileId,
	$name = null
)
Создаёт объект BFile, используя $fileId. Значение $fileId используется для поиска записи в таблице b_file по ID. Параметры:
  • $fileId {int} - идентификатор файла из таблицы b_file.
  • $name {string} - имя, с которым будет отдан файл на скачивание.
createByFileId(
	$fileId,
	$name = null
)
Создаёт объект BFile, используя $fileId. Значение $fileId используется для поиска записи в таблице b_file по ID. Параметры:
  • $fileId {int} - идентификатор файла из таблицы b_file.
  • $name {string} - имя, с которым будет отдан файл на скачивание.
getPath(
)
Получение абсолютного пути до файла.
setPath(
	$path
)
Установка абсолютного пути до файла. Параметры:
  • $path {string} - Абсолютный путь до файла.
getName(
)
Получение имени файла.
setName(
	$name
)
Получение имени файла. Параметры:
  • $name {string} - имя файла.
getContentType(
)
Получение content-type данного файла. По умолчанию данные берутся из таблицы b_file.
setContentType(
	$contentType
)
Установка content-type данного файла. Параметры:
  • $contentType {string} - content-type файла.
showInline(
	$enabled
)
Параметры:
  • $enabled {bool} Если true, то будет установлен заголовок Content-Disposition: inline, иначе Content-Disposition: attachment.
setCacheTime(
	$cacheTime
)
Устанавливает время кеширования. Параметры:
  • $cacheTime {int} Время кеширования файла браузером в секундах.
getCacheTime(
)
Возвращает установленное время кеширования файла.

© «Битрикс», 2001-2024, «1С-Битрикс», 2024