Phar::setDefaultStub

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

Phar::setDefaultStub — Utilisé pour fixer le chargeur PHP ou le conteneur de chargement d'une archive Phar en tant que chargeur par défaut

Description

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

Note:
Cette méthode nécessite que la variable de configuration INI phar.readonly soit définie à 0 pour fonctionner avec les objets Phar. Sinon, une exception PharException sera lançée.

Cette méthode est un raccourci qui combine les fonctionnalités de Phar::createDefaultStub() et de Phar::setStub().

Liste de paramètres

index: Chemin relatif au sein de l'archive phar à exécuter si lancée à partir de la ligne de commande
webIndex: Chemin relatif au sein de l'archive phar à exécuter si lancée à partir d'un navigateur

Valeurs de retour

Retourne toujours true.

Erreurs / Exceptions

Une exception UnexpectedValueException est levée si phar.readonly est activée dans le php.ini. Une exception PharException est levée si des problèmes sont rencontrés lors de l'écriture des changements sur disque.

Historique

Version	Description
8.4.0	Phar::setDefaultStub() a maintenant un type de retour provisoire de true.
8.0.0	`webIndex` est désormais nullable.

Exemples

Exemple #1 Un exemple avec Phar::setDefaultStub()

<?php
try {
    $phar = new Phar('monphar.phar');
    $phar->setDefaultStub('cli.php', 'web/index.php');
    // est identique à :
    // $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
} catch (Exception $e) {
    // traite les erreurs
}
?>

Voir aussi

Phar::setStub() - Utilisé pour spécifier le chargeur PHP ou le conteneur de chargement d'une archive Phar
Phar::createDefaultStub() - Crée un conteneur de chargement d'une archive Phar