SimpleUnzip Class Reference

Public Member Functions
	__construct ($in_FileName='')
	Count ()
	GetData ($in_Index)
	GetEntry ($in_Index)
	GetError ($in_Index)
	GetErrorMsg ($in_Index)
	GetName ($in_Index)
	GetPath ($in_Index)
	GetTime ($in_Index)
	ReadFile ($in_FileName)

Public Attributes
	$Comment = ''
	$Entries = array()
	$Name = ''
	$Size = 0
	$Time = 0

Detailed Description

Definition at line 48 of file unzip.lib.php.

Constructor & Destructor Documentation

__construct()

SimpleUnzip::__construct

(

$in_FileName = ''

)

Contructor of the class

Parameters

string

File name

Returns

SimpleUnzip Instanced class @access public @uses SimpleUnzip::ReadFile() Opens file on new if specified

Since

1.0

Definition at line 110 of file unzip.lib.php.

Member Function Documentation

Count()

SimpleUnzip::Count

(

)

Counts the entries

Returns

integer Count of ZIP entries @access public @uses $Entries

Since

1.0

Definition at line 125 of file unzip.lib.php.

GetData()

SimpleUnzip::GetData

(

$in_Index

)

Gets data of the specified ZIP entry

Parameters

integer

Index of the ZIP entry

Returns

mixed Data for the ZIP entry @uses SimpleUnzipEntry::$Data @access public

Since

1.0

Definition at line 139 of file unzip.lib.php.

GetEntry()

SimpleUnzip::GetEntry

(

$in_Index

)

Gets an entry of the ZIP file

Parameters

integer

Index of the ZIP entry

Returns

SimpleUnzipEntry Entry of the ZIP file @uses $Entries @access public

Since

1.0

Definition at line 153 of file unzip.lib.php.

GetError()

SimpleUnzip::GetError

(

$in_Index

)

Gets error code for the specified ZIP entry

Parameters

integer

Index of the ZIP entry

Returns

integer Error code for the ZIP entry @uses SimpleUnzipEntry::$Error @access public

Since

1.0

Definition at line 167 of file unzip.lib.php.

GetErrorMsg()

SimpleUnzip::GetErrorMsg

(

$in_Index

)

Gets error message for the specified ZIP entry

Parameters

integer

Index of the ZIP entry

Returns

string Error message for the ZIP entry @uses SimpleUnzipEntry::$ErrorMsg @access public

Since

1.0

Definition at line 181 of file unzip.lib.php.

GetName()

SimpleUnzip::GetName

(

$in_Index

)

Gets file name for the specified ZIP entry

Parameters

integer

Index of the ZIP entry

Returns

string File name for the ZIP entry @uses SimpleUnzipEntry::$Name @access public

Since

1.0

Definition at line 195 of file unzip.lib.php.

GetPath()

SimpleUnzip::GetPath

(

$in_Index

)

Gets path of the file for the specified ZIP entry

Parameters

integer

Index of the ZIP entry

Returns

string Path of the file for the ZIP entry @uses SimpleUnzipEntry::$Path @access public

Since

1.0

Definition at line 209 of file unzip.lib.php.

GetTime()

SimpleUnzip::GetTime

(

$in_Index

)

Gets file time for the specified ZIP entry

Parameters

integer

Index of the ZIP entry

Returns

integer File time for the ZIP entry (unix timestamp) @uses SimpleUnzipEntry::$Time @access public

Since

1.0

Definition at line 223 of file unzip.lib.php.

ReadFile()

SimpleUnzip::ReadFile

(

$in_FileName

)

Reads ZIP file and extracts the entries

Parameters

string

File name of the ZIP archive

Returns

array ZIP entry list (see also class variable $Entries) @uses SimpleUnzipEntry For the entries @access public

Since

1.0

Definition at line 237 of file unzip.lib.php.

Member Data Documentation

$Comment

SimpleUnzip::$Comment = ''

Definition at line 58 of file unzip.lib.php.

$Entries

SimpleUnzip::$Entries = array()

Definition at line 69 of file unzip.lib.php.

$Name

SimpleUnzip::$Name = ''

Definition at line 79 of file unzip.lib.php.

$Size

SimpleUnzip::$Size = 0

Definition at line 89 of file unzip.lib.php.

$Time

SimpleUnzip::$Time = 0

Definition at line 99 of file unzip.lib.php.

---

The documentation for this class was generated from the following file:

• plugins/myadmin/unzip.lib.php