Phar::getStub

Return the PHP loader or bootstrap stub of a Phar archive

&reftitle.description; public `string` `Phar::getStub`

Phar archives contain a bootstrap loader, or `stub` written in PHP that is executed when the archive is executed in PHP either via include:

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

or by simple execution:

    php myphar.phar

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

Returns a string containing the contents of the bootstrap loader (stub) of the current Phar archive.

&reftitle.errors;

Throws `RuntimeException` if it is not possible to read the stub from the Phar archive.

&reftitle.examples;

### A `Phar::getStub` example

    <?php
    $p = new Phar('/path/to/my.phar', 0, 'my.phar');
    echo $p->getStub();
    echo "==NEXT==\n";
    $p->setStub("<?php
    function __autoload($class)
    {
        include 'phar://' . str_replace('_', '/', $class);
    }
    Phar::mapPhar('myphar.phar');
    include 'phar://myphar.phar/startup.php';
    __HALT_COMPILER(); ?>");
    echo $p->getStub();
    ?>

&example.outputs;

    <?php __HALT_COMPILER(); ?>
    ==NEXT==
    <?php
    function __autoload($class)
    {
        include 'phar://' . str_replace('_', '/', $class);
    }
    Phar::mapPhar('myphar.phar');
    include 'phar://myphar.phar/startup.php';
    __HALT_COMPILER(); ?>

&reftitle.seealso;

- `Phar::setStub`
- `Phar::createDefaultStub`