reference/phar/PharData/addFile.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -1,16 +1,16 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phardata.addfile">
3
+
<refentry xml:id="phardata.addfile" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>PharData::addFile</refname>
6
6
<refpurpose>Add a file from the filesystem to the tar/zip archive</refpurpose>
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
-
<methodsynopsis>
11
-
<modifier>public</modifier> <type>void</type><methodname>Phar::addFile</methodname>
12
-
<methodparam><type>string</type><parameter>file</parameter></methodparam>
13
-
<methodparam choice="opt"><type>string</type><parameter>localname</parameter></methodparam>
10
+
<methodsynopsis role="PharData">
11
+
<modifier>public</modifier> <type>void</type><methodname>PharData::addFile</methodname>
12
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>localName</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
16
16
<para>
...
...
@@ -28,7 +28,7 @@
28
28
<para>
29
29
<variablelist>
30
30
<varlistentry>
31
-
<term><parameter>file</parameter></term>
31
+
<term><parameter>filename</parameter></term>
32
32
<listitem>
33
33
<para>
34
34
Full or relative path to a file on disk to be added
...
...
@@ -37,7 +37,7 @@
37
37
</listitem>
38
38
</varlistentry>
39
39
<varlistentry>
40
-
<term><parameter>localname</parameter></term>
40
+
<term><parameter>localName</parameter></term>
41
41
<listitem>
42
42
<para>
43
43
Path that the file will be stored in the archive.
...
...
@@ -55,6 +55,28 @@
55
55
</para>
56
56
</refsect1>
57
57
58
+
<refsect1 role="changelog">
59
+
&reftitle.changelog;
60
+
<informaltable>
61
+
<tgroup cols="2">
62
+
<thead>
63
+
<row>
64
+
<entry>&Version;</entry>
65
+
<entry>&Description;</entry>
66
+
</row>
67
+
</thead>
68
+
<tbody>
69
+
<row>
70
+
<entry>8.0.0</entry>
71
+
<entry>
72
+
<parameter>localName</parameter> is now nullable.
73
+
</entry>
74
+
</row>
75
+
</tbody>
76
+
</tgroup>
77
+
</informaltable>
78
+
</refsect1>
79
+
58
80
<refsect1 role="examples">
59
81
&reftitle.examples;
60
82
<para>
...
...
@@ -85,6 +107,11 @@ try {
85
107
</para>
86
108
</refsect1>
87
109
110
+
<refsect1 role="notes">
111
+
&reftitle.notes;
112
+
&phardata.note.performance;
113
+
</refsect1>
114
+
88
115
<refsect1 role="seealso">
89
116
&reftitle.seealso;
90
117
<para>
...
...
@@ -99,7 +126,6 @@ try {
99
126
100
127
101
128
</refentry>
102
-
103
129
<!-- Keep this comment at the end of the file
104
130
Local variables:
105
131
mode: sgml
106
132