The ZipArchive class

(PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0)

Introducción

Un fichero, comprimido con Zip.

Sinopsis de la Clase

ZipArchive {

/* Propiedades */

int $status;

int $statusSys;

int $numFiles;

string $filename;

string $comment;

/* Métodos */

bool addEmptyDir ( string $dirname )

bool addFile ( string $filename [, string $localname = NULL [, int $start = 0 [, int $length = 0 ]]] )

bool addFromString ( string $localname , string $contents )

bool addGlob ( string $pattern [, int $flags = 0 [, array $options = array() ]] )

bool addPattern ( string $pattern [, string $path = "." [, array $options = array() ]] )

bool close ( void )

bool deleteIndex ( int $index )

bool deleteName ( string $name )

bool extractTo ( string $destination [, mixed $entries ] )

string getArchiveComment ([ int $flags ] )

string getCommentIndex ( int $index [, int $flags ] )

string getCommentName ( string $name [, int $flags ] )

bool GetExternalAttributesIndex ( int $index , int &$opsys , int &$attr [, int $flags ] )

bool getExternalAttributesName ( string $name , int &$opsys , int &$attr [, int $flags ] )

string getFromIndex ( int $index [, int $length = 0 [, int $flags ]] )

string getFromName ( string $name [, int $length = 0 [, int $flags ]] )

string getNameIndex ( int $index [, int $flags ] )

string getStatusString ( void )

resource getStream ( string $name )

int locateName ( string $name [, int $flags ] )

mixed open ( string $filename [, int $flags ] )

bool renameIndex ( int $index , string $newname )

bool renameName ( string $name , string $newname )

bool setArchiveComment ( string $comment )

bool setCommentIndex ( int $index , string $comment )

bool setCommentName ( string $name , string $comment )

bool setCompressionIndex ( int $index , int $comp_method [, int $comp_flags = 0 ] )

bool setCompressionName ( string $name , int $comp_method [, int $comp_flags = 0 ] )

bool setExternalAttributesIndex ( int $index , int $opsys , int $attr [, int $flags ] )

bool setExternalAttributesName ( string $name , int $opsys , int $attr [, int $flags ] )

public bool setPassword ( string $password )

array statIndex ( int $index [, int $flags ] )

array statName ( string $name [, int $flags ] )

bool unchangeAll ( void )

bool unchangeArchive ( void )

bool unchangeIndex ( int $index )

bool unchangeName ( string $name )

}

Propiedades

status: Estado del archivo Zip
statusSys: Estado del sistema del archivo Zip
numFiles: Número de ficheros en el archivo
filename: Nombre del archivo en le sistema de archivos
comment: Comentario para el archivo

Tabla de contenidos

ZipArchive::addEmptyDir — Añadir un nuevo directorio
ZipArchive::addFile — Añade un fichero al archivo ZIP para la ruta dada
ZipArchive::addFromString — Añadir un fichero al archivo ZIP usando su contenido
ZipArchive::addGlob — Añadir ficheros de un directorio mediante un patrón glob
ZipArchive::addPattern — Añade ficheros de un directorio a partir de un patrón PCRE
ZipArchive::close — Cierra el fichero activo (abierto o el nuevo creado)
ZipArchive::deleteIndex — Elimina una entrada en el archivo usando su índice
ZipArchive::deleteName — Elimina una entrada en el archivo por su nombre
ZipArchive::extractTo — Extraer el contenido del archivo
ZipArchive::getArchiveComment — Devuelve el comentario del archivo ZIP
ZipArchive::getCommentIndex — Devuelve el comentario de una entrada usando la entrada díndice
ZipArchive::getCommentName — Devuelve el comentario de una entrada usando el nombre de la entrada
ZipArchive::getExternalAttributesIndex — Obtener los atributos externos de una entrada definida por su índice
ZipArchive::getExternalAttributesName — Obtener los atributos externos de una entrada definida por su nombre
ZipArchive::getFromIndex — Devuelve el contenido de la entrada usando su índice
ZipArchive::getFromName — Devuelve el contenido de la entrada utilizando su nombre
ZipArchive::getNameIndex — Devuelve el nombre de una entrada utilizando su índice
ZipArchive::getStatusString — Devuelve mensajes de: estado de error, de sistema y/o mensajes de zip
ZipArchive::getStream — Obtener un manejador de fichero para la entrada definido por su nombre (sólo lectura)
ZipArchive::locateName — Devuelve el índice de la entrada en el archivo
ZipArchive::open — Abrir un fichero de archivo en formato ZIP
ZipArchive::renameIndex — Renombra una entrada definida por su índice
ZipArchive::renameName — Renombra una entrada definida por su nombre
ZipArchive::setArchiveComment — Establece el comentario de un archivo ZIP
ZipArchive::setCommentIndex — Establece el comentario de una entrada definido por su índice
ZipArchive::setCommentName — Establece el comentario de una entrada definido por su nombre
ZipArchive::setCompressionIndex — Establecer el método de compresión de una entrada definida por su índice
ZipArchive::setCompressionName — Establecer el método de compresión de una entrada definida por su nombre
ZipArchive::setExternalAttributesIndex — Establece los atributos externos de una entrada definida por su índice
ZipArchive::setExternalAttributesName — Establece los atributos externos de una entrada definida por su nombre
ZipArchive::setPassword — Establece la contraseña para el archivo activo
ZipArchive::statIndex — Obtiene los detalles de una entrada definida por su índice
ZipArchive::statName — Obtener los detalles de una entrada definida por su nombre
ZipArchive::unchangeAll — Deshacer todos los cambios hechos en el archivo
ZipArchive::unchangeArchive — Revertir todos los cambios globales hechos en el archivo
ZipArchive::unchangeIndex — Revertir todos los cambios hechos a una entrada en el índice dado
ZipArchive::unchangeName — Deshace todos los cambios realizados a una entrada con un nombre dado