-
Notifications
You must be signed in to change notification settings - Fork 70
/
createDefaultStub.xml
165 lines (155 loc) · 5.55 KB
/
createDefaultStub.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.createdefaultstub" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::createDefaultStub</refname>
<refpurpose>Создать заглушку в формате phar-архива</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>Phar::createDefaultStub</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>index</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>webIndex</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Этот метод создаёт код заглушку (stub) в специфичном для phar-архива формате
и не предназначенный для использования с файловыми архивами на основе tar или zip.
</para>
<para>
Phar-архивы содержат загрузчик (<literal>stub</literal>), написанный на
PHP, который запускается при запуске архива, когда его подключают через include:
<programlisting role="php">
<![CDATA[
<?php
include 'myphar.phar';
?>
]]>
</programlisting>
или просто запускают:
<screen>
<![CDATA[
php myphar.phar
]]>
</screen>
</para>
<para>
Этот метод предоставляет простой способ для создания заглушку, который будет
отрабатывать при запуске phar-архива. Кроме того, можно указывать разные
файлы для запуска phar-архива через веб-сервер и через командную строку.
Заглушка также вызывает <function>Phar::interceptFileFuncs</function>
для простого создания приложений PHP с доступом к файловой системе.
Если модуль phar отсутствует, то заглушка распакует phar-архив во временную
директорию и запустит приложение оттуда. Функция завершения работы удалит все
временные файлы.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
Относительный путь в phar-архиве для запуска при доступе из командной строки
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>webIndex</parameter></term>
<listitem>
<para>
Относительный путь в phar-архиве для запуска при доступе через браузер
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает текст с кодом заглушку, который позволит Phar-архиву запускаться
независимо от того, подключён ли модуль Phar или нет.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Выбросит исключение <classname>UnexpectedValueException</classname>, если любой
из параметров будет длиннее 400 байт.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>index</parameter> и <parameter>webIndex</parameter> теперь допускают значение null.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::createDefaultStub</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$phar = new Phar('myphar.phar');
$phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
} catch (Exception $e) {
// обработка ошибок
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::setStub</function></member>
<member><function>Phar::getStub</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->