Référence de la classe Gzip

Graphe d'héritage de Gzip:

Fonctions membres publiques
	__construct ($options=array())
	extract ($archive, $destination)
	getFilePosition ()

Fonctions membres publiques statiques
static	isSupported ()

Attributs protégés
	$options = array()

Attributs privés
	$flags = array('FTEXT' => 0x01, 'FHCRC' => 0x02, 'FEXTRA' => 0x04, 'FNAME' => 0x08, 'FCOMMENT' => 0x10)
	$data

Description détaillée

Gzip format adapter for the Archive package

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project http://www.horde.org

Michael Slusarz slusa.nosp@m.rz@h.nosp@m.orde..nosp@m.org Michael Cochrane mike@.nosp@m.graf.nosp@m.tonha.nosp@m.ll.c.nosp@m.o.nz

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$options = array()

)

Create a new Archive object.

Paramètres

array | \ArrayAccess

$options

An array of options

Depuis

1.0

Exceptions

Références Gzip\$options.

Documentation des fonctions membres

extract()

extract	(		$archive,
			$destination
	)

Extract a Gzip compressed file to a given path

Paramètres

string	$archive	Path to ZIP archive to extract
string	$destination	Path to extract archive to

Renvoie

boolean True if successful

Depuis

1.0

Exceptions

Implémente ExtractableInterface.

Références $buffer, $input, $output, $position, Gzip\getFilePosition(), Stream\getStream(), null, et File\write().

getFilePosition()

getFilePosition

(

)

Get file data offset for archive

Renvoie

integer Data position marker for archive

Depuis

1.0

Exceptions

Références $info, et $position.

Référencé par Gzip\extract().

isSupported()

static isSupported ( )

static

Tests whether this adapter can unpack files on this computer.

Renvoie

boolean True if supported

Depuis

1.0

Implémente ExtractableInterface.

Documentation des champs

$data

$data

private

$flags

$flags = array('FTEXT' => 0x01, 'FHCRC' => 0x02, 'FEXTRA' => 0x04, 'FNAME' => 0x08, 'FCOMMENT' => 0x10)

private

$options

$options = array()

protected

Référencé par Gzip\__construct().

---

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

• Gzip.php