Class: PHPExcel_Writer_Excel5_BIFFwriter

Source Location: /PHPExcel/Writer/Excel5/BIFFwriter.php

Class Overview

Class for writing Excel BIFF records.

Author(s):

Xavier Noguer <xnoguer@php.net>

Child classes:

PHPExcel_Writer_Excel5_Workbook: Class for generating Excel Spreadsheets

PHPExcel_Writer_Excel5_Worksheet: Class for generating Excel Spreadsheets

Class Details

[line 52]
Class for writing Excel BIFF records.

Class for writing Excel BIFF records. From "MICROSOFT EXCEL BINARY FILE FORMAT" by Mark O'Brien (Microsoft Corporation): BIFF (BInary File Format) is the file format in which Excel documents are saved on disk. A BIFF file is a complete description of an Excel document. BIFF files consist of sequences of variable-length records. There are many different types of BIFF records. For example, one record type describes a formula entered into a cell; one describes the size and location of a window into a document; another describes a picture format.

Tags:

author:

Xavier Noguer <xnoguer@php.net>

[ Top ]

Class Variables

$_BIFF_version = 0x0500

[line 58]

The BIFF/Excel version (5).

Tags:

access:

private

Type:

integer

[ Top ]

$_byte_order =

[line 64]

The byte order of this architecture.

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

Tags:

access:

private

Type:

integer

[ Top ]

$_data =

[line 70]

The string containing the data of the BIFF stream

Tags:

access:

private

Type:

string

[ Top ]

$_datasize =

[line 76]

The size of the data in bytes.

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

Tags:

access:

private

Type:

integer

[ Top ]

$_limit =

[line 83]

The maximun length for a BIFF record.

The maximun length for a BIFF record. See _addContinue()

Tags:

see:	PHPExcel_Writer_Excel5_BIFFwriter::_addContinue()
access:	private

Type:

integer

[ Top ]

Class Methods

constructor PHPExcel_Writer_Excel5_BIFFwriter [line 90]

PHPExcel_Writer_Excel5_BIFFwriter PHPExcel_Writer_Excel5_BIFFwriter(
)

Constructor

Tags:

access:

public

[ Top ]

method writeData [line 159]

string writeData(
string
$data)

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

Tags:

access:

public

Parameters:

string

$data

binary data to write

[ Top ]

method writeEof [line 220]

void writeEof(
)

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

Tags:

access:

public

[ Top ]

method _addContinue [line 240]

string _addContinue(
string
$data)

Excel limits the size of BIFF records. Excel 97 the limit is 8228 bytes. must be split up into CONTINUE blocks.

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.

Tags:

return:	A very convenient string of continue blocks
access:	private

Parameters:

string

$data

The original binary data to be written

[ Top ]

method _append [line 144]

void _append(
string
$data)

General storage function

Parameters:

string

$data

binary data to append

[ Top ]

method _prepend [line 129]

void _prepend(
string
$data)

General storage function

Tags:

access:

private

Parameters:

string

$data

binary data to prepend

[ Top ]

method _setByteOrder [line 106]

void _setByteOrder(
)

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

Tags:

access:

private

[ Top ]

method _storeBof [line 178]

void _storeBof(
integer
$type)

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

Tags:

access:

private

Parameters:

integer

$type

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

[ Top ]

method _storeEof [line 207]

void _storeEof(
)

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

Tags:

access:

private

[ Top ]

Documentation generated on Mon, 05 Jan 2009 20:36:27 +0100 by phpDocumentor 1.4.1