Spreadsheet_Excel_Writer_Workbook Class Reference

Inheritance diagram for Spreadsheet_Excel_Writer_Workbook:

Collaboration diagram for Spreadsheet_Excel_Writer_Workbook:

Public Member Functions
	Spreadsheet_Excel_Writer_Workbook ($filename)
	Class constructor. More...
	close ()
	Calls finalization methods. More...
	sheets ()
	An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets() More...
	worksheets ()
	An accessor for the _worksheets[] array. More...
	setVersion ($version)
	Sets the BIFF version. More...
	setCountry ($code)
	Set the country identifier for the workbook. More...
&	addWorksheet ($name='')
	Add a new worksheet to the Excel workbook. More...
&	addFormat ($properties=array())
	Add a new format to the Excel workbook. More...
&	addValidator ()
	Create new validator. More...
	setCustomColor ($index, $red, $green, $blue)
	Change the RGB components of the elements in the colour palette. More...
	_setPaletteXl97 ()
	Sets the colour palette to the Excel 97+ default. More...
	_storeWorkbook ()
	Assemble worksheets into a workbook and send the BIFF data to an OLE storage. More...
	_storeOLEFile ()
	Store the workbook in an OLE container. More...
	_calcSheetOffsets ()
	Calculate offsets for Worksheet BOF records. More...
	_storeAllFonts ()
	Store the Excel FONT records. More...
	_storeAllNumFormats ()
	Store user defined numerical formats i.e. More...
	_storeAllXfs ()
	Write all XF records. More...
	_storeAllStyles ()
	Write all STYLE records. More...
	_storeExterns ()
	Write the EXTERNCOUNT and EXTERNSHEET records. More...
	_storeNames ()
	Write the NAME record to define the print area and the repeat rows and cols. More...
	_storeCodepage ()
	Stores the CODEPAGE biff record. More...
	_storeWindow1 ()
	Write Excel BIFF WINDOW1 record. More...
	_storeBoundsheet ($sheetname, $offset)
	Writes Excel BIFF BOUNDSHEET record. More...
	_storeSupbookInternal ()
	Write Internal SUPBOOK record. More...
	_storeExternsheetBiff8 ()
	Writes the Excel BIFF EXTERNSHEET record. More...
	_storeStyle ()
	Write Excel BIFF STYLE records. More...
	_storeNumFormat ($format, $ifmt)
	Writes Excel FORMAT record for non "built-in" numerical formats. More...
	_storeDatemode ()
	Write DATEMODE record to indicate the date system in use (1904 or 1900). More...
	_storeExterncount ($cxals)
	Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook. More...
	_storeExternsheet ($sheetname)
	Writes the Excel BIFF EXTERNSHEET record. More...
	_storeNameShort ($index, $type, $rowmin, $rowmax, $colmin, $colmax)
	Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only. More...
	_storeNameLong ($index, $type, $rowmin, $rowmax, $colmin, $colmax)
	Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. More...
	_storeCountry ()
	Stores the COUNTRY record for localization. More...
	_storePalette ()
	Stores the PALETTE biff record. More...
	_calculateSharedStringsSizes ()
	Calculate 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. More...
	_storeSharedStringsTable ()
	Write all of the workbooks strings into an indexed array. More...
Public Member Functions inherited from Spreadsheet_Excel_Writer_BIFFwriter
	Spreadsheet_Excel_Writer_BIFFwriter ()
	Constructor. More...
	_setByteOrder ()
	Determine the byte order and store it as class data to avoid recalculating it for each call to new(). More...
	_prepend ($data)
	General storage function. More...
	_append ($data)
	General storage function. 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...
	_addContinue ($data)
	Excel limits the size of BIFF records. More...
	setTempDir ($dir)
	Sets the temp dir used for storing the OLE file. More...
Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor. More...
	_PEAR ()
	Destructor (the emulated type of...). More...
&	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...
	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...
	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...
	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...
	popExpect ()
	This method pops one element off the expected error codes stack. More...
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...
&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...
	popErrorHandling ()
	Pop the last error handler used. More...
	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
	$_filename
	$_parser
	$_1904
	$_activesheet
	$_firstsheet
	$_selected
	$_xf_index
	$_fileclosed
	$_biffsize
	$_sheetname
	$_tmp_format
	$_worksheets
	$_sheetnames
	$_formats
	$_palette
	$_url_format
	$_codepage
	$_country_code
	$_string_sizeinfo_size
Data Fields inherited from Spreadsheet_Excel_Writer_BIFFwriter
	$_BIFF_version = 0x0500
	$_byte_order
	$_data
	$_datasize
	$_limit
	$_tmp_dir
Data Fields inherited from PEAR
	$_debug = false
	$_default_error_mode = null
	$_default_error_options = null
	$_default_error_handler = ''
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Detailed Description

Definition at line 50 of file Workbook.php.

Member Function Documentation

_calcSheetOffsets()

Spreadsheet_Excel_Writer_Workbook::_calcSheetOffsets

(

)

Calculate offsets for Worksheet BOF records.

private

Definition at line 606 of file Workbook.php.

References Spreadsheet_Excel_Writer_BIFFwriter\$_datasize, and _calculateSharedStringsSizes().

Referenced by _storeWorkbook().

    {
        if ($this->_BIFF_version == 0x0600) {
            $boundsheet_length = 12;  // fixed length for a BOUNDSHEET record
        } else {
            $boundsheet_length = 11;
        }
        $EOF               = 4;
        $offset            = $this->_datasize;

        if ($this->_BIFF_version == 0x0600) {
            // add the length of the SST
            /* TODO: check this works for a lot of strings (> 8224 bytes) */
            $offset += $this->_calculateSharedStringsSizes();
            if ($this->_country_code != -1) {
                $offset += 8; // adding COUNTRY record
            }
            // add the lenght of SUPBOOK, EXTERNSHEET and NAME records
            //$offset += 8; // FIXME: calculate real value when storing the records
        }
        $total_worksheets = count($this->_worksheets);
        // add the length of the BOUNDSHEET records
        for ($i = 0; $i < $total_worksheets; $i++) {
            $offset += $boundsheet_length + strlen($this->_worksheets[$i]->name);
        }
        $offset += $EOF;

        for ($i = 0; $i < $total_worksheets; $i++) {
            $this->_worksheets[$i]->offset = $offset;
            $offset += $this->_worksheets[$i]->_datasize;
        }
        $this->_biffsize = $offset;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_calculateSharedStringsSizes()

Spreadsheet_Excel_Writer_Workbook::_calculateSharedStringsSizes

(

)

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

private

Definition at line 1293 of file Workbook.php.

Referenced by _calcSheetOffsets().

    {
        /* Iterate through the strings to calculate the CONTINUE block sizes.
           For simplicity we use the same size for the SST and CONTINUE records:
           8228 : Maximum Excel97 block size
             -4 : Length of block header
             -8 : Length of additional SST header information
             -8 : Arbitrary number to keep within _add_continue() limit = 8208
        */
        $continue_limit     = 8208;
        $block_length       = 0;
        $written            = 0;
        $this->_block_sizes = array();
        $continue           = 0;

        foreach (array_keys($this->_str_table) as $string) {
            $string_length = strlen($string);
            $headerinfo    = unpack("vlength/Cencoding", $string);
            $encoding      = $headerinfo["encoding"];
            $split_string  = 0;

            // Block length is the total length of the strings that will be
            // written out in a single SST or CONTINUE block.
            $block_length += $string_length;

            // We can write the string if it doesn't cross a CONTINUE boundary
            if ($block_length < $continue_limit) {
                $written      += $string_length;
                continue;
            }

            // Deal with the cases where the next string to be written will exceed
            // the CONTINUE boundary. If the string is very long it may need to be
            // written in more than one CONTINUE record.
            while ($block_length >= $continue_limit) {

                // We need to avoid the case where a string is continued in the first
                // n bytes that contain the string header information.
                $header_length   = 3; // Min string + header size -1
                $space_remaining = $continue_limit - $written - $continue;


                /* TODO: Unicode data should only be split on char (2 byte)
                boundaries. Therefore, in some cases we need to reduce the
                amount of available
                */
                $align = 0;

                // Only applies to Unicode strings
                if ($encoding == 1) {
                    // Min string + header size -1
                    $header_length = 4;

                    if ($space_remaining > $header_length) {
                        // String contains 3 byte header => split on odd boundary
                        if (!$split_string && $space_remaining % 2 != 1) {
                            $space_remaining--;
                            $align = 1;
                        }
                        // Split section without header => split on even boundary
                        else if ($split_string && $space_remaining % 2 == 1) {
                            $space_remaining--;
                            $align = 1;
                        }

                        $split_string = 1;
                    }
                }


                if ($space_remaining > $header_length) {
                    // Write as much as possible of the string in the current block
                    $written      += $space_remaining;

                    // Reduce the current block length by the amount written
                    $block_length -= $continue_limit - $continue - $align;

                    // Store the max size for this block
                    $this->_block_sizes[] = $continue_limit - $align;

                    // If the current string was split then the next CONTINUE block
                    // should have the string continue flag (grbit) set unless the
                    // split string fits exactly into the remaining space.
                    if ($block_length > 0) {
                        $continue = 1;
                    } else {
                        $continue = 0;
                    }
                } else {
                    // Store the max size for this block
                    $this->_block_sizes[] = $written + $continue;

                    // Not enough space to start the string in the current block
                    $block_length -= $continue_limit - $space_remaining - $continue;
                    $continue = 0;

                }

                // If the string (or substr) is small enough we can write it in the
                // new CONTINUE block. Else, go through the loop again to write it in
                // one or more CONTINUE blocks
                if ($block_length < $continue_limit) {
                    $written = $block_length;
                } else {
                    $written = 0;
                }
            }
        }

        // Store the max size for the last block unless it is empty
        if ($written + $continue) {
            $this->_block_sizes[] = $written + $continue;
        }


        /* Calculate the total length of the SST and associated CONTINUEs (if any).
         The SST record will have a length even if it contains no strings.
         This length is required to set the offsets in the BOUNDSHEET records since
         they must be written before the SST records
        */

        $tmp_block_sizes = array();
        $tmp_block_sizes = $this->_block_sizes;

        $length  = 12;
        if (!empty($tmp_block_sizes)) {
            $length += array_shift($tmp_block_sizes); // SST
        }
        while (!empty($tmp_block_sizes)) {
            $length += 4 + array_shift($tmp_block_sizes); // CONTINUEs
        }

        return $length;
    }

Here is the caller graph for this function:

_setPaletteXl97()

Spreadsheet_Excel_Writer_Workbook::_setPaletteXl97

(

)

Sets the colour palette to the Excel 97+ default.

private

Definition at line 421 of file Workbook.php.

Referenced by Spreadsheet_Excel_Writer_Workbook().

    {
        $this->_palette = array(
                           array(0x00, 0x00, 0x00, 0x00),   // 8
                           array(0xff, 0xff, 0xff, 0x00),   // 9
                           array(0xff, 0x00, 0x00, 0x00),   // 10
                           array(0x00, 0xff, 0x00, 0x00),   // 11
                           array(0x00, 0x00, 0xff, 0x00),   // 12
                           array(0xff, 0xff, 0x00, 0x00),   // 13
                           array(0xff, 0x00, 0xff, 0x00),   // 14
                           array(0x00, 0xff, 0xff, 0x00),   // 15
                           array(0x80, 0x00, 0x00, 0x00),   // 16
                           array(0x00, 0x80, 0x00, 0x00),   // 17
                           array(0x00, 0x00, 0x80, 0x00),   // 18
                           array(0x80, 0x80, 0x00, 0x00),   // 19
                           array(0x80, 0x00, 0x80, 0x00),   // 20
                           array(0x00, 0x80, 0x80, 0x00),   // 21
                           array(0xc0, 0xc0, 0xc0, 0x00),   // 22
                           array(0x80, 0x80, 0x80, 0x00),   // 23
                           array(0x99, 0x99, 0xff, 0x00),   // 24
                           array(0x99, 0x33, 0x66, 0x00),   // 25
                           array(0xff, 0xff, 0xcc, 0x00),   // 26
                           array(0xcc, 0xff, 0xff, 0x00),   // 27
                           array(0x66, 0x00, 0x66, 0x00),   // 28
                           array(0xff, 0x80, 0x80, 0x00),   // 29
                           array(0x00, 0x66, 0xcc, 0x00),   // 30
                           array(0xcc, 0xcc, 0xff, 0x00),   // 31
                           array(0x00, 0x00, 0x80, 0x00),   // 32
                           array(0xff, 0x00, 0xff, 0x00),   // 33
                           array(0xff, 0xff, 0x00, 0x00),   // 34
                           array(0x00, 0xff, 0xff, 0x00),   // 35
                           array(0x80, 0x00, 0x80, 0x00),   // 36
                           array(0x80, 0x00, 0x00, 0x00),   // 37
                           array(0x00, 0x80, 0x80, 0x00),   // 38
                           array(0x00, 0x00, 0xff, 0x00),   // 39
                           array(0x00, 0xcc, 0xff, 0x00),   // 40
                           array(0xcc, 0xff, 0xff, 0x00),   // 41
                           array(0xcc, 0xff, 0xcc, 0x00),   // 42
                           array(0xff, 0xff, 0x99, 0x00),   // 43
                           array(0x99, 0xcc, 0xff, 0x00),   // 44
                           array(0xff, 0x99, 0xcc, 0x00),   // 45
                           array(0xcc, 0x99, 0xff, 0x00),   // 46
                           array(0xff, 0xcc, 0x99, 0x00),   // 47
                           array(0x33, 0x66, 0xff, 0x00),   // 48
                           array(0x33, 0xcc, 0xcc, 0x00),   // 49
                           array(0x99, 0xcc, 0x00, 0x00),   // 50
                           array(0xff, 0xcc, 0x00, 0x00),   // 51
                           array(0xff, 0x99, 0x00, 0x00),   // 52
                           array(0xff, 0x66, 0x00, 0x00),   // 53
                           array(0x66, 0x66, 0x99, 0x00),   // 54
                           array(0x96, 0x96, 0x96, 0x00),   // 55
                           array(0x00, 0x33, 0x66, 0x00),   // 56
                           array(0x33, 0x99, 0x66, 0x00),   // 57
                           array(0x00, 0x33, 0x00, 0x00),   // 58
                           array(0x33, 0x33, 0x00, 0x00),   // 59
                           array(0x99, 0x33, 0x00, 0x00),   // 60
                           array(0x99, 0x33, 0x66, 0x00),   // 61
                           array(0x33, 0x33, 0x99, 0x00),   // 62
                           array(0x33, 0x33, 0x33, 0x00),   // 63
                         );
    }

Here is the caller graph for this function:

_storeAllFonts()

Spreadsheet_Excel_Writer_Workbook::_storeAllFonts

(

)

Store the Excel FONT records.

private

Definition at line 645 of file Workbook.php.

References $_tmp_format, $fonts, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        // tmp_format is added by the constructor. We use this to write the default XF's
        $format = $this->_tmp_format;
        $font   = $format->getFont();

        // Note: Fonts are 0-indexed. According to the SDK there is no index 4,
        // so the following fonts are 0, 1, 2, 3, 5
        //
        for ($i = 1; $i <= 5; $i++){
            $this->_append($font);
        }

        // Iterate through the XF objects and write a FONT record if it isn't the
        // same as the default FONT and if it hasn't already been used.
        //
        $fonts = array();
        $index = 6;                  // The first user defined FONT

        $key = $format->getFontKey(); // The default font from _tmp_format
        $fonts[$key] = 0;             // Index of the default font

        $total_formats = count($this->_formats);
        for ($i = 0; $i < $total_formats; $i++) {
            $key = $this->_formats[$i]->getFontKey();
            if (isset($fonts[$key])) {
                // FONT has already been used
                $this->_formats[$i]->font_index = $fonts[$key];
            } else {
                // Add a new FONT record
                $fonts[$key]        = $index;
                $this->_formats[$i]->font_index = $index;
                $index++;
                $font = $this->_formats[$i]->getFont();
                $this->_append($font);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeAllNumFormats()

Spreadsheet_Excel_Writer_Workbook::_storeAllNumFormats

(

)

Store user defined numerical formats i.e.

FORMAT records

private

Definition at line 689 of file Workbook.php.

References _storeNumFormat().

Referenced by _storeWorkbook().

    {
        // Leaning num_format syndrome
        $hash_num_formats = array();
        $num_formats      = array();
        $index = 164;

        // Iterate through the XF objects and write a FORMAT record if it isn't a
        // built-in format type and if the FORMAT string hasn't already been used.
        $total_formats = count($this->_formats);
        for ($i = 0; $i < $total_formats; $i++) {
            $num_format = $this->_formats[$i]->_num_format;

            // Check if $num_format is an index to a built-in format.
            // Also check for a string of zeros, which is a valid format string
            // but would evaluate to zero.
            //
            if (!preg_match("/^0+\d/", $num_format)) {
                if (preg_match("/^\d+$/", $num_format)) { // built-in format
                    continue;
                }
            }

            if (isset($hash_num_formats[$num_format])) {
                // FORMAT has already been used
                $this->_formats[$i]->_num_format = $hash_num_formats[$num_format];
            } else{
                // Add a new FORMAT
                $hash_num_formats[$num_format]  = $index;
                $this->_formats[$i]->_num_format = $index;
                array_push($num_formats,$num_format);
                $index++;
            }
        }

        // Write the new FORMAT records starting from 0xA4
        $index = 164;
        foreach ($num_formats as $num_format) {
            $this->_storeNumFormat($num_format,$index);
            $index++;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeAllStyles()

Spreadsheet_Excel_Writer_Workbook::_storeAllStyles

(

)

Write all STYLE records.

private

Definition at line 764 of file Workbook.php.

References _storeStyle().

Referenced by _storeWorkbook().

    {
        $this->_storeStyle();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeAllXfs()

Spreadsheet_Excel_Writer_Workbook::_storeAllXfs

(

)

Write all XF records.

private

Definition at line 737 of file Workbook.php.

References $_tmp_format, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        // _tmp_format is added by the constructor. We use this to write the default XF's
        // The default font index is 0
        //
        $format = $this->_tmp_format;
        for ($i = 0; $i <= 14; $i++) {
            $xf = $format->getXf('style'); // Style XF
            $this->_append($xf);
        }

        $xf = $format->getXf('cell');      // Cell XF
        $this->_append($xf);

        // User defined XFs
        $total_formats = count($this->_formats);
        for ($i = 0; $i < $total_formats; $i++) {
            $xf = $this->_formats[$i]->getXf('cell');
            $this->_append($xf);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeBoundsheet()

Spreadsheet_Excel_Writer_Workbook::_storeBoundsheet	(		$sheetname,
			$offset
	)

Writes Excel BIFF BOUNDSHEET record.

FIXME: inconsistent with BIFF documentation

Parameters

string	$sheetname	Worksheet name
integer	$offset	Location of worksheet BOF private

Definition at line 921 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $record    = 0x0085;                    // Record identifier
        if ($this->_BIFF_version == 0x0600) {
            $length    = 0x08 + strlen($sheetname); // Number of bytes to follow
        } else {
            $length = 0x07 + strlen($sheetname); // Number of bytes to follow
        }

        $grbit     = 0x0000;                    // Visibility and sheet type
        $cch       = strlen($sheetname);        // Length of sheet name

        $header    = pack("vv",  $record, $length);
        if ($this->_BIFF_version == 0x0600) {
            $data      = pack("Vvv", $offset, $grbit, $cch);
        } else {
            $data      = pack("VvC", $offset, $grbit, $cch);
        }
        $this->_append($header.$data.$sheetname);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeCodepage()

Spreadsheet_Excel_Writer_Workbook::_storeCodepage

(

)

Stores the CODEPAGE biff record.

private

Definition at line 871 of file Workbook.php.

References $_codepage, $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $record          = 0x0042;             // Record identifier
        $length          = 0x0002;             // Number of bytes to follow
        $cv              = $this->_codepage;   // The code page

        $header          = pack('vv', $record, $length);
        $data            = pack('v',  $cv);

        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeCountry()

Spreadsheet_Excel_Writer_Workbook::_storeCountry

(

)

Stores the COUNTRY record for localization.

private

Definition at line 1247 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $record          = 0x008C;    // Record identifier
        $length          = 4;         // Number of bytes to follow

        $header = pack('vv',  $record, $length);
        /* using the same country code always for simplicity */
        $data = pack('vv', $this->_country_code, $this->_country_code);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeDatemode()

Spreadsheet_Excel_Writer_Workbook::_storeDatemode

(

)

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

private

Definition at line 1033 of file Workbook.php.

References $_1904, $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $record    = 0x0022;         // Record identifier
        $length    = 0x0002;         // Bytes to follow

        $f1904     = $this->_1904;   // Flag for 1904 date system

        $header    = pack("vv", $record, $length);
        $data      = pack("v", $f1904);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeExterncount()

Spreadsheet_Excel_Writer_Workbook::_storeExterncount

(

$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 private

Definition at line 1059 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeExterns().

    {
        $record   = 0x0016;          // Record identifier
        $length   = 0x0002;          // Number of bytes to follow

        $header   = pack("vv", $record, $length);
        $data     = pack("v",  $cxals);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeExterns()

Spreadsheet_Excel_Writer_Workbook::_storeExterns

(

)

Write the EXTERNCOUNT and EXTERNSHEET records.

These are used as indexes for the NAME records.

private

Definition at line 775 of file Workbook.php.

References _storeExterncount(), and _storeExternsheet().

Referenced by _storeWorkbook().

    {
        // Create EXTERNCOUNT with number of worksheets
        $this->_storeExterncount(count($this->_worksheets));

        // Create EXTERNSHEET for each worksheet
        foreach ($this->_sheetnames as $sheetname) {
            $this->_storeExternsheet($sheetname);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeExternsheet()

Spreadsheet_Excel_Writer_Workbook::_storeExternsheet

(

$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 private

Definition at line 1080 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeExterns().

    {
        $record      = 0x0017;                     // Record identifier
        $length      = 0x02 + strlen($sheetname);  // Number of bytes to follow

        $cch         = strlen($sheetname);         // Length of sheet name
        $rgch        = 0x03;                       // Filename encoding

        $header      = pack("vv",  $record, $length);
        $data        = pack("CC", $cch, $rgch);
        $this->_append($header . $data . $sheetname);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeExternsheetBiff8()

Spreadsheet_Excel_Writer_Workbook::_storeExternsheetBiff8

(

)

Writes the Excel BIFF EXTERNSHEET record.

These references are used by formulas.

Parameters

string

$sheetname

Worksheet name private

Definition at line 964 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

    {
        $total_references = count($this->_parser->_references);
        $record   = 0x0017;                     // Record identifier
        $length   = 2 + 6 * $total_references;  // Number of bytes to follow

        $supbook_index = 0;           // FIXME: only using internal SUPBOOK record
        $header           = pack("vv",  $record, $length);
        $data             = pack('v', $total_references);
        for ($i = 0; $i < $total_references; $i++) {
            $data .= $this->_parser->_references[$i];
        }
        $this->_append($header . $data);
    }

Here is the call graph for this function:

_storeNameLong()

Spreadsheet_Excel_Writer_Workbook::_storeNameLong	(		$index,
			$type,
			$rowmin,
			$rowmax,
			$colmin,
			$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 _storeNameShort() 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 private

Definition at line 1172 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeNames().

    {
        $record          = 0x0018;       // Record identifier
        $length          = 0x003d;       // Number of bytes to follow
        $grbit           = 0x0020;       // Option flags
        $chKey           = 0x00;         // Keyboard shortcut
        $cch             = 0x01;         // Length of text name
        $cce             = 0x002e;       // Length of text definition
        $ixals           = $index + 1;   // Sheet index
        $itab            = $ixals;       // Equal to ixals
        $cchCustMenu     = 0x00;         // Length of cust menu text
        $cchDescription  = 0x00;         // Length of description text
        $cchHelptopic    = 0x00;         // Length of help topic text
        $cchStatustext   = 0x00;         // Length of status bar text
        $rgch            = $type;        // Built-in name type

        $unknown01       = 0x29;
        $unknown02       = 0x002b;
        $unknown03       = 0x3b;
        $unknown04       = 0xffff-$index;
        $unknown05       = 0x0000;
        $unknown06       = 0x0000;
        $unknown07       = 0x1087;
        $unknown08       = 0x8008;

        $header             = pack("vv",  $record, $length);
        $data               = pack("v", $grbit);
        $data              .= pack("C", $chKey);
        $data              .= pack("C", $cch);
        $data              .= pack("v", $cce);
        $data              .= pack("v", $ixals);
        $data              .= pack("v", $itab);
        $data              .= pack("C", $cchCustMenu);
        $data              .= pack("C", $cchDescription);
        $data              .= pack("C", $cchHelptopic);
        $data              .= pack("C", $cchStatustext);
        $data              .= pack("C", $rgch);
        $data              .= pack("C", $unknown01);
        $data              .= pack("v", $unknown02);
        // Column definition
        $data              .= pack("C", $unknown03);
        $data              .= pack("v", $unknown04);
        $data              .= pack("v", $unknown05);
        $data              .= pack("v", $unknown06);
        $data              .= pack("v", $unknown07);
        $data              .= pack("v", $unknown08);
        $data              .= pack("v", $index);
        $data              .= pack("v", $index);
        $data              .= pack("v", 0x0000);
        $data              .= pack("v", 0x3fff);
        $data              .= pack("C", $colmin);
        $data              .= pack("C", $colmax);
        // Row definition
        $data              .= pack("C", $unknown03);
        $data              .= pack("v", $unknown04);
        $data              .= pack("v", $unknown05);
        $data              .= pack("v", $unknown06);
        $data              .= pack("v", $unknown07);
        $data              .= pack("v", $unknown08);
        $data              .= pack("v", $index);
        $data              .= pack("v", $index);
        $data              .= pack("v", $rowmin);
        $data              .= pack("v", $rowmax);
        $data              .= pack("C", 0x00);
        $data              .= pack("C", 0xff);
        // End of data
        $data              .= pack("C", 0x10);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeNames()

Spreadsheet_Excel_Writer_Workbook::_storeNames

(

)

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

private

Definition at line 791 of file Workbook.php.

References _storeNameLong(), and _storeNameShort().

Referenced by _storeWorkbook().

    {
        // Create the print area NAME records
        $total_worksheets = count($this->_worksheets);
        for ($i = 0; $i < $total_worksheets; $i++) {
            // Write a Name record if the print area has been defined
            if (isset($this->_worksheets[$i]->print_rowmin)) {
                $this->_storeNameShort(
                    $this->_worksheets[$i]->index,
                    0x06, // NAME type
                    $this->_worksheets[$i]->print_rowmin,
                    $this->_worksheets[$i]->print_rowmax,
                    $this->_worksheets[$i]->print_colmin,
                    $this->_worksheets[$i]->print_colmax
                    );
            }
        }

        // Create the print title NAME records
        $total_worksheets = count($this->_worksheets);
        for ($i = 0; $i < $total_worksheets; $i++) {
            $rowmin = $this->_worksheets[$i]->title_rowmin;
            $rowmax = $this->_worksheets[$i]->title_rowmax;
            $colmin = $this->_worksheets[$i]->title_colmin;
            $colmax = $this->_worksheets[$i]->title_colmax;

            // Determine if row + col, row, col or nothing has been defined
            // and write the appropriate record
            //
            if (isset($rowmin) && isset($colmin)) {
                // Row and column titles have been defined.
                // Row title has been defined.
                $this->_storeNameLong(
                    $this->_worksheets[$i]->index,
                    0x07, // NAME type
                    $rowmin,
                    $rowmax,
                    $colmin,
                    $colmax
                    );
            } elseif (isset($rowmin)) {
                // Row title has been defined.
                $this->_storeNameShort(
                    $this->_worksheets[$i]->index,
                    0x07, // NAME type
                    $rowmin,
                    $rowmax,
                    0x00,
                    0xff
                    );
            } elseif (isset($colmin)) {
                // Column title has been defined.
                $this->_storeNameShort(
                    $this->_worksheets[$i]->index,
                    0x07, // NAME type
                    0x0000,
                    0x3fff,
                    $colmin,
                    $colmax
                    );
            } else {
                // Print title hasn't been defined.
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeNameShort()

Spreadsheet_Excel_Writer_Workbook::_storeNameShort	(		$index,
			$type,
			$rowmin,
			$rowmax,
			$colmin,
			$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 private

Definition at line 1106 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeNames().

    {
        $record          = 0x0018;       // Record identifier
        $length          = 0x0024;       // Number of bytes to follow

        $grbit           = 0x0020;       // Option flags
        $chKey           = 0x00;         // Keyboard shortcut
        $cch             = 0x01;         // Length of text name
        $cce             = 0x0015;       // Length of text definition
        $ixals           = $index + 1;   // Sheet index
        $itab            = $ixals;       // Equal to ixals
        $cchCustMenu     = 0x00;         // Length of cust menu text
        $cchDescription  = 0x00;         // Length of description text
        $cchHelptopic    = 0x00;         // Length of help topic text
        $cchStatustext   = 0x00;         // Length of status bar text
        $rgch            = $type;        // Built-in name type

        $unknown03       = 0x3b;
        $unknown04       = 0xffff-$index;
        $unknown05       = 0x0000;
        $unknown06       = 0x0000;
        $unknown07       = 0x1087;
        $unknown08       = 0x8005;

        $header             = pack("vv", $record, $length);
        $data               = pack("v", $grbit);
        $data              .= pack("C", $chKey);
        $data              .= pack("C", $cch);
        $data              .= pack("v", $cce);
        $data              .= pack("v", $ixals);
        $data              .= pack("v", $itab);
        $data              .= pack("C", $cchCustMenu);
        $data              .= pack("C", $cchDescription);
        $data              .= pack("C", $cchHelptopic);
        $data              .= pack("C", $cchStatustext);
        $data              .= pack("C", $rgch);
        $data              .= pack("C", $unknown03);
        $data              .= pack("v", $unknown04);
        $data              .= pack("v", $unknown05);
        $data              .= pack("v", $unknown06);
        $data              .= pack("v", $unknown07);
        $data              .= pack("v", $unknown08);
        $data              .= pack("v", $index);
        $data              .= pack("v", $index);
        $data              .= pack("v", $rowmin);
        $data              .= pack("v", $rowmax);
        $data              .= pack("C", $colmin);
        $data              .= pack("C", $colmax);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeNumFormat()

Spreadsheet_Excel_Writer_Workbook::_storeNumFormat	(		$format,
			$ifmt
	)

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

Parameters

string	$format	Custom format string
integer	$ifmt	Format index code private

Definition at line 1006 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeAllNumFormats().

    {
        $record    = 0x041E;                      // Record identifier

        if ($this->_BIFF_version == 0x0600) {
            $length    = 5 + strlen($format);      // Number of bytes to follow
            $encoding = 0x0;
        } elseif ($this->_BIFF_version == 0x0500) {
            $length    = 3 + strlen($format);      // Number of bytes to follow
        }

        $cch       = strlen($format);             // Length of format string

        $header    = pack("vv", $record, $length);
        if ($this->_BIFF_version == 0x0600) {
            $data      = pack("vvC", $ifmt, $cch, $encoding);
        } elseif ($this->_BIFF_version == 0x0500) {
            $data      = pack("vC", $ifmt, $cch);
        }
        $this->_append($header . $data . $format);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeOLEFile()

Spreadsheet_Excel_Writer_Workbook::_storeOLEFile

(

)

Store the workbook in an OLE container.

private

Returns

mixed true on success. PEAR_Error on failure

Definition at line 566 of file Workbook.php.

References $res, OLE\Asc2Ucs(), PEAR\isError(), and PEAR\raiseError().

Referenced by _storeWorkbook().

    {
        if($this->_BIFF_version == 0x0600) {
            $OLE = new OLE_PPS_File(OLE::Asc2Ucs('Workbook'));
        } else {
            $OLE = new OLE_PPS_File(OLE::Asc2Ucs('Book'));
        }
        if ($this->_tmp_dir != '') {
            $OLE->setTempDir($this->_tmp_dir);
        }
        $res = $OLE->init();
        if ($this->isError($res)) {
            return $this->raiseError("OLE Error: ".$res->getMessage());
        }
        $OLE->append($this->_data);

        $total_worksheets = count($this->_worksheets);
        for ($i = 0; $i < $total_worksheets; $i++) {
            while ($tmp = $this->_worksheets[$i]->getData()) {
                $OLE->append($tmp);
            }
        }

        $root = new OLE_PPS_Root(time(), time(), array($OLE));
        if ($this->_tmp_dir != '') {
            $root->setTempDir($this->_tmp_dir);
        }

        $res = $root->save($this->_filename);
        if ($this->isError($res)) {
            return $this->raiseError("OLE Error: ".$res->getMessage());
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storePalette()

Spreadsheet_Excel_Writer_Workbook::_storePalette

(

)

Stores the PALETTE biff record.

private

Definition at line 1263 of file Workbook.php.

References $_palette, $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $aref            = $this->_palette;

        $record          = 0x0092;                 // Record identifier
        $length          = 2 + 4 * count($aref);   // Number of bytes to follow
        $ccv             =         count($aref);   // Number of RGB values to follow
        $data = '';                                // The RGB data

        // Pack the RGB data
        foreach ($aref as $color) {
            foreach ($color as $byte) {
                $data .= pack("C",$byte);
            }
        }

        $header = pack("vvv",  $record, $length, $ccv);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeSharedStringsTable()

Spreadsheet_Excel_Writer_Workbook::_storeSharedStringsTable

(

)

Write all of the workbooks strings into an indexed array.

See the comments in _calculate_shared_string_sizes() for more information.

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.

private

Definition at line 1439 of file Workbook.php.

References $data, $header, $total, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $record  = 0x00fc;  // Record identifier
        $length  = 0x0008;  // Number of bytes to follow
        $total   = 0x0000;

        // Iterate through the strings to calculate the CONTINUE block sizes
        $continue_limit = 8208;
        $block_length   = 0;
        $written        = 0;
        $continue       = 0;

        // sizes are upside down
        $tmp_block_sizes = $this->_block_sizes;
        // $tmp_block_sizes = array_reverse($this->_block_sizes);

        // The SST record is required even if it contains no strings. Thus we will
        // always have a length
        //
        if (!empty($tmp_block_sizes)) {
            $length = 8 + array_shift($tmp_block_sizes);
        }
        else {
            // No strings
            $length = 8;
        }



        // Write the SST block header information
        $header      = pack("vv", $record, $length);
        $data        = pack("VV", $this->_str_total, $this->_str_unique);
        $this->_append($header . $data);




        /* TODO: not good for performance */
        foreach (array_keys($this->_str_table) as $string) {

            $string_length = strlen($string);
            $headerinfo    = unpack("vlength/Cencoding", $string);
            $encoding      = $headerinfo["encoding"];
            $split_string  = 0;

            // Block length is the total length of the strings that will be
            // written out in a single SST or CONTINUE block.
            //
            $block_length += $string_length;


            // We can write the string if it doesn't cross a CONTINUE boundary
            if ($block_length < $continue_limit) {
                $this->_append($string);
                $written += $string_length;
                continue;
            }

            // Deal with the cases where the next string to be written will exceed
            // the CONTINUE boundary. If the string is very long it may need to be
            // written in more than one CONTINUE record.
            //
            while ($block_length >= $continue_limit) {

                // We need to avoid the case where a string is continued in the first
                // n bytes that contain the string header information.
                //
                $header_length   = 3; // Min string + header size -1
                $space_remaining = $continue_limit - $written - $continue;


                // Unicode data should only be split on char (2 byte) boundaries.
                // Therefore, in some cases we need to reduce the amount of available
                // space by 1 byte to ensure the correct alignment.
                $align = 0;

                // Only applies to Unicode strings
                if ($encoding == 1) {
                    // Min string + header size -1
                    $header_length = 4;

                    if ($space_remaining > $header_length) {
                        // String contains 3 byte header => split on odd boundary
                        if (!$split_string && $space_remaining % 2 != 1) {
                            $space_remaining--;
                            $align = 1;
                        }
                        // Split section without header => split on even boundary
                        else if ($split_string && $space_remaining % 2 == 1) {
                            $space_remaining--;
                            $align = 1;
                        }

                        $split_string = 1;
                    }
                }


                if ($space_remaining > $header_length) {
                    // Write as much as possible of the string in the current block
                    $tmp = substr($string, 0, $space_remaining);
                    $this->_append($tmp);

                    // The remainder will be written in the next block(s)
                    $string = substr($string, $space_remaining);

                    // Reduce the current block length by the amount written
                    $block_length -= $continue_limit - $continue - $align;

                    // If the current string was split then the next CONTINUE block
                    // should have the string continue flag (grbit) set unless the
                    // split string fits exactly into the remaining space.
                    //
                    if ($block_length > 0) {
                        $continue = 1;
                    } else {
                        $continue = 0;
                    }
                } else {
                    // Not enough space to start the string in the current block
                    $block_length -= $continue_limit - $space_remaining - $continue;
                    $continue = 0;
                }

                // Write the CONTINUE block header
                if (!empty($this->_block_sizes)) {
                    $record  = 0x003C;
                    $length  = array_shift($tmp_block_sizes);

                    $header  = pack('vv', $record, $length);
                    if ($continue) {
                        $header .= pack('C', $encoding);
                    }
                    $this->_append($header);
                }

                // If the string (or substr) is small enough we can write it in the
                // new CONTINUE block. Else, go through the loop again to write it in
                // one or more CONTINUE blocks
                //
                if ($block_length < $continue_limit) {
                    $this->_append($string);
                    $written = $block_length;
                } else {
                    $written = 0;
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeStyle()

Spreadsheet_Excel_Writer_Workbook::_storeStyle

(

)

Write Excel BIFF STYLE records.

private

Definition at line 984 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeAllStyles().

    {
        $record    = 0x0293;   // Record identifier
        $length    = 0x0004;   // Bytes to follow

        $ixfe      = 0x8000;   // Index to style XF
        $BuiltIn   = 0x00;     // Built-in style
        $iLevel    = 0xff;     // Outline style level

        $header    = pack("vv",  $record, $length);
        $data      = pack("vCC", $ixfe, $BuiltIn, $iLevel);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeSupbookInternal()

Spreadsheet_Excel_Writer_Workbook::_storeSupbookInternal

(

)

Write Internal SUPBOOK record.

private

Definition at line 947 of file Workbook.php.

References $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

    {
        $record    = 0x01AE;   // Record identifier
        $length    = 0x0004;   // Bytes to follow

        $header    = pack("vv", $record, $length);
        $data      = pack("vv", count($this->_worksheets), 0x0104);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

_storeWindow1()

Spreadsheet_Excel_Writer_Workbook::_storeWindow1

(

)

Write Excel BIFF WINDOW1 record.

private

Definition at line 888 of file Workbook.php.

References $_activesheet, $_firstsheet, $_selected, $data, $header, and Spreadsheet_Excel_Writer_BIFFwriter\_append().

Referenced by _storeWorkbook().

    {
        $record    = 0x003D;                 // Record identifier
        $length    = 0x0012;                 // Number of bytes to follow

        $xWn       = 0x0000;                 // Horizontal position of window
        $yWn       = 0x0000;                 // Vertical position of window
        $dxWn      = 0x25BC;                 // Width of window
        $dyWn      = 0x1572;                 // Height of window

        $grbit     = 0x0038;                 // Option flags
        $ctabsel   = $this->_selected;       // Number of workbook tabs selected
        $wTabRatio = 0x0258;                 // Tab to scrollbar ratio

        $itabFirst = $this->_firstsheet;     // 1st displayed worksheet
        $itabCur   = $this->_activesheet;    // Active worksheet

        $header    = pack("vv",        $record, $length);
        $data      = pack("vvvvvvvvv", $xWn, $yWn, $dxWn, $dyWn,
                                       $grbit,
                                       $itabCur, $itabFirst,
                                       $ctabsel, $wTabRatio);
        $this->_append($header . $data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storeWorkbook()

Spreadsheet_Excel_Writer_Workbook::_storeWorkbook

(

)

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

private

Returns

mixed true on success. PEAR_Error on failure

Definition at line 490 of file Workbook.php.

References $res, _calcSheetOffsets(), _storeAllFonts(), _storeAllNumFormats(), _storeAllStyles(), _storeAllXfs(), Spreadsheet_Excel_Writer_BIFFwriter\_storeBof(), _storeBoundsheet(), _storeCodepage(), _storeCountry(), _storeDatemode(), Spreadsheet_Excel_Writer_BIFFwriter\_storeEof(), _storeExterns(), _storeNames(), _storeOLEFile(), _storePalette(), _storeSharedStringsTable(), _storeWindow1(), PEAR\isError(), and PEAR\raiseError().

Referenced by close().

    {
        if (count($this->_worksheets) == 0) {
            return true;
        }

        // Ensure that at least one worksheet has been selected.
        if ($this->_activesheet == 0) {
            $this->_worksheets[0]->selected = 1;
        }

        // Calculate the number of selected worksheet tabs and call the finalization
        // methods for each worksheet
        $total_worksheets = count($this->_worksheets);
        for ($i = 0; $i < $total_worksheets; $i++) {
            if ($this->_worksheets[$i]->selected) {
                $this->_selected++;
            }
            $this->_worksheets[$i]->close($this->_sheetnames);
        }

        // Add Workbook globals
        $this->_storeBof(0x0005);
        $this->_storeCodepage();
        if ($this->_BIFF_version == 0x0600) {
            $this->_storeWindow1();
        }
        if ($this->_BIFF_version == 0x0500) {
            $this->_storeExterns();    // For print area and repeat rows
        }
        $this->_storeNames();      // For print area and repeat rows
        if ($this->_BIFF_version == 0x0500) {
            $this->_storeWindow1();
        }
        $this->_storeDatemode();
        $this->_storeAllFonts();
        $this->_storeAllNumFormats();
        $this->_storeAllXfs();
        $this->_storeAllStyles();
        $this->_storePalette();
        $this->_calcSheetOffsets();

        // Add BOUNDSHEET records
        for ($i = 0; $i < $total_worksheets; $i++) {
            $this->_storeBoundsheet($this->_worksheets[$i]->name,$this->_worksheets[$i]->offset);
        }

        if ($this->_country_code != -1) {
            $this->_storeCountry();
        }

        if ($this->_BIFF_version == 0x0600) {
            //$this->_storeSupbookInternal();
            /* TODO: store external SUPBOOK records and XCT and CRN records
            in case of external references for BIFF8 */
            //$this->_storeExternsheetBiff8();
            $this->_storeSharedStringsTable();
        }

        // End Workbook globals
        $this->_storeEof();

        // Store the workbook in an OLE container
        $res = $this->_storeOLEFile();
        if ($this->isError($res)) {
            return $this->raiseError($res->getMessage());
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addFormat()

& Spreadsheet_Excel_Writer_Workbook::addFormat

(

$properties = array()

)

Add a new format to the Excel workbook.

Also, pass any properties to the Format constructor.

public

Parameters

array

$properties

array with properties for initializing the format.

Returns

&Spreadsheet_Excel_Writer_Format reference to an Excel Format

Definition at line 356 of file Workbook.php.

Referenced by Spreadsheet_Excel_Writer_Workbook().

    {
        $format = new Spreadsheet_Excel_Writer_Format($this->_BIFF_version, $this->_xf_index, $properties);
        $this->_xf_index += 1;
        $this->_formats[] = &$format;
        return $format;
    }

Here is the caller graph for this function:

addValidator()

& Spreadsheet_Excel_Writer_Workbook::addValidator

(

)

Create new validator.

public

Returns

&Spreadsheet_Excel_Writer_Validator reference to a Validator

Definition at line 370 of file Workbook.php.

References $valid.

    {
        include_once 'Spreadsheet/Excel/Writer/Validator.php';
        /* FIXME: check for successful inclusion*/
        $valid = new Spreadsheet_Excel_Writer_Validator($this->_parser);
        return $valid;
    }

addWorksheet()

& Spreadsheet_Excel_Writer_Workbook::addWorksheet

(

$name = ''

)

Add a new worksheet to the Excel workbook.

If no name is given the name of the worksheet will be Sheeti$i, with $i in [1..].

public

Parameters

string

$name

the optional name of the worksheet

Returns

mixed reference to a worksheet object on success, PEAR_Error on failure

Definition at line 310 of file Workbook.php.

References $_sheetname, and PEAR\raiseError().

    {
        $index     = count($this->_worksheets);
        $sheetname = $this->_sheetname;

        if ($name == '') {
            $name = $sheetname.($index+1);
        }

        // Check that sheetname is <= 31 chars (Excel limit before BIFF8).
        if ($this->_BIFF_version != 0x0600)
        {
            if (strlen($name) > 31) {
                return $this->raiseError("Sheetname $name must be <= 31 chars");
            }
        }

        // Check that the worksheet name doesn't already exist: a fatal Excel error.
        $total_worksheets = count($this->_worksheets);
        for ($i = 0; $i < $total_worksheets; $i++) {
            if ($this->_worksheets[$i]->getName() == $name) {
                return $this->raiseError("Worksheet '$name' already exists");
            }
        }

        $worksheet = new Spreadsheet_Excel_Writer_Worksheet($this->_BIFF_version,
                                   $name, $index,
                                   $this->_activesheet, $this->_firstsheet,
                                   $this->_str_total, $this->_str_unique,
                                   $this->_str_table, $this->_url_format,
                                   $this->_parser, $this->_tmp_dir);
        
        $this->_worksheets[$index] = &$worksheet;    // Store ref for iterator
        $this->_sheetnames[$index] = $name;          // Store EXTERNSHEET names
        $this->_parser->setExtSheet($name, $index);  // Register worksheet name with parser
        return $worksheet;
    }

Here is the call graph for this function:

close()

Spreadsheet_Excel_Writer_Workbook::close

(

)

Calls finalization methods.

This method should always be the last one to be called on every workbook

public

Returns

mixed true on success. PEAR_Error on failure

Definition at line 213 of file Workbook.php.

References $res, _storeWorkbook(), PEAR\isError(), and PEAR\raiseError().

    {
        if ($this->_fileclosed) { // Prevent close() from being called twice.
            return true;
        }
        $res = $this->_storeWorkbook();
        if ($this->isError($res)) {
            return $this->raiseError($res->getMessage());
        }
        $this->_fileclosed = 1;
        return true;
    }

Here is the call graph for this function:

setCountry()

Spreadsheet_Excel_Writer_Workbook::setCountry

(

$code

)

Set the country identifier for the workbook.

public

Parameters

integer

$code

Is the international calling country code for the chosen country.

Definition at line 295 of file Workbook.php.

References $code.

    {
        $this->_country_code = $code;
    }

setCustomColor()

Spreadsheet_Excel_Writer_Workbook::setCustomColor	(		$index,
			$red,
			$green,
			$blue
	)

Change the RGB components of the elements in the colour palette.

public

Parameters

integer	$index	colour index
integer	$red	red RGB value [0-255]
integer	$green	green RGB value [0-255]
integer	$blue	blue RGB value [0-255]

Returns

integer The palette index for the custom color

Definition at line 388 of file Workbook.php.

References $blue, $green, $red, and PEAR\raiseError().

    {
        // Match a HTML #xxyyzz style parameter
        /*if (defined $_[1] and $_[1] =~ /^#(\w\w)(\w\w)(\w\w)/ ) {
            @_ = ($_[0], hex $1, hex $2, hex $3);
        }*/

        // Check that the colour index is the right range
        if ($index < 8 or $index > 64) {
            // TODO: assign real error codes
            return $this->raiseError("Color index $index outside range: 8 <= index <= 64");
        }

        // Check that the colour components are in the right range
        if (($red   < 0 or $red   > 255) ||
            ($green < 0 or $green > 255) ||
            ($blue  < 0 or $blue  > 255))
        {
            return $this->raiseError("Color component outside range: 0 <= color <= 255");
        }

        $index -= 8; // Adjust colour index (wingless dragonfly)

        // Set the RGB value
        $this->_palette[$index] = array($red, $green, $blue, 0);
        return($index + 8);
    }

Here is the call graph for this function:

setVersion()

Spreadsheet_Excel_Writer_Workbook::setVersion

(

$version

)

Sets the BIFF version.

This method exists just to access experimental functionality from BIFF8. It will be deprecated ! Only possible value is 8 (Excel 97/2000). For any other value it fails silently.

public

Parameters

integer

$version

The BIFF version

Definition at line 262 of file Workbook.php.

    {
        if ($version == 8) { // only accept version 8
            $version = 0x0600;
            $this->_BIFF_version = $version;
            // change BIFFwriter limit for CONTINUE records
            $this->_limit = 8228;
            $this->_tmp_format->_BIFF_version = $version;
            $this->_url_format->_BIFF_version = $version;
            $this->_parser->_BIFF_version = $version;
            $this->_codepage = 0x04B0;

            $total_worksheets = count($this->_worksheets);
            // change version for all worksheets too
            for ($i = 0; $i < $total_worksheets; $i++) {
                $this->_worksheets[$i]->_BIFF_version = $version;
            }

            $total_formats = count($this->_formats);
            // change version for all formats too
            for ($i = 0; $i < $total_formats; $i++) {
                $this->_formats[$i]->_BIFF_version = $version;
            }
        }
    }

sheets()

Spreadsheet_Excel_Writer_Workbook::sheets

(

)

An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets()

public

See also

worksheets()

Returns

array

Definition at line 235 of file Workbook.php.

References worksheets().

    {
        return $this->worksheets();
    }

Here is the call graph for this function:

Spreadsheet_Excel_Writer_Workbook()

Spreadsheet_Excel_Writer_Workbook::Spreadsheet_Excel_Writer_Workbook

(

$filename

)

Class constructor.

Parameters

string

filename for storing the workbook. "-" for writing to stdout. public

Definition at line 174 of file Workbook.php.

References $filename, _setPaletteXl97(), addFormat(), and Spreadsheet_Excel_Writer_BIFFwriter\Spreadsheet_Excel_Writer_BIFFwriter().

Referenced by Spreadsheet_Excel_Writer\Spreadsheet_Excel_Writer().

    {
        // It needs to call its parent's constructor explicitly
        $this->Spreadsheet_Excel_Writer_BIFFwriter();

        $this->_filename         = $filename;
        $this->_parser           =& new Spreadsheet_Excel_Writer_Parser($this->_byte_order, $this->_BIFF_version);
        $this->_1904             = 0;
        $this->_activesheet      = 0;
        $this->_firstsheet       = 0;
        $this->_selected         = 0;
        $this->_xf_index         = 16; // 15 style XF's and 1 cell XF.
        $this->_fileclosed       = 0;
        $this->_biffsize         = 0;
        $this->_sheetname        = 'Sheet';
        $this->_tmp_format       =& new Spreadsheet_Excel_Writer_Format($this->_BIFF_version);
        $this->_worksheets       = array();
        $this->_sheetnames       = array();
        $this->_formats          = array();
        $this->_palette          = array();
        $this->_codepage         = 0x04E4; // FIXME: should change for BIFF8
        $this->_country_code     = -1;
        $this->_string_sizeinfo  = 3;

        // Add the default format for hyperlinks
        $this->_url_format =& $this->addFormat(array('color' => 'blue', 'underline' => 1));
        $this->_str_total       = 0;
        $this->_str_unique      = 0;
        $this->_str_table       = array();
        $this->_setPaletteXl97();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

worksheets()

Spreadsheet_Excel_Writer_Workbook::worksheets

(

)

An accessor for the _worksheets[] array.

Returns an array of the worksheet objects in a workbook

public

Returns

array

Definition at line 247 of file Workbook.php.

References $_worksheets.

Referenced by sheets().

    {
        return $this->_worksheets;
    }

Here is the caller graph for this function:

Field Documentation

$_1904

Spreadsheet_Excel_Writer_Workbook::$_1904

Definition at line 68 of file Workbook.php.

Referenced by _storeDatemode().

$_activesheet

Spreadsheet_Excel_Writer_Workbook::$_activesheet

Definition at line 74 of file Workbook.php.

Referenced by _storeWindow1().

$_biffsize

Spreadsheet_Excel_Writer_Workbook::$_biffsize

Definition at line 106 of file Workbook.php.

$_codepage

Spreadsheet_Excel_Writer_Workbook::$_codepage

Definition at line 154 of file Workbook.php.

Referenced by _storeCodepage().

$_country_code

Spreadsheet_Excel_Writer_Workbook::$_country_code

Definition at line 160 of file Workbook.php.

$_fileclosed

Spreadsheet_Excel_Writer_Workbook::$_fileclosed

Definition at line 99 of file Workbook.php.

$_filename

Spreadsheet_Excel_Writer_Workbook::$_filename

Definition at line 56 of file Workbook.php.

$_firstsheet

Spreadsheet_Excel_Writer_Workbook::$_firstsheet

Definition at line 80 of file Workbook.php.

Referenced by _storeWindow1().

$_formats

Spreadsheet_Excel_Writer_Workbook::$_formats

Definition at line 136 of file Workbook.php.

$_palette

Spreadsheet_Excel_Writer_Workbook::$_palette

Definition at line 142 of file Workbook.php.

Referenced by _storePalette().

$_parser

Spreadsheet_Excel_Writer_Workbook::$_parser

Definition at line 62 of file Workbook.php.

$_selected

Spreadsheet_Excel_Writer_Workbook::$_selected

Definition at line 86 of file Workbook.php.

Referenced by _storeWindow1().

$_sheetname

Spreadsheet_Excel_Writer_Workbook::$_sheetname

Definition at line 112 of file Workbook.php.

Referenced by addWorksheet().

$_sheetnames

Spreadsheet_Excel_Writer_Workbook::$_sheetnames

Definition at line 130 of file Workbook.php.

$_string_sizeinfo_size

Spreadsheet_Excel_Writer_Workbook::$_string_sizeinfo_size

Definition at line 166 of file Workbook.php.

$_tmp_format

Spreadsheet_Excel_Writer_Workbook::$_tmp_format

Definition at line 118 of file Workbook.php.

Referenced by _storeAllFonts(), and _storeAllXfs().

$_url_format

Spreadsheet_Excel_Writer_Workbook::$_url_format

Definition at line 148 of file Workbook.php.

$_worksheets

Spreadsheet_Excel_Writer_Workbook::$_worksheets

Definition at line 124 of file Workbook.php.

Referenced by worksheets().

$_xf_index

Spreadsheet_Excel_Writer_Workbook::$_xf_index

Definition at line 92 of file Workbook.php.

---

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

• Services/PEAR/lib/Spreadsheet/Excel/Writer/Workbook.php