Zippy API
Class

Alchemy\Zippy\Archive\Archive

class Archive implements ArchiveInterface

Represents an archive

Methods

__construct(ResourceInterface $resource, AdapterInterface $adapter, ResourceManager $manager)

Constructor
count()

ArrayIterator getIterator()

Returns an Iterator for the current archive
Array getMembers()

ArchiveInterface addMembers(String|Array|SplFileInfo $sources, Boolean $recursive = true)

ArchiveInterface removeMembers(String|Array $sources)

ArchiveInterface extract(String $toDirectory)

ArchiveInterface extractMembers(String|Array $members, string $toDirectory = null)

Details

at line 62
public __construct(ResourceInterface $resource, AdapterInterface $adapter, ResourceManager $manager)

Constructor

Parameters

ResourceInterface $resource Path to the archive
AdapterInterface $adapter An archive adapter
ResourceManager $manager The resource manager

at line 72
public count()

at line 84
public ArrayIterator getIterator()

Returns an Iterator for the current archive

This method implements the IteratorAggregate interface.

Return Value

ArrayIterator An iterator

at line 92
public Array getMembers()

Return Value

Array An array of File

at line 100
public ArchiveInterface addMembers(String|Array|SplFileInfo $sources, Boolean $recursive = true)

Parameters

String|Array|SplFileInfo $sources The path to the file or a folder
Boolean $recursive Recurse into sub-directories

Return Value

ArchiveInterface

at line 110
public ArchiveInterface removeMembers(String|Array $sources)

Parameters

String|Array $sources The path to an archive or a folder member

Return Value

ArchiveInterface

at line 120
public ArchiveInterface extract(String $toDirectory)

Parameters

String $toDirectory The path the extracted archive

Return Value

ArchiveInterface

at line 130
public ArchiveInterface extractMembers(String|Array $members, string $toDirectory = null)

Parameters

String|Array $members An array of members path
string $toDirectory The destination $directory

Return Value

ArchiveInterface