Source for file Worksheet.php
Documentation is available at Worksheet.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.
* Spreadsheet_Excel_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('Spreadsheet/Excel/Writer/Parser.php');
require_once('Spreadsheet/Excel/Writer/BIFFwriter.php');
* Class for generating Excel Spreadsheets
* @author Xavier Noguer <xnoguer@rezebra.com>
* @package Spreadsheet_Excel_Writer
* Index for the Worksheet
* Reference to the (default) Format object for URLs
* Reference to the parser used for parsing formulas
* Filehandle to the temporary file for storing data
* Boolean indicating if we are using a temporary file for storing data
* Maximum number of rows for an Excel spreadsheet (BIFF5)
* Maximum number of columns for an Excel spreadsheet (BIFF5)
* Maximum number of characters for a string (LABEL record in BIFF5)
* First row for the DIMENSIONS record
* @see _storeDimensions()
* Last row for the DIMENSIONS record
* @see _storeDimensions()
* First column for the DIMENSIONS record
* @see _storeDimensions()
* Last column for the DIMENSIONS record
* @see _storeDimensions()
* Array containing format information for columns
* Array containing the selected area for the worksheet
* Array containing the panes for the worksheet
* The active pane for the worksheet
* Bit specifying if panes are frozen
* Bit specifying if the worksheet is selected
* The paper size (for printing) (DOCUMENT!!!)
* Bit specifying paper orientation (for printing). 0 => landscape, 1 => portrait
* The page header caption
* The page footer caption
* The horizontal centering value for the page
* The vertical centering value for the page
* The margin for the header
* The margin for the footer
* The left margin for the worksheet in inches
* The right margin for the worksheet in inches
* The top margin for the worksheet in inches
* The bottom margin for the worksheet in inches
* First row to reapeat on each printed page
* Last row to reapeat on each printed page
* First column to reapeat on each printed page
* First row of the area to print
* Last row to of the area to print
* First column of the area to print
* Last column of the area to print
* Whether to use outline.
* Whether to have outline summary below.
* Whether to have outline summary at the right.
* Whether to fit to page when printing or not.
* Number of pages to fit wide
* Number of pages to fit high
* Reference to the total number of strings in the workbook
* Reference to the number of unique strings in the workbook
* Reference to the array containing all the unique strings in the workbook
* @param string $name The name of the new worksheet
* @param integer $index The index of the new worksheet
* @param mixed &$activesheet The current activesheet of the workbook we belong to
* @param mixed &$firstsheet The first worksheet in the workbook we belong to
* @param mixed &$url_format The default format for hyperlinks
* @param mixed &$parser The formula parser created for the Workbook
function Spreadsheet_Excel_Writer_Worksheet ($BIFF_version, $name,
&$firstsheet, &$str_total,
&$str_unique, &$str_table,
// It needs to call its parent's constructor explicitly
$this->_BIFF_version = $BIFF_version;
$rowmax = 65536; // 16384 in Excel 5
$this->activesheet = &$activesheet;
$this->firstsheet = &$firstsheet;
$this->_str_total = &$str_total;
$this->_str_unique = &$str_unique;
$this->_str_table = &$str_table;
$this->_url_format = &$url_format;
$this->_parser = &$parser;
//$this->ext_sheets = array();
$this->_using_tmpfile = true;
$this->_xls_rowmax = $rowmax;
$this->_xls_colmax = $colmax;
$this->_xls_strmax = 255;
$this->_dim_rowmin = $rowmax + 1;
$this->_dim_colmin = $colmax + 1;
$this->_colinfo = array ();
$this->_selection = array (0 ,0 ,0 ,0 );
$this->_paper_size = 0x0;
$this->_orientation = 0x1;
$this->_margin_head = 0.50;
$this->_margin_foot = 0.50;
$this->_margin_left = 0.75;
$this->_margin_right = 0.75;
$this->_margin_top = 1.00;
$this->_margin_bottom = 1.00;
$this->title_colmax = NULL;
$this->_print_gridlines = 1;
$this->_screen_gridlines = 1;
$this->_print_headers = 0;
$this->_hbreaks = array ();
$this->_vbreaks = array ();
$this->col_sizes = array ();
$this->_row_sizes = array ();
$this->_print_scale = 100;
$this->_outline_row_level = 0;
$this->_outline_style = 0;
$this->_outline_below = 1;
$this->_outline_right = 1;
$this->_merged_ranges = array ();
* Open a tmp file to store the majority of the Worksheet data. If this fails,
* for example due to write permissions, store the data in memory. This can be
// Open tmp file for storing Worksheet data
$this->_filehandle = $fh;
// If tmpfile() fails store data in memory
$this->_using_tmpfile = false;
* Add data to the beginning of the workbook (note the reverse order)
* and to the end of the workbook.
* @see Spreadsheet_Excel_Writer_Workbook::storeWorkbook()
* @param array $sheetnames The array of sheetnames from the Workbook this
function close($sheetnames)
$num_sheets = count($sheetnames);
/***********************************************
* Prepend in reverse order!!
// Prepend the sheet dimensions
$this->_storeDimensions ();
// Prepend the sheet password
// Prepend the sheet protection
// Prepend the page setup
/* FIXME: margins are actually appended */
// Prepend the bottom margin
$this->_storeMarginBottom ();
// Prepend the top margin
$this->_storeMarginTop ();
// Prepend the right margin
$this->_storeMarginRight ();
// Prepend the left margin
$this->_storeMarginLeft ();
// Prepend the page vertical centering
// Prepend the page horizontal centering
// Prepend the page footer
// Prepend the page header
// Prepend the vertical page breaks
// Prepend the horizontal page breaks
if ($this->_BIFF_version == 0x0500 ) {
// Prepend PRINTGRIDLINES
$this->_storePrintGridlines ();
$this->_storePrintHeaders ();
// Prepend EXTERNSHEET references
if ($this->_BIFF_version == 0x0500 ) {
for ($i = $num_sheets; $i > 0; $i-- ) {
$sheetname = $sheetnames[$i-1 ];
$this->_storeExternsheet ($sheetname);
// Prepend the EXTERNCOUNT of external references.
if ($this->_BIFF_version == 0x0500 ) {
$this->_storeExterncount ($num_sheets);
// Prepend the COLINFO records if they exist
if (!empty ($this->_colinfo))
for ($i=0; $i < count($this->_colinfo); $i++ ) {
$this->_storeColinfo ($this->_colinfo[$i]);
// Prepend the BOF record
$this->_storeBof (0x0010 );
* End of prepend. Read upwards from here.
***********************************************/
if (!empty ($this->_panes)) {
$this->_storePanes ($this->_panes);
$this->_storeSelection ($this->_selection);
$this->_storeMergedCells ();
/* TODO: add data validity */
/*if ($this->_BIFF_version == 0x0600) {
$this->_storeDataValidity();
* Retrieve the worksheet name.
* This is usefull when creating worksheets without a name.
* @return string The worksheet's name
* Retrieves data from memory in one chunk, or from disk in $buffer
* @return string The data
// Return data stored in memory
$fh = $this->_filehandle;
if ($this->_using_tmpfile) {
// Return data stored on disk
if ($this->_using_tmpfile)
if ($tmp = fread($this->_filehandle, $buffer)) {
* Sets a merged cell range
* @param integer $first_row First row of the area to merge
* @param integer $first_col First column of the area to merge
* @param integer $last_row Last row of the area to merge
* @param integer $last_col Last column of the area to merge
function setMerge($first_row, $first_col, $last_row, $last_col)
if (($last_row < $first_row) or ($last_col < $first_col)) {
// don't check rowmin, rowmax, etc... because we don't know when this
$this->_merged_ranges[] = array ($first_row, $first_col, $last_row, $last_col);
* Set this worksheet as a selected worksheet,
* i.e. the worksheet has its tab highlighted.
* Set this worksheet as the active worksheet,
* i.e. the worksheet that is displayed when the workbook is opened.
* Also set it as selected.
$this->activesheet = $this->index;
* Set this worksheet as the first visible sheet.
* This is necessary when there are a large number of worksheets and the
* activated worksheet is not visible on the screen.
$this->firstsheet = $this->index;
* Set the worksheet protection flag
* to prevent accidental modification and to
* hide formulas if the locked and hidden format properties have been set.
* @param string $password The password to use for protecting the sheet.
$this->_password = $this->_encodePassword ($password);
* Set the width of a single column or a range of columns.
* @param integer $firstcol first column on the range
* @param integer $lastcol last column on the range
* @param integer $width width to set
* @param mixed $format The optional XF format to apply to the columns
* @param integer $hidden The optional hidden atribute
* @param integer $level The optional outline level
function setColumn($firstcol, $lastcol, $width, $format = 0 , $hidden = 0 , $level = 0 )
$this->_colinfo[] = array ($firstcol, $lastcol, $width, &$format, $hidden, $level);
// Set width to zero if column is hidden
$width = ($hidden) ? 0 : $width;
for ($col = $firstcol; $col <= $lastcol; $col++ ) {
$this->col_sizes[$col] = $width;
* Set which cell or cells are selected in a worksheet
* @param integer $first_row first row in the selected quadrant
* @param integer $first_column first column in the selected quadrant
* @param integer $last_row last row in the selected quadrant
* @param integer $last_column last column in the selected quadrant
function setSelection($first_row,$first_column,$last_row,$last_column)
$this->_selection = array ($first_row,$first_column,$last_row,$last_column);
* Set panes and mark them as frozen.
* @param array $panes This is the only parameter received and is composed of the following:
* 0 => Vertical split position,
* 1 => Horizontal split position
* 3 => Leftmost column visible
* Set panes and mark them as unfrozen.
* @param array $panes This is the only parameter received and is composed of the following:
* 0 => Vertical split position,
* 1 => Horizontal split position
* 3 => Leftmost column visible
* Set the page orientation as portrait.
* Set the page orientation as landscape.
* Set the paper type. Ex. 1 = US Letter, 9 = A4
* @param integer $size The type of paper size to use
$this->_paper_size = $size;
* Set the page header caption and optional margin.
* @param string $string The header text
* @param float $margin optional head margin in inches.
//carp 'Header string must be less than 255 characters';
$this->_header = $string;
$this->_margin_head = $margin;
* Set the page footer caption and optional margin.
* @param string $string The footer text
* @param float $margin optional foot margin in inches.
//carp 'Footer string must be less than 255 characters';
$this->_footer = $string;
$this->_margin_foot = $margin;
* Center the page horinzontally.
* @param integer $center the optional value for centering. Defaults to 1 (center).
$this->_hcenter = $center;
* Center the page vertically.
* @param integer $center the optional value for centering. Defaults to 1 (center).
$this->_vcenter = $center;
* Set all the page margins to the same value in inches.
* @param float $margin The margin to set in inches
* Set the left and right margins to the same value in inches.
* @param float $margin The margin to set in inches
* Set the top and bottom margins to the same value in inches.
* @param float $margin The margin to set in inches
* Set the left margin in inches.
* @param float $margin The margin to set in inches
$this->_margin_left = $margin;
* Set the right margin in inches.
* @param float $margin The margin to set in inches
$this->_margin_right = $margin;
* Set the top margin in inches.
* @param float $margin The margin to set in inches
$this->_margin_top = $margin;
* Set the bottom margin in inches.
* @param float $margin The margin to set in inches
$this->_margin_bottom = $margin;
* Set the rows to repeat at the top of each printed page.
* @param integer $first_row First row to repeat
* @param integer $last_row Last row to repeat. Optional.
if (isset ($last_row)) { //Second row is optional
* Set the columns to repeat at the left hand side of each printed page.
* @param integer $first_col First column to repeat
* @param integer $last_col Last column to repeat. Optional.
if (isset ($last_col)) { // Second col is optional
$this->title_colmax = $last_col;
$this->title_colmax = $first_col;
* Set the area of each worksheet that will be printed.
* @param integer $first_row First row of the area to print
* @param integer $first_col First column of the area to print
* @param integer $last_row Last row of the area to print
* @param integer $last_col Last column of the area to print
function printArea($first_row, $first_col, $last_row, $last_col)
* Set the option to hide gridlines on the printed page.
$this->_print_gridlines = 0;
* Set the option to hide gridlines on the worksheet (as seen on the screen).
$this->_screen_gridlines = 0;
* Set the option to print the row and column headers on the printed page.
* @param integer $print Whether to print the headers or not. Defaults to 1 (print).
$this->_print_headers = $print;
* Set the vertical and horizontal number of pages that will define the maximum area printed.
* It doesn't seem to work with OpenOffice.
* @param integer $width Maximun width of printed area in pages
* @param integer $height Maximun heigth of printed area in pages
$this->_fit_width = $width;
$this->_fit_height = $height;
* Store the horizontal page breaks on a worksheet (for printing).
* The breaks represent the row after which the break is inserted.
* @param array $breaks Array containing the horizontal page breaks
foreach($breaks as $break) {
* Store the vertical page breaks on a worksheet (for printing).
* The breaks represent the column after which the break is inserted.
* @param array $breaks Array containing the vertical page breaks
foreach($breaks as $break) {
* Set the worksheet zoom factor.
* @param integer $scale The zoom factor
// Confine the scale to Excel's range
if ($scale < 10 or $scale > 400 )
$this->raiseError (" Zoom factor $scale outside range: 10 <= zoom <= 400" );
$this->_zoom = floor($scale);
* Set the scale factor for the printed page.
* It turns off the "fit to page" option
* @param integer $scale The optional scale factor. Defaults to 100
// Confine the scale to Excel's range
if ($scale < 10 or $scale > 400 )
$this->raiseError (" Print scale $scale outside range: 10 <= zoom <= 400" );
// Turn off "fit to page" option
$this->_print_scale = floor($scale);
* Map to the appropriate write method acording to the token recieved.
* @param integer $row The row of the cell we are writing to
* @param integer $col The column of the cell we are writing to
* @param mixed $token What we are writing
* @param mixed $format The optional format to apply to the cell
function write($row, $col, $token, $format = 0 )
// Check for a cell reference in A1 notation and substitute row and column
@_ = $this->_substituteCellref(@_);
if (preg_match("/^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/",$token)) {
return $this->writeUrl($row, $col, $token, '', $format);
return $this->writeUrl($row, $col, $token, '', $format);
// Match internal or external sheet link
elseif (preg_match("/^(?:in|ex)ternal:/",$token)) {
return $this->writeUrl($row, $col, $token, '', $format);
* Write an array of values as a row
* @param integer $row The row we are writing to
* @param integer $col The first col (leftmost col) we are writing to
* @param array $val The array of values to write
* @param mixed $format The optional format to apply to the cell
* @return mixed PEAR_Error on failure
function writeRow($row, $col, $val, $format=0 )
$this->writeCol($row, $col, $v, $format);
$this->write($row, $col, $v, $format);
$retval = new PEAR_Error ('$val needs to be an array');
* Write an array of values as a column
* @param integer $row The first row (uppermost row) we are writing to
* @param integer $col The col we are writing to
* @param array $val The array of values to write
* @param mixed $format The optional format to apply to the cell
* @return mixed PEAR_Error on failure
function writeCol($row, $col, $val, $format=0 )
$this->write($row, $col, $v, $format);
$retval = new PEAR_Error ('$val needs to be an array');
* Returns an index to the XF record in the workbook
* @param mixed &$format The optional XF format
* @return integer The XF record index
return($format->getXfIndex ());
/******************************************************************************
*******************************************************************************
* Store Worksheet data in memory using the parent's class append() or to a
* temporary file, the default.
* @param string $data The binary data to append
if ($this->_using_tmpfile)
// Add CONTINUE records if necessary
if (strlen($data) > $this->_limit) {
$data = $this->_addContinue ($data);
fwrite($this->_filehandle,$data);
$this->_datasize += strlen($data);
* Substitute an Excel cell reference in A1 notation for zero based row and
* column values in an argument list.
* Ex: ("A4", "Hello") is converted to (3, 0, "Hello").
* @param string $cell The cell reference. Or range of cells.
function _substituteCellref ($cell)
// Convert a column range: 'A:A' or 'B:G'
if (preg_match("/([A-I]?[A-Z]):([A-I]?[A-Z])/",$cell,$match)) {
list ($no_use, $col1) = $this->_cellToRowcol ($match[1 ] . '1'); // Add a dummy row
list ($no_use, $col2) = $this->_cellToRowcol ($match[2 ] . '1'); // Add a dummy row
return(array ($col1, $col2));
// Convert a cell range: 'A1:B7'
if (preg_match("/\$?([A-I]?[A-Z]\$?\d+):\$?([A-I]?[A-Z]\$?\d+)/",$cell,$match)) {
list ($row1, $col1) = $this->_cellToRowcol ($match[1 ]);
list ($row2, $col2) = $this->_cellToRowcol ($match[2 ]);
return(array ($row1, $col1, $row2, $col2));
// Convert a cell reference: 'A1' or 'AD2000'
if (preg_match("/\$?([A-I]?[A-Z]\$?\d+)/",$cell)) {
list ($row1, $col1) = $this->_cellToRowcol ($match[1 ]);
return(array ($row1, $col1));
// TODO use real error codes
$this->raiseError (" Unknown cell reference $cell" , 0 , PEAR_ERROR_DIE );
* Convert an Excel cell reference in A1 notation to a zero based row and column
* reference; converts C1 to (0, 2).
* @param string $cell The cell reference.
* @return array containing (row, column)
function _cellToRowcol ($cell)
preg_match("/\$?([A-I]?[A-Z])\$?(\d+)/",$cell,$match);
// Convert base26 column string to number
$chars = split('', $col);
$col += (ord($char) - ord('A') +1 ) * pow(26 ,$expn);
// Convert 1-index to zero-index
return(array ($row, $col));
* Based on the algorithm provided by Daniel Rentz of OpenOffice.
* @param string $plaintext The password to be encoded in plaintext.
* @return string The encoded password
function _encodePassword ($plaintext)
// split the plain text password in its component characters
$chars = preg_split('//', $plaintext, -1 , PREG_SPLIT_NO_EMPTY );
$value = ord($char) << $i; // shifted ASCII value
$rotated_bits = $value >> 15; // rotated bits beyond bit 15
$value &= 0x7fff; // first 15 bits
$password ^= ($value | $rotated_bits);
$password ^= strlen($plaintext);
* This method sets the properties for outlining and grouping. The defaults
* correspond to Excel's defaults.
* @param bool $symbols_below
* @param bool $symbols_right
* @param bool $auto_style
function setOutline($visible = true , $symbols_below = true , $symbols_right = true , $auto_style = false )
$this->_outline_on = $visible;
$this->_outline_below = $symbols_below;
$this->_outline_right = $symbols_right;
$this->_outline_style = $auto_style;
// Ensure this is a boolean vale for Window2
if ($this->_outline_on) {
/******************************************************************************
*******************************************************************************
* Write a double to the specified row and column (zero indexed).
* An integer can be written as a double. Excel will display an
* integer. $format is optional.
* Returns 0 : normal termination
* -2 : row or column out of range
* @param integer $row Zero indexed row
* @param integer $col Zero indexed column
* @param float $num The number to write
* @param mixed $format The optional XF format
$record = 0x0203; // Record identifier
$length = 0x000E; // Number of bytes to follow
$xf = $this->_XF ($format); // The cell format
// Check that row and col are valid and store max and min values
if ($row >= $this->_xls_rowmax)
if ($col >= $this->_xls_colmax)
if ($row < $this->_dim_rowmin)
$this->_dim_rowmin = $row;
if ($row > $this->_dim_rowmax)
$this->_dim_rowmax = $row;
if ($col < $this->_dim_colmin)
$this->_dim_colmin = $col;
if ($col > $this->_dim_colmax)
$this->_dim_colmax = $col;
$header = pack("vv", $record, $length);
$data = pack("vvv", $row, $col, $xf);
$xl_double = pack("d", $num);
if ($this->_byte_order) // if it's Big Endian
$xl_double = strrev($xl_double);
$this->_append ($header. $data. $xl_double);
* Write a string to the specified row and column (zero indexed).
* NOTE: there is an Excel 5 defined limit of 255 characters.
* Returns 0 : normal termination
* -2 : row or column out of range
* -3 : long string truncated to 255 chars
* @param integer $row Zero indexed row
* @param integer $col Zero indexed column
* @param string $str The string to write
* @param mixed $format The XF format for the cell
if ($this->_BIFF_version == 0x0600 ) {
$record = 0x0204; // Record identifier
$length = 0x0008 + $strlen; // Bytes to follow
$xf = $this->_XF ($format); // The cell format
// Check that row and col are valid and store max and min values
if ($row >= $this->_xls_rowmax)
if ($col >= $this->_xls_colmax)
if ($row < $this->_dim_rowmin)
$this->_dim_rowmin = $row;
if ($row > $this->_dim_rowmax)
$this->_dim_rowmax = $row;
if ($col < $this->_dim_colmin)
$this->_dim_colmin = $col;
if ($col > $this->_dim_colmax)
$this->_dim_colmax = $col;
if ($strlen > $this->_xls_strmax) // LABEL must be < 255 chars
$str = substr($str, 0 , $this->_xls_strmax);
$length = 0x0008 + $this->_xls_strmax;
$strlen = $this->_xls_strmax;
$header = pack("vv", $record, $length);
$data = pack("vvvv", $row, $col, $xf, $strlen);
$this->_append ($header. $data. $str);
$record = 0x00FD; // Record identifier
$length = 0x000A; // Bytes to follow
$xf = $this->_XF ($format); // The cell format
// Check that row and col are valid and store max and min values
if ($this->_checkRowCol ($row, $col) == false ) {
$str = pack('vC', $strlen, $encoding). $str;
/* check if string is already present */
if (!isset ($this->_str_table[$str])) {
$this->_str_table[$str] = $this->_str_unique++;
$header = pack('vv', $record, $length);
$data = pack('vvvV', $row, $col, $xf, $this->_str_table[$str]);
$this->_append ($header. $data);
* Check row and col before writing to a cell, and update the sheet's
* @param integer $row Zero indexed row
* @param integer $col Zero indexed column
* @return boolean true for success, false if row and/or col are grester
function _checkRowCol ($row, $col)
if ($row >= $this->_xls_rowmax) {
if ($col >= $this->_xls_colmax) {
if ($row < $this->_dim_rowmin) {
$this->_dim_rowmin = $row;
if ($row > $this->_dim_rowmax) {
$this->_dim_rowmax = $row;
if ($col < $this->_dim_colmin) {
$this->_dim_colmin = $col;
if ($col > $this->_dim_colmax) {
$this->_dim_colmax = $col;
* Writes a note associated with the cell given by the row and column.
* NOTE records don't have a length limit.
* @param integer $row Zero indexed row
* @param integer $col Zero indexed column
* @param string $note The note to write
$record = 0x001C; // Record identifier
$max_length = 2048; // Maximun length for a NOTE record
//$length = 0x0006 + $note_length; // Bytes to follow
// Check that row and col are valid and store max and min values
if ($row >= $this->_xls_rowmax)
if ($col >= $this->_xls_colmax)
if ($row < $this->_dim_rowmin)
$this->_dim_rowmin = $row;
if ($row > $this->_dim_rowmax)
$this->_dim_rowmax = $row;
if ($col < $this->_dim_colmin)
$this->_dim_colmin = $col;
if ($col > $this->_dim_colmax)
$this->_dim_colmax = $col;
// Length for this record is no more than 2048 + 6
$length = 0x0006 + min($note_length, 2048 );
$header = pack("vv", $record, $length);
$data = pack("vvv", $row, $col, $note_length);
$this->_append ($header. $data. substr($note, 0 , 2048 ));
for($i = $max_length; $i < $note_length; $i += $max_length)
$chunk = substr($note, $i, $max_length);
$length = 0x0006 + strlen($chunk);
$header = pack("vv", $record, $length);
$this->_append ($header. $data. $chunk);
* Write a blank cell to the specified row and column (zero indexed).
* A blank cell is used to specify formatting without adding a string
* A blank cell without a format serves no purpose. Therefore, we don't write
* a BLANK record unless a format is specified.
* Returns 0 : normal termination (including no format)
* -1 : insufficient number of arguments
* -2 : row or column out of range
* @param integer $row Zero indexed row
* @param integer $col Zero indexed column
* @param mixed $format The XF format
// Don't write a blank cell unless it has a format
$record = 0x0201; // Record identifier
$length = 0x0006; // Number of bytes to follow
$xf = $this->_XF ($format); // The cell format
// Check that row and col are valid and store max and min values
if ($row >= $this->_xls_rowmax)
if ($col >= $this->_xls_colmax)
if ($row < $this->_dim_rowmin)
$this->_dim_rowmin = $row;
if ($row > $this->_dim_rowmax)
$this->_dim_rowmax = $row;
if ($col < $this->_dim_colmin)
$this->_dim_colmin = $col;
if ($col > $this->_dim_colmax)
$this->_dim_colmax = $col;
$header = pack("vv", $record, $length);
$data = pack("vvv", $row, $col, $xf);
$this->_append ($header. $data);
* Write a formula to the specified row and column (zero indexed).
* The textual representation of the formula is passed to the parser in
* Parser.php which returns a packed binary string.
* Returns 0 : normal termination
* -1 : formula errors (bad formula)
* -2 : row or column out of range
* @param integer $row Zero indexed row
* @param integer $col Zero indexed column
* @param string $formula The formula text string
* @param mixed $format The optional XF format
$record = 0x0006; // Record identifier
// Excel normally stores the last calculated value of the formula in $num.
// Clearly we are not in a position to calculate this a priori. Instead
// we set $num to zero and set the option flags in $grbit to ensure
// automatic calculation of the formula when the file is opened.
$xf = $this->_XF ($format); // The cell format
$num = 0x00; // Current value of formula
$grbit = 0x03; // Option flags
$unknown = 0x0000; // Must be zero
// Check that row and col are valid and store max and min values
if ($this->_checkRowCol ($row, $col) == false ) {
// Strip the '=' or '@' sign at the beginning of the formula string
$this->writeString($row, $col, 'Unrecognised character for formula');
// Parse the formula using the parser in Parser.php
$error = $this->_parser->parse ($formula);
if ($this->isError ($error))
$formula = $this->_parser->toReversePolish ();
if ($this->isError ($formula))
$this->writeString($row, $col, $formula->getMessage ());
$formlen = strlen($formula); // Length of the binary string
$length = 0x16 + $formlen; // Length of the record data
$header = pack("vv", $record, $length);
$data = pack("vvvdvVv", $row, $col, $xf, $num,
$grbit, $unknown, $formlen);
$this->_append ($header. $data. $formula);
* This is comprised of two elements: the visible label and
* the invisible link. The visible label is the same as the link unless an
* alternative string is specified. The label is written using the
* writeString() method. Therefore the 255 characters string limit applies.
* $string and $format are optional.
* The hyperlink can be to a http, ftp, mail, internal sheet (not yet), or external
* Returns 0 : normal termination
* -2 : row or column out of range
* -3 : long string truncated to 255 chars
* @param integer $row Row
* @param integer $col Column
* @param string $url URL string
* @param string $string Alternative label
* @param mixed $format The cell format
function writeUrl($row, $col, $url, $string = '', $format = 0 )
// Add start row and col to arg list
return($this->_writeUrlRange ($row, $col, $row, $col, $url, $string, $format));
* This is the more general form of writeUrl(). It allows a hyperlink to be
* written to a range of cells. This function also decides the type of hyperlink
* to be written. These are either, Web (http, ftp, mailto), Internal
* (Sheet1!A1) or external ('c:\temp\foo.xls#Sheet1!A1').
* @param integer $row1 Start row
* @param integer $col1 Start column
* @param integer $row2 End row
* @param integer $col2 End column
* @param string $url URL string
* @param string $string Alternative label
* @param mixed $format The cell format
function _writeUrlRange ($row1, $col1, $row2, $col2, $url, $string = '', $format = 0 )
// Check for internal/external sheet links or default to web link
return($this->_writeUrlInternal ($row1, $col1, $row2, $col2, $url, $string, $format));
return($this->_writeUrlExternal ($row1, $col1, $row2, $col2, $url, $string, $format));
return($this->_writeUrlWeb ($row1, $col1, $row2, $col2, $url, $string, $format));
* Used to write http, ftp and mailto hyperlinks.
* The link type ($options) is 0x03 is the same as absolute dir ref without
* sheet. However it is differentiated by the $unknown2 data stream.
* @param integer $row1 Start row
* @param integer $col1 Start column
* @param integer $row2 End row
* @param integer $col2 End column
* @param string $url URL string
* @param string $str Alternative label
* @param mixed $format The cell format
function _writeUrlWeb ($row1, $col1, $row2, $col2, $url, $str, $format = 0 )
$record = 0x01B8; // Record identifier
$length = 0x00000; // Bytes to follow
$format = $this->_url_format;
// Write the visible label using the writeString() method.
$str_error = $this->writeString($row1, $col1, $str, $format);
if (($str_error == -2 ) or ($str_error == -3 )) {
// Pack the undocumented parts of the hyperlink stream
$unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000");
$unknown2 = pack("H*", "E0C9EA79F9BACE118C8200AA004BA90B");
$options = pack("V", 0x03 );
// Convert URL to a null terminated wchar string
// Pack the length of the URL
// Calculate the data length
$length = 0x34 + strlen($url);
$header = pack("vv", $record, $length);
$data = pack("vvvv", $row1, $row2, $col1, $col2);
$this->_append ( $header. $data.
$unknown2. $url_len. $url);
* Used to write internal reference hyperlinks such as "Sheet1!A1".
* @param integer $row1 Start row
* @param integer $col1 Start column
* @param integer $row2 End row
* @param integer $col2 End column
* @param string $url URL string
* @param string $str Alternative label
* @param mixed $format The cell format
function _writeUrlInternal ($row1, $col1, $row2, $col2, $url, $str, $format = 0 )
$record = 0x01B8; // Record identifier
$length = 0x00000; // Bytes to follow
$format = $this->_url_format;
// Write the visible label
$str_error = $this->writeString($row1, $col1, $str, $format);
if (($str_error == -2 ) or ($str_error == -3 )) {
// Pack the undocumented parts of the hyperlink stream
$unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000");
$options = pack("V", 0x08 );
// Convert the URL type and to a null terminated wchar string
// Pack the length of the URL as chars (not wchars)
// Calculate the data length
$length = 0x24 + strlen($url);
$header = pack("vv", $record, $length);
$data = pack("vvvv", $row1, $row2, $col1, $col2);
$this->_append ($header. $data.
* Write links to external directory names such as 'c:\foo.xls',
* c:\foo.xls#Sheet1!A1', '../../foo.xls'. and '../../foo.xls#Sheet1!A1'.
* Note: Excel writes some relative links with the $dir_long string. We ignore
* these cases for the sake of simpler code.
* @param integer $row1 Start row
* @param integer $col1 Start column
* @param integer $row2 End row
* @param integer $col2 End column
* @param string $url URL string
* @param string $str Alternative label
* @param mixed $format The cell format
function _writeUrlExternal ($row1, $col1, $row2, $col2, $url, $str, $format = 0 )
// Network drives are different. We will handle them separately
// MS/Novell network drives and shares start with \\
return; //($this->_writeUrlExternal_net($row1, $col1, $row2, $col2, $url, $str, $format));
$record = 0x01B8; // Record identifier
$length = 0x00000; // Bytes to follow
$format = $this->_url_format;
// Strip URL type and change Unix dir separator to Dos style (if needed)
// Write the visible label
$str_error = $this->writeString($row1, $col1, $str, $format);
if (($str_error == -2 ) or ($str_error == -3 )) {
// Determine if the link is relative or absolute:
// relative if link contains no dir separator, "somefile.xls"
// relative if link starts with up-dir, "..\..\somefile.xls"
$absolute = 0x02; // Bit mask
// Determine if the link contains a sheet reference and change some of the
// parameters accordingly.
// Split the dir name and sheet name (if it exists)
list ($dir_long , $sheet) = split('/\#/', $url);
$link_type = 0x01 | $absolute;
$link_type = pack("V", $link_type);
// Calculate the up-level dir count e.g.. (..\..\..\ == 3)
$up_count = pack("v", $up_count);
// Store the short dos dir name (null terminated)
$dir_short = preg_replace('/\.\.\\/', '', $dir_long) . "\0";
// Store the long dir name as a wchar string (non-null terminated)
$dir_long = join("\0", split('', $dir_long));
$dir_long = $dir_long . "\0";
// Pack the lengths of the dir strings
$stream_len = pack("V", strlen($dir_long) + 0x06 );
// Pack the undocumented parts of the hyperlink stream
$unknown1 = pack("H*",'D0C9EA79F9BACE118C8200AA004BA90B02000000' );
$unknown2 = pack("H*",'0303000000000000C000000000000046' );
$unknown3 = pack("H*",'FFFFADDE000000000000000000000000000000000000000');
$unknown4 = pack("v", 0x03 );
// Pack the main data stream
$data = pack("vvvv", $row1, $row2, $col1, $col2) .
$header = pack("vv", $record, $length);
$this->_append ($header. $data);
* This method is used to set the height and format for a row.
* @param integer $row The row to set
* @param integer $height Height we are giving to the row.
* Use NULL to set XF without setting height
* @param mixed $format XF format we are giving to the row
* @param bool $hidden The optional hidden attribute
* @param integer $level The optional outline level for row, in range [0,7]
function setRow($row, $height, $format = 0 , $hidden = false , $level = 0 )
$record = 0x0208; // Record identifier
$length = 0x0010; // Number of bytes to follow
$colMic = 0x0000; // First defined column
$colMac = 0x0000; // Last defined column
$irwMac = 0x0000; // Used by Excel to optimise loading
$reserved = 0x0000; // Reserved
$grbit = 0x0000; // Option flags
$ixfe = $this->_XF ($format); // XF index
// set _row_sizes so _sizeRow() can use it
$this->_row_sizes[$row] = $height;
// Use setRow($row, NULL, $XF) to set XF format without setting height
$miyRw = $height * 20; // row height
$miyRw = 0xff; // default row height is 256
$level = max(0 , min($level, 7 )); // level should be between 0 and 7
$this->_outline_row_level = max($level, $this->_outline_row_level);
// Set the options flags. fUnsynced is used to show that the font and row
// heights are not compatible. This is usually the case for WriteExcel.
// The collapsed flag 0x10 doesn't seem to be used to indicate that a row
// is collapsed. Instead it is used to indicate that the previous row is
// collapsed. The zero height flag, 0x20, is used to collapse a row.
$grbit |= 0x0040; // fUnsynced
$header = pack("vv", $record, $length);
$data = pack("vvvvvvvv", $row, $colMic, $colMac, $miyRw,
$irwMac,$reserved, $grbit, $ixfe);
$this->_append ($header. $data);
* Writes Excel DIMENSIONS to define the area in which there is data.
function _storeDimensions ()
$record = 0x0200; // Record identifier
$row_min = $this->_dim_rowmin; // First row
$row_max = $this->_dim_rowmax + 1; // Last row plus 1
$col_min = $this->_dim_colmin; // First column
$col_max = $this->_dim_colmax + 1; // Last column plus 1
$reserved = 0x0000; // Reserved by Excel
if ($this->_BIFF_version == 0x0500 ) {
$length = 0x000A; // Number of bytes to follow
$data = pack("vvvvv", $row_min, $row_max,
$col_min, $col_max, $reserved);
elseif ($this->_BIFF_version == 0x0600 ) {
$data = pack("VVvvv", $row_min, $row_max,
$col_min, $col_max, $reserved);
$header = pack("vv", $record, $length);
$this->_prepend ($header. $data);
* Write BIFF record Window2.
$record = 0x023E; // Record identifier
if ($this->_BIFF_version == 0x0500 ) {
$length = 0x000A; // Number of bytes to follow
elseif ($this->_BIFF_version == 0x0600 ) {
$grbit = 0x00B6; // Option flags
$rwTop = 0x0000; // Top row visible in window
$colLeft = 0x0000; // Leftmost column visible in window
// The options flags that comprise $grbit
$fDspFmla = 0; // 0 - bit
$fDspGrid = $this->_screen_gridlines; // 1
$fFrozen = $this->_frozen; // 3
$fDspGuts = $this->_outline_on; // 7
$fFrozenNoSplit = 0; // 0 - bit
$grbit |= $fDspGrid << 1;
$grbit |= $fDspRwCol << 2;
$grbit |= $fDspZeros << 4;
$grbit |= $fDefaultHdr << 5;
$grbit |= $fDspGuts << 7;
$grbit |= $fFrozenNoSplit << 8;
$grbit |= $fSelected << 9;
$header = pack("vv", $record, $length);
$data = pack("vvv", $grbit, $rwTop, $colLeft);
if ($this->_BIFF_version == 0x0500 ) {
$rgbHdr = 0x00000000; // Row/column heading and gridline color
$data .= pack("V", $rgbHdr);
elseif ($this->_BIFF_version == 0x0600 ) {
$rgbHdr = 0x0040; // Row/column heading and gridline color index
$zoom_factor_page_break = 0x0000;
$zoom_factor_normal = 0x0000;
$data .= pack("vvvvV", $rgbHdr, 0x0000 , $zoom_factor_page_break, $zoom_factor_normal, 0x00000000 );
$this->_append ($header. $data);
* Write BIFF record DEFCOLWIDTH if COLINFO records are in use.
$record = 0x0055; // Record identifier
$length = 0x0002; // Number of bytes to follow
$colwidth = 0x0008; // Default column width
$header = pack("vv", $record, $length);
$data = pack("v", $colwidth);
$this->_prepend ($header. $data);
* Write BIFF record COLINFO to define column widths
* Note: The SDK says the record length is 0x0B but Excel writes a 0x0C
* @param array $col_array This is the only parameter received and is composed of the following:
* 0 => First formatted column,
* 1 => Last formatted column,
* 2 => Col width (8.43 is Excel default),
* 3 => The optional XF format of the column,
* 5 => Optional outline level
function _storeColinfo ($col_array)
if (isset ($col_array[0 ])) {
$colFirst = $col_array[0 ];
if (isset ($col_array[1 ])) {
$colLast = $col_array[1 ];
if (isset ($col_array[2 ])) {
if (isset ($col_array[3 ])) {
if (isset ($col_array[4 ])) {
if (isset ($col_array[5 ])) {
$record = 0x007D; // Record identifier
$length = 0x000B; // Number of bytes to follow
$coldx += 0.72; // Fudge. Excel subtracts 0.72 !?
$coldx *= 256; // Convert to units of 1/256 of a char
$ixfe = $this->_XF ($format);
$reserved = 0x00; // Reserved
$level = max(0 , min($level, 7 ));
$header = pack("vv", $record, $length);
$data = pack("vvvvvC", $colFirst, $colLast, $coldx,
$ixfe, $grbit, $reserved);
$this->_prepend ($header. $data);
* Write BIFF record SELECTION.
* @param array $array array containing ($rwFirst,$colFirst,$rwLast,$colLast)
function _storeSelection ($array)
list ($rwFirst,$colFirst,$rwLast,$colLast) = $array;
$record = 0x001D; // Record identifier
$length = 0x000F; // Number of bytes to follow
$pnn = $this->_active_pane; // Pane position
$rwAct = $rwFirst; // Active row
$colAct = $colFirst; // Active column
$irefAct = 0; // Active cell ref
$cref = 1; // Number of refs
$rwLast = $rwFirst; // Last row in reference
$colLast = $colFirst; // Last col in reference
// Swap last row/col for first row/col as necessary
list ($rwFirst, $rwLast) = array ($rwLast, $rwFirst);
if ($colFirst > $colLast)
list ($colFirst, $colLast) = array ($colLast, $colFirst);
$header = pack("vv", $record, $length);
$data = pack("CvvvvvvCC", $pnn, $rwAct, $colAct,
$this->_append ($header. $data);
* Store the MERGEDCELLS record for all ranges of merged cells
function _storeMergedCells ()
// if there are no merged cell ranges set, return
if (count($this->_merged_ranges) == 0 ) {
$length = 2 + count($this->_merged_ranges) * 8;
$header = pack('vv', $record, $length);
$data = pack('v', count($this->_merged_ranges));
foreach ($this->_merged_ranges as $range) {
$data .= pack('vvvv', $range[0 ], $range[2 ], $range[1 ], $range[3 ]);
$this->_append ($header. $data);
* Write BIFF record EXTERNCOUNT to indicate the number of external sheet
* references in a worksheet.
* Excel only stores references to external sheets that are used in formulas.
* For simplicity we store references to all the sheets in the workbook
* regardless of whether they are used or not. This reduces the overall
* complexity and eliminates the need for a two way dialogue between the formula
* parser the worksheet objects.
* @param integer $count The number of external sheet references in this worksheet
function _storeExterncount ($count)
$record = 0x0016; // Record identifier
$length = 0x0002; // Number of bytes to follow
$header = pack("vv", $record, $length);
$data = pack("v", $count);
$this->_prepend ($header. $data);
* Writes the Excel BIFF EXTERNSHEET record. These references are used by
* formulas. A formula references a sheet name via an index. Since we store a
* reference to all of the external worksheets the EXTERNSHEET index is the same
* as the worksheet index.
* @param string $sheetname The name of a external worksheet
function _storeExternsheet ($sheetname)
$record = 0x0017; // Record identifier
// References to the current sheet are encoded differently to references to
if ($this->name == $sheetname) {
$length = 0x02; // The following 2 bytes
$cch = 1; // The following byte
$rgch = 0x02; // Self reference
$length = 0x02 + strlen($sheetname);
$rgch = 0x03; // Reference to a sheet in the current workbook
$header = pack("vv", $record, $length);
$data = pack("CC", $cch, $rgch);
$this->_prepend ($header. $data. $sheetname);
* Writes the Excel BIFF PANE record.
* The panes can either be frozen or thawed (unfrozen).
* Frozen panes are specified in terms of an integer number of rows and columns.
* Thawed panes are specified in terms of Excel's units for rows and columns.
* @param array $panes This is the only parameter received and is composed of the following:
* 0 => Vertical split position,
* 1 => Horizontal split position
* 3 => Leftmost column visible
function _storePanes ($panes)
if (count($panes) > 4 ) { // if Active pane was received
$record = 0x0041; // Record identifier
$length = 0x000A; // Number of bytes to follow
// Code specific to frozen or thawed panes.
// Set default values for $rwTop and $colLeft
// Set default values for $rwTop and $colLeft
// Convert Excel's row and column units to the internal units.
// The default row height is 12.75
// The default column width is 8.43
// The following slope and intersection values were interpolated.
// Determine which pane should be active. There is also the undocumented
// option to override this should it be necessary: may be removed later.
$pnnAct = 0; // Bottom right
$pnnAct = 1; // Top right
$pnnAct = 2; // Bottom left
$this->_active_pane = $pnnAct; // Used in _storeSelection
$header = pack("vv", $record, $length);
$data = pack("vvvvv", $x, $y, $rwTop, $colLeft, $pnnAct);
$this->_append ($header. $data);
* Store the page setup SETUP BIFF record.
$record = 0x00A1; // Record identifier
$length = 0x0022; // Number of bytes to follow
$iPaperSize = $this->_paper_size; // Paper size
$iScale = $this->_print_scale; // Print scaling factor
$iPageStart = 0x01; // Starting page number
$iFitWidth = $this->_fit_width; // Fit to number of pages wide
$iFitHeight = $this->_fit_height; // Fit to number of pages high
$grbit = 0x00; // Option flags
$iRes = 0x0258; // Print resolution
$iVRes = 0x0258; // Vertical print resolution
$numHdr = $this->_margin_head; // Header Margin
$numFtr = $this->_margin_foot; // Footer Margin
$iCopies = 0x01; // Number of copies
$fLeftToRight = 0x0; // Print over then down
$fLandscape = $this->_orientation; // Page orientation
$fNoPls = 0x0; // Setup not read from printer
$fNoColor = 0x0; // Print black and white
$fDraft = 0x0; // Print draft quality
$fNotes = 0x0; // Print notes
$fNoOrient = 0x0; // Orientation not set
$fUsePage = 0x0; // Use custom starting page
$grbit |= $fLandscape << 1;
$grbit |= $fNoColor << 3;
$grbit |= $fNoOrient << 6;
$grbit |= $fUsePage << 7;
$numHdr = pack("d", $numHdr);
$numFtr = pack("d", $numFtr);
if ($this->_byte_order) // if it's Big Endian
$header = pack("vv", $record, $length);
$data1 = pack("vvvvvvvv", $iPaperSize,
$data2 = $numHdr. $numFtr;
$data3 = pack("v", $iCopies);
$this->_prepend ($header. $data1. $data2. $data3);
* Store the header caption BIFF record.
$record = 0x0014; // Record identifier
$str = $this->_header; // header string
$cch = strlen($str); // Length of header string
if ($this->_BIFF_version == 0x0600 ) {
$encoding = 0x0; // TODO: Unicode support
$length = 3 + $cch; // Bytes to follow
$length = 1 + $cch; // Bytes to follow
$header = pack("vv", $record, $length);
if ($this->_BIFF_version == 0x0600 ) {
$data = pack("vC", $cch, $encoding);
$this->_append ($header. $data. $str);
* Store the footer caption BIFF record.
$record = 0x0015; // Record identifier
$str = $this->_footer; // Footer string
$cch = strlen($str); // Length of footer string
if ($this->_BIFF_version == 0x0600 ) {
$encoding = 0x0; // TODO: Unicode support
$length = 3 + $cch; // Bytes to follow
$header = pack("vv", $record, $length);
if ($this->_BIFF_version == 0x0600 ) {
$data = pack("vC", $cch, $encoding);
$this->_append ($header. $data. $str);
* Store the horizontal centering HCENTER BIFF record.
$record = 0x0083; // Record identifier
$length = 0x0002; // Bytes to follow
$fHCenter = $this->_hcenter; // Horizontal centering
$header = pack("vv", $record, $length);
$data = pack("v", $fHCenter);
$this->_append ($header. $data);
* Store the vertical centering VCENTER BIFF record.
$record = 0x0084; // Record identifier
$length = 0x0002; // Bytes to follow
$fVCenter = $this->_vcenter; // Horizontal centering
$header = pack("vv", $record, $length);
$data = pack("v", $fVCenter);
$this->_append ($header. $data);
* Store the LEFTMARGIN BIFF record.
function _storeMarginLeft ()
$record = 0x0026; // Record identifier
$length = 0x0008; // Bytes to follow
$margin = $this->_margin_left; // Margin in inches
$header = pack("vv", $record, $length);
$data = pack("d", $margin);
if ($this->_byte_order) // if it's Big Endian
$this->_append ($header. $data);
* Store the RIGHTMARGIN BIFF record.
function _storeMarginRight ()
$record = 0x0027; // Record identifier
$length = 0x0008; // Bytes to follow
$margin = $this->_margin_right; // Margin in inches
$header = pack("vv", $record, $length);
$data = pack("d", $margin);
if ($this->_byte_order) // if it's Big Endian
$this->_append ($header. $data);
* Store the TOPMARGIN BIFF record.
function _storeMarginTop ()
$record = 0x0028; // Record identifier
$length = 0x0008; // Bytes to follow
$margin = $this->_margin_top; // Margin in inches
$header = pack("vv", $record, $length);
$data = pack("d", $margin);
if ($this->_byte_order) // if it's Big Endian
$this->_append ($header. $data);
* Store the BOTTOMMARGIN BIFF record.
function _storeMarginBottom ()
$record = 0x0029; // Record identifier
$length = 0x0008; // Bytes to follow
$margin = $this->_margin_bottom; // Margin in inches
$header = pack("vv", $record, $length);
$data = pack("d", $margin);
if ($this->_byte_order) // if it's Big Endian
$this->_append ($header. $data);
* Merges the area given by its arguments.
* This is an Excel97/2000 method. It is required to perform more complicated
* merging than the normal setAlign('merge').
* @param integer $first_row First row of the area to merge
* @param integer $first_col First column of the area to merge
* @param integer $last_row Last row of the area to merge
* @param integer $last_col Last column of the area to merge
function mergeCells($first_row, $first_col, $last_row, $last_col)
$record = 0x00E5; // Record identifier
$length = 0x000A; // Bytes to follow
$cref = 1; // Number of refs
// Swap last row/col for first row/col as necessary
if ($first_row > $last_row) {
list ($first_row, $last_row) = array ($last_row, $first_row);
if ($first_col > $last_col) {
list ($first_col, $last_col) = array ($last_col, $first_col);
$header = pack("vv", $record, $length);
$data = pack("vvvvv", $cref, $first_row, $last_row,
$this->_append ($header. $data);
* Write the PRINTHEADERS BIFF record.
function _storePrintHeaders ()
$record = 0x002a; // Record identifier
$length = 0x0002; // Bytes to follow
$fPrintRwCol = $this->_print_headers; // Boolean flag
$header = pack("vv", $record, $length);
$data = pack("v", $fPrintRwCol);
$this->_prepend ($header. $data);
* Write the PRINTGRIDLINES BIFF record. Must be used in conjunction with the
function _storePrintGridlines ()
$record = 0x002b; // Record identifier
$length = 0x0002; // Bytes to follow
$fPrintGrid = $this->_print_gridlines; // Boolean flag
$header = pack("vv", $record, $length);
$data = pack("v", $fPrintGrid);
$this->_prepend ($header. $data);
* Write the GRIDSET BIFF record. Must be used in conjunction with the
$record = 0x0082; // Record identifier
$length = 0x0002; // Bytes to follow
$fGridSet = !($this->_print_gridlines); // Boolean flag
$header = pack("vv", $record, $length);
$data = pack("v", $fGridSet);
$this->_prepend ($header. $data);
* Write the GUTS BIFF record. This is used to configure the gutter margins
* where Excel outline symbols are displayed. The visibility of the gutters is
* controlled by a flag in WSBOOL.
$record = 0x0080; // Record identifier
$length = 0x0008; // Bytes to follow
$dxRwGut = 0x0000; // Size of row gutter
$dxColGut = 0x0000; // Size of col gutter
$row_level = $this->_outline_row_level;
// Calculate the maximum column outline level. The equivalent calculation
// for the row outline level is carried out in setRow().
for ($i=0; $i < count($this->_colinfo); $i++ )
// Skip cols without outline level info.
if (count($col_level) >= 6 ) {
$col_level = max($this->_colinfo[$i][5 ], $col_level);
// Set the limits for the outline levels (0 <= x <= 7).
$col_level = max(0 , min($col_level, 7 ));
// The displayed level is one greater than the max outline levels
$header = pack("vv", $record, $length);
$data = pack("vvvv", $dxRwGut, $dxColGut, $row_level, $col_level);
$this->_prepend ($header. $data);
* Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction
$record = 0x0081; // Record identifier
$length = 0x0002; // Bytes to follow
// The only option that is of interest is the flag for fit to page. So we
// set all the options in one go.
/*if ($this->_fit_page) {
$grbit |= 0x0001; // Auto page breaks visible
if ($this->_outline_style) {
$grbit |= 0x0020; // Auto outline styles
if ($this->_outline_below) {
$grbit |= 0x0040; // Outline summary below
if ($this->_outline_right) {
$grbit |= 0x0080; // Outline summary right
$grbit |= 0x0100; // Page setup fit to page
if ($this->_outline_on) {
$grbit |= 0x0400; // Outline symbols displayed
$header = pack("vv", $record, $length);
$data = pack("v", $grbit);
$this->_prepend ($header. $data);
* Write the HORIZONTALPAGEBREAKS BIFF record.
// Return if the user hasn't specified pagebreaks
if (empty ($this->_hbreaks)) {
// Sort and filter array of page breaks
$breaks = $this->_hbreaks;
sort($breaks, SORT_NUMERIC );
if ($breaks[0 ] == 0 ) { // don't use first break if it's 0
$record = 0x001b; // Record identifier
$cbrk = count($breaks); // Number of page breaks
if ($this->_BIFF_version == 0x0600 ) {
$length = 2 + 6* $cbrk; // Bytes to follow
$length = 2 + 2* $cbrk; // Bytes to follow
$header = pack("vv", $record, $length);
$data = pack("v", $cbrk);
// Append each page break
foreach($breaks as $break) {
if ($this->_BIFF_version == 0x0600 ) {
$data .= pack("vvv", $break, 0x0000 , 0x00ff );
$data .= pack("v", $break);
$this->_prepend ($header. $data);
* Write the VERTICALPAGEBREAKS BIFF record.
// Return if the user hasn't specified pagebreaks
if (empty ($this->_vbreaks)) {
// 1000 vertical pagebreaks appears to be an internal Excel 5 limit.
// It is slightly higher in Excel 97/200, approx. 1026
// Sort and filter array of page breaks
sort($breaks, SORT_NUMERIC );
if ($breaks[0 ] == 0 ) { // don't use first break if it's 0
$record = 0x001a; // Record identifier
$cbrk = count($breaks); // Number of page breaks
if ($this->_BIFF_version == 0x0600 )
$length = 2 + 6* $cbrk; // Bytes to follow
$length = 2 + 2* $cbrk; // Bytes to follow
$header = pack("vv", $record, $length);
$data = pack("v", $cbrk);
// Append each page break
foreach ($breaks as $break) {
if ($this->_BIFF_version == 0x0600 ) {
$data .= pack("vvv", $break, 0x0000 , 0xffff );
$data .= pack("v", $break);
$this->_prepend ($header. $data);
* Set the Biff PROTECT record to indicate that the worksheet is protected.
// Exit unless sheet protection has been specified
if ($this->_protect == 0 ) {
$record = 0x0012; // Record identifier
$length = 0x0002; // Bytes to follow
$fLock = $this->_protect; // Worksheet is protected
$header = pack("vv", $record, $length);
$data = pack("v", $fLock);
$this->_prepend ($header. $data);
* Write the worksheet PASSWORD record.
function _storePassword ()
// Exit unless sheet protection and password have been specified
if (($this->_protect == 0 ) or (!isset ($this->_password))) {
$record = 0x0013; // Record identifier
$length = 0x0002; // Bytes to follow
$wPassword = $this->_password; // Encoded password
$header = pack("vv", $record, $length);
$data = pack("v", $wPassword);
$this->_prepend ($header. $data);
* Insert a 24bit bitmap image in a worksheet.
* @param integer $row The row we are going to insert the bitmap into
* @param integer $col The column we are going to insert the bitmap into
* @param string $bitmap The bitmap filename
* @param integer $x The horizontal position (offset) of the image inside the cell.
* @param integer $y The vertical position (offset) of the image inside the cell.
* @param integer $scale_x The horizontal scale
* @param integer $scale_y The vertical scale
function insertBitmap($row, $col, $bitmap, $x = 0 , $y = 0 , $scale_x = 1 , $scale_y = 1 )
$bitmap_array = $this->_processBitmap ($bitmap);
if ($this->isError ($bitmap_array))
$this->writeString($row, $col, $bitmap_array->getMessage ());
list ($width, $height, $size, $data) = $bitmap_array; //$this->_processBitmap($bitmap);
// Scale the frame of the image.
// Calculate the vertices of the image and write the OBJ record
$this->_positionImage ($col, $row, $x, $y, $width, $height);
// Write the IMDATA record to store the bitmap data
$header = pack("vvvvV", $record, $length, $cf, $env, $lcb);
$this->_append ($header. $data);
* Calculate the vertices that define the position of the image as required by
* +------------+------------+
* +-----+------------+------------+
* | 1 |(A1)._______|______ |
* +-----+----| BITMAP |-----+
* | 2 | |______________. |
* +---- +------------+------------+
* Example of a bitmap that covers some of the area from cell A1 to cell B2.
* Based on the width and height of the bitmap we need to calculate 8 vars:
* $col_start, $row_start, $col_end, $row_end, $x1, $y1, $x2, $y2.
* The width and height of the cells are also variable and have to be taken into
* The values of $col_start and $row_start are passed in from the calling
* function. The values of $col_end and $row_end are calculated by subtracting
* the width and height of the bitmap from the width and height of the
* The vertices are expressed as a percentage of the underlying cell width as
* follows (rhs values are in pixels):
* Where: X is distance from the left side of the underlying cell
* Y is distance from the top of the underlying cell
* W is the width of the cell
* H is the height of the cell
* @note the SDK incorrectly states that the height should be expressed as a
* @param integer $col_start Col containing upper left corner of object
* @param integer $row_start Row containing top left corner of object
* @param integer $x1 Distance to left side of object
* @param integer $y1 Distance to top of object
* @param integer $width Width of image frame
* @param integer $height Height of image frame
function _positionImage ($col_start, $row_start, $x1, $y1, $width, $height)
// Initialise end cell to the same as the start cell
$col_end = $col_start; // Col containing lower right corner of object
$row_end = $row_start; // Row containing bottom right corner of object
// Zero the specified offset if greater than the cell dimensions
if ($x1 >= $this->_sizeCol ($col_start))
if ($y1 >= $this->_sizeRow ($row_start))
$width = $width + $x1 -1;
$height = $height + $y1 -1;
// Subtract the underlying cell widths to find the end cell of the image
while ($width >= $this->_sizeCol ($col_end)) {
$width -= $this->_sizeCol ($col_end);
// Subtract the underlying cell heights to find the end cell of the image
while ($height >= $this->_sizeRow ($row_end)) {
$height -= $this->_sizeRow ($row_end);
// Bitmap isn't allowed to start or finish in a hidden cell, i.e. a cell
// with zero eight or width.
if ($this->_sizeCol ($col_start) == 0 )
if ($this->_sizeCol ($col_end) == 0 )
if ($this->_sizeRow ($row_start) == 0 )
if ($this->_sizeRow ($row_end) == 0 )
// Convert the pixel values to the percentage value expected by Excel
$x1 = $x1 / $this->_sizeCol ($col_start) * 1024;
$y1 = $y1 / $this->_sizeRow ($row_start) * 256;
$x2 = $width / $this->_sizeCol ($col_end) * 1024; // Distance to right side of object
$y2 = $height / $this->_sizeRow ($row_end) * 256; // Distance to bottom of object
$this->_storeObjPicture ( $col_start, $x1,
* Convert the width of a cell from user's units to pixels. By interpolation
* the relationship is: y = 7x +5. If the width hasn't been set by the user we
* use the default value. If the col is hidden we use a value of zero.
* @param integer $col The column
* @return integer The width in pixels
// Look up the cell value to see if it has been changed
if (isset ($this->col_sizes[$col])) {
if ($this->col_sizes[$col] == 0 ) {
return(floor(7 * $this->col_sizes[$col] + 5 ));
* Convert the height of a cell from user's units to pixels. By interpolation
* the relationship is: y = 4/3x. If the height hasn't been set by the user we
* use the default value. If the row is hidden we use a value of zero. (Not
* possible to hide row yet).
* @param integer $row The row
* @return integer The width in pixels
// Look up the cell value to see if it has been changed
if (isset ($this->_row_sizes[$row])) {
if ($this->_row_sizes[$row] == 0 ) {
return(floor(4/3 * $this->_row_sizes[$row]));
* Store the OBJ record that precedes an IMDATA record. This could be generalise
* to support other Excel objects.
* @param integer $colL Column containing upper left corner of object
* @param integer $dxL Distance from left side of cell
* @param integer $rwT Row containing top left corner of object
* @param integer $dyT Distance from top of cell
* @param integer $colR Column containing lower right corner of object
* @param integer $dxR Distance from right of cell
* @param integer $rwB Row containing bottom right corner of object
* @param integer $dyB Distance from bottom of cell
function _storeObjPicture ($colL,$dxL,$rwT,$dyT,$colR,$dxR,$rwB,$dyB)
$record = 0x005d; // Record identifier
$length = 0x003c; // Bytes to follow
$cObj = 0x0001; // Count of objects in file (set to 1)
$OT = 0x0008; // Object type. 8 = Picture
$id = 0x0001; // Object ID
$grbit = 0x0614; // Option flags
$cbMacro = 0x0000; // Length of FMLA structure
$Reserved1 = 0x0000; // Reserved
$Reserved2 = 0x0000; // Reserved
$icvBack = 0x09; // Background colour
$icvFore = 0x09; // Foreground colour
$fls = 0x00; // Fill pattern
$fAuto = 0x00; // Automatic fill
$icv = 0x08; // Line colour
$lns = 0xff; // Line style
$lnw = 0x01; // Line weight
$fAutoB = 0x00; // Automatic border
$frs = 0x0000; // Frame style
$cf = 0x0009; // Image format, 9 = bitmap
$Reserved3 = 0x0000; // Reserved
$cbPictFmla = 0x0000; // Length of FMLA structure
$Reserved4 = 0x0000; // Reserved
$grbit2 = 0x0001; // Option flags
$Reserved5 = 0x0000; // Reserved
$header = pack("vv", $record, $length);
$data = pack("V", $cObj);
$data .= pack("v", $grbit);
$data .= pack("v", $colL);
$data .= pack("v", $dxL);
$data .= pack("v", $rwT);
$data .= pack("v", $dyT);
$data .= pack("v", $colR);
$data .= pack("v", $dxR);
$data .= pack("v", $rwB);
$data .= pack("v", $dyB);
$data .= pack("v", $cbMacro);
$data .= pack("V", $Reserved1);
$data .= pack("v", $Reserved2);
$data .= pack("C", $icvBack);
$data .= pack("C", $icvFore);
$data .= pack("C", $fls);
$data .= pack("C", $fAuto);
$data .= pack("C", $icv);
$data .= pack("C", $lns);
$data .= pack("C", $lnw);
$data .= pack("C", $fAutoB);
$data .= pack("v", $frs);
$data .= pack("v", $Reserved3);
$data .= pack("v", $cbPictFmla);
$data .= pack("v", $Reserved4);
$data .= pack("v", $grbit2);
$data .= pack("V", $Reserved5);
$this->_append ($header. $data);
* Convert a 24 bit bitmap into the modified internal format used by Windows.
* This is described in BITMAPCOREHEADER and BITMAPCOREINFO structures in the
* @param string $bitmap The bitmap to process
* @return array Array with data and properties of the bitmap
function _processBitmap ($bitmap)
$bmp_fd = @fopen($bitmap,"rb");
$this->raiseError (" Couldn't import $bitmap" );
// Slurp the file into a string.
// Check that the file is big enough to be a bitmap.
$this->raiseError (" $bitmap doesn't contain enough data.\n" );
// The first 2 bytes are used to identify the bitmap.
$identity = unpack("A2ident", $data);
if ($identity['ident'] != "BM") {
$this->raiseError (" $bitmap doesn't appear to be a valid bitmap image.\n" );
// Remove bitmap data: ID.
// Read and remove the bitmap size. This is more reliable than reading
// the data size at offset 0x22.
$size = $size_array['sa'];
$size -= 0x36; // Subtract size of bitmap header.
$size += 0x0C; // Add size of BIFF header.
// Remove bitmap data: reserved, offset, header length.
// Read and remove the bitmap width and height. Verify the sizes.
$width = $width_and_height[1 ];
$height = $width_and_height[2 ];
$this->raiseError (" $bitmap: largest image width supported is 65k.\n" );
$this->raiseError (" $bitmap: largest image height supported is 65k.\n" );
// Read and remove the bitmap planes and bpp data. Verify them.
if ($planes_and_bitcount[2 ] != 24 ) { // Bitcount
$this->raiseError (" $bitmap isn't a 24bit true color bitmap.\n" );
if ($planes_and_bitcount[1 ] != 1 ) {
$this->raiseError (" $bitmap: only 1 plane supported in bitmap image.\n" );
// Read and remove the bitmap compression. Verify compression.
if ($compression['comp'] != 0 ) {
$this->raiseError (" $bitmap: compression not supported in bitmap image.\n" );
// Remove bitmap data: data size, hres, vres, colours, imp. colours.
// Add the BITMAPCOREHEADER data
$header = pack("Vvvvv", 0x000c , $width, $height, 0x01 , 0x18 );
return (array ($width, $height, $size, $data));
* Store the window zoom factor. This should be a reduced fraction but for
* simplicity we will store all fractions with a numerator of 100.
// If scale is 100 we don't need to write a record
if ($this->_zoom == 100 ) {
$record = 0x00A0; // Record identifier
$length = 0x0004; // Bytes to follow
$header = pack("vv", $record, $length);
$data = pack("vv", $this->_zoom, 100 );
$this->_append ($header. $data);
$this->_dv[] = $validator->_getData () .
pack("vvvvv", 1 , $row1, $row2, $col1, $col2);
* Store the DVAL and DV records.
function _storeDataValidity ()
$record = 0x01b2; // Record identifier
$length = 0x0012; // Bytes to follow
$grbit = 0x0002; // Prompt box at cell, no cached validity data at DV records
$horPos = 0x00000000; // Horizontal position of prompt box, if fixed position
$verPos = 0x00000000; // Vertical position of prompt box, if fixed position
$objId = 0xffffffff; // Object identifier of drop down arrow object, or -1 if not visible
$header = pack('vv', $record, $length);
$data = pack('vVVVV', $grbit, $horPos, $verPos, $objId,
$this->_append ($header. $data);
$record = 0x01be; // Record identifier
foreach($this->_dv as $dv)
$length = strlen($dv); // Bytes to follow
$header = pack("vv", $record, $length);
$this->_append ($header. $dv);
Documentation generated on Mon, 11 Mar 2019 13:52:00 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|