Class: PHPUnzip

Source Location: /PHPUnzip.class.php

Class Overview

A stream based PHP 4 class for reading the contents of a ZIP Archive.
Supports no compression, deflate, and bzip storage modes.
Inspiration derived from the SimpleUnzip class contributed to phpMyAdmin by Holger Boskugel <vbwebprofi@gmx.de>

Author(s):

Drew Phillips <drew@drew-phillips.com>

Version:

Variables

Methods

Class Details

[line 225]
A stream based PHP 4 class for reading the contents of a ZIP Archive.
Supports no compression, deflate, and bzip storage modes.
Inspiration derived from the SimpleUnzip class contributed to phpMyAdmin by Holger Boskugel <vbwebprofi@gmx.de>

File Processing Constants

Tags:

uses:	ZipFileEntry
author:	Drew Phillips <drew@drew-phillips.com>
version:	1.0

[ Top ]

Class Variables

$comment =

[line 243]

The ZIP file comment text, if any

File Processing Constants

Type:

string

[ Top ]

$error =

[line 249]

The error encountered while parsing the file

File Processing Constants

Type:

int

[ Top ]

$error_str =

[line 255]

The error message associated with the error

File Processing Constants

Type:

unknown_type

[ Top ]

$files =

[line 237]

Array of ZipFileEntry objects representing the files and directories in the archive

File Processing Constants

Type:

array

[ Top ]

$open =

[line 231]

Indicates if a zip file was successfully opened for reading

File Processing Constants

Type:

boolean

[ Top ]

$output_file_path =

[line 312]

Where to output the files

File Processing Constants

Type:

string

[ Top ]

$overwrite_existing_files =

[line 306]

Overwrite existing files

File Processing Constants

Type:

boolean

[ Top ]

Class Methods

constructor PHPUnzip [line 334]

ReadZip PHPUnzip(
)

Class constructor - Initialize variables

File Processing Constants

[ Top ]

method Open [line 379]

boolean Open(
string
$file)

Open a zip file for reading Note: Individual zip file entries can contain errors and this can still return true

File Processing Constants

Tags:

return:

true if file was opened, false on error

Parameters:

string

$file

The ZIP file to open

[ Top ]

method Read [line 400]

boolean Read(
)

Read the contents of the ZIP file If set for file output, the ZipFileEntry object's data will be null

File Processing Constants

[ Top ]

method SetOption [line 357]

boolean SetOption(
int
$long_option, mixed
$value)

Set an option for the ZIP file processing

File Processing Constants

Tags:

return:

true if the value was set, false if not

Parameters:

int	$long_option	The option constant to set
mixed	$value	The value to set

[ Top ]

Documentation generated on Sat, 23 Jun 2007 00:09:58 -0700 by phpDocumentor 1.3.1