-
Notifications
You must be signed in to change notification settings - Fork 70
/
offsetUnset.xml
117 lines (108 loc) · 3.59 KB
/
offsetUnset.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.offsetunset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::offsetUnset</refname>
<refpurpose>Удалить файл из phar-архива</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>void</type><methodname>Phar::offsetUnset</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
</methodsynopsis>
&phar.write;
<para>
Это реализация интерфейса <interfacename>ArrayAccess</interfacename>,
позволяющая манипулировать содержимым Phar-архива в стиле доступа к элементам
массива. offsetUnset используется для удаления файлов и запускается каждый раз,
когда используется конструкция <function>unset</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
Имя файла (относительный путь).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Если опция <link linkend="ini.phar.readonly">phar.readonly</link> установлен в
<literal>1</literal>, то будет выброшено исключение
<classname>BadMethodCallException</classname>, так как модифицировать Phar-архив
можно только, если phar.readonly равен <literal>0</literal>. Если возникнут
какие-либо проблемы с записью на диск - выбрасывается исключение
<classname>PharException</classname>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::offsetUnset</function></title>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
try {
// удаляет file.txt из my.phar путём вызова offsetUnset
unset($p['file.txt']);
} catch (Exception $e) {
echo 'Не удалось удалить file.txt: ', $e;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::offsetExists</function></member>
<member><function>Phar::offsetGet</function></member>
<member><function>Phar::offsetSet</function></member>
<member><function>Phar::unlinkArchive</function></member>
<member><function>Phar::delete</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
-->