Создать заглушку в формате phar-архива

# Phar::createDefaultStub

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

Phar::createDefaultStub — Создать заглушку в формате phar-архива

### Описание

final public static function Phar::createDefaultStub(?string `$index` = `null`, ?string `$webIndex` = `null`): string

Этот метод создаёт код заглушку (stub) в специфичном для phar-архива формате и не предназначенный для использования с файловыми архивами на основе tar или zip.

Phar-архивы содержат загрузчик (`stub`), написанный на PHP, который запускается при запуске архива, когда его подключают через include:

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

или просто запускают:

    php myphar.phar

Этот метод предоставляет простой способ для создания заглушку, который будет отрабатывать при запуске phar-архива. Кроме того, можно указывать разные файлы для запуска phar-архива через веб-сервер и через командную строку. Заглушка также вызывает Phar::interceptFileFuncs() для простого создания приложений PHP с доступом к файловой системе. Если модуль phar отсутствует, то заглушка распакует phar-архив во временную директорию и запустит приложение оттуда. Функция завершения работы удалит все временные файлы.

### Список параметров

`index`

  Относительный путь в phar-архиве для запуска при доступе из командной строки

`webIndex`

  Относительный путь в phar-архиве для запуска при доступе через браузер

### Возвращаемые значения

Возвращает текст с кодом заглушку, который позволит Phar-архиву запускаться независимо от того, подключён ли модуль Phar или нет.

### Ошибки

Выбросит исключение UnexpectedValueException, если любой из параметров будет длиннее 400 байт.

### Список изменений

Версия | Описание
--- | ---
8.0.0 | `index` и `webIndex` теперь допускают значение null.

### Примеры

Пример #1 Пример использования Phar::createDefaultStub()

    <?php
    try {
        $phar = new Phar('myphar.phar');
        $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
    } catch (Exception $e) {
        // обработка ошибок
    }
    ?>

### Смотрите также

- Phar::setStub() - Устанавливает в Phar-архив заглушку, которая играет роль начального загрузчика PHP
- Phar::getStub() - Получить загрузчик PHP или загрузчик заглушки Phar-архива

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open