(PHP >= 5.3.0, PECL phar >= 1.0.0)

Phar::setStubUsed to set the PHP loader or bootstrap stub of a Phar archive


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


This method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException will be thrown.

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:

include 'myphar.phar';

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

include 'phar://myphar.phar/somefile.php';

Elenco dei parametri


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


Valori restituiti

Restituisce TRUE in caso di successo, FALSE in caso di fallimento.


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


Example #1 A Phar::setStub() example

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(); ?>');
$p['b.php'] = '<?php var_dump("World");';
$p->setStub('<?php var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>');
} catch (
Exception $e) {
'Write operations failed on brandnewphar.phar: '$e;

Il precedente esempio visualizzerĂ :

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(); ?>"

Log delle modifiche

Versione Descrizione
5.4.0 Added len parameter.

Vedere anche:

add a note add a note

User Contributed Notes 2 notes

Olivier Laviale
4 years ago
If your stub has a namespace, it is used for each include that doesn't define one.
jaimz22 at gmail dot com
7 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.
To Top