"TYPO3 4.0.1: em_unzip Class Reference", "datetime" => "Sat Dec 2 19:24:52 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

em_unzip Class Reference

List of all members.

Public Member Functions

 em_unzip ($p_zipname)
 extract ($p_params=0)
 errorCode ()
 errorName ($p_with_code=false)
 errorInfo ($p_full=false)
 _checkFormat ($p_level=0)
 _openFd ($p_mode)
 _closeFd ()
 _convertHeader2FileInfo ($p_header, &$p_info)
 _extractByRule (&$p_file_list, &$p_params)
 _extractFile (&$p_entry, $p_path, $p_remove_path, $p_remove_all_path, &$p_params)
 _readFileHeader (&$p_header)
 _readCentralFileHeader (&$p_header)
 _readEndCentralDir (&$p_central_dir)
 _dirCheck ($p_dir, $p_is_dir=false)
 _check_parameters (&$p_params, $p_default)
 _errorLog ($p_error_code=0, $p_error_string='')
 _errorReset ()
 _tool_PathReduction ($p_dir)
 _tool_PathInclusion ($p_dir, $p_path)
 _tool_CopyBlock ($p_src, $p_dest, $p_size, $p_mode=0)
 _tool_Rename ($p_src, $p_dest)
 _tool_TranslateWinPath ($p_path, $p_remove_disk_letter=true)

Public Attributes

 $_zipname = ''
 $_zip_fd = 0
 $_error_code = 1
 $_error_string = ''

Detailed Description

Class for unpacking zip archive files

Author:
Vincent Blavet <vincent@blavet.net>

Karsten Dambekalns <karsten@typo3.org>

Definition at line 89 of file class.em_unzip.php.

Constructor & Destructor Documentation

em_unzip::em_unzip (  $  p_zipname  ) 
 

em_unzip Class constructor. This flavour of the constructor only declare a new em_unzip object, identifying it by the name of the zip file.

Parameters:
string $p_zipname The name of the zip archive to create public

Definition at line 122 of file class.em_unzip.php.

Member Function Documentation

em_unzip::_check_parameters (  &$  p_params,
$  p_default
) 
 

em_unzip::_check_parameters()

{ Description }

Parameters:
integer $p_error_code
string $p_error_string

Definition at line 1090 of file class.em_unzip.php.

References errorCode().

Referenced by extract().

em_unzip::_checkFormat (  $  p_level = 0  ) 
 

em_unzip::_checkFormat()

{ Description }

Parameters:
integer $p_level

Definition at line 261 of file class.em_unzip.php.

Referenced by extract().

em_unzip::_closeFd (   ) 
 

em_unzip::_closeFd()

{ Description }

Definition at line 331 of file class.em_unzip.php.

em_unzip::_convertHeader2FileInfo (  $  p_header,
&$  p_info
) 
 

em_unzip::_convertHeader2FileInfo()

{ Description }

Definition at line 350 of file class.em_unzip.php.

em_unzip::_dirCheck (  $  p_dir,
$  p_is_dir = false
) 
 

em_unzip::_dirCheck()

{ Description }

Parameters:
[type] $p_is_dir

Definition at line 1045 of file class.em_unzip.php.

References errorCode().

em_unzip::_errorLog (  $  p_error_code = 0,
$  p_error_string = ''
) 
 

em_unzip::_errorLog()

{ Description }

Parameters:
integer $p_error_code
string $p_error_string

Definition at line 1143 of file class.em_unzip.php.

em_unzip::_errorReset (   ) 
 

em_unzip::_errorReset()

{ Description }

Definition at line 1154 of file class.em_unzip.php.

Referenced by extract().

em_unzip::_extractByRule (  &$  p_file_list,
&$  p_params
) 
 

em_unzip::_extractByRule()

{ Description }

Definition at line 390 of file class.em_unzip.php.

References errorCode().

Referenced by extract().

em_unzip::_extractFile (  &$  p_entry,
$  p_path,
$  p_remove_path,
$  p_remove_all_path,
&$  p_params
) 
 

em_unzip::_extractFile()

{ Description }

Definition at line 506 of file class.em_unzip.php.

em_unzip::_openFd (  $  p_mode  ) 
 

em_unzip::_openFd()

{ Description }

Definition at line 303 of file class.em_unzip.php.

References errorCode().

em_unzip::_readCentralFileHeader (  &$  p_header  ) 
 

em_unzip::_readCentralFileHeader()

{ Description }

Definition at line 826 of file class.em_unzip.php.

References errorCode().

em_unzip::_readEndCentralDir (  &$  p_central_dir  ) 
 

em_unzip::_readEndCentralDir()

{ Description }

Definition at line 922 of file class.em_unzip.php.

References errorCode().

em_unzip::_readFileHeader (  &$  p_header  ) 
 

em_unzip::_readFileHeader()

{ Description }

Definition at line 730 of file class.em_unzip.php.

References errorCode().

em_unzip::_tool_CopyBlock (  $  p_src,
$  p_dest,
$  p_size,
$  p_mode = 0
) 
 

_tool_CopyBlock()

{ Description }

Parameters:
integer $p_mode

Definition at line 1260 of file class.em_unzip.php.

em_unzip::_tool_PathInclusion (  $  p_dir,
$  p_path
) 
 

_tool_PathInclusion()

{ Description }

Definition at line 1201 of file class.em_unzip.php.

em_unzip::_tool_PathReduction (  $  p_dir  ) 
 

_tool_PathReduction()

{ Description }

Definition at line 1165 of file class.em_unzip.php.

em_unzip::_tool_Rename (  $  p_src,
$  p_dest
) 
 

_tool_Rename()

{ Description }

Definition at line 1308 of file class.em_unzip.php.

em_unzip::_tool_TranslateWinPath (  $  p_path,
$  p_remove_disk_letter = true
) 
 

_tool_TranslateWinPath()

{ Description }

Parameters:
[type] $p_remove_disk_letter

Definition at line 1333 of file class.em_unzip.php.

em_unzip::errorCode (   ) 
 

Method that gives the lastest error code.

public

Returns:
integer The error code value.

Definition at line 198 of file class.em_unzip.php.

Referenced by _check_parameters(), _dirCheck(), _extractByRule(), _openFd(), _readCentralFileHeader(), _readEndCentralDir(), and _readFileHeader().

em_unzip::errorInfo (  $  p_full = false  ) 
 

This method returns the description associated with the latest error.

public

Parameters:
boolean $p_full If set to true gives the description with the error code, the name and the description. If set to false gives only the description and the error code.
Returns:
string The error description.

Definition at line 245 of file class.em_unzip.php.

em_unzip::errorName (  $  p_with_code = false  ) 
 

This method gives the latest error code name.

public

Parameters:
boolean $p_with_code If true, gives the name and the int value.
Returns:
string The error name.

Definition at line 209 of file class.em_unzip.php.

em_unzip::extract (  $  p_params = 0  ) 
 

This method extract the files and folders which are in the zip archive. It can extract all the archive or a part of the archive by using filter feature (extract by name, by index, by ereg, by preg). The extraction can occur in the current path or an other path. All the advanced features are activated by the use of variable parameters. The return value is an array of entry descriptions which gives information on extracted files (See listContent()). The method may return a success value (an array) even if some files are not correctly extracted (see the file status in listContent()). The supported variable parameters for this method are : 'add_path' : Path where the files and directories are to be extracted

public

Parameters:
mixed $p_params An array of variable parameters and values.
Returns:
mixed An array of file description on success, 0 on an unrecoverable failure, an error code is logged.

Definition at line 159 of file class.em_unzip.php.

References _check_parameters(), _checkFormat(), _errorReset(), and _extractByRule().

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