Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JArchiveZip
+ Graphe d'héritage de JArchiveZip:
+ Graphe de collaboration de JArchiveZip:

Liste de tous les membres

Fonctions membres publiques

 create ($archive, $files, $options=array())
 extract ($archive, $destination, $options=array())
 checkZipData (&$data)
- Fonctions membres publiques inherited from JObject
 __construct ($properties=null)
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

static isSupported ()
static hasNativeSupport ()

Fonctions membres privées

 _extract ($archive, $destination, $options)
 _extractNative ($archive, $destination, $options)
 _readZipInfo (&$data)
 _getFileData ($key)
 _unix2DOSTime ($unixtime=null)
 _addToZIPFile (&$file, &$contents, &$ctrldir)
 _createZIPFile (&$contents, &$ctrlDir, $path)

Attributs privés

 $_methods
 $_ctrlDirHeader = "\x50\x4b\x01\x02"
 $_ctrlDirEnd = "\x50\x4b\x05\x06\x00\x00\x00\x00"
 $_fileHeader = "\x50\x4b\x03\x04"
 $_data = null
 $_metadata = null

Additional Inherited Members

- Attributs protégés inherited from JObject
 $_errors = array()

Documentation des fonctions membres

JArchiveZip::_addToZIPFile ( $file,
$contents,
$ctrldir 
)
private

Adds a "file" to the ZIP archive.

Paramètres:
array&$fileFile data array to add
array&$contentsAn array of existing zipped files.
array&$ctrldirAn array of central directory information.
Renvoie:
void
Depuis:
11.1

Références $data, $file, $name, et null.

JArchiveZip::_createZIPFile ( $contents,
$ctrlDir,
  $path 
)
private

Creates the ZIP file.

Official ZIP file format: http://www.pkware.com/appnote.txt

Paramètres:
array&$contentsAn array of existing zipped files.
array&$ctrlDirAn array of central directory information.
string$pathThe path to store the archive.
Renvoie:
boolean True if successful
Depuis:
11.1

Références $data, $path, et JFile\write().

+ Voici le graphe d'appel pour cette fonction :

JArchiveZip::_extract (   $archive,
  $destination,
  $options 
)
private

Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support

Paramètres:
string$archivePath to ZIP archive to extract.
string$destinationPath to extract archive into.
array$optionsExtraction options [unused].
Renvoie:
boolean True if successful
Depuis:
11.1

Références $i, $n, $path, JText\_(), JPath\clean(), JFolder\create(), null, JFile\read(), et JFile\write().

+ Voici le graphe d'appel pour cette fonction :

JArchiveZip::_extractNative (   $archive,
  $destination,
  $options 
)
private

Extract a ZIP compressed file to a given path using native php api calls for speed

Paramètres:
string$archivePath to ZIP archive to extract
string$destinationPath to extract archive into
array$optionsExtraction options [unused]
Renvoie:
boolean True if successful
Depuis:
11.1

Références $file, JText\_(), JFolder\create(), et JFile\write().

+ Voici le graphe d'appel pour cette fonction :

JArchiveZip::_getFileData (   $key)
private

Returns the file data for a file by offsest in the ZIP archive

Paramètres:
integer$keyThe position of the file in the archive.
Renvoie:
string Uncompressed file data buffer.
Depuis:
11.1

Références $key, elseif, et JPATH_ISWIN.

JArchiveZip::_readZipInfo ( $data)
private

Get the list of files/data from a ZIP archive buffer.

 KEY: Position in zipfile
 VALUES: 'attr'  –  File attributes
 'crc'   –  CRC checksum
 'csize' –  Compressed file size
 'date'  –  File modification time
 'name'  –  Filename
 'method'–  Compression method
 'size'  –  Original file size
 'type'  –  File type
 
Paramètres:
string&$dataThe ZIP archive buffer.
Renvoie:
boolean True on success.
Depuis:
11.1

Références $data, $name, JText\_(), et null.

+ Voici le graphe d'appel pour cette fonction :

JArchiveZip::_unix2DOSTime (   $unixtime = null)
private

Converts a UNIX timestamp to a 4-byte DOS date and time format (date in high 2-bytes, time in low 2-bytes allowing magnitude comparison).

Paramètres:
integer$unixtimeThe current UNIX timestamp.
Renvoie:
integer The current date in a 4-byte DOS format.
Depuis:
11.1
JArchiveZip::checkZipData ( $data)

Checks to see if the data is a valid ZIP file.

Paramètres:
string&$dataZIP archive data buffer.
Renvoie:
boolean True if valid, false if invalid.
Depuis:
11.1

Références $data.

JArchiveZip::create (   $archive,
  $files,
  $options = array() 
)

Create a ZIP compressed file from an array of file data.

Paramètres:
string$archivePath to save archive.
array$filesArray of files to add to archive.
array$optionsCompression options (unused).
Renvoie:
boolean True if successful.
Depuis:
11.1

Références $file, et $files.

JArchiveZip::extract (   $archive,
  $destination,
  $options = array() 
)

Extract a ZIP compressed file to a given path

Paramètres:
string$archivePath to ZIP archive to extract
string$destinationPath to extract archive into
array$optionsExtraction options [unused]
Renvoie:
boolean True if successful
Depuis:
11.1

Références $options, et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

static JArchiveZip::hasNativeSupport ( )
static

Method to determine if the server has native zip support for faster handling

Renvoie:
boolean True if php has native ZIP support
Depuis:
11.1
static JArchiveZip::isSupported ( )
static

Tests whether this adapter can unpack files on this computer.

Renvoie:
boolean True if supported
Depuis:
11.3

Documentation des données membres

JArchiveZip::$_ctrlDirEnd = "\x50\x4b\x05\x06\x00\x00\x00\x00"
private
JArchiveZip::$_ctrlDirHeader = "\x50\x4b\x01\x02"
private
JArchiveZip::$_data = null
private
JArchiveZip::$_fileHeader = "\x50\x4b\x03\x04"
private
JArchiveZip::$_metadata = null
private
JArchiveZip::$_methods
private
Valeur initiale :
array(0x0 => 'None', 0x1 => 'Shrunk', 0x2 => 'Super Fast', 0x3 => 'Fast', 0x4 => 'Normal', 0x5 => 'Maximum', 0x6 => 'Imploded',
0x8 => 'Deflated')

La documentation de cette classe a été générée à partir du fichier suivant :