(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 ] )


Для корректной работы с объектами Phar этому методу необходима установка значения php.ini phar.readonly в 0. В противном случае, будет выброшено исключение PharException.

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';

Список параметров


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


Возвращаемые значения

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.


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


Пример #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;

Результат выполнения данного примера:

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

Список изменений

Версия Описание
5.4.0 Added len parameter.

Смотрите также


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.
2008-01-16 17:04:53
If your stub has a namespace, it is used for each include that doesn't define one.
2011-07-17 10:14:05
Its not clear in the docs but __HALT_COMPILER() is required in the stub.
2018-01-08 23:57:17

    Поддержать сайт на родительском проекте КГБ