Documentation

Workbook extends BIFFwriter

in package

• Application

Table of Contents

Properties

$_data  : string|null

The string containing the data of the BIFF stream.

$_datasize  : int

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

$addedFonts  : array<string|int, mixed>

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

$addedNumberFormats  : array<string|int, mixed>

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

$byteOrder  : int|null

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

$codepage  : int

The codepage indicates the text encoding used for strings.

$colors  : array<string|int, mixed>

Color cache.

$countryCode  : int

The country code used for localization.

$escher  : Escher|null

Escher object corresponding to MSODRAWINGGROUP.

$fontWriters  : array<string|int, Font>

Fonts writers.

$limit  : int

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

$numberFormats  : array<string|int, mixed>

Shared number formats.

$palette  : array<string|int, mixed>

Array containing the colour palette.

$parser  : Parser

Formula parser.

$spreadsheet  : Spreadsheet

Workbook.

$stringTable  : array<string|int, mixed>

Array of unique shared strings in workbook.

$stringTotal  : int

Total number of shared strings in workbook.

$stringUnique  : int

Number of unique shared strings in workbook.

$worksheetOffsets  : array<string|int, mixed>

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

$worksheetSizes  : array<string|int, mixed>

Sizes of the binary worksheet streams.

$xfWriters  : array<string|int, Xf>

XF Writers.

Methods

__construct()  : mixed

Class constructor.

addColor()  : int

Alter color palette adding a custom color.

addFont()  : int

Add a font to added fonts.

addXfWriter()  : int

Add a new XF writer.

getByteOrder()  : int

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

getEscher()  : Escher|null

Get Escher object.

setEscher()  : void

Set Escher object.

writeData()  : string

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

writeEof()  : string

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

writeWorkbook()  : string

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

append()  : void

General storage function.

storeBof()  : void

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

storeEof()  : void

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

addContinue()  : 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.

calcSheetOffsets()  : void

Calculate offsets for Worksheet BOF records.

parseDefinedNameValue()  : string

setPaletteXl97()  : void

Sets the colour palette to the Excel 97+ default.

writeAllDefinedNamesBiff8()  : string

Writes all the DEFINEDNAME records (BIFF8).

writeAllFonts()  : void

Store the Excel FONT records.

writeAllNumberFormats()  : void

Store user defined numerical formats i.e. FORMAT records.

writeAllStyles()  : void

Write all STYLE records.

writeAllXfs()  : void

Write all XF records.

writeBoundSheet()  : void

Writes Excel BIFF BOUNDSHEET record.

writeCodepage()  : void

Stores the CODEPAGE biff record.

writeCountry()  : string

Stores the COUNTRY record for localization.

writeDateMode()  : void

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

writeDefinedNameBiff8()  : string

Write a DEFINEDNAME record for BIFF8 using explicit binary formula data.

writeExternalsheetBiff8()  : string

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

writeMsoDrawingGroup()  : string

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

writeNumberFormat()  : void

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

writePalette()  : void

Stores the PALETTE biff record.

writeRecalcId()  : string

Write the RECALCID record.

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

writeShortNameBiff8()  : string

Write a short NAME record.

writeStyle()  : void

Write Excel BIFF STYLE records.

writeSupbookInternal()  : string

Write Internal SUPBOOK record.

writeWindow1()  : void

Write Excel BIFF WINDOW1 record.