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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="phardata.buildfromiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>PharData::buildFromIterator</refname>
<refpurpose>Construct a tar or zip archive from an iterator.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>PharData::buildFromIterator</methodname>
<methodparam><type>Iterator</type><parameter>iter</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>base_directory</parameter></methodparam>
</methodsynopsis>
<para>
Populate a tar or zip archive from an iterator. Two styles of iterators are supported,
iterators that map the filename within the tar/zip to the name of a file on disk,
and iterators like DirectoryIterator that return
SplFileInfo objects. For iterators that return SplFileInfo objects, the second
parameter is required.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>A <function>PharData::buildFromIterator</function> with SplFileInfo</title>
<para>
For most tar/zip archives, the archive will reflect an actual directory layout, and
the second style is the most useful. For instance, to create a tar/zip archive
containing the files in this sample directory layout:
</para>
<para>
<screen>
<![CDATA[
/path/to/project/
config/
dist.xml
debug.xml
lib/
file1.php
file2.php
src/
processthing.php
www/
index.php
cli/
index.php
]]>
</screen>
</para>
<para>
This code could be used to add these files to the "project.tar" tar archive:
</para>
<para>
<programlisting role="php">
<![CDATA[
<?php
$phar = new PharData('project.tar');
$phar->buildFromIterator(
new RecursiveIteratorIterator(
new RecursiveDirectoryIterator('/path/to/project')),
'/path/to/project');
?>
]]>
</programlisting>
</para>
<para>
The file <literal>project.tar</literal> can then be used immediately. <function>PharData::buildFromIterator</function> does not
set values such as compression, metadata, and this can be done after creating the
tar/zip archive.
</para>
<para>
As an interesting note, <function>PharData::buildFromIterator</function> can also be used to
copy the contents of an existing phar, tar or zip archive, as the PharData object descends
from <classname>DirectoryIterator</classname>:
</para>
<para>
<programlisting role="php">
<![CDATA[
<?php
$phar = new PharData('project.tar');
$phar->buildFromIterator(
new RecursiveIteratorIterator(
new Phar('/path/to/anotherphar.phar')),
'phar:///path/to/anotherphar.phar/path/to/project');
$phar->setStub($phar->createDefaultWebStub('cli/index.php', 'www/index.php'));
?>
]]>
</programlisting>
</para>
</example>
<example>
<title>A <function>PharData::buildFromIterator</function> with other iterators</title>
<para>
The second form of the iterator can be used with any iterator that returns
a key => value mapping, such as an <classname>ArrayIterator</classname>:
</para>
<para>
<programlisting role="php">
<![CDATA[
<?php
$phar = new PharData('project.tar');
$phar->buildFromIterator(
new ArrayIterator(
array(
'internal/file.php' => dirname(__FILE__) . '/somefile.php',
'another/file.jpg' => fopen('/path/to/bigfile.jpg', 'rb'),
)));
?>
]]>
</programlisting>
</para>
</example>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>iter</parameter></term>
<listitem>
<para>
Any iterator that either associatively maps tar/zip file to location or
returns SplFileInfo objects
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>base_directory</parameter></term>
<listitem>
<para>
For iterators that return SplFileInfo objects, the portion of each
file's full path to remove when adding to the tar/zip archive
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>PharData::buildFromIterator</function> returns an associative array
mapping internal path of file to the full path of the file on the
filesystem.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
This method returns <classname>UnexpectedValueException</classname> when the
iterator returns incorrect values, such as an integer key instead of a
string, a <classname>BadMethodCallException</classname> when an
SplFileInfo-based iterator is passed without a <parameter>base_directory</parameter>
parameter, or a <classname>PharException</classname> if there were errors
saving the phar archive.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::buildFromIterator</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
-->
|
