Properties

$_data

$_data : string

The string containing the data of the BIFF stream

Type

string

$_datasize

$_datasize : integer

The size of the data in bytes. Should be the same as strlen($this->_data)

Type

integer

$_limit

$_limit : integer

The maximum length for a BIFF record (excluding record header and length field). See _addContinue()

Type

integer

$_biffsize

$_biffsize : integer

The BIFF file size for the workbook.

Type

integer

$_palette

$_palette : array

Array containing the colour palette

Type

array

$_codepage

$_codepage : integer

The codepage indicates the text encoding used for strings

Type

integer

$_country_code

$_country_code : integer

The country code used for localization

Type

integer

$_byte_order

$_byte_order : integer

The byte order of this architecture. 0 => little endian, 1 => big endian

Type

integer

$_phpExcel

$_phpExcel : \PHPExcel

Workbook

Type

\PHPExcel

$_addedFonts

$_addedFonts : array

Added fonts. Maps from font's hash => index in workbook

Type

array

$_numberFormats

$_numberFormats : array

Shared number formats

Type

array

$_addedNumberFormats

$_addedNumberFormats : array

Added number formats. Maps from numberFormat's hash => index in workbook

Type

array

$_worksheetSizes

$_worksheetSizes : array

Sizes of the binary worksheet streams

Type

array

$_worksheetOffsets

$_worksheetOffsets : array

Offsets of the binary worksheet streams relative to the start of the global workbook stream

Type

array

$_str_total

$_str_total : integer

Total number of shared strings in workbook

Type

integer

$_str_unique

$_str_unique : integer

Number of unique shared strings in workbook

Type

integer

$_str_table

$_str_table : array

Array of unique shared strings in workbook

Type

array

$_colors

$_colors : 

Color cache

Type

$_escher

$_escher : \PHPExcel_Shared_Escher

Escher object corresponding to MSODRAWINGGROUP

Type

\PHPExcel_Shared_Escher

Methods

__construct()

__construct(\PHPExcel  $phpExcel = null,   $str_total,   $str_unique,   $str_table,   $colors, mixed  $parser) 

Class constructor

Parameters

\PHPExcel $phpExcel

The Workbook

$str_total
$str_unique
$str_table
$colors
mixed $parser

The formula parser created for the Workbook

getByteOrder()

getByteOrder() : integer

Determine the byte order and store it as class data to avoid recalculating it for each call to new().

Returns

integer

_append()

_append(string  $data) 

General storage function

Parameters

string $data

binary data to append

writeData()

writeData(string  $data) : string

General storage function like _append, but returns string instead of modifying $this->_data

Parameters

string $data

binary data to write

Returns

string

_storeBof()

_storeBof(integer  $type) 

Writes Excel BOF record to indicate the beginning of a stream or sub-stream in the BIFF file.

Parameters

integer $type

Type of BIFF file to write: 0x0005 Workbook, 0x0010 Worksheet.

_storeEof()

_storeEof() 

Writes Excel EOF record to indicate the end of a BIFF stream.

writeEof()

writeEof() 

Writes Excel EOF record to indicate the end of a BIFF stream.

_addContinue()

_addContinue(string  $data) : string

Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In Excel 97 the limit is 8228 bytes. Records that are longer than these limits must be split up into CONTINUE blocks.

This function takes a long BIFF record and inserts CONTINUE records as necessary.

Parameters

string $data

The original binary data to be written

Returns

string —

A very convenient string of continue blocks

addXfWriter()

addXfWriter(  $style,   $isStyleXf = false) : integer

Add a new XF writer

Parameters

$style
$isStyleXf

Returns

integer —

Index to XF record

_addFont()

_addFont(\PHPExcel_Style_Font  $font) : integer

Add a font to added fonts

Parameters

\PHPExcel_Style_Font $font

Returns

integer —

Index to FONT record

_setPaletteXl97()

_setPaletteXl97() 

Sets the colour palette to the Excel 97+ default.

writeWorkbook()

writeWorkbook(array  $pWorksheetSizes = null) : string

Assemble worksheets into a workbook and send the BIFF data to an OLE storage.

Parameters

array $pWorksheetSizes

The sizes in bytes of the binary worksheet streams

Returns

string —

Binary data for workbook stream

_calcSheetOffsets()

_calcSheetOffsets() 

Calculate offsets for Worksheet BOF records.

setEscher()

setEscher(\PHPExcel_Shared_Escher  $pValue = null) 

Set Escher object

Parameters

\PHPExcel_Shared_Escher $pValue

_addColor()

_addColor(string  $rgb) : integer

Alter color palette adding a custom color

Parameters

string $rgb

E.g. 'FF00AA'

Returns

integer —

Color index

_writeAllFonts()

_writeAllFonts() 

Store the Excel FONT records.

_writeAllNumFormats()

_writeAllNumFormats() 

Store user defined numerical formats i.e. FORMAT records

_writeAllXfs()

_writeAllXfs() 

Write all XF records.

_writeAllStyles()

_writeAllStyles() 

Write all STYLE records.

_writeExterns()

_writeExterns() 

Write the EXTERNCOUNT and EXTERNSHEET records. These are used as indexes for the NAME records.

_writeNames()

_writeNames() 

Write the NAME record to define the print area and the repeat rows and cols.

_writeAllDefinedNamesBiff8()

_writeAllDefinedNamesBiff8() 

Writes all the DEFINEDNAME records (BIFF8).

So far this is only used for repeating rows/columns (print titles) and print areas

_writeDefinedNameBiff8()

_writeDefinedNameBiff8(string  $name, string  $formulaData, string  $sheetIndex, boolean  $isBuiltIn = false) : string

Write a DEFINEDNAME record for BIFF8 using explicit binary formula data

Parameters

string $name

The name in UTF-8

string $formulaData

The binary formula data

string $sheetIndex

1-based sheet index the defined name applies to. 0 = global

boolean $isBuiltIn

Built-in name?

Returns

string —

Complete binary record data

_writeShortNameBiff8()

_writeShortNameBiff8(string  $name, string  $sheetIndex, array<mixed,integer[]>  $rangeBounds, boolean  $isHidden = false) : string

Write a short NAME record

Parameters

string $name
string $sheetIndex

1-based sheet index the defined name applies to. 0 = global

array<mixed,integer[]> $rangeBounds

range boundaries

boolean $isHidden

Returns

string —

Complete binary record data

_writeCodepage()

_writeCodepage() 

Stores the CODEPAGE biff record.

_writeWindow1()

_writeWindow1() 

Write Excel BIFF WINDOW1 record.

_writeBoundsheet()

_writeBoundsheet(\PHPExcel_Worksheet  $sheet, integer  $offset) 

Writes Excel BIFF BOUNDSHEET record.

Parameters

\PHPExcel_Worksheet $sheet

Worksheet name

integer $offset

Location of worksheet BOF

_writeSupbookInternal()

_writeSupbookInternal() 

Write Internal SUPBOOK record

_writeExternsheetBiff8()

_writeExternsheetBiff8() 

Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas.

_writeStyle()

_writeStyle() 

Write Excel BIFF STYLE records.

_writeNumFormat()

_writeNumFormat(string  $format, integer  $ifmt) 

Writes Excel FORMAT record for non "built-in" numerical formats.

Parameters

string $format

Custom format string

integer $ifmt

Format index code

_writeDatemode()

_writeDatemode() 

Write DATEMODE record to indicate the date system in use (1904 or 1900).

_writeExterncount()

_writeExterncount(integer  $cxals) 

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 rows and columns.

A similar method is used in Worksheet.php for a slightly different purpose.

Parameters

integer $cxals

Number of external references

_writeExternsheet()

_writeExternsheet(string  $sheetname) 

Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. NAME record is required to define the print area and the repeat rows and columns.

A similar method is used in Worksheet.php for a slightly different purpose.

Parameters

string $sheetname

Worksheet name

_writeNameShort()

_writeNameShort(integer  $index, integer  $type, integer  $rowmin, integer  $rowmax, integer  $colmin, integer  $colmax) 

Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.

Parameters

integer $index

Sheet index

integer $type

Built-in name type

integer $rowmin

Start row

integer $rowmax

End row

integer $colmin

Start colum

integer $colmax

End column

_writeNameLong()

_writeNameLong(integer  $index, integer  $type, integer  $rowmin, integer  $rowmax, integer  $colmin, integer  $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 _writeNameShort() but we use a separate method to keep the code clean.

Code abstraction for reuse can be carried too far, and I should know. ;-)

Parameters

integer $index

Sheet index

integer $type

Built-in name type

integer $rowmin

Start row

integer $rowmax

End row

integer $colmin

Start colum

integer $colmax

End column

_writeCountry()

_writeCountry() : string

Stores the COUNTRY record for localization

Returns

string

_writeRecalcId()

_writeRecalcId() : string

Write the RECALCID record

Returns

string

_writePalette()

_writePalette() 

Stores the PALETTE biff record.

_writeSharedStringsTable()

_writeSharedStringsTable() : string

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 supported).

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.

Returns

string —

Binary data

_writeMsoDrawingGroup()

_writeMsoDrawingGroup() 

Writes the MSODRAWINGGROUP record if needed. Possibly split using CONTINUE records.