PHP Manual
Phar
Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader

Phar::setDefaultStub

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

Phar::setDefaultStub — Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader

Description

public Phar::setDefaultStub ([ string $index [, string $webindex ]] ) : bool

Note:
This method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException will be thrown.

This method is a convenience method that combines the functionality of Phar::createDefaultStub() and Phar::setStub().

Parameters

index: Relative path within the phar archive to run if accessed on the command-line
webindex: Relative path within the phar archive to run if accessed through a web browser

Return Values

Returns TRUE on success or FALSE on failure.

Errors/Exceptions

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

Examples

Example #1 A Phar::setDefaultStub() example

<?phptry { $phar = new Phar('myphar.phar'); $phar->setDefaultStub('cli.php', 'web/index.php'); // this is the same as: // $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));} catch (Exception $e) { // handle errors}?>

Php/docs/phar.setdefaultstub

Contents