Phar::setStub

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

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

Opis

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

Informacja:

Ta metoda wymaga ustawienia w php.ini wartości phar.readonly na 0 aby działała z obiektami Phar. W przeciwnym przypadku, klasa PharException zwróci wyjątek .

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

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

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

Parametry

stub

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

len

Zwracane wartości

Zwraca TRUE w przypadku powodzenia, FALSE w przypadku błędu.

Błędy/Wyjątki

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

Przykłady

Przykład #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;
}
?>

Powyższy przykład wyświetli:

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

Rejestr zmian

Wersja Opis
5.4.0 Added len parameter.

Zobacz też:

add a note add a note

User Contributed Notes 3 notes

up
1
Scott Dutton
6 years ago
Its not clear in the docs but __HALT_COMPILER() is required in the stub.
up
0
Olivier Laviale
12 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
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.
To Top