Source for file Workbook.php
Documentation is available at Workbook.php
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com>
* The majority of this is _NOT_ my code. I simply ported it from the
* PERL Spreadsheet::WriteExcel module.
* The author of the Spreadsheet::WriteExcel module is John McNamara
* I _DO_ maintain this code, and John McNamara has nothing to do with the
* porting of this code to PHP. Any questions directly related to this
* class library should be directed to me.
* PHPExcel_Writer_Excel5_Writer: A library for generating Excel Spreadsheets
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com
* 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
require_once 'PHPExcel/Writer/Excel5/Format.php';
require_once 'PHPExcel/Writer/Excel5/BIFFwriter.php';
require_once 'PHPExcel/Writer/Excel5/Worksheet.php';
require_once 'PHPExcel/Writer/Excel5/Parser.php';
require_once 'PHPExcel/Shared/Date.php';
require_once 'PHPExcel/Shared/OLE/OLE_Root.php';
require_once 'PHPExcel/Shared/OLE/OLE_File.php';
require_once 'PHPExcel/Shared/String.php';
* Class for generating Excel Spreadsheets
* @author Xavier Noguer <xnoguer@rezebra.com>
* @package PHPExcel_Writer_Excel5
* Filename for the Workbook
* The active worksheet of the workbook (0 indexed)
* 1st displayed worksheet in the workbook (0 indexed)
* Number of workbook tabs selected
* Index for creating adding new formats to the workbook
* Flag for preventing close from being called twice.
* The BIFF file size for the workbook.
* @see _calcSheetOffsets()
* The default sheetname for all sheets created.
* Array containing references to all of this workbook's worksheets
* Array of sheetnames for creating the EXTERNSHEET records
* Array containing references to all of this workbook's formats
* Array containing the colour palette
* The default format for URLs.
* The codepage indicates the text encoding used for strings
* The country code used for localization
* The temporary dir for storing the OLE file
* number of bytes for sizeinfo of strings
* @param string filename for storing the workbook. "-" for writing to stdout.
* @param PHPExcel $phpExcel The Workbook
// It needs to call its parent's constructor explicitly
$this->_xf_index = 16; // 15 style XF's and 1 cell XF.
$this->_tmp_format->setFontFamily($phpExcel->getSheet(0)->getDefaultStyle()->getFont()->getName());
$this->_tmp_format->setSize($phpExcel->getSheet(0)->getDefaultStyle()->getFont()->getSize());
$this->_codepage = 0x04E4; // FIXME: should change for BIFF8
$this->_string_sizeinfo = 3;
// Add the default format for hyperlinks
$this->_str_table = array();
* Calls finalization methods.
* This method should always be the last one to be called on every workbook
* @return mixed true on success
if ($this->_fileclosed) { // Prevent close() from being called twice.
* An accessor for the _worksheets[] array
* Returns an array of the worksheet objects in a workbook
* It actually calls to worksheets()
* An accessor for the _worksheets[] array.
* Returns an array of the worksheet objects in a workbook
* This method exists just to access experimental functionality
* from BIFF8. It will be deprecated !
* Only possible value is 8 (Excel 97/2000).
* For any other value it fails silently.
* @param integer $version The BIFF version
if ($version == 8) { // only accept version 8
// change BIFFwriter limit for CONTINUE records
$this->_parser->_BIFF_version = $version;
// change version for all worksheets too
for ($i = 0; $i < $total_worksheets; ++ $i) {
// change version for all formats too
for ($i = 0; $i < $total_formats; ++ $i) {
$this->_formats[$i]->_BIFF_version = $version;
* Set the country identifier for the workbook
* @param integer $code Is the international calling country code for the
* Add a new worksheet to the Excel workbook.
* If no name is given the name of the worksheet will be Sheeti$i, with
* @param string $name the optional name of the worksheet
* @param PHPExcel_Worksheet $phpSheet
* @return mixed reference to a worksheet object on success
$name = $sheetname. ($index+ 1);
// Check that sheetname is <= 31 chars (Excel limit before BIFF8).
throw new Exception("Sheetname $name must be <= 31 chars");
// Check that the worksheet name doesn't already exist: a fatal Excel error.
for ($i = 0; $i < $total_worksheets; ++ $i) {
throw new Exception("Worksheet '$name' already exists");
$this->_str_total, $this->_str_unique,
$this->_worksheets[$index] = &$worksheet; // Store ref for iterator
$this->_sheetnames[$index] = $name; // Store EXTERNSHEET names
$this->_parser->setExtSheet($name, $index); // Register worksheet name with parser
$ref = pack('vvv', $supbook_index, $total_worksheets, $total_worksheets);
$this->_parser->_references[] = $ref; // Register reference with parser
* Add a new format to the Excel workbook.
* Also, pass any properties to the Format constructor.
* @param array $properties array with properties for initializing the format.
* @return &PHPExcel_Writer_Excel5_Format reference to an Excel Format
* Change the RGB components of the elements in the colour palette.
* @param integer $index colour index
* @param integer $red red RGB value [0-255]
* @param integer $green green RGB value [0-255]
* @param integer $blue blue RGB value [0-255]
* @return integer The palette index for the custom color
// Match a HTML #xxyyzz style parameter
/*if (defined $_[1] and $_[1] =~ /^#(\w\w)(\w\w)(\w\w)/ ) {
@_ = ($_[0], hex $1, hex $2, hex $3);
// Check that the colour index is the right range
if ($index < 8 or $index > 64) {
// TODO: assign real error codes
throw new Exception("Color index $index outside range: 8 <= index <= 64");
// Check that the colour components are in the right range
if (($red < 0 or $red > 255) ||
($green < 0 or $green > 255) ||
($blue < 0 or $blue > 255))
throw new Exception("Color component outside range: 0 <= color <= 255");
$index -= 8; // Adjust colour index (wingless dragonfly)
$this->_palette[$index] = array($red, $green, $blue, 0);
* Sets the colour palette to the Excel 97+ default.
array(0x00, 0x00, 0x00, 0x00), // 8
array(0xff, 0xff, 0xff, 0x00), // 9
array(0xff, 0x00, 0x00, 0x00), // 10
array(0x00, 0xff, 0x00, 0x00), // 11
array(0x00, 0x00, 0xff, 0x00), // 12
array(0xff, 0xff, 0x00, 0x00), // 13
array(0xff, 0x00, 0xff, 0x00), // 14
array(0x00, 0xff, 0xff, 0x00), // 15
array(0x80, 0x00, 0x00, 0x00), // 16
array(0x00, 0x80, 0x00, 0x00), // 17
array(0x00, 0x00, 0x80, 0x00), // 18
array(0x80, 0x80, 0x00, 0x00), // 19
array(0x80, 0x00, 0x80, 0x00), // 20
array(0x00, 0x80, 0x80, 0x00), // 21
array(0xc0, 0xc0, 0xc0, 0x00), // 22
array(0x80, 0x80, 0x80, 0x00), // 23
array(0x99, 0x99, 0xff, 0x00), // 24
array(0x99, 0x33, 0x66, 0x00), // 25
array(0xff, 0xff, 0xcc, 0x00), // 26
array(0xcc, 0xff, 0xff, 0x00), // 27
array(0x66, 0x00, 0x66, 0x00), // 28
array(0xff, 0x80, 0x80, 0x00), // 29
array(0x00, 0x66, 0xcc, 0x00), // 30
array(0xcc, 0xcc, 0xff, 0x00), // 31
array(0x00, 0x00, 0x80, 0x00), // 32
array(0xff, 0x00, 0xff, 0x00), // 33
array(0xff, 0xff, 0x00, 0x00), // 34
array(0x00, 0xff, 0xff, 0x00), // 35
array(0x80, 0x00, 0x80, 0x00), // 36
array(0x80, 0x00, 0x00, 0x00), // 37
array(0x00, 0x80, 0x80, 0x00), // 38
array(0x00, 0x00, 0xff, 0x00), // 39
array(0x00, 0xcc, 0xff, 0x00), // 40
array(0xcc, 0xff, 0xff, 0x00), // 41
array(0xcc, 0xff, 0xcc, 0x00), // 42
array(0xff, 0xff, 0x99, 0x00), // 43
array(0x99, 0xcc, 0xff, 0x00), // 44
array(0xff, 0x99, 0xcc, 0x00), // 45
array(0xcc, 0x99, 0xff, 0x00), // 46
array(0xff, 0xcc, 0x99, 0x00), // 47
array(0x33, 0x66, 0xff, 0x00), // 48
array(0x33, 0xcc, 0xcc, 0x00), // 49
array(0x99, 0xcc, 0x00, 0x00), // 50
array(0xff, 0xcc, 0x00, 0x00), // 51
array(0xff, 0x99, 0x00, 0x00), // 52
array(0xff, 0x66, 0x00, 0x00), // 53
array(0x66, 0x66, 0x99, 0x00), // 54
array(0x96, 0x96, 0x96, 0x00), // 55
array(0x00, 0x33, 0x66, 0x00), // 56
array(0x33, 0x99, 0x66, 0x00), // 57
array(0x00, 0x33, 0x00, 0x00), // 58
array(0x33, 0x33, 0x00, 0x00), // 59
array(0x99, 0x33, 0x00, 0x00), // 60
array(0x99, 0x33, 0x66, 0x00), // 61
array(0x33, 0x33, 0x99, 0x00), // 62
array(0x33, 0x33, 0x33, 0x00), // 63
* Assemble worksheets into a workbook and send the BIFF data to an OLE
* @return mixed true on success
// Ensure that at least one worksheet has been selected.
// Calculate the number of selected worksheet tabs and call the finalization
// methods for each worksheet
for ($i = 0; $i < $total_worksheets; ++ $i) {
// Add part 1 of the Workbook globals, what goes before the SHEET records
$this->_storeNames(); // For print area and repeat rows
// Prepare part 3 of the workbook global stream, what goes after the SHEET records
/* TODO: store external SUPBOOK records and XCT and CRN records
in case of external references for BIFF8 */
// Add part 2 of the Workbook globals, the SHEET records
for ($i = 0; $i < $total_worksheets; ++ $i) {
// Add part 3 of the Workbook globals
// Store the workbook in an OLE container
* Sets the temp dir used for storing the OLE file
* @param string $dir The dir to be used as temp dir
* @return true if given dir is valid, false otherwise
* Store the workbook in an OLE container
* @return mixed true on success
$OLE->append($this->_data);
for ($i = 0; $i < $total_worksheets; ++ $i) {
* Calculate offsets for Worksheet BOF records.
$boundsheet_length = 12; // fixed length for a BOUNDSHEET record
// size of Workbook globals part 1 + 3
// add size of Workbook globals part 2, the length of the SHEET records
for ($i = 0; $i < $total_worksheets; ++ $i) {
// sheet name is stored in uncompressed notation
// sheet name is stored in compressed notation, and ASCII is assumed
// add the sizes of each of the Sheet substreams, respectively
for ($i = 0; $i < $total_worksheets; ++ $i) {
* Store the Excel FONT records.
// tmp_format is added by the constructor. We use this to write the default XF's
$font = $format->getFont();
// Note: Fonts are 0-indexed. According to the SDK there is no index 4,
// so the following fonts are 0, 1, 2, 3, 5
for ($i = 1; $i <= 5; ++ $i){
// Iterate through the XF objects and write a FONT record if it isn't the
// same as the default FONT and if it hasn't already been used.
$index = 6; // The first user defined FONT
$key = $format->getFontKey(); // The default font from _tmp_format
$fonts[$key] = 0; // Index of the default font
for ($i = 0; $i < $total_formats; ++ $i) {
$key = $this->_formats[$i]->getFontKey();
if (isset ($fonts[$key])) {
// FONT has already been used
$this->_formats[$i]->font_index = $fonts[$key];
$this->_formats[$i]->font_index = $index;
* Store user defined numerical formats i.e. FORMAT records
// Leaning num_format syndrome
$hash_num_formats = array();
// Iterate through the XF objects and write a FORMAT record if it isn't a
// built-in format type and if the FORMAT string hasn't already been used.
for ($i = 0; $i < $total_formats; ++ $i) {
$num_format = $this->_formats[$i]->_num_format;
//////////////////////////////////////////////////////////////////////////////////////////
// Removing this block for now. No true support for built-in number formats in PHPExcel //
//////////////////////////////////////////////////////////////////////////////////////////
// Check if $num_format is an index to a built-in format.
// Also check for a string of zeros, which is a valid format string
// but would evaluate to zero.
if (!preg_match("/^0+\d/", $num_format)) {
if (preg_match("/^\d+$/", $num_format)) { // built-in format
if (isset ($hash_num_formats[$num_format])) {
// FORMAT has already been used
$this->_formats[$i]->_num_format = $hash_num_formats[$num_format];
$hash_num_formats[$num_format] = $index;
$this->_formats[$i]->_num_format = $index;
$num_formats[] = $num_format;
// Write the new FORMAT records starting from 0xA4
foreach ($num_formats as $num_format) {
// _tmp_format is added by the constructor. We use this to write the default XF's
// The default font index is 0
for ($i = 0; $i <= 14; ++ $i) {
$xf = $format->getXf('style'); // Style XF
$xf = $format->getXf('cell'); // Cell XF
for ($i = 0; $i < $total_formats; ++ $i) {
$xf = $this->_formats[$i]->getXf('cell');
* Write all STYLE records.
* Write the EXTERNCOUNT and EXTERNSHEET records. These are used as indexes for
// Create EXTERNCOUNT with number of worksheets
// Create EXTERNSHEET for each worksheet
* Write the NAME record to define the print area and the repeat rows and cols.
// Create the print area NAME records
for ($i = 0; $i < $total_worksheets; ++ $i) {
// Write a Name record if the print area has been defined
// Create the print title NAME records
for ($i = 0; $i < $total_worksheets; ++ $i) {
// Determine if row + col, row, col or nothing has been defined
// and write the appropriate record
if (isset ($rowmin) && isset ($colmin)) {
// Row and column titles have been defined.
// Row title has been defined.
} elseif (isset ($rowmin)) {
// Row title has been defined.
} elseif (isset ($colmin)) {
// Column title has been defined.
// Print title hasn't been defined.
* Writes all the DEFINEDNAME records (BIFF8).
* So far this is only used for repeating rows/columns (print titles) and print areas
// write the print titles (repeating rows, columns), if any
for ($i = 0; $i < $total_worksheets; ++ $i) {
// repeatColumns / repeatRows
if ($this->_phpExcel->getSheet($i)->getPageSetup()->isColumnsToRepeatAtLeftSet() || $this->_phpExcel->getSheet($i)->getPageSetup()->isRowsToRepeatAtTopSet()) {
// Row and column titles have been defined
if ($this->_phpExcel->getSheet($i)->getPageSetup()->isColumnsToRepeatAtLeftSet()) {
$repeat = $this->_phpExcel->getSheet($i)->getPageSetup()->getColumnsToRepeatAtLeft();
if ($this->_phpExcel->getSheet($i)->getPageSetup()->isRowsToRepeatAtTopSet()) {
$repeat = $this->_phpExcel->getSheet($i)->getPageSetup()->getRowsToRepeatAtTop();
$rowmin = $repeat[0] - 1;
$rowmax = $repeat[1] - 1;
// construct formula data manually because parser does not recognize absolute 3d cell references
$formulaData = pack('Cvvvvv', 0x3B, $i, $rowmin, $rowmax, $colmin, $colmax);
// store the DEFINEDNAME record
// write the print areas, if any
for ($i = 0; $i < $total_worksheets; ++ $i) {
if ($this->_phpExcel->getSheet($i)->getPageSetup()->isPrintAreaSet()) {
$print_rowmin = $printArea[0][1] - 1;
$print_rowmax = $printArea[1][1] - 1;
// construct formula data manually because parser does not recognize absolute 3d cell references
$formulaData = pack('Cvvvvv', 0x3B, $i, $print_rowmin, $print_rowmax, $print_colmin, $print_colmax);
// store the DEFINEDNAME record
* Write a DEFINEDNAME record for BIFF8 using explicit binary formula data
* @param string $name The name in UTF-8
* @param string $formulaData The binary formula data
* @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global
* @param boolean $isBuiltIn Built-in name?
* @return string Complete binary record data
$options = $isBuiltIn ? 0x20 : 0x00;
// length of the name, character count
// name with stripped length field
// size of the formula (in bytes)
$data = pack('vCCvvvCCCC', $options, 0, $nlen, $sz, 0, $sheetIndex, 0, 0, 0, 0)
$header = pack('vv', $record, $length);
/******************************************************************************
* Stores the CODEPAGE biff record.
$record = 0x0042; // Record identifier
$length = 0x0002; // Number of bytes to follow
$header = pack('vv', $record, $length);
* Write Excel BIFF WINDOW1 record.
$record = 0x003D; // Record identifier
$length = 0x0012; // Number of bytes to follow
$xWn = 0x0000; // Horizontal position of window
$yWn = 0x0000; // Vertical position of window
$dxWn = 0x25BC; // Width of window
$dyWn = 0x1572; // Height of window
$grbit = 0x0038; // Option flags
$ctabsel = $this->_selected; // Number of workbook tabs selected
$wTabRatio = 0x0258; // Tab to scrollbar ratio
$itabFirst = $this->_firstsheet; // 1st displayed worksheet
$header = pack("vv", $record, $length);
$data = pack("vvvvvvvvv", $xWn, $yWn, $dxWn, $dyWn,
* Writes Excel BIFF BOUNDSHEET record.
* FIXME: inconsistent with BIFF documentation
* @param string $sheetname Worksheet name
* @param integer $offset Location of worksheet BOF
$record = 0x0085; // Record identifier
//$recordData = $this->_writeUnicodeDataShort($sheetname);
$length = 0x06 + strlen($recordData); // Number of bytes to follow
$length = 0x07 + strlen($sheetname); // Number of bytes to follow
$grbit = 0x0000; // Visibility and sheet type
$header = pack("vv", $record, $length);
$data = pack("Vv", $offset, $grbit);
$this->_append($header. $data. $recordData);
$cch = strlen($sheetname); // Length of sheet name
$data = pack("VvC", $offset, $grbit, $cch);
$this->_append($header. $data. $sheetname);
* Write Internal SUPBOOK record
$record = 0x01AE; // Record identifier
$length = 0x0004; // Bytes to follow
$header = pack("vv", $record, $length);
//$data = pack("vv", count($this->_worksheets), 0x0104);
//$this->_append($header . $data);
* Writes the Excel BIFF EXTERNSHEET record. These references are used by
* @param string $sheetname Worksheet name
$record = 0x0017; // Record identifier
$length = 2 + 6 * $total_references; // Number of bytes to follow
$supbook_index = 0; // FIXME: only using internal SUPBOOK record
$header = pack("vv", $record, $length);
$data = pack('v', $total_references);
for ($i = 0; $i < $total_references; ++ $i) {
$data .= $this->_parser->_references[$i];
//$this->_append($header . $data);
* Write Excel BIFF STYLE records.
$record = 0x0293; // Record identifier
$length = 0x0004; // Bytes to follow
$ixfe = 0x8000; // Index to style XF
$BuiltIn = 0x00; // Built-in style
$iLevel = 0xff; // Outline style level
$header = pack("vv", $record, $length);
$data = pack("vCC", $ixfe, $BuiltIn, $iLevel);
* Writes Excel FORMAT record for non "built-in" numerical formats.
* @param string $format Custom format string
* @param integer $ifmt Format index code
$record = 0x041E; // Record identifier
//$numberFormatString = $this->_writeUnicodeDataLong($format);
$length = 2 + strlen($numberFormatString); // Number of bytes to follow
$length = 3 + strlen($format); // Number of bytes to follow
$header = pack("vv", $record, $length);
$data = pack("v", $ifmt) . $numberFormatString;
$cch = strlen($format); // Length of format string
$data = pack("vC", $ifmt, $cch);
$this->_append($header . $data . $format);
* Write DATEMODE record to indicate the date system in use (1904 or 1900).
$record = 0x0022; // Record identifier
$length = 0x0002; // Bytes to follow
1 : 0; // Flag for 1904 date system
$header = pack("vv", $record, $length);
$data = pack("v", $f1904);
* Write BIFF record EXTERNCOUNT to indicate the number of external sheet
* references in the workbook.
* Excel only stores references to external sheets that are used in NAME.
* The workbook NAME record is required to define the print area and the repeat
* A similar method is used in Worksheet.php for a slightly different purpose.
* @param integer $cxals Number of external references
$record = 0x0016; // Record identifier
$length = 0x0002; // Number of bytes to follow
$header = pack("vv", $record, $length);
$data = pack("v", $cxals);
* Writes the Excel BIFF EXTERNSHEET record. These references are used by
* formulas. NAME record is required to define the print area and the repeat
* A similar method is used in Worksheet.php for a slightly different purpose.
* @param string $sheetname Worksheet name
$record = 0x0017; // Record identifier
$length = 0x02 + strlen($sheetname); // Number of bytes to follow
$cch = strlen($sheetname); // Length of sheet name
$rgch = 0x03; // Filename encoding
$header = pack("vv", $record, $length);
$data = pack("CC", $cch, $rgch);
$this->_append($header . $data . $sheetname);
* Store the NAME record in the short format that is used for storing the print
* area, repeat rows only and repeat columns only.
* @param integer $index Sheet index
* @param integer $type Built-in name type
* @param integer $rowmin Start row
* @param integer $rowmax End row
* @param integer $colmin Start colum
* @param integer $colmax End column
function _storeNameShort($index, $type, $rowmin, $rowmax, $colmin, $colmax)
$record = 0x0018; // Record identifier
$length = 0x0024; // Number of bytes to follow
$grbit = 0x0020; // Option flags
$chKey = 0x00; // Keyboard shortcut
$cch = 0x01; // Length of text name
$cce = 0x0015; // Length of text definition
$ixals = $index + 1; // Sheet index
$itab = $ixals; // Equal to ixals
$cchCustMenu = 0x00; // Length of cust menu text
$cchDescription = 0x00; // Length of description text
$cchHelptopic = 0x00; // Length of help topic text
$cchStatustext = 0x00; // Length of status bar text
$rgch = $type; // Built-in name type
$unknown04 = 0xffff- $index;
$header = pack("vv", $record, $length);
$data = pack("v", $grbit);
$data .= pack("C", $chKey);
$data .= pack("C", $cch);
$data .= pack("v", $cce);
$data .= pack("v", $ixals);
$data .= pack("v", $itab);
$data .= pack("C", $cchCustMenu);
$data .= pack("C", $cchDescription);
$data .= pack("C", $cchHelptopic);
$data .= pack("C", $cchStatustext);
$data .= pack("C", $rgch);
$data .= pack("C", $unknown03);
$data .= pack("v", $unknown04);
$data .= pack("v", $unknown05);
$data .= pack("v", $unknown06);
$data .= pack("v", $unknown07);
$data .= pack("v", $unknown08);
$data .= pack("v", $index);
$data .= pack("v", $index);
$data .= pack("v", $rowmin);
$data .= pack("v", $rowmax);
$data .= pack("C", $colmin);
$data .= pack("C", $colmax);
* Store the NAME record in the long format that is used for storing the repeat
* rows and columns when both are specified. This shares a lot of code with
* _storeNameShort() but we use a separate method to keep the code clean.
* Code abstraction for reuse can be carried too far, and I should know. ;-)
* @param integer $index Sheet index
* @param integer $type Built-in name type
* @param integer $rowmin Start row
* @param integer $rowmax End row
* @param integer $colmin Start colum
* @param integer $colmax End column
function _storeNameLong($index, $type, $rowmin, $rowmax, $colmin, $colmax)
$record = 0x0018; // Record identifier
$length = 0x003d; // Number of bytes to follow
$grbit = 0x0020; // Option flags
$chKey = 0x00; // Keyboard shortcut
$cch = 0x01; // Length of text name
$cce = 0x002e; // Length of text definition
$ixals = $index + 1; // Sheet index
$itab = $ixals; // Equal to ixals
$cchCustMenu = 0x00; // Length of cust menu text
$cchDescription = 0x00; // Length of description text
$cchHelptopic = 0x00; // Length of help topic text
$cchStatustext = 0x00; // Length of status bar text
$rgch = $type; // Built-in name type
$unknown04 = 0xffff- $index;
$header = pack("vv", $record, $length);
$data = pack("v", $grbit);
$data .= pack("C", $chKey);
$data .= pack("C", $cch);
$data .= pack("v", $cce);
$data .= pack("v", $ixals);
$data .= pack("v", $itab);
$data .= pack("C", $cchCustMenu);
$data .= pack("C", $cchDescription);
$data .= pack("C", $cchHelptopic);
$data .= pack("C", $cchStatustext);
$data .= pack("C", $rgch);
$data .= pack("C", $unknown01);
$data .= pack("v", $unknown02);
$data .= pack("C", $unknown03);
$data .= pack("v", $unknown04);
$data .= pack("v", $unknown05);
$data .= pack("v", $unknown06);
$data .= pack("v", $unknown07);
$data .= pack("v", $unknown08);
$data .= pack("v", $index);
$data .= pack("v", $index);
$data .= pack("v", 0x0000);
$data .= pack("v", 0x3fff);
$data .= pack("C", $colmin);
$data .= pack("C", $colmax);
$data .= pack("C", $unknown03);
$data .= pack("v", $unknown04);
$data .= pack("v", $unknown05);
$data .= pack("v", $unknown06);
$data .= pack("v", $unknown07);
$data .= pack("v", $unknown08);
$data .= pack("v", $index);
$data .= pack("v", $index);
$data .= pack("v", $rowmin);
$data .= pack("v", $rowmax);
$data .= pack("C", 0x00);
$data .= pack("C", 0xff);
$data .= pack("C", 0x10);
* Stores the COUNTRY record for localization
$record = 0x008C; // Record identifier
$length = 4; // Number of bytes to follow
$header = pack('vv', $record, $length);
/* using the same country code always for simplicity */
//$this->_append($header . $data);
* Stores the PALETTE biff record.
$record = 0x0092; // Record identifier
$length = 2 + 4 * count($aref); // Number of bytes to follow
$ccv = count($aref); // Number of RGB values to follow
$data = ''; // The RGB data
foreach ($aref as $color) {
foreach ($color as $byte) {
$data .= pack("C",$byte);
$header = pack("vvv", $record, $length, $ccv);
* Handling of the SST continue blocks is complicated by the need to include an
* additional continuation byte depending on whether the string is split between
* blocks or whether it starts at the beginning of the block. (There are also
* additional complications that will arise later when/if Rich Strings are
/* Iterate through the strings to calculate the CONTINUE block sizes.
For simplicity we use the same size for the SST and CONTINUE records:
8228 : Maximum Excel97 block size
-4 : Length of block header
-8 : Length of additional SST header information
$this->_block_sizes = array();
foreach (array_keys($this->_str_table) as $string) {
$string_length = strlen($string);
$headerinfo = unpack("vlength/Cencoding", $string);
$encoding = $headerinfo["encoding"];
// Block length is the total length of the strings that will be
// written out in a single SST or CONTINUE block.
$block_length += $string_length;
// We can write the string if it doesn't cross a CONTINUE boundary
if ($block_length < $continue_limit) {
$written += $string_length;
// Deal with the cases where the next string to be written will exceed
// the CONTINUE boundary. If the string is very long it may need to be
// written in more than one CONTINUE record.
while ($block_length >= $continue_limit) {
// We need to avoid the case where a string is continued in the first
// n bytes that contain the string header information.
$header_length = 3; // Min string + header size -1
$space_remaining = $continue_limit - $written - $continue;
/* TODO: Unicode data should only be split on char (2 byte)
boundaries. Therefore, in some cases we need to reduce the
// Only applies to Unicode strings
// Min string + header size -1
if ($space_remaining > $header_length) {
// String contains 3 byte header => split on odd boundary
if (!$split_string && $space_remaining % 2 != 1) {
// Split section without header => split on even boundary
else if ($split_string && $space_remaining % 2 == 1) {
if ($space_remaining > $header_length) {
// Write as much as possible of the string in the current block
$written += $space_remaining;
// Reduce the current block length by the amount written
$block_length -= $continue_limit - $continue - $align;
// Store the max size for this block
$this->_block_sizes[] = $continue_limit - $align;
// If the current string was split then the next CONTINUE block
// should have the string continue flag (grbit) set unless the
// split string fits exactly into the remaining space.
// Store the max size for this block
$this->_block_sizes[] = $written + $continue;
// Not enough space to start the string in the current block
$block_length -= $continue_limit - $space_remaining - $continue;
// If the string (or substr) is small enough we can write it in the
// new CONTINUE block. Else, go through the loop again to write it in
// one or more CONTINUE blocks
if ($block_length < $continue_limit) {
$written = $block_length;
// Store the max size for the last block unless it is empty
if ($written + $continue) {
$this->_block_sizes[] = $written + $continue;
/* Calculate the total length of the SST and associated CONTINUEs (if any).
The SST record will have a length even if it contains no strings.
This length is required to set the offsets in the BOUNDSHEET records since
they must be written before the SST records
$tmp_block_sizes = array();
$tmp_block_sizes = $this->_block_sizes;
if (!empty($tmp_block_sizes)) {
$length += array_shift($tmp_block_sizes); // SST information
while (!empty($tmp_block_sizes)) {
$length += 4 + array_shift($tmp_block_sizes); // add CONTINUE headers
* Write all of the workbooks strings into an indexed array.
* See the comments in _calculate_shared_string_sizes() for more information.
* The Excel documentation says that the SST record should be followed by an
* EXTSST record. The EXTSST record is a hash table that is used to optimise
* access to SST. However, despite the documentation it doesn't seem to be
* required so we will ignore it.
$record = 0x00fc; // Record identifier
$length = 0x0008; // Number of bytes to follow
// Iterate through the strings to calculate the CONTINUE block sizes
$tmp_block_sizes = $this->_block_sizes;
// $tmp_block_sizes = array_reverse($this->_block_sizes);
// The SST record is required even if it contains no strings. Thus we will
if (!empty($tmp_block_sizes)) {
// Write the SST block header information
$header = pack("vv", $record, $length);
$data = pack("VV", $this->_str_total, $this->_str_unique);
//$this->_append($header . $data);
/* TODO: not good for performance */
foreach (array_keys($this->_str_table) as $string) {
$string_length = strlen($string);
$headerinfo = unpack("vlength/Cencoding", $string);
$encoding = $headerinfo["encoding"];
// Block length is the total length of the strings that will be
// written out in a single SST or CONTINUE block.
$block_length += $string_length;
// We can write the string if it doesn't cross a CONTINUE boundary
if ($block_length < $continue_limit) {
//$this->_append($string);
$written += $string_length;
// Deal with the cases where the next string to be written will exceed
// the CONTINUE boundary. If the string is very long it may need to be
// written in more than one CONTINUE record.
while ($block_length >= $continue_limit) {
// We need to avoid the case where a string is continued in the first
// n bytes that contain the string header information.
$header_length = 3; // Min string + header size -1
$space_remaining = $continue_limit - $written - $continue;
// Unicode data should only be split on char (2 byte) boundaries.
// Therefore, in some cases we need to reduce the amount of available
// space by 1 byte to ensure the correct alignment.
// Only applies to Unicode strings
// Min string + header size -1
if ($space_remaining > $header_length) {
// String contains 3 byte header => split on odd boundary
if (!$split_string && $space_remaining % 2 != 1) {
// Split section without header => split on even boundary
else if ($split_string && $space_remaining % 2 == 1) {
if ($space_remaining > $header_length) {
// Write as much as possible of the string in the current block
$tmp = substr($string, 0, $space_remaining);
// The remainder will be written in the next block(s)
$string = substr($string, $space_remaining);
// Reduce the current block length by the amount written
$block_length -= $continue_limit - $continue - $align;
// If the current string was split then the next CONTINUE block
// should have the string continue flag (grbit) set unless the
// split string fits exactly into the remaining space.
// Not enough space to start the string in the current block
$block_length -= $continue_limit - $space_remaining - $continue;
// Write the CONTINUE block header
if (!empty($this->_block_sizes)) {
$header = pack('vv', $record, $length);
$header .= pack('C', $encoding);
//$this->_append($header);
// If the string (or substr) is small enough we can write it in the
// new CONTINUE block. Else, go through the loop again to write it in
// one or more CONTINUE blocks
if ($block_length < $continue_limit) {
//$this->_append($string);
$written = $block_length;
|