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

Descrição

public Phar::setDefaultStub(?string $index = null, ?string $webIndex = null): bool

Nota:
Este método requer que a configuração phar.readonly do php.ini seja definida como 0 para funcionar com objetos Phar. Caso contrário, uma exceção PharException será lançada.

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

Parâmetros

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

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Erros/Exceções

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

Registro de Alterações

Versão	Descrição
8.0.0	`webIndex` is nullable now.

Exemplos

Exemplo #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
}
?>

Veja Também

Phar::setStub() - Used to set the PHP loader or bootstrap stub of a Phar archive
Phar::createDefaultStub() - Create a phar-file format specific stub

add a note

User Contributed Notes

There are no user contributed notes for this page.