Documentation

Archiver
in package

AbstractYes

Class Archiver

Table of Contents

Properties

$archive_file  : string
$options  : array<string|int, mixed>

Methods

addEmptyFolders()  : $this
compress()  : $this
create()  : ZipArchiver
extract()  : $this
setArchive()  : $this
setOptions()  : $this
getArchiveFiles()  : RecursiveIteratorIterator

Properties

$archive_file

protected string $archive_file

$options

protected array<string|int, mixed> $options = ['exclude_files' => ['.DS_Store'], 'exclude_paths' => []]

Methods

addEmptyFolders()

public abstract addEmptyFolders(array<string|int, mixed> $folders[, callable|null $status = null ]) : $this
Parameters
$folders : array<string|int, mixed>
$status : callable|null = null
Return values
$this

compress()

public abstract compress(string $folder[, callable|null $status = null ]) : $this
Parameters
$folder : string
$status : callable|null = null
Return values
$this

extract()

public abstract extract(string $destination[, callable|null $status = null ]) : $this
Parameters
$destination : string
$status : callable|null = null
Return values
$this

setArchive()

public setArchive(string $archive_file) : $this
Parameters
$archive_file : string
Return values
$this

setOptions()

public setOptions(array<string|int, mixed> $options) : $this
Parameters
$options : array<string|int, mixed>
Return values
$this

getArchiveFiles()

protected getArchiveFiles(string $rootPath) : RecursiveIteratorIterator
Parameters
$rootPath : string
Return values
RecursiveIteratorIterator

        
On this page

Search results