Class PimPluginArchiveExtractor

Extractor for plugin archive files

Package: PluginManager
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Frederic Schneider
Located at plugins/pim/classes/util/zip/class.pimpluginarchiveextractor.php

Methods summary
`public`	# `__construct( string $source, string $filename )` Constructor of ArchiveExtractor, load the file list Constructor of ArchiveExtractor, load the file list Parameters `$source` `string` $source path to the temp directory `$filename` `string` $filename name of zip archive Throws `cException` if the source file does not exists
`public`	# `closeArchive( )`
`public`	# `setDestinationPath( string $destination )` Sets the path where the extractor extracts the archive files Sets the path where the extractor extracts the archive files Parameters `$destination` `string` $destination string Throws `cException` if the destination path can not set (directory is not writable) `cException` if the defined destination already exists
`public`	# `extractArchive( )` Extracts the whole archive Extracts the whole archive Throws `cException` if the extraction failed
`public string`	# `extractArchiveFileToVariable( string $filename, boolean $content = true )` Extracts a specific file from archive and return its content to use it in a variable Extracts a specific file from archive and return its content to use it in a variable Parameters `$filename` `string` $filename `$content` `boolean` $content [optional] whether to return the content or just the dir and filename of the extracted file Returns `string` content of extracted file or dir and filename of extracted File
`public`	# `destroyTempFiles( )` Destory temporary plugin files (plugin.xml, plugin_install.sql and files at CONTENIDO temp dir) Destory temporary plugin files (plugin.xml, plugin_install.sql and files at CONTENIDO temp dir) Throws `cInvalidArgumentException`

Properties summary
`protected integer`	`$_extractor`	`0`	# The extractor initializer The extractor initializer
`protected string`	`$tempDir`	`''`	# The temp dir The temp dir
`protected string`	`$_source`	`''`	# The archive file The archive file
`protected string`	`$_destination`	`''`	# The destination path The destination path
`protected string`	`$_absPath`	`''`	# The absolute path The absolute path

Packages

Classes

Class PimPluginArchiveExtractor

Parameters

Throws

Parameters

Throws

Throws

Parameters

Returns

Throws