Phar::setStub

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

Phar::setStub — Used to set the PHP loader or bootstrap stub of a Phar archive

Descrição

public Phar::setStub(resource|string $stub, int $length = -1): bool

Nota:
Este método requer que a configuração phar.readonly do php.ini seja definida como 0 para funcionar com objetos Phar. Caso contrário, uma exceção PharException será lançada.

This method is used to add a PHP bootstrap loader stub to a new Phar archive, or to replace the loader stub in an existing Phar archive.

The loader stub for a Phar archive is used whenever an archive is included directly as in this example:

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

The loader is not accessed when including a file through the phar stream wrapper like so:

<?php
include 'phar://myphar.phar/somefile.php';
?>

Parâmetros

stub: A string or an open stream handle to use as the executable stub for this phar archive.
length

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Erros/Exceções

UnexpectedValueException is thrown if phar.readonly is enabled in php.ini. PharException is thrown if any problems are encountered flushing changes to disk.

Registro de Alterações

Versão	Descrição
8.3.0	Calling Phar::setStub() with a resource and a `length` is now deprecated. Such calls should be replaced by: `$phar->setStub(stream_get_contents($resource));`

Exemplos

Exemplo #1 A Phar::setStub() example

<?php
try {
    $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
    $p['a.php'] = '<?php var_dump("Hello");';
    $p->setStub('<?php var_dump("First"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>');
    include 'phar://brandnewphar.phar/a.php';
    var_dump($p->getStub());
    $p['b.php'] = '<?php var_dump("World");';
    $p->setStub('<?php var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>');
    include 'phar://brandnewphar.phar/b.php';
    var_dump($p->getStub());
} catch (Exception $e) {
    echo 'Write operations failed on brandnewphar.phar: ', $e;
}
?>

O exemplo acima produzirá:

string(5) "Hello"
string(82) "<?php var_dump("First"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>"
string(5) "World"
string(83) "<?php var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>"

Veja Também

Phar::getStub() - Return the PHP loader or bootstrap stub of a Phar archive
Phar::createDefaultStub() - Create a phar-file format specific stub

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