Phar::setStub

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

Phar::setStub — Utilisé pour spécifier le chargeur PHP ou le conteneur de chargement d'une archive Phar

Description

public Phar::setStub(resource|string $stub, int $length = -1): bool

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 utilisée pour ajouter un chargeur PHP à une nouvelle archive Phar, ou pour remplacer le conteneur de chargement d'une archive Phar existante.

Le conteneur de chargement d'une archive Phar est utilisé quand une archive est incluse directement comme dans cet exemple :

<?php
include 'monphar.phar';
?>

Le chargeur n'est pas utilisé quand un fichier est inclus via le flux phar comme ceci :

<?php
include 'phar://monphar.phar/unfichier.php';
?>

Liste de paramètres

stub: Une chaîne ou une resource de flux ouvert à utiliser comme conteneur exécutable pour cette archive phar.
length

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Erreurs / Exceptions

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

Historique

Version	Description
8.3.0	Appeler Phar::setStub() avec une resource et une `length` est désormais obsolète. De tels appels devraient être remplacés par : `$phar->setStub(stream_get_contents($resource));`

Exemples

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

<?php
try {
    $p = new Phar(dirname(__FILE__) . '/nouveau.phar', 0, 'nouveau.phar');
    $p['a.php'] = '<?php var_dump("Salut");';
    $p->setStub('<?php var_dump("Premier"); Phar::mapPhar("nouveau.phar"); __HALT_COMPILER(); ?>');
    include 'phar://nouveau.phar/a.php';
    var_dump($p->getStub());
    $p['b.php'] = '<?php var_dump("Tout le monde");';
    $p->setStub('<?php var_dump("Second"); Phar::mapPhar("nouveau.phar"); __HALT_COMPILER(); ?>');
    include 'phar://nouveau.phar/b.php';
    var_dump($p->getStub());
} catch (Exception $e) {
    echo 'Erreur lors de l'écriture de nouveau.phar: ', $e;
}
?>

L'exemple ci-dessus va afficher :

string(5) "Salut"
string(79) "<?php var_dump("Premier"); Phar::mapPhar("nouveau.phar"); __HALT_COMPILER(); ?>"
string(13) "Tout le monde"
string(78) "<?php var_dump("Second"); Phar::mapPhar("nouveau.phar"); __HALT_COMPILER(); ?>"

Voir aussi

Phar::getStub() - Retourne le chargeur PHP ou le conteneur de chargement d'une archive Phar
Phar::createDefaultStub() - Crée un conteneur de chargement d'une archive Phar