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

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

 __construct ($path, $siteId=null)
 Archiver constructor. Подробнее...
 
 pack (Translate\Directory $directory)
 Pack language folder. Подробнее...
 
 extract (Translate\Directory $target)
 Extract language archive into target folder. Подробнее...
 
- Открытые члены унаследованные от File
 open ($mode)
 Opens the file and returns the file pointer. Подробнее...
 
 close ()
 Closes the file. Подробнее...
 
 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 libAvailable ()
 Checks zlib|gzcompress availability. Подробнее...
 
- Открытые статические члены унаследованные от File
static isFileExists ($path)
 
static getFileContents ($path)
 
static putFileContents ($path, $data, $flags=self::REWRITE)
 
static deleteFile ($path)
 

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

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

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

См. определение в файле archiver.php строка 9

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

◆ __construct()

__construct (   $path,
  $siteId = null 
)

Archiver constructor.

Аргументы
string$pathEnd point archive file path.
string | null$siteIdSite id.

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

См. определение в файле archiver.php строка 23

24  {
26 
27  $this->canUseCompression = self::libAvailable();
28 
29  }

Методы

◆ extract()

extract ( Translate\Directory  $target)

Extract language archive into target folder.

Аргументы
Translate\Directory$targetFolder to extract files into it.
Возвращает
boolean

См. определение в файле archiver.php строка 78

79  {
80  $this->archive = new \CArchiver($this->getPhysicalPath(), true);
81  $this->archive->_strSeparator = '|';
82 
83  $res = $this->archive->extractFiles($target->getPhysicalPath());
84 
85  if (!$res)
86  {
87  $errors = $this->archive->GetErrors();
88  if (count($errors) > 0)
89  {
90  foreach ($errors as $errorMessage)
91  {
92  $this->addError(new Main\Error($errorMessage[1], $errorMessage[0]));
93  }
94  }
95  }
96 
97  return ($this->hasErrors() !== true);
98  }

◆ libAvailable()

static libAvailable ( )
static

Checks zlib|gzcompress availability.

Возвращает
boolean

См. определение в файле archiver.php строка 36

37  {
38  return (extension_loaded('zlib') || function_exists('gzcompress'));
39  }

◆ pack()

pack ( Translate\Directory  $directory)

Pack language folder.

Аргументы
Translate\Directory$directoryFolder to pack into archive.
Возвращает
boolean

См. определение в файле archiver.php строка 49

50  {
51  $this->archive = new \CArchiver($this->getPhysicalPath(), $this->canUseCompression);
52  $this->archive->_strSeparator = '|';
53 
54  $res = $this->archive->Add($directory->getPhysicalPath(), false, $directory->getDirectory()->getPhysicalPath());
55 
56  if (!$res)
57  {
58  $errors = $this->archive->GetErrors();
59  if (count($errors) > 0)
60  {
61  foreach ($errors as $errorMessage)
62  {
63  $this->addError(new Main\Error($errorMessage[1], $errorMessage[0]));
64  }
65  }
66  }
67 
68  return ($this->hasErrors() !== true);
69  }

Объявления и описания членов класса находятся в файле:
Bitrix\Main\IO\FileSystemEntry\$path
$path
Definition: filesystementry.php:8
Bitrix\Main\hasErrors
hasErrors()
Return true if collection has errors.
Definition: errorableimplementation.php:17
Bitrix\Translate\Archiver\libAvailable
static libAvailable()
Checks zlib|gzcompress availability.
Definition: archiver.php:36
Bitrix\Main\IO\FileSystemEntry\getPhysicalPath
getPhysicalPath()
Definition: filesystementry.php:90
Bitrix\Main\IO\FileSystemEntry\$siteId
$siteId
Definition: filesystementry.php:11
Bitrix\Sender\Connector\__construct
__construct(Base $connector)
Constructor.
Definition: resultview.php:40