ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
BIFFwriter.php
Go to the documentation of this file.
1<?php
2/*
3* Module written/ported by Xavier Noguer <xnoguer@php.net>
4*
5* The majority of this is _NOT_ my code. I simply ported it from the
6* PERL Spreadsheet::WriteExcel module.
7*
8* The author of the Spreadsheet::WriteExcel module is John McNamara
9* <jmcnamara@cpan.org>
10*
11* I _DO_ maintain this code, and John McNamara has nothing to do with the
12* porting of this code to PHP. Any questions directly related to this
13* class library should be directed to me.
14*
15* License Information:
16*
17* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets
18* Copyright (c) 2002-2003 Xavier Noguer xnoguer@php.net
19*
20* This library is free software; you can redistribute it and/or
21* modify it under the terms of the GNU Lesser General Public
22* License as published by the Free Software Foundation; either
23* version 2.1 of the License, or (at your option) any later version.
24*
25* This library is distributed in the hope that it will be useful,
26* but WITHOUT ANY WARRANTY; without even the implied warranty of
27* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
28* Lesser General Public License for more details.
29*
30* You should have received a copy of the GNU Lesser General Public
31* License along with this library; if not, write to the Free Software
32* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33*/
34
35require_once 'PEAR.php';
36
55{
60 var $_BIFF_version = 0x0500;
61
67
72 var $_data;
73
79
86
92
99 {
100 $this->_byte_order = '';
101 $this->_data = '';
102 $this->_datasize = 0;
103 $this->_limit = 2080;
104 $this->_tmp_dir = '';
105 // Set the byte order
106 $this->_setByteOrder();
107 }
108
115 function _setByteOrder()
116 {
117 // Check if "pack" gives the required IEEE 64bit float
118 $teststr = pack("d", 1.2345);
119 $number = pack("C8", 0x8D, 0x97, 0x6E, 0x12, 0x83, 0xC0, 0xF3, 0x3F);
120 if ($number == $teststr) {
121 $byte_order = 0; // Little Endian
122 } elseif ($number == strrev($teststr)){
123 $byte_order = 1; // Big Endian
124 } else {
125 // Give up. I'll fix this in a later version.
126 return $this->raiseError("Required floating point format ".
127 "not supported on this platform.");
128 }
129 $this->_byte_order = $byte_order;
130 }
131
138 function _prepend($data)
139 {
140 if (strlen($data) > $this->_limit) {
141 $data = $this->_addContinue($data);
142 }
143 $this->_data = $data.$this->_data;
144 $this->_datasize += strlen($data);
145 }
146
153 function _append($data)
154 {
155 if (strlen($data) > $this->_limit) {
156 $data = $this->_addContinue($data);
157 }
158 $this->_data = $this->_data.$data;
159 $this->_datasize += strlen($data);
160 }
161
170 function _storeBof($type)
171 {
172 $record = 0x0809; // Record identifier
173
174 // According to the SDK $build and $year should be set to zero.
175 // However, this throws a warning in Excel 5. So, use magic numbers.
176 if ($this->_BIFF_version == 0x0500) {
177 $length = 0x0008;
178 $unknown = '';
179 $build = 0x096C;
180 $year = 0x07C9;
181 } elseif ($this->_BIFF_version == 0x0600) {
182 $length = 0x0010;
183 $unknown = pack("VV", 0x00000041, 0x00000006); //unknown last 8 bytes for BIFF8
184 $build = 0x0DBB;
185 $year = 0x07CC;
186 }
187 $version = $this->_BIFF_version;
188
189 $header = pack("vv", $record, $length);
190 $data = pack("vvvv", $version, $type, $build, $year);
191 $this->_prepend($header . $data . $unknown);
192 }
193
199 function _storeEof()
200 {
201 $record = 0x000A; // Record identifier
202 $length = 0x0000; // Number of bytes to follow
203 $header = pack("vv", $record, $length);
204 $this->_append($header);
205 }
206
220 {
221 $limit = $this->_limit;
222 $record = 0x003C; // Record identifier
223
224 // The first 2080/8224 bytes remain intact. However, we have to change
225 // the length field of the record.
226 $tmp = substr($data, 0, 2).pack("v", $limit-4).substr($data, 4, $limit - 4);
227
228 $header = pack("vv", $record, $limit); // Headers for continue records
229
230 // Retrieve chunks of 2080/8224 bytes +4 for the header.
231 $data_length = strlen($data);
232 for ($i = $limit; $i < ($data_length - $limit); $i += $limit) {
233 $tmp .= $header;
234 $tmp .= substr($data, $i, $limit);
235 }
236
237 // Retrieve the last chunk of data
238 $header = pack("vv", $record, strlen($data) - $i);
239 $tmp .= $header;
240 $tmp .= substr($data, $i, strlen($data) - $i);
241
242 return $tmp;
243 }
244
252 function setTempDir($dir)
253 {
254 if (is_dir($dir)) {
255 $this->_tmp_dir = $dir;
256 return true;
257 }
258 return false;
259 }
260}
261?>
& raiseError($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
This method is a wrapper that returns an instance of the configured error class with this object's de...
Definition: PEAR.php:524
_storeBof($type)
Writes Excel BOF record to indicate the beginning of a stream or sub-stream in the BIFF file.
Definition: BIFFwriter.php:170
_addContinue($data)
Excel limits the size of BIFF records.
Definition: BIFFwriter.php:219
setTempDir($dir)
Sets the temp dir used for storing the OLE file.
Definition: BIFFwriter.php:252
Spreadsheet_Excel_Writer_BIFFwriter()
Constructor.
Definition: BIFFwriter.php:98
_prepend($data)
General storage function.
Definition: BIFFwriter.php:138
_storeEof()
Writes Excel EOF record to indicate the end of a BIFF stream.
Definition: BIFFwriter.php:199
_setByteOrder()
Determine the byte order and store it as class data to avoid recalculating it for each call to new().
Definition: BIFFwriter.php:115
_append($data)
General storage function.
Definition: BIFFwriter.php:153
$header
$data