Solutions Open Source

Référence de la classe em_unzip

Liste de tous les membres

Fonctions membres publiques

 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)

Attributs publics

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


Description détaillée

Class for unpacking zip archive files

Auteur:
Vincent Blavet <vincent@blavet.net>

Karsten Dambekalns <karsten@typo3.org>


Documentation des fonctions membres

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.

Paramètres:
string $p_zipname The name of the zip archive to create public

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

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

em_unzip::errorCode (  ) 

Method that gives the lastest error code.

public

Renvoie:
integer The error code value.

em_unzip::errorName ( p_with_code = false  ) 

This method gives the latest error code name.

public

Paramètres:
boolean $p_with_code If true, gives the name and the int value.
Renvoie:
string The error name.

em_unzip::errorInfo ( p_full = false  ) 

This method returns the description associated with the latest error.

public

Paramètres:
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.
Renvoie:
string The error description.

em_unzip::_checkFormat ( p_level = 0  ) 

em_unzip::_checkFormat()

{ Description }

Paramètres:
integer $p_level

em_unzip::_openFd ( p_mode  ) 

em_unzip::_openFd()

{ Description }

em_unzip::_closeFd (  ) 

em_unzip::_closeFd()

{ Description }

em_unzip::_convertHeader2FileInfo ( p_header,
&$  p_info 
)

em_unzip::_convertHeader2FileInfo()

{ Description }

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

em_unzip::_extractByRule()

{ Description }

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

em_unzip::_extractFile()

{ Description }

em_unzip::_readFileHeader ( &$  p_header  ) 

em_unzip::_readFileHeader()

{ Description }

em_unzip::_readCentralFileHeader ( &$  p_header  ) 

em_unzip::_readCentralFileHeader()

{ Description }

em_unzip::_readEndCentralDir ( &$  p_central_dir  ) 

em_unzip::_readEndCentralDir()

{ Description }

em_unzip::_dirCheck ( p_dir,
p_is_dir = false 
)

em_unzip::_dirCheck()

{ Description }

Paramètres:
[type] $p_is_dir

em_unzip::_check_parameters ( &$  p_params,
p_default 
)

em_unzip::_check_parameters()

{ Description }

Paramètres:
integer $p_error_code
string $p_error_string

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

em_unzip::_errorLog()

{ Description }

Paramètres:
integer $p_error_code
string $p_error_string

em_unzip::_errorReset (  ) 

em_unzip::_errorReset()

{ Description }

em_unzip::_tool_PathReduction ( p_dir  ) 

_tool_PathReduction()

{ Description }

em_unzip::_tool_PathInclusion ( p_dir,
p_path 
)

_tool_PathInclusion()

{ Description }

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

_tool_CopyBlock()

{ Description }

Paramètres:
integer $p_mode

em_unzip::_tool_Rename ( p_src,
p_dest 
)

_tool_Rename()

{ Description }

em_unzip::_tool_TranslateWinPath ( p_path,
p_remove_disk_letter = true 
)

_tool_TranslateWinPath()

{ Description }

Paramètres:
[type] $p_remove_disk_letter


Documentation des données membres

em_unzip::$_zipname = ''

em_unzip::$_zip_fd = 0

em_unzip::$_error_code = 1

em_unzip::$_error_string = ''


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:40:54 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3