reference/phar/Phar/extractTo.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -8,19 +8,18 @@
8
8

9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<methodsynopsis>
11
+
<methodsynopsis role="Phar">
12
12
<modifier>public</modifier> <type>bool</type><methodname>Phar::extractTo</methodname>
13
-
<methodparam><type>string</type><parameter>pathto</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string|array</type><parameter>files</parameter></methodparam>
15
-
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter><initializer>false</initializer></methodparam>
13
+
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>files</parameter><initializer>&null;</initializer></methodparam>
15
+
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter><initializer>&false;</initializer></methodparam>
16
16
</methodsynopsis>
17
-
&phar.write;
18
17

19
18
<para>
20
19
Extract all files within a phar archive to disk. Extracted files and directories preserve
21
20
permissions as stored in the archive. The optional parameters allow optional control over
22
21
which files are extracted, and whether existing files on disk can be overwritten.
23
-
The second parameter <literal>files</literal> can be either the name of a file or
22
+
The second parameter <parameter>files</parameter> can be either the name of a file or
24
23
directory to extract, or an array of names of files and directories to extract. By
25
24
default, this method will not overwrite existing files, the third parameter can be
26
25
set to true to enable overwriting of files.
...
...
@@ -33,10 +32,10 @@
33
32
<para>
34
33
<variablelist>
35
34
<varlistentry>
36
-
<term><parameter>pathto</parameter></term>
35
+
<term><parameter>directory</parameter></term>
37
36
<listitem>
38
37
<para>
39
-
Path within an archive to the file to delete.
38
+
Path to extract the given <parameter>files</parameter> to
40
39
</para>
41
40
</listitem>
42
41
</varlistentry>
...
...
@@ -44,7 +43,8 @@
44
43
<term><parameter>files</parameter></term>
45
44
<listitem>
46
45
<para>
47
-
The name of a file or directory to extract, or an array of files/directories to extract
46
+
The name of a file or directory to extract, or an array of files/directories to extract,
47
+
&null; to skip this param
48
48
</para>
49
49
</listitem>
50
50
</varlistentry>
...
...
@@ -102,6 +102,11 @@ try {
102
102
</para>
103
103
</refsect1>
104
104

105
+
<refsect1 role="notes">
106
+
&reftitle.notes;
107
+
&note.extractto-windows;
108
+
</refsect1>
109
+

105
110
<refsect1 role="seealso">
106
111
&reftitle.seealso;
107
112
<para>
...
...
@@ -112,7 +117,6 @@ try {
112
117
</refsect1>
113
118

114
119
</refentry>
115
-

116
120
<!-- Keep this comment at the end of the file
117
121
Local variables:
118
122
mode: sgml
119
123