Опис

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

Зауваження:
Для роботи з об'єктами 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:

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

or by simple execution:

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

Параметри

stub: A string or an open stream handle to use as the executable stub for this phar archive.
length: Length of stub in bytes.
Увага
Passing the length argument with a resource in the first argument is DEPRECATED as of PHP 8.3.0. Use $phar->setStub(stream_get_contents($resource)) instead.

Значення, що повертаються

Завжди повертає true.

Помилки/виключення

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

Журнал змін

Версія	Опис
8.4.0	The return type is `true` now; previously, it was bool.
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));`

Приклади

Приклад #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;
}
?>

Поданий вище приклад виведе:

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() - Return the PHP loader or bootstrap stub of a Phar archive
Phar::createDefaultStub() - Create a phar-file format specific stub