1. interface
  2. Thelia
  3. Core
  4. Archiver
  5. ArchiverInterface

ArchiverInterface

interface ArchiverInterface

Interface ArchiverInterface

Methods

string
getId()

Get archiver identifier

string
getName()

Get archiver name

string
getExtension()

Get archiver extension

string
getMimeType()

Get archiver mime type

boolean
isAvailable()

Get archiver availability

string
getArchivePath()

Get archive path

$this
setArchivePath( string $archivePath)

Set archive path

$this
create( string $baseName)

Create a new archive

$this
open( string $path)

Open an archive

$this
add( string $path, null|string $pathInArchive = null)

Add directory or file to archive

boolean
save()

Save archive

File
extract( string $toPath)

Extract archive

Details

at line 26
string getId()

Get archiver identifier

Return Value

string The archiver identifier

at line 33
string getName()

Get archiver name

Return Value

string The archiver name

at line 40
string getExtension()

Get archiver extension

Return Value

string The archiver extension

at line 47
string getMimeType()

Get archiver mime type

Return Value

string The archiver mime type

at line 54
boolean isAvailable()

Get archiver availability

Return Value

boolean Archiver availability

at line 61
string getArchivePath()

Get archive path

Return Value

string

at line 70
$this setArchivePath( string $archivePath)

Set archive path

Parameters

string $archivePath

Return Value

$this Return $this, allow chaining

at line 79
$this create( string $baseName)

Create a new archive

Parameters

string $baseName The archive name without extension

Return Value

$this Return $this, allow chaining

at line 88
$this open( string $path)

Open an archive

Parameters

string $path Path to archive

Return Value

$this Return $this, allow chaining

at line 98
$this add( string $path, null|string $pathInArchive = null)

Add directory or file to archive

Parameters

string $path
null|string $pathInArchive

Return Value

$this Return $this, allow chaining

at line 105
boolean save()

Save archive

Return Value

boolean True on success, false otherwise

at line 114
File extract( string $toPath)

Extract archive

Parameters

string $toPath Where to extract

Return Value

File