PHPExcel_Writer_Excel5
[ class tree: PHPExcel_Writer_Excel5 ] [ index: PHPExcel_Writer_Excel5 ] [ all elements ]

Class: PHPExcel_Writer_Excel5_BIFFwriter

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

Class Overview


PHPExcel_Writer_Excel5_BIFFwriter


Author(s):

Copyright:

  • Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)

Variables

Methods


Child classes:

PHPExcel_Writer_Excel5_Workbook
PHPExcel_Writer_Excel5_Workbook
PHPExcel_Writer_Excel5_Worksheet
PHPExcel_Writer_Excel5_Worksheet

Class Details

[line 70]
PHPExcel_Writer_Excel5_BIFFwriter

PHPExcel_Writer_Excel5_BIFFwriter




Tags:

copyright:  Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)


[ Top ]


Class Variables

static $_byte_order =

[line 82]

The byte order of this architecture.

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




Tags:

access:  private

Type:   integer


[ Top ]

$_BIFF_version =  0x0500

[line 76]

The BIFF/Excel version (5).

The BIFF/Excel version (5).




Tags:

access:  private

Type:   integer


[ Top ]

$_data =

[line 88]

The string containing the data of the BIFF stream

The string containing the data of the BIFF stream




Tags:

access:  private

Type:   string


[ Top ]

$_datasize =

[line 94]

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 101]

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

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




Tags:


Type:   integer


[ Top ]



Class Methods


static method getByteOrder [line 119]

static int getByteOrder( )

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

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




Tags:

access:  public


[ Top ]

constructor __construct [line 106]

PHPExcel_Writer_Excel5_BIFFwriter __construct( )

Constructor

Constructor




Tags:

access:  public


Overridden in child classes as:

PHPExcel_Writer_Excel5_Workbook::__construct()
Class constructor
PHPExcel_Writer_Excel5_Worksheet::__construct()
Constructor

[ Top ]

method writeData [line 161]

string writeData( string $data)

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

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




Tags:

access:  public


Parameters:

string   $data   binary data to write

[ Top ]

method writeEof [line 224]

void writeEof( )

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

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




Tags:

access:  public


[ Top ]

method _addContinue [line 244]

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 146]

void _append( string $data)

General storage function

General storage function




Tags:

access:  private


Overridden in child classes as:

PHPExcel_Writer_Excel5_Worksheet::_append()
Store Worksheet data in memory using the parent's class append() or to a temporary file, the default.

Parameters:

string   $data   binary data to append

[ Top ]

method _storeBof [line 179]

void _storeBof( integer $type)

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

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 211]

void _storeEof( )

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

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




Tags:

access:  private


[ Top ]


Documentation generated on Mon, 11 Jan 2010 08:06:37 +0100 by phpDocumentor 1.4.1