Phar

Introducción

La extensión phar proporciona un medio para empaquetar una aplicación PHP completa en un único archivo llamado "phar" (PHP Archive) para facilitar la instalación y configuración. Además de este servicio, la extensión también proporciona una clase de abstracción de formato de archivo para crear y manipular archivos tar y zip a través de la clase PharData, de manera similar a como PDO proporciona una interfaz unificada para acceder a diferentes bases de datos. Sin embargo, a diferencia de PDO, que no puede transferir datos entre bases de datos, Phar tiene la capacidad de convertir archivos tar, zip y phar con una sola línea de código. Consulte Phar::convertToExecutable() para obtener un ejemplo.

¿Qué es phar? Las archivos phar son en realidad un medio práctico para agrupar varios archivos en uno solo. Así, un archivo phar permite distribuir una aplicación PHP completa en un único archivo y ejecutarla desde este archivo sin necesidad de extraerlo en el disco. Además, los archivos phar pueden ser ejecutados por PHP tan fácilmente como cualquier otro archivo, tanto desde la línea de comandos como a través de un servidor web. Phar es una especie de memoria USB para aplicaciones PHP.

Phar implementa esta funcionalidad mediante un flujo. Normalmente, para utilizar un archivo externo desde un script PHP, se debe utilizar la función include:

Ejemplo #1 Utilizar un archivo externo

<?php
 include '/ruta/al/archivo/externo.php';
 ?>

Puede considerarse que PHP convierte en realidad /ruta/al/archivo/externo.php en un flujo file:///ruta/al/archivo/externo.php, y que utiliza de forma oculta las funciones de flujo de archivos planos para acceder a archivos locales.

Para utilizar un archivo llamado archivo.php contenido en un archivo phar /ruta/al/miphar.phar, la sintaxis es casi similar a la sintaxis file:// anterior.

Ejemplo #2 Utilizar un archivo contenido en un archivo phar

<?php
 include 'phar:///ruta/al/miphar.phar/archivo.php';
 ?>

En realidad, un archivo phar puede tratarse como si fuera un disco externo, utilizando cualquiera de las funciones relacionadas con fopen(), opendir() y mkdir() para leer, modificar o crear nuevos archivos o directorios dentro del archivo phar. Esto permite que aplicaciones PHP completas sean distribuidas en un único archivo y ejecutadas desde él.

El uso más común de un archivo phar es distribuir una aplicación completa en un único archivo. Por ejemplo, el instalador PEAR que se incluye con las versiones de PHP se distribuye mediante un archivo phar. Para utilizar el archivo phar distribuido de esta manera, este puede ser ejecutado mediante la línea de comandos o a través de un navegador web.

Los archivos phar pueden distribuirse en formato tar, zip o en el formato phar especialmente diseñado para la extensión phar. Cada formato de archivo tiene sus ventajas e inconvenientes. Los archivos zip y tar pueden ser extraídos por cualquier herramienta de terceros que pueda leer el formato, pero requieren la extensión phar para ser ejecutados por PHP. El formato de archivo phar es único y dedicado a la extensión phar y solo puede ser creado por esta o por el paquete PEAR » PHP_Archive, pero tiene la ventaja de no requerir la instalación de la extensión phar para que la aplicación empaquetada pueda ser ejecutada.

En otras palabras, incluso con la extensión phar desactivada, es posible ejecutar o incluir un archivo basado en phar. Acceder a archivos individuales dentro de un archivo phar solo es posible con la extensión phar a menos que el archivo phar haya sido creado por PHP_Archive.

La extensión phar también es capaz de convertir un archivo phar desde un tar hacia un archivo zip o phar con un solo comando:

Ejemplo #3 Convertir un archivo phar al formato tar

<?php
 $phar = new Phar('miphar.phar');
 $pgz = $phar->convertToExecutable(Phar::TAR, Phar::GZ); // produce miphar.phar.tar.gz
 ?>

Phar puede comprimir archivos individuales o un archivo completo utilizando la compresión gzip o bzip2, y puede verificar la integridad del archivo automáticamente utilizando funciones de firma MD5, SHA-1, SHA-256 o SHA-512.

Finalmente, la extensión phar está orientada a la seguridad, desactiva por defecto los accesos de escritura en archivos phar ejecutables y requiere la desactivación a nivel de sistema del parámetro phar.readonly del php.ini para crear o modificar archivos phar. Los archivos tar y zip sin el marcador ejecutable pueden ser siempre creados o modificados utilizando la clase PharData.

Si se crean aplicaciones con el propósito de distribuirlas, se debe leer Cómo crear archivos Phar. Si se desea más información sobre las diferencias entre los formatos de archivo que phar soporta, se debe leer Phar, Tar y Zip.

Si se utilizan aplicaciones phar, hay trucos muy útiles en Cómo utilizar archivos Phar.

La palabra phar es la contracción de PHP y de Archive y está fuertemente inspirada en la palabra jar (Java Archive) familiar a los desarrolladores Java.

La implementación de los archivos Phar se basa en el paquete PEAR » PHP_Archive, y los detalles de implementación son los mismos, aunque la extensión Phar es más potente. Además, esta permite que la mayoría de las aplicaciones PHP sean ejecutadas sin modificación mientras que los archivos basados en PHP_Archive requieren a menudo muchas modificaciones para funcionar.

Instalación/Configuración
Constantes predefinidas
Utilizar los archivos Phar
Creación de archivos Phar
- Creación de archivos Phar: Introducción
¿Qué hace que un phar sea un phar y no un tar o un zip?
Phar — La clase Phar
- Phar::addEmptyDir — Añade un directorio vacío al archivo phar
- Phar::addFile — Añade un fichero del sistema de ficheros al archivo phar
- Phar::addFromString — Añade un fichero desde un string al archivo phar
- Phar::apiVersion — Devuelve la versión de la API
- Phar::buildFromDirectory — Construye un archivo phar a partir de los ficheros de un directorio
- Phar::buildFromIterator — Construye un archivo phar a partir de un iterador
- Phar::canCompress — Determina si la extensión phar soporta la compresión utilizando zip o bzip2
- Phar::canWrite — Determina si la extensión phar soporta la creación y escritura de archivos phar
- Phar::compress — Comprime el archivo Phar completo utilizando la compresión Gzip o Bzip2
- Phar::compressFiles — Comprime todos los ficheros del archivo Phar actual
- Phar::__construct — Construye un objeto de archivo Phar
- Phar::convertToData — Convierte un archivo phar en un fichero no ejecutable
- Phar::convertToExecutable — Convierte un archivo phar a otro formato de archivo de archivo phar ejecutable
- Phar::copy — Copia un fichero perteneciente a un archivo hacia otro fichero del mismo archivo
- Phar::count — Devuelve el número de entradas (ficheros) en el archivo Phar
- Phar::createDefaultStub — Crea un contenedor de carga de un archivo Phar
- Phar::decompress — Descomprime el archivo tar completo
- Phar::decompressFiles — Descomprime todos los ficheros del archivo Phar actual
- Phar::delMetadata — Elimina los metadatos globales del phar
- Phar::delete — Elimina un fichero dentro de un archivo phar
- Phar::__destruct — Destruye un objeto archivo Phar
- Phar::extractTo — Extrae el contenido de un archivo phar hacia un directorio
- Phar::getAlias — Obtiene el alias para Phar
- Phar::getMetadata — Devuelve las metadatos del archivo phar
- Phar::getModified — Indica si el archivo phar ha sido modificado
- Phar::getPath — Obtiene la ruta de acceso absoluta del archivo Phar en el disco
- Phar::getSignature — Devuelve la firma MD5/SHA1/SHA256/SHA512 de un archivo Phar
- Phar::getStub — Retorna el cargador PHP o el contenedor de carga de un archivo Phar
- Phar::getSupportedCompression — Devuelve un array de los algoritmos de compresión soportados
- Phar::getSupportedSignatures — Devuelve un array de los tipos de firma soportados
- Phar::getVersion — Devuelve las informaciones de versión del archivo Phar
- Phar::hasMetadata — Determina si el phar contiene o no metadatos
- Phar::interceptFileFuncs — Indica a phar que debe interceptar las funciones de archivos
- Phar::isBuffering — Determina si las operaciones de escritura de Phar están en búfer o se escriben directamente en el disco
- Phar::isCompressed — Devuelve Phar::GZ o PHAR::BZ2 si el archivo completo está comprimido (.tar.gz/tar.bz, etc)
- Phar::isFileFormat — Retorna true si el archivo phar está basado en el formato de archivo tar/phar/zip según el argumento
- Phar::isValidPharFilename — Determina si el nombre de fichero especificado es un nombre de fichero válido para un archivo phar
- Phar::isWritable — Retorna true si el archivo phar puede ser modificado
- Phar::loadPhar — Carga cualquier archivo phar con un alias
- Phar::mapPhar — Lee el phar ejecutado y carga su manifiesto
- Phar::mount — Monta un camino o un fichero externo a una ubicación virtual dentro del archivo phar
- Phar::mungServer — Define una lista de un máximo de 4 variables $_SERVER que deben ser modificadas durante la ejecución
- Phar::offsetExists — Determina si un fichero existe en el phar
- Phar::offsetGet — Obtiene un objeto PharFileInfo a partir de un fichero
- Phar::offsetSet — Establece el contenido de un fichero interno en el archivo a partir del contenido de un fichero externo
- Phar::offsetUnset — Elimina un fichero de un phar
- Phar::running — Devuelve la ruta completa en el disco o la URL phar completa del archivo phar actualmente ejecutado
- Phar::setAlias — Establece el alias del archivo Phar
- Phar::setDefaultStub — Utilizado para establecer el cargador PHP o el contenedor de carga de un archivo Phar como cargador por defecto
- Phar::setMetadata — Establece las metadatos del archivo phar
- Phar::setSignatureAlgorithm — Establece y aplica el algoritmo de firma de un phar
- Phar::setStub — Utilizado para especificar el cargador PHP o el contenedor de carga de un archivo Phar
- Phar::startBuffering — Inicia el almacenamiento en búfer de escrituras Phar, sin modificar el objeto Phar en el disco
- Phar::stopBuffering — Detiene el almacenamiento en búfer de las escrituras Phar y provoca la escritura en el disco
- Phar::unlinkArchive — Elimina completamente un archivo phar del disco y de la memoria
- Phar::webPhar — Redirige una solicitud desde un navegador web a un fichero interno en el archivo phar
PharData — La clase PharData
- PharData::addEmptyDir — Añade un directorio vacío al archivo tar/zip
- PharData::addFile — Añade un fichero del sistema de archivos al archivo tar/zip
- PharData::addFromString — Añade un fichero a partir de un string al archivo tar/zip
- PharData::buildFromDirectory — Construye un archivo tar/zip a partir de los ficheros de un directorio
- PharData::buildFromIterator — Construye un archivo tar o zip a partir de un iterador
- PharData::compress — Comprime el archivo tar/zip completo utilizando la compresión Gzip o Bzip2
- PharData::compressFiles — Comprime todos los ficheros del archivo tar/zip actual
- PharData::__construct — Construye un objeto de archivo tar o zip no ejecutable
- PharData::convertToData — Convierte un archivo phar en un archivo tar o zip no ejecutable
- PharData::convertToExecutable — Convierte un archivo tar/zip no ejecutable en un archivo phar ejecutable
- PharData::copy — Copia un fichero interno del archivo tar/zip a otro fichero dentro del mismo archivo
- PharData::decompress — Descomprime el archivo Phar completo
- PharData::decompressFiles — Descomprime todos los ficheros del archivo zip actual
- PharData::delMetadata — Elimina los metadatos globales de un archivo zip
- PharData::delete — Elimina un fichero dentro del archivo tar/zip
- PharData::__destruct — Destruye un objeto tar no ejecutable o un archivo zip
- PharData::extractTo — Extrae el contenido de un archivo tar/zip hacia un directorio
- PharData::isWritable — Verifica si el archivo tar/zip puede ser modificado
- PharData::offsetSet — Rellena un fichero dentro del archivo tar/zip con el contenido de un fichero externo o de un string
- PharData::offsetUnset — Elimina un fichero de un archivo tar/zip
- PharData::setAlias — Función inútil (Phar::setAlias no es válido para PharData)
- PharData::setDefaultStub — Función inútil (Phar::setDefaultStub no es válido para PharData)
- PharData::setMetadata — Fija las metadatos del archivo
- PharData::setSignatureAlgorithm — Asigna el algoritmo de firma de un phar y lo aplica
- PharData::setStub — Función inútil (Phar::setStub no es válido para PharData)
PharFileInfo — La clase PharFileInfo
- PharFileInfo::chmod — Fija los bits de permiso específicos de los ficheros
- PharFileInfo::compress — Comprime la entrada Phar actual con una de las compresiones zlib o bzip2
- PharFileInfo::__construct — Construye un objeto de entrada Phar
- PharFileInfo::decompress — Descomprime la entrada Phar actual dentro del phar
- PharFileInfo::delMetadata — Elimina las metadatos de la entrada
- PharFileInfo::__destruct — Destruye un objeto PharFileInfo
- PharFileInfo::getCRC32 — Retorna el código CRC32 o levanta una excepción si el CRC no ha sido verificado
- PharFileInfo::getCompressedSize — Devuelve el tamaño actual (con compresión) del fichero dentro del archivo Phar
- PharFileInfo::getContent — Obtiene el contenido completo del fichero de la entrada
- PharFileInfo::getMetadata — Devuelve las metadatos específicas adjuntas a un fichero
- PharFileInfo::getPharFlags — Devuelve los flags del archivo Phar
- PharFileInfo::hasMetadata — Devuelve las metadatos de la entrada
- PharFileInfo::isCRCChecked — Determina si el fichero tiene un CRC verificado
- PharFileInfo::isCompressed — Indica si la entrada está comprimida
- PharFileInfo::setMetadata — Establece las metadatos específicas de un fichero
PharException — La clase PharException