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

CBXVirtualFile

Описание

CBXVirtualFile - класс файла.

Экземпляр класса не связан с физическим файлом, т.е. файл реально может не существовать. Экземпяр класса можно получить, например, вызвав метод GetFile($path) экземпляра класса CBXVirtualFile.

$fp = $io->RelativeToAbsolutePath("/папка1/.access.php");
$f = $io->GetFile($fp);
$f->MarkWritable();

Примечание:

Класс считается устаревшим. Рекомендуется использовать класс нового ядра D7, расположенный /bitrix/modules/main/lib/io/file.php.

Список методов

Метод Описание С версии
GetName
string
CBXVirtualFile::GetName()
Без параметров. Возвращает имя файла.
GetPath
string
CBXVirtualFile::GetPath()
Без параметров. Возвращает путь к файлу .
GetPathWithName
string
CBXVirtualFile::GetPathWithName()
Без параметров. Возвращает имя файла с путем.
IsDirectory
bool
CBXVirtualFile::IsDirectory()
Без параметров. Возвращает false.
IsExists
bool
CBXVirtualFile::IsExists()
Без параметров. Возвращает true, если файл физически существует. Иначе - false.
MarkWritable
void
CBXVirtualFile::MarkWritable()
Без параметров. Делает файл доступным для записи.
GetPermissions
int
CBXVirtualFile::GetPermissions()
Без параметров. Возвращяет файловые права на файл.
GetModificationTime
int
CBXVirtualFile::GetModificationTime()
Без параметров. Возвращает время последнего изменения файла.
GetLastAccessTime
int
CBXVirtualFile::GetLastAccessTime()
Без параметров. Возвращает время последнего доступа к файлу.
GetType
string
CBXVirtualFile::GetType()
Без параметров. Возвращает тип файла на основании его расширения. Доступные типы: IMAGE, FLASH, SOURCE, UNKNOWN.
GetExtension
string
CBXVirtualFile::GetExtension()
Без параметров. Возвращает расширение файла.
Open
resource
CBXVirtualFile::Open string $mode)
Открывает файл в указанном режиме и возвращает его дескриптор. Лучше не применять этот метод, если это действительно не нужно.
GetContents
string
CBXVirtualFile::GetContents()
Без параметров. Метод возвращает содержимое файла. Если файл не существует, возвращается null.
PutContents
bool
CBXVirtualFile::($data)
Без параметров. Метод записывает новое содержимое в файл. Если файл не существует, то он создается. Возвращает true в случае успешной записи и false - в противном случае.
GetFileSize
int
CBXVirtualFile::GetFileSize()
Без параметров. Возвращает размер файла или 0, если файл не существует.
IsWritable
bool
CBXVirtualFile::IsWritable()
Без параметров. Возвращает true, если файл доступен для записи. Иначе - false.
IsReadable
bool
CBXVirtualFile::IsReadable()
Без параметров. Возвращает true, если файл доступен для чтения. Иначе - false.
ReadFile
string
CBXVirtualFile::ReadFile()
Без параметров. Выкидывает содержимое файла в поток.
GetErrors
array
CBXVirtualFile::GetErrors()
Без параметров. Возвращает массив ошибок, произошедших во время последней файловой операции.


© «Битрикс», 2001-2022, «1С-Битрикс», 2022
Наверх