Phar::setStub

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

Phar::setStub — Установить загрузчик или загрузочную заглушку в Phar-архив

Описание

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

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

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

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

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

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

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

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

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

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

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

Ошибки

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

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

Версия	Описание
8.3.0	Вызов метода Phar::setStub() с ресурсом (resource) и параметром `length` теперь является устаревшим. Такие вызовы должны быть заменены на: `$phar->setStub(stream_get_contents($resource));`

Примеры

Пример #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 'Операции записи на 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(); ?>"

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

Phar::getStub() - Получить загрузчик PHP или загрузчик заглушки Phar-архива
Phar::createDefaultStub() - Создать заглушку в формате 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