PHPExcel_Writer_Excel5_BIFFwriter Class Reference

Inheritance diagram for PHPExcel_Writer_Excel5_BIFFwriter:

Collaboration diagram for PHPExcel_Writer_Excel5_BIFFwriter:

Public Member Functions
	__construct ()
	Constructor. More...
	_append ($data)
	General storage function. More...
	writeData ($data)
	General storage function like _append, but returns string instead of modifying $this->_data. More...
	_storeBof ($type)
	Writes Excel BOF record to indicate the beginning of a stream or sub-stream in the BIFF file. More...
	_storeEof ()
	Writes Excel EOF record to indicate the end of a BIFF stream. More...
	writeEof ()
	Writes Excel EOF record to indicate the end of a BIFF stream. More...
	_addContinue ($data)
	Excel limits the size of BIFF records. More...

Static Public Member Functions
static	getByteOrder ()
	Determine the byte order and store it as class data to avoid recalculating it for each call to new(). More...

Data Fields
	$_data
	$_datasize
	$_limit = 8224

Static Private Attributes
static	$_byte_order

Detailed Description

Definition at line 70 of file BIFFwriter.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Writer_Excel5_BIFFwriter::__construct

(

)

Constructor.

Definition at line 100 of file BIFFwriter.php.

        {
                $this->_data       = '';
                $this->_datasize   = 0;
//              $this->_limit      = 8224;
        }

Member Function Documentation

_addContinue()

PHPExcel_Writer_Excel5_BIFFwriter::_addContinue

(

$data

)

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 @access private

Definition at line 229 of file BIFFwriter.php.

        {
                $limit  = $this->_limit;
                $record = 0x003C;         // Record identifier
 
                // The first 2080/8224 bytes remain intact. However, we have to change
                // the length field of the record.
                $tmp = substr($data, 0, 2) . pack("v", $limit) . substr($data, 4, $limit);
 
                $header = pack("vv", $record, $limit);  // Headers for continue records
 
                // Retrieve chunks of 2080/8224 bytes +4 for the header.
                $data_length = strlen($data);
                for ($i = $limit + 4; $i < ($data_length - $limit); $i += $limit) {
                        $tmp .= $header;
                        $tmp .= substr($data, $i, $limit);
                }
 
                // Retrieve the last chunk of data
                $header  = pack("vv", $record, strlen($data) - $i);
                $tmp    .= $header;
                $tmp    .= substr($data, $i, strlen($data) - $i);
 
                return $tmp;
        }

References $_limit, $data, and $header.

Referenced by _append(), and writeData().

Here is the caller graph for this function:

_append()

PHPExcel_Writer_Excel5_BIFFwriter::_append

(

$data

)

General storage function.

Parameters

string

$data

binary data to append @access private

Definition at line 139 of file BIFFwriter.php.

        {
                if (strlen($data) - 4 > $this->_limit) {
                        $data = $this->_addContinue($data);
                }
                $this->_data            .= $data;
                $this->_datasize        += strlen($data);
        }

References $data, and _addContinue().

Referenced by _storeBof(), _storeEof(), PHPExcel_Writer_Excel5_Workbook\_writeAllFonts(), PHPExcel_Writer_Excel5_Workbook\_writeAllXfs(), PHPExcel_Writer_Excel5_Worksheet\_writeBlank(), PHPExcel_Writer_Excel5_Worksheet\_writeBoolErr(), PHPExcel_Writer_Excel5_Worksheet\_writeFormula(), PHPExcel_Writer_Excel5_Worksheet\_writeLabel(), PHPExcel_Writer_Excel5_Worksheet\_writeLabelSst(), PHPExcel_Writer_Excel5_Worksheet\_writeNote(), PHPExcel_Writer_Excel5_Worksheet\_writeNumber(), PHPExcel_Writer_Excel5_Worksheet\_writeRichTextString(), PHPExcel_Writer_Excel5_Worksheet\_writeStringRecord(), PHPExcel_Writer_Excel5_Worksheet\_writeUrlInternal(), and PHPExcel_Writer_Excel5_Worksheet\_writeUrlWeb().

Here is the call graph for this function:

Here is the caller graph for this function:

_storeBof()

PHPExcel_Writer_Excel5_BIFFwriter::_storeBof

(

$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. @access private

Definition at line 172 of file BIFFwriter.php.

        {
                $record  = 0x0809;                      // Record identifier    (BIFF5-BIFF8)
                $length  = 0x0010;
 
                // by inspection of real files, MS Office Excel 2007 writes the following
                $unknown = pack("VV", 0x000100D1, 0x00000406);
 
                $build   = 0x0DBB;                      //      Excel 97
                $year    = 0x07CC;                      //      Excel 97
 
                $version = 0x0600;                      //      BIFF8
 
                $header  = pack("vv",   $record, $length);
                $data    = pack("vvvv", $version, $type, $build, $year);
                $this->_append($header . $data . $unknown);
        }

References $data, $header, $version, and _append().

Referenced by PHPExcel_Writer_Excel5_Worksheet\close(), and PHPExcel_Writer_Excel5_Workbook\writeWorkbook().

Here is the call graph for this function:

Here is the caller graph for this function:

_storeEof()

PHPExcel_Writer_Excel5_BIFFwriter::_storeEof

(

)

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

@access private

Definition at line 195 of file BIFFwriter.php.

        {
                $record    = 0x000A;   // Record identifier
                $length    = 0x0000;   // Number of bytes to follow
 
                $header    = pack("vv", $record, $length);
                $this->_append($header);
        }

References $header, and _append().

Referenced by PHPExcel_Writer_Excel5_Worksheet\close().

Here is the call graph for this function:

Here is the caller graph for this function:

getByteOrder()

static PHPExcel_Writer_Excel5_BIFFwriter::getByteOrder ( )

static

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

Returns

int

Definition at line 113 of file BIFFwriter.php.

        {
                if (!isset(self::$_byte_order)) {
                        // Check if "pack" gives the required IEEE 64bit float
                        $teststr = pack("d", 1.2345);
                        $number  = pack("C8", 0x8D, 0x97, 0x6E, 0x12, 0x83, 0xC0, 0xF3, 0x3F);
                        if ($number == $teststr) {
                                $byte_order = 0;    // Little Endian
                        } elseif ($number == strrev($teststr)){
                                $byte_order = 1;    // Big Endian
                        } else {
                                // Give up. I'll fix this in a later version.
                                throw new PHPExcel_Writer_Exception("Required floating point format not supported on this platform.");
                        }
                        self::$_byte_order = $byte_order;
                }
 
                return self::$_byte_order;
        }

References $_byte_order.

Referenced by PHPExcel_Writer_Excel5_Parser\_convertNumber().

Here is the caller graph for this function:

writeData()

PHPExcel_Writer_Excel5_BIFFwriter::writeData

(

$data

)

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

Parameters

string

$data

binary data to write

Returns

string

Definition at line 154 of file BIFFwriter.php.

        {
                if (strlen($data) - 4 > $this->_limit) {
                        $data = $this->_addContinue($data);
                }
                $this->_datasize += strlen($data);
 
                return $data;
        }

References $data, and _addContinue().

Referenced by writeEof().

Here is the call graph for this function:

Here is the caller graph for this function:

writeEof()

PHPExcel_Writer_Excel5_BIFFwriter::writeEof

(

)

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

@access private

Definition at line 209 of file BIFFwriter.php.

        {
                $record    = 0x000A;   // Record identifier
                $length    = 0x0000;   // Number of bytes to follow
                $header    = pack("vv", $record, $length);
                return $this->writeData($header);
        }

References $header, and writeData().

Referenced by PHPExcel_Writer_Excel5_Workbook\writeWorkbook().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_byte_order

PHPExcel_Writer_Excel5_BIFFwriter::$_byte_order

staticprivate

Definition at line 76 of file BIFFwriter.php.

Referenced by getByteOrder().

$_data

PHPExcel_Writer_Excel5_BIFFwriter::$_data

Definition at line 82 of file BIFFwriter.php.

Referenced by PHPExcel_Writer_Excel5_Worksheet\getData(), and PHPExcel_Writer_Excel5_Workbook\writeWorkbook().

$_datasize

PHPExcel_Writer_Excel5_BIFFwriter::$_datasize

Definition at line 88 of file BIFFwriter.php.

Referenced by PHPExcel_Writer_Excel5_Workbook\_calcSheetOffsets().

$_limit

PHPExcel_Writer_Excel5_BIFFwriter::$_limit = 8224

Definition at line 95 of file BIFFwriter.php.

Referenced by _addContinue().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Writer/Excel5/BIFFwriter.php