Bitrix-D7  20.0.0
Класс File
Граф наследования:File:
File Errorable FileEntry IFileStream FileSystemEntry

Открытые члены

 __construct ($path, $siteId=null)
 Constructor. Подробнее...
 
 openLoad ()
 Opens file for reading. Подробнее...
 
 openWrite ()
 Opens file for writing. Подробнее...
 
 read ($length)
 Read file. Подробнее...
 
 write ($content)
 Write file. Подробнее...
 
 close ()
 Closes the file. Подробнее...
 
 getErrors ()
 Getting array of errors. Подробнее...
 
 getErrorByCode ($code)
 Getting once error with the necessary code. Подробнее...
 
 hasErrors ()
 Getting array of errors. Подробнее...
 
- Открытые члены унаследованные от File
 open ($mode)
 Opens the file and returns the file pointer. Подробнее...
 
 isExists ()
 
 getContents ()
 
 putContents ($data, $flags=self::REWRITE)
 
 getSize ()
 Returns the file size. Подробнее...
 
 seek ($position)
 Seeks on the file pointer from the beginning (SEEK_SET only). Подробнее...
 
 isWritable ()
 
 isReadable ()
 
 readFile ()
 
 getCreationTime ()
 
 getLastAccessTime ()
 
 getModificationTime ()
 
 markWritable ()
 
 getPermissions ()
 
 delete ()
 
 getContentType ()
 
- Открытые члены унаследованные от FileEntry
 getExtension ()
 
 putContents ($data)
 
 getFileSize ()
 
 isDirectory ()
 
 isFile ()
 
 isLink ()
 
- Открытые члены унаследованные от FileSystemEntry
 isSystem ()
 
 getName ()
 
 getDirectoryName ()
 
 getPath ()
 
 getDirectory ()
 
 getPhysicalPath ()
 
 rename ($newPath)
 

Открытые статические члены

static generateTemporalFile ($prefix, $suffix='.tmp', $timeToLive=1)
 Creates temporal file. Подробнее...
 
- Открытые статические члены унаследованные от File
static isFileExists ($path)
 
static getFileContents ($path)
 
static putFileContents ($path, $data, $flags=self::REWRITE)
 
static deleteFile ($path)
 

Защищенные члены

 addError (Error $error)
 Adds error to error collection. Подробнее...
 
 addErrors (array $errors)
 Adds list of errors to error collection. Подробнее...
 

Защищенные данные

 $errorCollection
 
- Защищенные данные унаследованные от File
 $filePointer
 
- Защищенные данные унаследованные от FileSystemEntry
 $path
 
 $originalPath
 
 $pathPhysical
 
 $siteId
 

Дополнительные унаследованные члены

- Поля данных унаследованные от File
const REWRITE = 0
 
const APPEND = 1
 
- Защищенные статические члены унаследованные от FileSystemEntry
static getDocumentRoot ($siteId)
 

Подробное описание

См. определение в файле translate/lib/file.php строка 11

Конструктор(ы)

◆ __construct()

__construct (   $path,
  $siteId = null 
)

Constructor.

Аргументы
string$pathFile path.
string | null$siteIdSite Id.

Переопределяет метод предка File.

См. определение в файле translate/lib/file.php строка 24

25  {
27  }

Методы

◆ addError()

addError ( Error  $error)
protected

Adds error to error collection.

Аргументы
Error$errorError.
Возвращает
$this

См. определение в файле translate/lib/file.php строка 137

138  {
139  if (!$this->errorCollection instanceof ErrorCollection)
140  {
141  $this->errorCollection = new ErrorCollection;
142  }
143 
144  $this->errorCollection[] = $error;
145 
146  return $this;
147  }

◆ addErrors()

addErrors ( array  $errors)
protected

Adds list of errors to error collection.

Аргументы
Error[]$errorsErrors.
Возвращает
$this

См. определение в файле translate/lib/file.php строка 155

156  {
157  if (!$this->errorCollection instanceof ErrorCollection)
158  {
159  $this->errorCollection = new ErrorCollection;
160  }
161 
162  $this->errorCollection->add($errors);
163 
164  return $this;
165  }

◆ close()

close ( )

Closes the file.

Возвращает
void

Переопределяет метод предка File.

См. определение в файле translate/lib/file.php строка 97

98  {
99  if (!is_resource($this->filePointer))
100  {
101  @fflush($this->filePointer);
102  }
103 
104  parent::close();
105 
106  @clearstatcache(true, $this->getPhysicalPath());
107  }

◆ generateTemporalFile()

static generateTemporalFile (   $prefix,
  $suffix = '.tmp',
  $timeToLive = 1 
)
static

Creates temporal file.

Аргументы
string$prefixName prefix.
string$suffixName suffix.
float$timeToLiveHours to keep files alive.
Возвращает
self

См. определение в файле translate/lib/file.php строка 118

119  {
120  $tempDir = \CTempFile::GetDirectoryName($timeToLive, array($prefix, uniqid($prefix, true)));
121  \CheckDirPath($tempDir);
122 
123  $hash = str_pad(dechex(crc32($tempDir)), 8, '0', STR_PAD_LEFT);
124  $fileName = uniqid($hash. '_', false). $suffix;
125 
126  return new static($tempDir. $fileName);
127  }

◆ getErrorByCode()

getErrorByCode (   $code)
final

Getting once error with the necessary code.

Аргументы
string$codeCode of error.
Возвращает
Error|null

Замещает Errorable.

См. определение в файле translate/lib/file.php строка 186

187  {
188  if (!$this->errorCollection instanceof ErrorCollection)
189  {
190  return null;
191  }
192 
193  return $this->errorCollection->getErrorByCode($code);
194  }

◆ getErrors()

getErrors ( )
final

Getting array of errors.

Возвращает
Error[]

Замещает Errorable.

См. определение в файле translate/lib/file.php строка 171

172  {
173  if (!$this->errorCollection instanceof ErrorCollection)
174  {
175  return array();
176  }
177 
178  return $this->errorCollection->toArray();
179  }

◆ hasErrors()

hasErrors ( )

Getting array of errors.

Возвращает
boolean

См. определение в файле translate/lib/file.php строка 201

202  {
203  if (!$this->errorCollection instanceof ErrorCollection)
204  {
205  return false;
206  }
207 
208  return $this->errorCollection->isEmpty();
209  }

◆ openLoad()

openLoad ( )

Opens file for reading.

Возвращает
bool

См. определение в файле translate/lib/file.php строка 35

36  {
37  if ($this->isExists())
38  {
39  $this->open(Main\IO\FileStreamOpenMode::READ);
40  }
41 
42  return $this->isExists() && $this->isReadable();
43  }

◆ openWrite()

openWrite ( )

Opens file for writing.

Возвращает
bool

См. определение в файле translate/lib/file.php строка 50

51  {
52  $this->open(Main\IO\FileStreamOpenMode::WRITE);
53 
54  return $this->isWritable();
55  }

◆ read()

read (   $length)

Read file.

Аргументы
int$lengthAmount bytes to read.
Возвращает
string

См. определение в файле translate/lib/file.php строка 65

66  {
67  if (feof($this->filePointer))
68  {
69  return '';
70  }
71 
72  return fread($this->filePointer, $length);
73  }

◆ write()

write (   $content)

Write file.

Аргументы
string$contentData to write.
Возвращает
bool|int

См. определение в файле translate/lib/file.php строка 82

83  {
84  if (!is_resource($this->filePointer))
85  {
86  return false;
87  }
88 
89  return fwrite($this->filePointer, $content);
90  }

Поля

◆ $errorCollection

$errorCollection
protected

См. определение в файле translate/lib/file.php строка 16


Объявления и описания членов класса находятся в файле:
Bitrix\Main\IO\FileSystemEntry\$path
$path
Definition: filesystementry.php:8
Bitrix\Main\IO\File\open
open($mode)
Opens the file and returns the file pointer.
Definition: main/lib/io/file.php:26
Bitrix\Main\IO\File\isExists
isExists()
Definition: main/lib/io/file.php:51
Bitrix\Main\IO\File\isWritable
isWritable()
Definition: main/lib/io/file.php:172
Bitrix\Main\IO\FileSystemEntry\getPhysicalPath
getPhysicalPath()
Definition: filesystementry.php:90
Bitrix\Main\IO\FileStreamOpenMode\READ
const READ
Definition: ifilestream.php:11
Bitrix\Main\IO\FileSystemEntry\$siteId
$siteId
Definition: filesystementry.php:11
Bitrix\Main\IO\FileStreamOpenMode\WRITE
const WRITE
Definition: ifilestream.php:12
Bitrix\Main\IO\File\isReadable
isReadable()
Definition: main/lib/io/file.php:180
Bitrix\Sender\Connector\__construct
__construct(Base $connector)
Constructor.
Definition: resultview.php:40
Bitrix\Main\IO
Definition: main/lib/io/directory.php:2