Phar::createDefaultStub

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)

Phar::createDefaultStub — Crea un contenedor de carga de un archivo Phar

Descripción

final public static Phar::createDefaultStub(?string $index = null, ?string $webIndex = null): string

Este método está destinado a la creación de contenedores específicos del formato de archivo phar y no está diseñado para ser utilizado con archivos phar basados en tar o zip.

Los archivos Phar contienen un cargador o contenedor escrito en PHP que se ejecuta cuando el archivo es ejecutado ya sea mediante una inclusión

<?php
include 'monphar.phar';
?>

o mediante una simple ejecución:

php monphar.phar

Este método proporciona un medio simple y fácil de crear un contenedor que lanzará un archivo de inicio desde el archivo phar. Además, se pueden especificar archivos diferentes para ejecutar el archivo desde la línea de comandos o desde un servidor web. El contenedor de carga llama entonces a Phar::interceptFileFuncs() para permitir el empaquetado fácil de aplicaciones PHP que acceden al sistema de archivos. Si la extensión phar no está presente, el contenedor de carga extraerá el archivo phar a un directorio temporal y tratará los archivos. Una función de apagado eliminará los archivos temporales al final.

Parámetros

index: Ruta relativa dentro del archivo phar a ejecutar en caso de acceso desde la línea de comandos
webIndex: Ruta relativa dentro del archivo phar a ejecutar en caso de acceso desde un navegador

Valores devueltos

Devuelve un string que contiene un contenedor de carga personalizado que permite que el archivo Phar creado funcione con o sin la extensión Phar activada.

Errores/Excepciones

Lanza una excepción UnexpectedValueException si uno de los argumentos es más largo de 400 bytes.

Historial de cambios

Versión	Descripción
8.0.0	`index` y `webIndex` ahora son nullable.

Ejemplos

Ejemplo #1 Ejemplo con Phar::createDefaultStub()

<?php
try {
    $phar = new Phar('monphar.phar');
    $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
} catch (Exception $e) {
    // trata los errores
}
?>

Ver también

Phar::setStub() - Utilizado para especificar el cargador PHP o el contenedor de carga de un archivo Phar
Phar::getStub() - Retorna el cargador PHP o el contenedor de carga de un archivo Phar