PHP Класс Pop\Archive\Archive

Автор: Nick Sagona, III ([email protected])

Защищенные свойства (Protected)

Свойство	Тип	Описание
$adapter	mixed	Archive adapter
$allowed	array	Array of allowed file types.

Метод	Описание
__construct ( string $archive, string $password = null, string $prefix = 'Pop\Archive\Adapter\' ) : Archive	Constructor
adapter ( ) : mixed	Method to return the adapter object
addFiles ( string \| array $files ) : Archive	Method to create an archive file
archive ( ) : mixed	Method to return the archive object within the adapter object
compress ( string $ext = 'gz' ) : Archive	Method to compress an archive file with Gzip or Bzip2
extract ( string $to = null ) : Archive	Method to extract an archived and/or compressed file
factory ( string $archive, string $password = null ) : Archive	Static method to instantiate the archive object and return itself to facilitate chaining methods together.
formats ( ) : array	Get formats
listFiles ( boolean $full = false ) : array	Method to return a listing of the contents of an archived file

Метод	Описание
setAdapter ( string $password = null, string $prefix ) : void	Method to set the adapter based on the file name

Instantiate the archive object

public __construct ( string $archive, string $password = null, string $prefix = 'Pop\Archive\Adapter\' ) : Archive
$archive	string
$password	string
$prefix	string
Результат	Archive

Method to return the adapter object

public adapter ( ) : mixed
Результат	mixed

Method to create an archive file

public addFiles ( string \| array $files ) : Archive
$files	string \| array
Результат	Archive

Method to return the archive object within the adapter object

public archive ( ) : mixed
Результат	mixed

Method to compress an archive file with Gzip or Bzip2

public compress ( string $ext = 'gz' ) : Archive
$ext	string
Результат	Archive

Method to extract an archived and/or compressed file

public extract ( string $to = null ) : Archive
$to	string
Результат	Archive

Static method to instantiate the archive object and return itself to facilitate chaining methods together.

public static factory ( string $archive, string $password = null ) : Archive
$archive	string
$password	string
Результат	Archive

Get formats

public static formats ( ) : array
Результат	array

Method to return a listing of the contents of an archived file

public listFiles ( boolean $full = false ) : array
$full	boolean
Результат	array

Method to set the adapter based on the file name

protected setAdapter ( string $password = null, string $prefix ) : void
$password	string
$prefix	string
Результат	void

Archive adapter

protected mixed $adapter
Результат	mixed

Array of allowed file types.

protected array $allowed
Результат	array