Writer.php
3.84 KB
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
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Base class for any writer
*
* PHP versions 4 and 5
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330,Boston,MA 02111-1307 USA
*
* @category File Formats
* @package File_Archive
* @author Vincent Lascaux <vincentlascaux@php.net>
* @copyright 1997-2005 The PHP Group
* @license http://www.gnu.org/copyleft/lesser.html LGPL
* @version CVS: $Id: Writer.php,v 1.12 2005/05/31 21:22:02 vincentlascaux Exp $
* @link http://pear.php.net/package/File_Archive
*/
require_once "PEAR.php";
/**
* Base class for any writer
*/
class File_Archive_Writer
{
/**
* Create a new file in the writer
*
* @param string $filename Name of the file, eventually including a path
* @param array $stat Its Statistics. None of the indexes are required
* @param string $mime MIME type of the file
*/
function newFile($filename, $stat = array(), $mime = "application/octet-stream")
{
}
/**
* Create a new file in the writer with the content of the physical file $filename
* and then unlink $filename.
* newFromTempFile($tmpfile, $filename, $stat, $mime) is equivalent to
* newFile($filename, $stat, $mime); writeFile($tmpfile); unlink($tmpfile);
* but can be more efficient.
* A typical use is for File_Archive_Writer_Files: it renames the temporary
* file instead of copy/delete
*
* @param string $tmpfile Name of the physical file that contains data and will be unlinked
* @param string $filename Name of the file, eventually including a path
* @param array $stat Its Statistics. None of the indexes are required
* @param string $mime MIME type of the file
*/
function newFromTempFile($tmpfile, $filename, $stat = array(), $mime = "application/octet-stream")
{
$this->newFile($filename, $stat, $mime);
$this->writeFile($tmpfile);
unlink($tmpfile);
}
/**
* Returns whether the writer newFile function needs the $mime parameter
* Default is false
*/
function newFileNeedsMIME()
{
return false;
}
/**
* Append the specified data to the writer
*
* @param String $data the data to append to the writer
*/
function writeData($data)
{
}
/**
* Append the content of the physical file $filename to the writer
* writeFile($filename) must be equivalent to
* writeData(file_get_contents($filename)) but can be more efficient
*
* @param string $filename Name of the file which content must be appended
* to the writer
*/
function writeFile($filename)
{
$handle = fopen($filename, "r");
if (!is_resource($handle)) {
return PEAR::raiseError("Unable to write to $filename");
}
while (!feof($handle)) {
$error = $this->writeData(fread($handle, 102400));
if (PEAR::isError($error)) {
return $error;
}
}
fclose($handle);
}
/**
* Close the writer, eventually flush the data, write the footer...
* This function must be called before the end of the script
*/
function close() { }
}
?>