PharFileInfo::compress

master Ver versión oficial en línea Licencia CC-BY-3.0Descargado el 2026-08-02

En esta página

Descripción#
Véase también#

Comprime la entrada Phar actual con una de las compresiones zlib o bzip2

Descripción#

public PharFileInfo::compress(int $compression): true
```php

Este método comprime el fichero dentro del archivo Phar utilizando una de las compresiones bzip2 o zlib. Las extensiones [bzip2](#ref.bzip2) o [zlib](#ref.zlib) deben estar activadas para aprovechar esta funcionalidad. Además, si el fichero ya está comprimido, la extensión adecuada debe estar activada para descomprimirlo. Al igual que con todas las funcionalidades que modifican el contenido de un phar, la variable INI [phar.readonly](#ini.phar.readonly) debe estar a off para tener éxito si el fichero está dentro de un archivo `Phar`. Los ficheros dentro de archivos `PharData` no tienen esta restricción.

## Parámetros

`compression`  
La compresión debe ser `Phar::GZ` o `Phar::BZ2`.

## Valores devueltos

Retorna siempre `true`.

## Errores/Excepciones

Levanta una excepción `BadMethodCallException` si la variable INI [phar.readonly](#ini.phar.readonly) está a on, o si la extensión [bzip2](#ref.bzip2)/[zlib](#ref.zlib) no está disponible.

## Ejemplos

Un ejemplo con `PharFileInfo::compress`

isCompressed(Phar::BZ2)); $p['mifichero.txt']->compress(Phar::BZ2); var_dump($file->isCompressed(Phar::BZ2)); } catch (Exception $e) { echo 'No puede crear/modificar mifichero.phar : ', $e; } ?>

```php

El ejemplo anterior mostrará:

bool(false)
bool(true)

Véase también#

PharFileInfo::getCompressedSize, PharFileInfo::isCompressed, PharFileInfo::decompress, Phar::canCompress, Phar::isCompressed, Phar::compressFiles, Phar::decompressFiles, Phar::compress, Phar::decompress, Phar::getSupportedCompression