Phar::setStub

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

Phar::setStubДобавить загрузчик(stub) в Phar-архив

Описание

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

Замечание:

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

Этот метод используется для добавления PHP-загрузчика в новый Phar-архив, либо для замены уже существующего загрузчика.

Загрузчик используется при подключении Phar-архива с помощью included:

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

Загрузчик не используется, когда архив подключается с использованием обертки phar, как в примере ниже:

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

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

stub

Строка, либо открытый ресурс потока.

len

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

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

Ошибки

Будет брошено исключение UnexpectedValueException, если phar.readonly разрешено в php.ini. В случае проблем с записью на диск будет выброшено исключение PharException.

Примеры

Пример #1 Пример использования Phar::setStub()

<?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;
}
?>

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

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 Добавлен параметр len.

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

add a note add a note

User Contributed Notes 3 notes

up
2
Scott Dutton
3 months ago
Its not clear in the docs but __HALT_COMPILER() is required in the stub.
up
0
Olivier Laviale
6 years ago
If your stub has a namespace, it is used for each include that doesn't define one.
up
0
jaimz22 at gmail dot com
10 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