-
Notifications
You must be signed in to change notification settings - Fork 70
/
webPhar.xml
249 lines (241 loc) · 9.47 KB
/
webPhar.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5beaad9885973652023784f1a4656a5e497779fb Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.webphar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Phar::webPhar</refname>
<refpurpose>Направляет запрос из браузера во внутренний файл в phar-архиве</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>Phar::webPhar</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>alias</parameter><initializer>&null;</initializer></methodparam>
<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>fileNotFoundScript</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>mimeTypes</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>rewrite</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>Phar::webPhar</function> служит <function>Phar::mapPhar</function> для веб-архивов phar.
Метод анализирует <varname>$_SERVER['REQUEST_URI']</varname> и направляет запрос из браузера во внутренний файл в phar-архиве.
Он имитирует веб-сервер, направляет запросы к нужному файлу, отображает правильные заголовки и анализирует файлы PHP по мере необходимости.
В сочетании с <function>Phar::mungServer</function>
и <function>Phar::interceptFileFuncs</function>, любое веб-приложение можно использовать без изменений из phar-архива.
</para>
<para>
<function>Phar::webPhar</function> должен вызываться только из
заглушки (stub) phar-архива (о том, что такое заглушка и
как с ним работать, читайте <link linkend="phar.fileformat.stub">тут</link>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>alias</parameter></term>
<listitem>
<para>
Псевдоним для использования в обёртках <literal>phar://</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
Местоположение в phar-архиве индексного файла.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fileNotFoundScript</parameter></term>
<listitem>
<para>
Местоположение скрипта, отвечающего за обработку ошибки
HTTP 404. Скрипт должен возвращать корректные заголовки для этой ошибки.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mimeTypes</parameter></term>
<listitem>
<para>
Массив сопоставления расширений файлов типам MIME.
Если достаточно сопоставления по умолчанию, то передайте сюда пустой массив.
По умолчанию используются такие сопоставления:
<programlisting role="php">
<![CDATA[
<?php
$mimes = array(
'phps' => Phar::PHPS, // передаётся в highlight_file()
'c' => 'text/plain',
'cc' => 'text/plain',
'cpp' => 'text/plain',
'c++' => 'text/plain',
'dtd' => 'text/plain',
'h' => 'text/plain',
'log' => 'text/plain',
'rng' => 'text/plain',
'txt' => 'text/plain',
'xsd' => 'text/plain',
'php' => Phar::PHP, // разбирается как PHP
'inc' => Phar::PHP, // разбирается как PHP
'avi' => 'video/avi',
'bmp' => 'image/bmp',
'css' => 'text/css',
'gif' => 'image/gif',
'htm' => 'text/html',
'html' => 'text/html',
'htmls' => 'text/html',
'ico' => 'image/x-ico',
'jpe' => 'image/jpeg',
'jpg' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'js' => 'application/x-javascript',
'midi' => 'audio/midi',
'mid' => 'audio/midi',
'mod' => 'audio/mod',
'mov' => 'movie/quicktime',
'mp3' => 'audio/mp3',
'mpg' => 'video/mpeg',
'mpeg' => 'video/mpeg',
'pdf' => 'application/pdf',
'png' => 'image/png',
'swf' => 'application/shockwave-flash',
'tif' => 'image/tiff',
'tiff' => 'image/tiff',
'wav' => 'audio/wav',
'xbm' => 'image/xbm',
'xml' => 'text/xml',
);
?>
]]>
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rewrite</parameter></term>
<listitem>
<para>
Функция перезаписи, которой передаётся единственный строковый параметр и
которая должна также вернуть строку, либо &false;.
</para>
<para>
Если вы используете fast-cgi или cgi, то параметром, передаваемым в эту функцию
будет значение переменной <varname>$_SERVER['PATH_INFO']</varname>.
В ином случае передаваться будет значение переменной
<varname>$_SERVER['REQUEST_URI']</varname>.
</para>
<para>
Если будет возвращена строка, то она будет использована как путь
к файлу внутри архива. Если вернётся &false;, то webPhar() пошлёт
код ошибки HTTP 403.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Выбросит исключение <classname>PharException</classname>, если будет невозможно
открыть какой-либо файл, либо если вызывать её не из заглушки.
Если в параметре <parameter>mimeTypes</parameter> указать некорректный MIME-тип,
или в <parameter>rewrite</parameter> будет передана некорректная функция
обратного вызова, то будет выброшено исключение
<classname>UnexpectedValueException</classname>.
</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>fileNotFoundScript</parameter> и <parameter>rewrite</parameter>
теперь допускают значение &null;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::webPhar</function></title>
<para>
В примере ниже, созданный phar отобразит <literal>Hello World</literal>
при обращении из браузера к <literal>/myphar.phar/index.php</literal> или к
<literal>/myphar.phar</literal>, и отобразит исходный код
<literal>index.phps</literal> при обращении к <literal>/myphar.phar/index.phps</literal>.
</para>
<programlisting role="php">
<![CDATA[
<?php
// создаём архив:
try {
$phar = new Phar('myphar.phar');
$phar['index.php'] = '<?php echo "Hello World"; ?>';
$phar['index.phps'] = '<?php echo "Hello World"; ?>';
$phar->setStub('<?php
Phar::webPhar();
__HALT_COMPILER(); ?>');
} catch (Exception $e) {
// обработка ошибок
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::mungServer</function></member>
<member><function>Phar::interceptFileFuncs</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
-->