Phar::setDefaultStub
(PHP 5 >= 5.3.0, PHP 7, PHP 8, 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
$index = null, ?string $webIndex = null): boolNote:
This method requires the php.ini setting
phar.readonlyto be set to0in 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.
Changelog
| Version | Description |
|---|---|
| 8.0.0 |
webIndex is nullable now.
|
Examples
Example #1 A Phar::setDefaultStub() example
<?php
try {
$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
}
?>
See Also
- Phar::setStub() - Used to set the PHP loader or bootstrap stub of a Phar archive
- Phar::createDefaultStub() - Create a phar-file format specific stub
