reference/phar/PharData/buildFromDirectory.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -3,15 +3,15 @@
3
3
<refentry xml:id="phardata.buildfromdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
4
<refnamediv>
5
5
<refname>PharData::buildFromDirectory</refname>
6
-
<refpurpose>Construct a tar/zip archive from the files within a directory.</refpurpose>
6
+
<refpurpose>Construct a tar/zip archive from the files within a directory</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<methodsynopsis>
12
-
<modifier>public</modifier> <type>array</type><methodname>Phar::buildFromDirectory</methodname>
13
-
<methodparam><type>string</type><parameter>base_dir</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>regex</parameter></methodparam>
11
+
<methodsynopsis role="PharData">
12
+
<modifier>public</modifier> <type>array</type><methodname>PharData::buildFromDirectory</methodname>
13
+
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
14
+
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter><initializer>""</initializer></methodparam>
15
15
</methodsynopsis>
16
16
17
17
<para>
...
...
@@ -27,7 +27,7 @@
27
27
<para>
28
28
<variablelist>
29
29
<varlistentry>
30
-
<term><parameter>base_dir</parameter></term>
30
+
<term><parameter>directory</parameter></term>
31
31
<listitem>
32
32
<para>
33
33
The full or relative path to the directory that contains all files
...
...
@@ -36,7 +36,7 @@
36
36
</listitem>
37
37
</varlistentry>
38
38
<varlistentry>
39
-
<term><parameter>regex</parameter></term>
39
+
<term><parameter>pattern</parameter></term>
40
40
<listitem>
41
41
<para>
42
42
An optional pcre regular expression that is used to filter the
...
...
@@ -54,7 +54,7 @@
54
54
<para>
55
55
<function>Phar::buildFromDirectory</function> returns an associative array
56
56
mapping internal path of file to the full path of the file on the
57
-
filesystem.
57
+
filesystem, &return.falseforfailure;.
58
58
</para>
59
59
</refsect1>
60
60
...
...
@@ -68,6 +68,28 @@
68
68
</para>
69
69
</refsect1>
70
70
71
+
<refsect1 role="changelog">
72
+
&reftitle.changelog;
73
+
<informaltable>
74
+
<tgroup cols="2">
75
+
<thead>
76
+
<row>
77
+
<entry>&Version;</entry>
78
+
<entry>&Description;</entry>
79
+
</row>
80
+
</thead>
81
+
<tbody>
82
+
<row>
83
+
<entry>8.1.0</entry>
84
+
<entry>
85
+
<methodname>PharData::buildFromDirectory</methodname> no longer returns &false;.
86
+
</entry>
87
+
</row>
88
+
</tbody>
89
+
</tgroup>
90
+
</informaltable>
91
+
</refsect1>
92
+
71
93
<refsect1 role="examples">
72
94
&reftitle.examples;
73
95
<example>
...
...
@@ -105,7 +127,6 @@ $phar2->buildFromDirectory(dirname(__FILE__) . '/project', '/\.php$/');
105
127
</refsect1>
106
128
107
129
</refentry>
108
-
109
130
<!-- Keep this comment at the end of the file
110
131
Local variables:
111
132
mode: sgml
112
133