Zippy API
Index
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

AbstractAdapter — Class in namespace Alchemy\Zippy\Adapter
AbstractBinaryAdapter — Class in namespace Alchemy\Zippy\Adapter
AbstractTarAdapter — Class in namespace Alchemy\Zippy\Adapter
AbstractTarAdapter::add() — Method in class AbstractTarAdapter
AdapterContainer — Class in namespace Alchemy\Zippy\Adapter
AdapterInterface — Class in namespace Alchemy\Zippy\Adapter
AdapterInterface::add() — Method in class AdapterInterface
Adds a file to the archive
ZipAdapter::add() — Method in class ZipAdapter
ZipExtensionAdapter::add() — Method in class ZipExtensionAdapter
ZipExtensionAdapter::addFileToZip() — Method in class ZipExtensionAdapter
ZipExtensionAdapter::addEmptyDir() — Method in class ZipExtensionAdapter
Archive — Class in namespace Alchemy\Zippy\Archive
Represents an archive
Archive::addMembers() — Method in class Archive
ArchiveInterface — Class in namespace Alchemy\Zippy\Archive
ArchiveInterface::addMembers() — Method in class ArchiveInterface
Adds a file or a folder into the archive
AbstractTeleporter — Class in namespace Alchemy\Zippy\Resource\Teleporter
$Zippy — Property in class Zippy
Zippy::addStrategy() — Method in class Zippy
Adds a strategy.

B

BinaryAdapterInterface — Class in namespace Alchemy\Zippy\Adapter
BSDTarOutputParser — Class in namespace Alchemy\Zippy\Parser
This class is responsable of parsing GNUTar command line output

C

AbstractTarAdapter::create() — Method in class AbstractTarAdapter
AdapterInterface::create() — Method in class AdapterInterface
Creates a new archive
ZipAdapter::create() — Method in class ZipAdapter
ZipExtensionAdapter::create() — Method in class ZipExtensionAdapter
ZipExtensionAdapter::checkReadability() — Method in class ZipExtensionAdapter
Archive::count() — Method in class Archive
ParserFactory::create() — Method in class ParserFactory
Maps the corresponding parser to the selected adapter
ProcessBuilderFactory::create() — Method in class ProcessBuilderFactory
ProcessBuilderFactoryInterface::create() — Method in class ProcessBuilderFactoryInterface
Returns a new instance of Symfony ProcessBuilder
RequestMapper::create() — Method in class RequestMapper
Creates the default RequestMapper
Resource::canBeProcessedInPlace() — Method in class Resource
Returns wheter the resource can be processed in place given a context or not.
ResourceCollection::canBeProcessedInPlace() — Method in class ResourceCollection
Returns true if all resources can be processed in place, false otherwise
ResourceManager::cleanup() — Method in class ResourceManager
This method must be called once the ResourceCollection has been processed.
ResourceManager::create() — Method in class ResourceManager
Creates a default ResourceManager
ResourceTeleporter::create() — Method in class ResourceTeleporter
Creates the ResourceTeleporter with the default TeleporterContainer
GuzzleTeleporter::create() — Method in class GuzzleTeleporter
Creates the GuzzleTeleporter
LocalTeleporter::create() — Method in class LocalTeleporter
Creates the LocalTeleporter
StreamTeleporter::create() — Method in class StreamTeleporter
Creates the StreamTeleporter
Zippy::create() — Method in class Zippy
Creates an archive

E

AbstractTarAdapter::extractMembers() — Method in class AbstractTarAdapter
AbstractTarAdapter::extract() — Method in class AbstractTarAdapter
AdapterInterface::extract() — Method in class AdapterInterface
Extracts an entire archive
AdapterInterface::extractMembers() — Method in class AdapterInterface
Extracts specific members of the archive
ZipAdapter::extract() — Method in class ZipAdapter
ZipAdapter::extractMembers() — Method in class ZipAdapter
ZipExtensionAdapter::extract() — Method in class ZipExtensionAdapter
ZipExtensionAdapter::extractMembers() — Method in class ZipExtensionAdapter
Archive::extract() — Method in class Archive
Archive::extractMembers() — Method in class Archive
ArchiveInterface::extract() — Method in class ArchiveInterface
Extracts current archive to the given directory
ArchiveInterface::extractMembers() — Method in class ArchiveInterface
Extracts specific members from the archive
Member::extract() — Method in class Member
Extract the member from its archive
MemberInterface::extract() — Method in class MemberInterface
Extract the member from its archive
ExceptionInterface — Class in namespace Alchemy\Zippy\Exception

F

FileResource — Class in namespace Alchemy\Zippy\Adapter\Resource
FormatNotSupportedException — Class in namespace Alchemy\Zippy\Exception
FileStrategyInterface — Class in namespace Alchemy\Zippy\FileStrategy
TeleporterContainer::fromResource() — Method in class TeleporterContainer
Returns the appropriate TeleporterInterface given a Resource

G

AbstractBinaryAdapter::getParser() — Method in class AbstractBinaryAdapter
AbstractBinaryAdapter::getDeflator() — Method in class AbstractBinaryAdapter
AbstractBinaryAdapter::getInflator() — Method in class AbstractBinaryAdapter
AbstractTarAdapter::getInflatorVersion() — Method in class AbstractTarAdapter
AbstractTarAdapter::getDeflatorVersion() — Method in class AbstractTarAdapter
AdapterInterface::getName() — Method in class AdapterInterface
Returns the adapter name
TarBSDTarAdapter::getName() — Method in class TarBSDTarAdapter
TarBSDTarAdapter::getDefaultDeflatorBinaryName() — Method in class TarBSDTarAdapter
TarBSDTarAdapter::getDefaultInflatorBinaryName() — Method in class TarBSDTarAdapter
BinaryAdapterInterface::getParser() — Method in class BinaryAdapterInterface
Gets the output parser
BinaryAdapterInterface::getInflator() — Method in class BinaryAdapterInterface
Returns the inflator process builder
BinaryAdapterInterface::getDeflator() — Method in class BinaryAdapterInterface
Returns the deflator process builder
BinaryAdapterInterface::getInflatorVersion() — Method in class BinaryAdapterInterface
Returns the inflator binary version
BinaryAdapterInterface::getDeflatorVersion() — Method in class BinaryAdapterInterface
Returns the deflator binary version
BinaryAdapterInterface::getDefaultInflatorBinaryName() — Method in class BinaryAdapterInterface
Gets the inflator adapter binary name
BinaryAdapterInterface::getDefaultDeflatorBinaryName() — Method in class BinaryAdapterInterface
Gets the deflator adapter binary name
TarGNUTarAdapter::getName() — Method in class TarGNUTarAdapter
TarGNUTarAdapter::getDefaultDeflatorBinaryName() — Method in class TarGNUTarAdapter
TarGNUTarAdapter::getDefaultInflatorBinaryName() — Method in class TarGNUTarAdapter
FileResource::getResource() — Method in class FileResource
Returns the actual resource used by an adapter
ResourceInterface::getResource() — Method in class ResourceInterface
Returns the actual resource used by an adapter
ZipArchiveResource::getResource() — Method in class ZipArchiveResource
Returns the actual resource used by an adapter
ZipAdapter::getDeflatorVersion() — Method in class ZipAdapter
ZipAdapter::getInflatorVersion() — Method in class ZipAdapter
ZipAdapter::getName() — Method in class ZipAdapter
ZipAdapter::getDefaultDeflatorBinaryName() — Method in class ZipAdapter
ZipAdapter::getDefaultInflatorBinaryName() — Method in class ZipAdapter
ZipExtensionAdapter::getName() — Method in class ZipExtensionAdapter
Archive::getIterator() — Method in class Archive
Returns an Iterator for the current archive
Archive::getMembers() — Method in class Archive
ArchiveInterface::getMembers() — Method in class ArchiveInterface
Lists files and directories archive members
Member::getLocation() — Method in class Member
Member::getLastModifiedDate() — Method in class Member
Member::getSize() — Method in class Member
MemberInterface::getLocation() — Method in class MemberInterface
Gets the location of an archive member
MemberInterface::getLastModifiedDate() — Method in class MemberInterface
MemberInterface::getSize() — Method in class MemberInterface
Returns the (uncompressed) size of the member
TargetLocatorException::getResource() — Method in class TargetLocatorException
FileStrategyInterface::getAdapters() — Method in class FileStrategyInterface
Returns an array of adapters that match the strategy
FileStrategyInterface::getFileExtension() — Method in class FileStrategyInterface
Returns the file extension that match the strategy
TB2FileStrategy::getAdapters() — Method in class TB2FileStrategy
Returns an array of adapters that match the strategy
TB2FileStrategy::getFileExtension() — Method in class TB2FileStrategy
Returns the file extension that match the strategy
TBz2FileStrategy::getAdapters() — Method in class TBz2FileStrategy
Returns an array of adapters that match the strategy
TBz2FileStrategy::getFileExtension() — Method in class TBz2FileStrategy
Returns the file extension that match the strategy
TGzFileStrategy::getAdapters() — Method in class TGzFileStrategy
Returns an array of adapters that match the strategy
TGzFileStrategy::getFileExtension() — Method in class TGzFileStrategy
Returns the file extension that match the strategy
TarBz2FileStrategy::getAdapters() — Method in class TarBz2FileStrategy
Returns an array of adapters that match the strategy
TarBz2FileStrategy::getFileExtension() — Method in class TarBz2FileStrategy
Returns the file extension that match the strategy
TarFileStrategy::getAdapters() — Method in class TarFileStrategy
Returns an array of adapters that match the strategy
TarFileStrategy::getFileExtension() — Method in class TarFileStrategy
Returns the file extension that match the strategy
TarGzFileStrategy::getAdapters() — Method in class TarGzFileStrategy
Returns an array of adapters that match the strategy
TarGzFileStrategy::getFileExtension() — Method in class TarGzFileStrategy
Returns the file extension that match the strategy
ZipFileStrategy::getAdapters() — Method in class ZipFileStrategy
Returns an array of adapters that match the strategy
ZipFileStrategy::getFileExtension() — Method in class ZipFileStrategy
Returns the file extension that match the strategy
GNUTarOutputParser — Class in namespace Alchemy\Zippy\Parser
This class is responsable of parsing GNUTar command line output
ProcessBuilderFactory::getBinary() — Method in class ProcessBuilderFactory
ProcessBuilderFactoryInterface::getBinary() — Method in class ProcessBuilderFactoryInterface
Returns the binary path
Resource::getTarget() — Method in class Resource
Returns the target
Resource::getOriginal() — Method in class Resource
Returns the original path
ResourceCollection::getContext() — Method in class ResourceCollection
Returns the context related to the collection
GuzzleTeleporter — Class in namespace Alchemy\Zippy\Resource\Teleporter
Guzzle Teleporter implementation for HTTP resources
Zippy::getStrategies() — Method in class Zippy
Returns the strategies as they are stored
Zippy::getAdapterFor() — Method in class Zippy
Returns an adapter for a file extension

H

ResourceManager::handle() — Method in class ResourceManager
Handles an archival request.

I

AbstractTarAdapter::isSupported() — Method in class AbstractTarAdapter
AdapterInterface::isSupported() — Method in class AdapterInterface
Tests if the adapter is supported by the current environment
ZipAdapter::isSupported() — Method in class ZipAdapter
ZipExtensionAdapter::isSupported() — Method in class ZipExtensionAdapter
Member::isDir() — Method in class Member
MemberInterface::isDir() — Method in class MemberInterface
Tells whether the member is a directory or not
IOException — Class in namespace Alchemy\Zippy\Exception
InvalidArgumentException — Class in namespace Alchemy\Zippy\Exception
ResourceCollection::isTemporary() — Method in class ResourceCollection
Tells wheter the collection is temporary or not.

L

AbstractTarAdapter::listMembers() — Method in class AbstractTarAdapter
AdapterContainer::load() — Method in class AdapterContainer
Builds the adapter container
AdapterInterface::listMembers() — Method in class AdapterInterface
Returns the list of all archive members
ZipAdapter::listMembers() — Method in class ZipAdapter
ZipExtensionAdapter::listMembers() — Method in class ZipExtensionAdapter
TargetLocator::locate() — Method in class TargetLocator
Locates the target for a resource in a context
TeleporterContainer::load() — Method in class TeleporterContainer
Instantiates TeleporterContainer and register default teleporters
LocalTeleporter — Class in namespace Alchemy\Zippy\Resource\Teleporter
This class transport an object using the local filesystem
Zippy::load() — Method in class Zippy
Creates Zippy and loads default strategies

M

Member — Class in namespace Alchemy\Zippy\Archive
Represents a member of an archive.
MemberInterface — Class in namespace Alchemy\Zippy\Archive
RequestMapper::map() — Method in class RequestMapper
Maps resources request to a ResourceCollection

N

AbstractBinaryAdapter::newInstance() — Method in class AbstractBinaryAdapter
Returns a new instance of the invoked adapter
ZipExtensionAdapter::newInstance() — Method in class ZipExtensionAdapter
Returns a new instance of the invoked adapter
NoAdapterOnPlatformException — Class in namespace Alchemy\Zippy\Exception
NotSupportedException — Class in namespace Alchemy\Zippy\Exception

O

AbstractAdapter::open() — Method in class AbstractAdapter
AdapterInterface::open() — Method in class AdapterInterface
Opens an archive
Zippy::open() — Method in class Zippy
Opens an archive.

P

BSDTarOutputParser::parseFileListing() — Method in class BSDTarOutputParser
BSDTarOutputParser::parseInflatorVersion() — Method in class BSDTarOutputParser
BSDTarOutputParser::parseDeflatorVersion() — Method in class BSDTarOutputParser
GNUTarOutputParser::parseFileListing() — Method in class GNUTarOutputParser
GNUTarOutputParser::parseInflatorVersion() — Method in class GNUTarOutputParser
GNUTarOutputParser::parseDeflatorVersion() — Method in class GNUTarOutputParser
ParserFactory — Class in namespace Alchemy\Zippy\Parser
ParserInterface — Class in namespace Alchemy\Zippy\Parser
ParserInterface::parseFileListing() — Method in class ParserInterface
Parses a file listing
ParserInterface::parseInflatorVersion() — Method in class ParserInterface
Parses the inflator binary version
ParserInterface::parsedeflatorVersion() — Method in class ParserInterface
Parses the deflator binary version
ZipOutputParser::parseFileListing() — Method in class ZipOutputParser
ZipOutputParser::parseInflatorVersion() — Method in class ZipOutputParser
ZipOutputParser::parseDeflatorVersion() — Method in class ZipOutputParser
ProcessBuilderFactory — Class in namespace Alchemy\Zippy\ProcessBuilder
ProcessBuilderFactoryInterface — Class in namespace Alchemy\Zippy\ProcessBuilder

R

AbstractTarAdapter::remove() — Method in class AbstractTarAdapter
AdapterInterface::remove() — Method in class AdapterInterface
Removes a member of the archive
ResourceInterface — Class in namespace Alchemy\Zippy\Adapter\Resource
ZipAdapter::remove() — Method in class ZipAdapter
ZipExtensionAdapter::remove() — Method in class ZipExtensionAdapter
Archive::removeMembers() — Method in class Archive
ArchiveInterface::removeMembers() — Method in class ArchiveInterface
Removes a file from the archive
RuntimeException — Class in namespace Alchemy\Zippy\Exception
RequestMapper — Class in namespace Alchemy\Zippy\Resource
Resource — Class in namespace Alchemy\Zippy\Resource
ResourceCollection — Class in namespace Alchemy\Zippy\Resource
ResourceManager — Class in namespace Alchemy\Zippy\Resource
ResourceTeleporter — Class in namespace Alchemy\Zippy\Resource

S

AbstractBinaryAdapter::setParser() — Method in class AbstractBinaryAdapter
AbstractBinaryAdapter::setDeflator() — Method in class AbstractBinaryAdapter
AbstractBinaryAdapter::setInflator() — Method in class AbstractBinaryAdapter
Sets the inflator process builder
BinaryAdapterInterface::setParser() — Method in class BinaryAdapterInterface
Sets the parser
BinaryAdapterInterface::setInflator() — Method in class BinaryAdapterInterface
Sets the inflator process builder
BinaryAdapterInterface::setDeflator() — Method in class BinaryAdapterInterface
Sets the deflator process builder
ResourceCollection::setContext() — Method in class ResourceCollection
Sets the context of the current collection
ResourceCollection::setTemporary() — Method in class ResourceCollection
Sets the collection temporary
StreamTeleporter — Class in namespace Alchemy\Zippy\Resource\Teleporter
This class transport an object using php stream wrapper

T

TarBSDTarAdapter — Class in namespace Alchemy\Zippy\Adapter\BSDTar
BSDTAR allows you to create and extract files from archives using BSD tar
TarBz2BSDTarAdapter — Class in namespace Alchemy\Zippy\Adapter\BSDTar
TarGzBSDTarAdapter — Class in namespace Alchemy\Zippy\Adapter\BSDTar
TarBz2GNUTarAdapter — Class in namespace Alchemy\Zippy\Adapter\GNUTar
TarGNUTarAdapter — Class in namespace Alchemy\Zippy\Adapter\GNUTar
GNUTarAdapter allows you to create and extract files from archives using GNU tar
TarGzGNUTarAdapter — Class in namespace Alchemy\Zippy\Adapter\GNUTar
TargetLocatorException — Class in namespace Alchemy\Zippy\Exception
TB2FileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
TBz2FileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
TGzFileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
TarBz2FileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
TarFileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
TarGzFileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
ResourceTeleporter::teleport() — Method in class ResourceTeleporter
Teleports a Resource to its target in the context
TargetLocator — Class in namespace Alchemy\Zippy\Resource
TeleporterContainer — Class in namespace Alchemy\Zippy\Resource
A container of TeleporterInterface
GuzzleTeleporter::teleport() — Method in class GuzzleTeleporter
Teleport a file from a destination to an other
LocalTeleporter::teleport() — Method in class LocalTeleporter
Teleport a file from a destination to an other
StreamTeleporter::teleport() — Method in class StreamTeleporter
Teleport a file from a destination to an other
TeleporterInterface — Class in namespace Alchemy\Zippy\Resource\Teleporter
TeleporterInterface::teleport() — Method in class TeleporterInterface
Teleport a file from a destination to an other

U

ProcessBuilderFactory::useBinary() — Method in class ProcessBuilderFactory
ProcessBuilderFactoryInterface::useBinary() — Method in class ProcessBuilderFactoryInterface
Sets the binary path

Z

ZipArchiveResource — Class in namespace Alchemy\Zippy\Adapter\Resource
ZipAdapter — Class in namespace Alchemy\Zippy\Adapter
ZipAdapter allows you to create and extract files from archives using Zip
ZipExtensionAdapter — Class in namespace Alchemy\Zippy\Adapter
ZipExtensionAdapter allows you to create and extract files from archives using PHP Zip extension
ZipFileStrategy — Class in namespace Alchemy\Zippy\FileStrategy
ZipOutputParser — Class in namespace Alchemy\Zippy\Parser
This class is responsable of parsing GNUTar command line output
Zippy — Class in namespace Alchemy\Zippy

_

AbstractAdapter::__construct() — Method in class AbstractAdapter
AbstractBinaryAdapter::__construct() — Method in class AbstractBinaryAdapter
Constructor
FileResource::__construct() — Method in class FileResource
ZipArchiveResource::__construct() — Method in class ZipArchiveResource
ZipExtensionAdapter::__construct() — Method in class ZipExtensionAdapter
Archive::__construct() — Method in class Archive
Constructor
Member::__construct() — Method in class Member
Constructor
Member::__toString() — Method in class Member
MemberInterface::__toString() — Method in class MemberInterface
TargetLocatorException::__construct() — Method in class TargetLocatorException
TB2FileStrategy::__construct() — Method in class TB2FileStrategy
TBz2FileStrategy::__construct() — Method in class TBz2FileStrategy
TGzFileStrategy::__construct() — Method in class TGzFileStrategy
TarBz2FileStrategy::__construct() — Method in class TarBz2FileStrategy
TarFileStrategy::__construct() — Method in class TarFileStrategy
TarGzFileStrategy::__construct() — Method in class TarGzFileStrategy
ZipFileStrategy::__construct() — Method in class ZipFileStrategy
ProcessBuilderFactory::__construct() — Method in class ProcessBuilderFactory
Constructor
RequestMapper::__construct() — Method in class RequestMapper
Constructor
Resource::__construct() — Method in class Resource
Constructor
ResourceCollection::__construct() — Method in class ResourceCollection
Constructor
ResourceManager::__construct() — Method in class ResourceManager
Constructor
ResourceTeleporter::__construct() — Method in class ResourceTeleporter
Constructor
GuzzleTeleporter::__construct() — Method in class GuzzleTeleporter
Constructor
LocalTeleporter::__construct() — Method in class LocalTeleporter
Constructor
Zippy::__construct() — Method in class Zippy