PHP Class Pop\Archive\Adapter\Tar

Author: Nick Sagona, III ([email protected])
Inheritance: implements Pop\Archive\Adapter\ArchiveInterface
Show file Open project: nicksagona/PopPHP

Protected Properties

Property Type Description
$archive Archive_Tar Archive_Tar object
$compression string Archive compression
$path string Archive path

Public Methods

Method Description
__construct ( Archive $archive ) : Tar Method to instantiate an archive adapter object
addFiles ( string | array $files ) : void Method to create an archive file
archive ( ) : mixed Method to return the archive object
extract ( string $to = null ) : void Method to extract an archived and/or compressed file
listFiles ( boolean $full = false ) : array Method to return a listing of the contents of an archived file

Method Details

__construct() public method

Method to instantiate an archive adapter object
public __construct ( Archive $archive ) : Tar
$archive Pop\Archive\Archive
return Tar

addFiles() public method

Method to create an archive file
public addFiles ( string | array $files ) : void
$files string | array
return void

archive() public method

Method to return the archive object
public archive ( ) : mixed
return mixed

extract() public method

Method to extract an archived and/or compressed file
public extract ( string $to = null ) : void
$to string
return void

listFiles() public method

Method to return a listing of the contents of an archived file
public listFiles ( boolean $full = false ) : array
$full boolean
return array

Property Details

$archive protected property

Archive_Tar object
protected Archive_Tar $archive
return Archive_Tar

$compression protected property

Archive compression
protected string $compression
return string

$path protected property

Archive path
protected string $path
return string