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

Класс CFile

Класс для работы с файлами и изображениями.

Аналог класса в новом ядре D7 - Bitrix\Main\FileTable.

Поля

ПолеТипОписание
IDintID файла.
TIMESTAMP_XtimestampДата изменения записи.
MODULE_IDvarchar(50)Идентификатор модуля которому принадлежит файл.
HEIGHTintВысота изображения (если файл - графический).
WIDTHintШирина изображения (если файл - графический).
FILE_SIZEintРазмер файла (байт).
CONTENT_TYPEvarchar(255)MIME тип файла.
SUBDIRvarchar(255)Подкаталог в котором находится файл на диске. Основной каталог для хранения файлов задается в параметре "Папка по умолчанию для загрузки файлов" в настройках главного модуля, значение данного параметра программно можно получить с помощью вызова метода:
COption::GetOptionString("main", "upload_dir", "upload");
FILE_NAMEvarchar(255)Имя файла на диске сервера.
ORIGINAL_NAMEvarchar(255)Оригинальное имя файла в момент загрузки его на сервер.
DESCRIPTIONvarchar(255)Описание файла.

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

МетодОписаниес версии
GetByIDВозвращает информацию по одному зарегистрированному файлу.3.1.6
GetListВозвращает отсортированную и отфильтрованную выборку зарегистрированных файлов.7.0.2
GetPathМетод возвращает путь от корня сайта к зарегистрированному файлу.3.3.21
ShowImageВозвращает HTML для показа изображения.
Show2ImagesВозвращает HTML для показа изображения при клике на которое в отдельном окне отображается другое изображение.3.2.1
CheckFileПроверяет размер, расширение и mime тип файла. В случае ошибки метод вернет строку с текстом ошибки.
CheckImageFileПроверяет что файл является картинкой и проверяет ее параметры. В случае ошибки метод вернет строку с текстом ошибки.
IsImageМетод проверяет расширение и заданный MIME тип файла. Если расширение и MIME тип файла соответствуют изображению, то возвращает "true", иначе "false". 3.3.18
MakeFileArrayМетод формирует массив описывающий файл. Структура массива аналогична структуре массива $_FILES[имя] (или $HTTP_POST_FILES[имя]). Данный массив может быть использован в методах CFile::SaveFile, CFile::CheckFile, CFile::CheckImageFile.3.2.9
InputFileВозвращает HTML код предназначенный для загрузки нового, либо замены существующего файла.
SaveFileСохраняет файл и регистрирует его в таблице файлов.
SaveForDBСохраняет файл и подготавливает данные для вставки/обновления записи в БД, содержащей ссылку на файл7.1.0
UpdateDescОбновляет описание к зарегистрированному файлу.3.3.21
CopyFileКопирует зарегистрированный файл.3.0.14
DeleteУдаляет файл из таблицы зарегистрированных файлов и с диска.
FormatSizeМетод переводит байты в единицы с учетом языка, установленного в текущем сайта..8.6.4
GetFileArray Возвращает массив описывающий файл с заданным идентификатором. 5.1.8
ResizeImageFile Метод производит изменение размера графического файла 7.1.1
ResizeImageGet Метод уменьшает картинку. 7.1.1
ResizeImage Обертка ResizeImageFile 7.1.1


Пользовательские комментарии

Пользовательские комментарии не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Добавлять комментарии могут только зарегистрированные пользователи. Сообщения для просмотра появляются после модерации.
5
Иван Левый
Так же в классе CFile есть функция CFile::GetFileArray() которая возвращает результат действия функций CFile::GetById() и CFile::GetPath().
Это бывает удобно, например, когда нужно получить одной функцией и имя файла, и путь к нему на сервере.
© «Битрикс», 2001-2018, «1С-Битрикс», 2018
Наверх