PHP Class PclZip, thinksns

The public methods allow the manipulation of the archive. Attributes : Attributes must not be accessed directly. Methods : PclZip() : Object creator create() : Creates the Zip archive listContent() : List the content of the Zip archive extract() : Extract the content of the archive properties() : List the properties of the archive
Show file Open project: medz/thinksns-4 Class Usage Examples

Public Properties

Property Type Description
$error_code ----- Internal error handling
$error_string
$magic_quotes_status The class can then disable the magic_quotes and reset it after
$zip_fd ----- File descriptor of the zip file
$zipname ----- Filename of the zip file

Public Methods

Method Description
PclZip ( $p_zipname ) --------------------------------------------------------------------------------
add ( $p_filelist ) --------------------------------------------------------------------------------
create ( $p_filelist ) --------------------------------------------------------------------------------
delete ( ) --------------------------------------------------------------------------------
deleteByIndex ( $p_index ) --------------------------------------------------------------------------------
duplicate ( $p_archive ) --------------------------------------------------------------------------------
errorCode ( ) --------------------------------------------------------------------------------
errorInfo ( $p_full = false ) --------------------------------------------------------------------------------
errorName ( $p_with_code = false ) --------------------------------------------------------------------------------
extract ( ) --------------------------------------------------------------------------------
extractByIndex ( $p_index ) function extractByIndex($p_index, options.
listContent ( ) --------------------------------------------------------------------------------
merge ( $p_archive_to_add ) --------------------------------------------------------------------------------
privAdd ( $p_filedescr_list, &$p_result_list, &$p_options ) --------------------------------------------------------------------------------
privAddFile ( $p_filedescr, &$p_header, &$p_options ) --------------------------------------------------------------------------------
privAddFileList ( $p_filedescr_list, &$p_result_list, &$p_options ) --------------------------------------------------------------------------------
privAddFileUsingTempFile ( $p_filedescr, &$p_header, &$p_options ) --------------------------------------------------------------------------------
privAddList ( $p_filedescr_list, &$p_result_list, &$p_options ) function privAddList($p_list, &$p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_options)
privCalculateStoredFilename ( &$p_filedescr, &$p_options ) --------------------------------------------------------------------------------
privCheckFileHeaders ( &$p_local_header, &$p_central_header ) --------------------------------------------------------------------------------
privCheckFormat ( $p_level ) --------------------------------------------------------------------------------
privCloseFd ( ) --------------------------------------------------------------------------------
privConvertHeader2FileInfo ( $p_header, &$p_info ) --------------------------------------------------------------------------------
privCreate ( $p_filedescr_list, &$p_result_list, &$p_options ) --------------------------------------------------------------------------------
privDeleteByRule ( &$p_result_list, &$p_options ) --------------------------------------------------------------------------------
privDirCheck ( $p_dir, $p_is_dir = false ) --------------------------------------------------------------------------------
privDisableMagicQuotes ( ) --------------------------------------------------------------------------------
privDuplicate ( $p_archive_filename ) --------------------------------------------------------------------------------
privErrorLog ( $p_error_code, $p_error_string = '' ) --------------------------------------------------------------------------------
privErrorReset ( ) --------------------------------------------------------------------------------
privExtractByRule ( &$p_file_list, $p_path, $p_remove_path, $p_remove_all_path, &$p_options ) --------------------------------------------------------------------------------
privExtractFile ( &$p_entry, $p_path, $p_remove_path, $p_remove_all_path, &$p_options ) --------------------------------------------------------------------------------
privExtractFileAsString ( &$p_entry, &$p_string, &$p_options ) --------------------------------------------------------------------------------
privExtractFileInOutput ( &$p_entry, &$p_options ) --------------------------------------------------------------------------------
privExtractFileUsingTempFile ( &$p_entry, &$p_options ) --------------------------------------------------------------------------------
privFileDescrExpand ( &$p_filedescr_list, &$p_options ) --------------------------------------------------------------------------------
privFileDescrParseAtt ( &$p_file_list, &$p_filedescr, $v_options, $v_requested_options = false ) --------------------------------------------------------------------------------
privList ( &$p_list ) --------------------------------------------------------------------------------
privMerge ( &$p_archive_to_add ) --------------------------------------------------------------------------------
privOpenFd ( $p_mode ) --------------------------------------------------------------------------------
privOptionDefaultThreshold ( &$p_options ) --------------------------------------------------------------------------------
privParseOptions ( &$p_options_list, $p_size, &$v_result_list, $v_requested_options = false ) --------------------------------------------------------------------------------
privReadCentralFileHeader ( &$p_header ) --------------------------------------------------------------------------------
privReadEndCentralDir ( &$p_central_dir ) --------------------------------------------------------------------------------
privReadFileHeader ( &$p_header ) --------------------------------------------------------------------------------
privSwapBackMagicQuotes ( ) --------------------------------------------------------------------------------
privWriteCentralFileHeader ( &$p_header ) --------------------------------------------------------------------------------
privWriteCentralHeader ( $p_nb_entries, $p_size, $p_offset, $p_comment ) --------------------------------------------------------------------------------
privWriteFileHeader ( &$p_header ) --------------------------------------------------------------------------------
properties ( ) --------------------------------------------------------------------------------

Method Details

PclZip() public method

--------------------------------------------------------------------------------
public PclZip ( $p_zipname )

add() public method

--------------------------------------------------------------------------------
public add ( $p_filelist )

create() public method

--------------------------------------------------------------------------------
public create ( $p_filelist )

delete() public method

--------------------------------------------------------------------------------
public delete ( )

deleteByIndex() public method

--------------------------------------------------------------------------------
public deleteByIndex ( $p_index )

duplicate() public method

--------------------------------------------------------------------------------
public duplicate ( $p_archive )

errorCode() public method

--------------------------------------------------------------------------------
public errorCode ( )

errorInfo() public method

--------------------------------------------------------------------------------
public errorInfo ( $p_full = false )

errorName() public method

--------------------------------------------------------------------------------
public errorName ( $p_with_code = false )

extract() public method

--------------------------------------------------------------------------------
public extract ( )

extractByIndex() public method

..)
public extractByIndex ( $p_index )

listContent() public method

--------------------------------------------------------------------------------
public listContent ( )

merge() public method

--------------------------------------------------------------------------------
public merge ( $p_archive_to_add )

privAdd() public method

--------------------------------------------------------------------------------
public privAdd ( $p_filedescr_list, &$p_result_list, &$p_options )

privAddFile() public method

--------------------------------------------------------------------------------
public privAddFile ( $p_filedescr, &$p_header, &$p_options )

privAddFileList() public method

--------------------------------------------------------------------------------
public privAddFileList ( $p_filedescr_list, &$p_result_list, &$p_options )

privAddFileUsingTempFile() public method

--------------------------------------------------------------------------------
public privAddFileUsingTempFile ( $p_filedescr, &$p_header, &$p_options )

privAddList() public method

function privAddList($p_list, &$p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_options)
public privAddList ( $p_filedescr_list, &$p_result_list, &$p_options )

privCalculateStoredFilename() public method

--------------------------------------------------------------------------------
public privCalculateStoredFilename ( &$p_filedescr, &$p_options )

privCheckFileHeaders() public method

--------------------------------------------------------------------------------
public privCheckFileHeaders ( &$p_local_header, &$p_central_header )

privCheckFormat() public method

--------------------------------------------------------------------------------
public privCheckFormat ( $p_level )

privCloseFd() public method

--------------------------------------------------------------------------------
public privCloseFd ( )

privConvertHeader2FileInfo() public method

--------------------------------------------------------------------------------
public privConvertHeader2FileInfo ( $p_header, &$p_info )

privCreate() public method

--------------------------------------------------------------------------------
public privCreate ( $p_filedescr_list, &$p_result_list, &$p_options )

privDeleteByRule() public method

--------------------------------------------------------------------------------
public privDeleteByRule ( &$p_result_list, &$p_options )

privDirCheck() public method

--------------------------------------------------------------------------------
public privDirCheck ( $p_dir, $p_is_dir = false )

privDisableMagicQuotes() public method

--------------------------------------------------------------------------------

privDuplicate() public method

--------------------------------------------------------------------------------
public privDuplicate ( $p_archive_filename )

privErrorLog() public method

--------------------------------------------------------------------------------
public privErrorLog ( $p_error_code, $p_error_string = '' )

privErrorReset() public method

--------------------------------------------------------------------------------
public privErrorReset ( )

privExtractByRule() public method

--------------------------------------------------------------------------------
public privExtractByRule ( &$p_file_list, $p_path, $p_remove_path, $p_remove_all_path, &$p_options )

privExtractFile() public method

--------------------------------------------------------------------------------
public privExtractFile ( &$p_entry, $p_path, $p_remove_path, $p_remove_all_path, &$p_options )

privExtractFileAsString() public method

--------------------------------------------------------------------------------
public privExtractFileAsString ( &$p_entry, &$p_string, &$p_options )

privExtractFileInOutput() public method

--------------------------------------------------------------------------------
public privExtractFileInOutput ( &$p_entry, &$p_options )

privExtractFileUsingTempFile() public method

--------------------------------------------------------------------------------
public privExtractFileUsingTempFile ( &$p_entry, &$p_options )

privFileDescrExpand() public method

--------------------------------------------------------------------------------
public privFileDescrExpand ( &$p_filedescr_list, &$p_options )

privFileDescrParseAtt() public method

--------------------------------------------------------------------------------
public privFileDescrParseAtt ( &$p_file_list, &$p_filedescr, $v_options, $v_requested_options = false )

privList() public method

--------------------------------------------------------------------------------
public privList ( &$p_list )

privMerge() public method

--------------------------------------------------------------------------------
public privMerge ( &$p_archive_to_add )

privOpenFd() public method

--------------------------------------------------------------------------------
public privOpenFd ( $p_mode )

privOptionDefaultThreshold() public method

--------------------------------------------------------------------------------
public privOptionDefaultThreshold ( &$p_options )

privParseOptions() public method

--------------------------------------------------------------------------------
public privParseOptions ( &$p_options_list, $p_size, &$v_result_list, $v_requested_options = false )

privReadCentralFileHeader() public method

--------------------------------------------------------------------------------
public privReadCentralFileHeader ( &$p_header )

privReadEndCentralDir() public method

--------------------------------------------------------------------------------
public privReadEndCentralDir ( &$p_central_dir )

privReadFileHeader() public method

--------------------------------------------------------------------------------
public privReadFileHeader ( &$p_header )

privSwapBackMagicQuotes() public method

--------------------------------------------------------------------------------

privWriteCentralFileHeader() public method

--------------------------------------------------------------------------------
public privWriteCentralFileHeader ( &$p_header )

privWriteCentralHeader() public method

--------------------------------------------------------------------------------
public privWriteCentralHeader ( $p_nb_entries, $p_size, $p_offset, $p_comment )

privWriteFileHeader() public method

--------------------------------------------------------------------------------
public privWriteFileHeader ( &$p_header )

properties() public method

--------------------------------------------------------------------------------
public properties ( )

Property Details

$error_code public property

----- Internal error handling
public $error_code

$error_string public property

public $error_string

$magic_quotes_status public property

The class can then disable the magic_quotes and reset it after
public $magic_quotes_status

$zip_fd public property

----- File descriptor of the zip file
public $zip_fd

$zipname public property

----- Filename of the zip file
public $zipname