-
Notifications
You must be signed in to change notification settings - Fork 70
/
addFile.xml
151 lines (139 loc) · 4.84 KB
/
addFile.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.addfile" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::addFile</refname>
<refpurpose>Добавляет в phar-архив файл из файловой системы</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>void</type><methodname>Phar::addFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>localName</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
&phar.write;
<para>
С помощью этого метода в phar-архив может быть добавлен любой
файл или содержимое, доступное по URL. Если указан необязательный
второй параметр <literal>localName</literal>, то файл будет сохранён
в архиве с таким именем, в ином случае в качестве пути для сохранения
внутри архива будет использован параметр <literal>file</literal>.
При добавлении содержимого, доступного по URL, параметр <literal>localname</literal>
должен быть указан, иначе будет выброшено исключение.
Этот метод аналогичен <function>ZipArchive::addFile</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Полный или относительный путь к файлу в файловой системе, который должен быть добавлен в phar-архив.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
Путь, по которому файл будет сохранён в архиве.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Нет возвращаемого значения, в случае возникновения ошибки выбрасывается исключение.
</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>localName</parameter> теперь допускает значение null.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::addFile</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$a = new Phar('/путь/к/phar.phar');
$a->addFile('/полный/путь/к/файлу');
// показывает, как хранится этот файл
$b = $a['полный/путь/к/файлу']->getContent();
$a->addFile('/полный/путь/к/файлу', 'моя_папка/file.txt');
$c = $a['моя_папка/file.txt']->getContent();
// показывает использоваие URL
$a->addFile('http://www.example.com', 'example.html');
} catch (Exception $e) {
// обработка ошибок
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&phar.note.performance;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::offsetSet</function></member>
<member><function>PharData::addFile</function></member>
<member><function>Phar::addFromString</function></member>
<member><function>Phar::addEmptyDir</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
-->