Phar::setStub

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

Phar::setStub — Establecer el cargador de PHP o la rutina de interoperabilidad de un archivo Phar

Descripción

public Phar::setStub(string $stub, int $len = -1): bool

Nota:
Este método requiere que la opción de php.ini phar.readonly esté establecida a 0 para que trabaje con objetos Phar. De otra manera, se lanzará una excepción de tipo PharException.

Este método se utiliza para añadir una rutina de interoperabilidad cargadora a un nuevo archivo Phar, o reemlazar la rutina de interoperabilidad de un archivo Phar existente.

La rutina de interoperabilidad cargadora de un archivo Phar se utiliza siempre que un archivo esté incluido directamente como en este ejemplo:

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

Al cargador no se accede cuando se incluye un archivo a través de la envoltura de flujos phar como aquí:

<?php
include 'phar://miphar.phar/un_fichero.php';
?>

Parámetros

stub: Una cadena o un gestor de flujo abierto para usarlo como la rutina de interoperabilidad ejecutable de este archivo phar.
len

Valores devueltos

Devuelve true en caso de éxito o false en caso de error.

Errores/Excepciones

Se lanza una excepción de tipo UnexpectedValueException si phar.readonly está habilitado en php.ini. Se lanza una excepción de tipo PharException si se encuentra cualquier problema al volcar los cambios al disco.

Ejemplos

Ejemplo #1 Un ejemplo de Phar::setStub()

<?php
try {
    $p = new Phar(dirname(__FILE__) . '/nuevo_phar.phar', 0, 'nuevo_phar.phar');
    $p['a.php'] = '<?php var_dump("Hola");';
    $p->setStub('<?php var_dump("Primero"); Phar::mapPhar("nuevo_phar.phar"); __HALT_COMPILER(); ?>');
    include 'phar://nuevo_phar.phar/a.php';
    var_dump($p->getStub());
    $p['b.php'] = '<?php var_dump("Mundo");';
    $p->setStub('<?php var_dump("Segundo"); Phar::mapPhar("nuevo_phar.phar"); __HALT_COMPILER(); ?>');
    include 'phar://nuevo_phar.phar/b.php';
    var_dump($p->getStub());
} catch (Exception $e) {
    echo 'Las operaciones de escritura sobre nuevo_phar.phar fallaron: ', $e;
}
?>

El resultado del ejemplo sería:

string(4) "Hola"
string(84) "<?php var_dump("Primero"); Phar::mapPhar("nuevo_phar.phar"); __HALT_COMPILER(); ?>"
string(5) "Mundo"
string(84) "<?php var_dump("Segundo"); Phar::mapPhar("nuevo_phar.phar"); __HALT_COMPILER(); ?>"

Historial de cambios

Versión	Descripción
5.4.0	Se añadió el parámetro `len`.

Ver también

Phar::getStub() - Devolver el cargador de PHP o la rutina de interoperabilidad de un archivo Phar
Phar::createDefaultStub() - Crear una rutina de interoperabilidad específica del formato de fichero phar

add a note

User Contributed Notes 3 notes

down

Scott Dutton ¶

6 years ago


Its not clear in the docs but __HALT_COMPILER() is required in the stub.

down

Olivier Laviale ¶

13 years ago


If your stub has a namespace, it is used for each include that doesn't define one.

down

jaimz22 at gmail dot com ¶

16 years ago


One thing I had alot of problems with, is that i can't set the stub unless I put the whole operation inside of a try/catch block!



If i remove the try/catch block it will error our and not write the stub with the content i want it to have.

add a note