Phar::createDefaultStub

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

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

Описание

final public static Phar::createDefaultStub ([ string $indexfile [, string $webindexfile ]] ) : string

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

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

<?php
include 'myphar.phar';
?>
или просто запускают:
php myphar.phar
    

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

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

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

Ошибки

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

Примеры

Пример #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-архив
  • Phar::getStub() - Получить загрузчик PHP или загрузчик заглушки Phar-архива