array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'phar.createdefaultstub.php', 1 => 'Phar::createDefaultStub', 2 => 'Создать заглушку в формате phar-архива', ), 'up' => array ( 0 => 'class.phar.php', 1 => 'Phar', ), 'prev' => array ( 0 => 'phar.count.php', 1 => 'Phar::count', ), 'next' => array ( 0 => 'phar.decompress.php', 1 => 'Phar::decompress', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/phar/Phar/createDefaultStub.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Phar::createDefaultStub

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

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

Описание

final public static 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) {
// обработка ошибок
}
?>

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