Docs For Class PHPExcel_Writer_Excel5

PHPExcel_Writer_Excel5_Worksheet __construct(
int
$BIFF_version, 
&$str_total, 
&$str_unique, 
&$str_table, 
&$colors, mixed
$parser, [string
$tempDir = ''], 
$preCalculateFormulas, PHPExcel_Worksheet
$phpSheet, int
$str_total, int
$str_unique, array
$str_table)

Constructor

Tags:

access:

public

Overrides PHPExcel_Writer_Excel5_BIFFwriter::__construct() (Constructor)

Parameters:

int	$BIFF_version	BIFF version
int	$str_total	Total number of strings
int	$str_unique	Total number of unique strings
array	$str_table
mixed	$parser	The formula parser created for the Workbook
string	$tempDir	The temporary directory to be used
PHPExcel_Worksheet	$phpSheet
	&$str_total
	&$str_unique
	&$str_table
	&$colors
	$preCalculateFormulas

[ Top ]

void cleanup(
)

Cleanup

Tags:

access:

public

[ Top ]

void close(
)

Add data to the beginning of the workbook (note the reverse order) and to the end of the workbook.

Tags:

see:	PHPExcel_Writer_Excel5_Workbook::storeWorkbook()
access:	public

[ Top ]

string getData(
)

Retrieves data from memory in one chunk, or from disk in $buffer sized chunks.

Tags:

return:

The data

[ Top ]

void insertBitmap(
integer
$row, integer
$col, mixed
$bitmap, [integer
$x = 0], [integer
$y = 0], [float
$scale_x = 1], [float
$scale_y = 1])

Insert a 24bit bitmap image in a worksheet.

Tags:

access:

public

Parameters:

integer	$row	The row we are going to insert the bitmap into
integer	$col	The column we are going to insert the bitmap into
mixed	$bitmap	The bitmap filename or GD-image resource
integer	$x	The horizontal position (offset) of the image inside the cell.
integer	$y	The vertical position (offset) of the image inside the cell.
float	$scale_x	The horizontal scale
float	$scale_y	The vertical scale

[ Top ]

void printRowColHeaders(
[integer
$print = 1])

Set the option to print the row and column headers on the printed page.

Tags:

access:

public

Parameters:

integer

$print

Whether to print the headers or not. Defaults to 1 (print).

[ Top ]

void setOutline(
[bool
$visible = true], [bool
$symbols_below = true], [bool
$symbols_right = true], [bool
$auto_style = false])

This method sets the properties for outlining and grouping. correspond to Excel's defaults.

This method sets the properties for outlining and grouping. The defaults correspond to Excel's defaults.

Parameters:

bool	$visible
bool	$symbols_below
bool	$symbols_right
bool	$auto_style

[ Top ]

void _append(
string
$data)

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

Tags:

access:

private

Overrides PHPExcel_Writer_Excel5_BIFFwriter::_append() (General storage function)

Parameters:

string

$data

The binary data to append

[ Top ]

void _initialize(
)

Open a tmp file to store the majority of the Worksheet data. for example due to write permissions, store the data in memory. slow for large files.

Open a tmp file to store the majority of the Worksheet data. If this fails, for example due to write permissions, store the data in memory. This can be slow for large files.

Tags:

access:

private

[ Top ]

void _mapErrorCode(

$errorCode)

Map Error code

Tags:

access:

private

Parameters:

$errorCode

[ Top ]

void _positionImage(
integer
$col_start, integer
$row_start, integer
$x1, integer
$y1, integer
$width, integer
$height)

Calculate the vertices that define the position of the image as required by the OBJ record.

Calculate the vertices that define the position of the image as required by the OBJ record. +------------+------------+ | A | B | +-----+------------+------------+ | |(x1,y1) | | | 1 |(A1)._______|______ | | | | | | | | | | | +-----+----| BITMAP |-----+ | | | | | | 2 | |______________. | | | | (B2)| | | | (x2,y2)| +---- +------------+------------+ Example of a bitmap that covers some of the area from cell A1 to cell B2. Based on the width and height of the bitmap we need to calculate 8 vars: $col_start, $row_start, $col_end, $row_end, $x1, $y1, $x2, $y2. The width and height of the cells are also variable and have to be taken into account. The values of $col_start and $row_start are passed in from the calling function. The values of $col_end and $row_end are calculated by subtracting the width and height of the bitmap from the width and height of the underlying cells. The vertices are expressed as a percentage of the underlying cell width as follows (rhs values are in pixels): x1 = X / W *1024 y1 = Y / H *256 x2 = (X-1) / W *1024 y2 = (Y-1) / H *256 Where: X is distance from the left side of the underlying cell Y is distance from the top of the underlying cell W is the width of the cell H is the height of the cell The SDK incorrectly states that the height should be expressed as a percentage of 1024.

Tags:

access:

private

Parameters:

integer	$col_start	Col containing upper left corner of object
integer	$row_start	Row containing top left corner of object
integer	$x1	Distance to left side of object
integer	$y1	Distance to top of object
integer	$width	Width of image frame
integer	$height	Height of image frame

[ Top ]

array _processBitmap(
string
$bitmap)

Convert a 24 bit bitmap into the modified internal format used by Windows.

Convert a 24 bit bitmap into the modified internal format used by Windows. This is described in BITMAPCOREHEADER and BITMAPCOREINFO structures in the MSDN library.

Tags:

return:	Array with data and properties of the bitmap
access:	private

Parameters:

string

$bitmap

The bitmap to process

[ Top ]

array _processBitmapGd(
resource
$image)

Convert a GD-image into the internal format.

Tags:

return:	Array with data and properties of the bitmap
access:	private

Parameters:

resource

$image

The image to process

[ Top ]

void _setColumn(
integer
$firstcol, integer
$lastcol, integer
$width, [integer
$xfIndex = 15], [integer
$hidden = 0], [integer
$level = 0])

Set the width of a single column or a range of columns.

Tags:

access:

private

Parameters:

integer	$firstcol	first column on the range
integer	$lastcol	last column on the range
integer	$width	width to set
integer	$xfIndex	The optional cell style Xf index to apply to the columns
integer	$hidden	The optional hidden atribute
integer	$level	The optional outline level

[ Top ]

void _setRow(
integer
$row, integer
$height, integer
$xfIndex, [bool
$hidden = false], [integer
$level = 0])

This method is used to set the height and format for a row.

Tags:

access:

private

Parameters:

integer	$row	The row to set
integer	$height	Height we are giving to the row. Use null to set XF without setting height
integer	$xfIndex	The optional cell style Xf index to apply to the columns
bool	$hidden	The optional hidden attribute
integer	$level	The optional outline level for row, in range [0,7]

[ Top ]

void _storeBreaks(
)

Write the HORIZONTALPAGEBREAKS and VERTICALPAGEBREAKS BIFF records.

Tags:

access:

private

[ Top ]

void _storeColinfo(
array
$col_array)

Write BIFF record COLINFO to define column widths Note: The SDK says the record length is 0x0B but Excel writes a 0x0C length record.

Tags:

access:

private

Parameters:

array

$col_array

This is the only parameter received and is composed of the following:

=> First formatted column,
=> Last formatted column,
=> Col width (8.43 is Excel default),
=> The optional XF format of the column,
=> Option flags.
=> Optional outline level

[ Top ]

void _storeDataValidity(
)

Store the DVAL and DV records.

Tags:

access:

private

[ Top ]

void _storeDefaultRowHeight(
)

Write BIFF record DEFAULTROWHEIGHT.

Tags:

access:

private

[ Top ]

void _storeDefcol(
)

Write BIFF record DEFCOLWIDTH if COLINFO records are in use.

Tags:

access:

private

[ Top ]

void _storeDimensions(
)

Writes Excel DIMENSIONS to define the area in which there is data.

Tags:

access:

private

[ Top ]

void _storeExterncount(
integer
$count)

Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in a worksheet.

Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in a worksheet. Excel only stores references to external sheets that are used in formulas. For simplicity we store references to all the sheets in the workbook regardless of whether they are used or not. This reduces the overall complexity and eliminates the need for a two way dialogue between the formula parser the worksheet objects.

Tags:

access:

private

Parameters:

integer

$count

The number of external sheet references in this worksheet

[ Top ]

void _storeExternsheet(
string
$sheetname)

Writes the Excel BIFF EXTERNSHEET record. formulas. reference to all of the external worksheets the EXTERNSHEET index is the same as the worksheet index.

Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. A formula references a sheet name via an index. Since we store a reference to all of the external worksheets the EXTERNSHEET index is the same as the worksheet index.

Tags:

access:

private

Parameters:

string

$sheetname

The name of a external worksheet

[ Top ]

void _storeFooter(
)

Store the footer caption BIFF record.

Tags:

access:

private

[ Top ]

void _storeGridset(
)

Write the GRIDSET BIFF record. PRINTGRIDLINES record.

Write the GRIDSET BIFF record. Must be used in conjunction with the PRINTGRIDLINES record.

Tags:

access:

private

[ Top ]

void _storeGuts(
)

Write the GUTS BIFF record. where Excel outline symbols are displayed. controlled by a flag in WSBOOL.

Write the GUTS BIFF record. This is used to configure the gutter margins where Excel outline symbols are displayed. The visibility of the gutters is controlled by a flag in WSBOOL.

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_storeWsbool()
access:	private

[ Top ]

void _storeHcenter(
)

Store the horizontal centering HCENTER BIFF record.

Tags:

access:

private

[ Top ]

void _storeHeader(
)

Store the header caption BIFF record.

Tags:

access:

private

[ Top ]

void _storeMarginBottom(
)

Store the BOTTOMMARGIN BIFF record.

Tags:

access:

private

[ Top ]

void _storeMarginLeft(
)

Store the LEFTMARGIN BIFF record.

Tags:

access:

private

[ Top ]

void _storeMarginRight(
)

Store the RIGHTMARGIN BIFF record.

Tags:

access:

private

[ Top ]

void _storeMarginTop(
)

Store the TOPMARGIN BIFF record.

Tags:

access:

private

[ Top ]

void _storeMergedCells(
)

Store the MERGEDCELLS records for all ranges of merged cells

Tags:

access:

private

[ Top ]

void _storeMsoDrawing(
)

Write MSODRAWING record

Tags:

access:

private

[ Top ]

void _storeObjPicture(
integer
$colL, integer
$dxL, integer
$rwT, integer
$dyT, integer
$colR, integer
$dxR, integer
$rwB, integer
$dyB)

Store the OBJ record that precedes an IMDATA record. to support other Excel objects.

Store the OBJ record that precedes an IMDATA record. This could be generalise to support other Excel objects.

Tags:

access:

private

Parameters:

integer	$colL	Column containing upper left corner of object
integer	$dxL	Distance from left side of cell
integer	$rwT	Row containing top left corner of object
integer	$dyT	Distance from top of cell
integer	$colR	Column containing lower right corner of object
integer	$dxR	Distance from right of cell
integer	$rwB	Row containing bottom right corner of object
integer	$dyB	Distance from bottom of cell

[ Top ]

void _storePanes(
)

Writes the Excel BIFF PANE record.

Writes the Excel BIFF PANE record. The panes can either be frozen or thawed (unfrozen). Frozen panes are specified in terms of an integer number of rows and columns. Thawed panes are specified in terms of Excel's units for rows and columns.

Tags:

access:

private

[ Top ]

void _storePassword(
)

Write the worksheet PASSWORD record.

Tags:

access:

private

[ Top ]

void _storePrintGridlines(
)

Write the PRINTGRIDLINES BIFF record. GRIDSET record.

Write the PRINTGRIDLINES BIFF record. Must be used in conjunction with the GRIDSET record.

Tags:

access:

private

[ Top ]

void _storePrintHeaders(
)

Write the PRINTHEADERS BIFF record.

Tags:

access:

private

[ Top ]

void _storeProtect(
)

Set the Biff PROTECT record to indicate that the worksheet is protected.

Tags:

access:

private

[ Top ]

void _storeRangeProtection(
)

Write BIFF record RANGEPROTECTION

Write BIFF record RANGEPROTECTION Openoffice.org's Documentaion of the Microsoft Excel File Format uses term RANGEPROTECTION for these records Microsoft Office Excel 97-2007 Binary File Format Specification uses term FEAT for these records

Tags:

access:

private

[ Top ]

void _storeSelection(
)

Write BIFF record SELECTION.

Tags:

access:

private

[ Top ]

void _storeSetup(
)

Store the page setup SETUP BIFF record.

Tags:

access:

private

[ Top ]

void _storeSheetLayout(
)

Write SHEETLAYOUT record

Tags:

access:

private

[ Top ]

void _storeVcenter(
)

Store the vertical centering VCENTER BIFF record.

Tags:

access:

private

[ Top ]

void _storeWindow2(
)

Write BIFF record Window2.

Tags:

access:

private

[ Top ]

void _storeWsbool(
)

Write the WSBOOL BIFF record, mainly for fit-to-page. with the SETUP record.

Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction with the SETUP record.

Tags:

access:

private

[ Top ]

void _storeZoom(
)

Store the window zoom factor. simplicity we will store all fractions with a numerator of 100.

Store the window zoom factor. This should be a reduced fraction but for simplicity we will store all fractions with a numerator of 100.

Tags:

access:

private

[ Top ]

string _writeBIFF8CellRangeAddressFixed(
[string
$range = 'A1'])

Write a cell range address in BIFF8

Write a cell range address in BIFF8 always fixed range See section 2.5.14 in OpenOffice.org's Documentation of the Microsoft Excel File Format

Tags:

return:	Binary data
access:	private

Parameters:

string

$range

E.g. 'A1' or 'A1:B6'

[ Top ]

void _writeBlank(
integer
$row, integer
$col, 
$xfIndex, mixed
$format)

Write a blank cell to the specified row and column (zero indexed).

Write a blank cell to the specified row and column (zero indexed). A blank cell is used to specify formatting without adding a string or a number. A blank cell without a format serves no purpose. Therefore, we don't write a BLANK record unless a format is specified. Returns 0 : normal termination (including no format) -1 : insufficient number of arguments -2 : row or column out of range

Tags:

access:

private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
mixed	$format	The XF format
	$xfIndex

[ Top ]

void _writeBoolErr(
int
$row, int
$col, int
$value, boolean
$isError, int
$xfIndex)

Write a boolean or an error type to the specified row and column (zero indexed)

Tags:

access:

private

Parameters:

int	$row	Row index (0-based)
int	$col	Column index (0-based)
int	$value
boolean	$isError	Error or Boolean?
int	$xfIndex

[ Top ]

integer _writeFormula(
integer
$row, integer
$col, string
$formula, 
$xfIndex, mixed
$calculatedValue, mixed
$format)

Write a formula to the specified row and column (zero indexed).

Write a formula to the specified row and column (zero indexed). The textual representation of the formula is passed to the parser in Parser.php which returns a packed binary string. Returns 0 : normal termination -1 : formula errors (bad formula) -2 : row or column out of range

Tags:

access:

private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
string	$formula	The formula text string
mixed	$format	The optional XF format
mixed	$calculatedValue	Calculated value
	$xfIndex

[ Top ]

integer _writeLabel(
integer
$row, integer
$col, string
$str, 
$xfIndex, mixed
$format)

Write a string to the specified row and column (zero indexed).

Write a string to the specified row and column (zero indexed). NOTE: there is an Excel 5 defined limit of 255 characters. $format is optional. Returns 0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars

Tags:

access:

private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
string	$str	The string to write
mixed	$format	The XF format for the cell
	$xfIndex

[ Top ]

integer _writeLabelSst(
integer
$row, integer
$col, string
$str, 
$xfIndex, mixed
$format)

Write a string to the specified row and column (zero indexed).

Write a string to the specified row and column (zero indexed). This is the BIFF8 version (no 255 chars limit). $format is optional. Returns 0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars

Tags:

access:

private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
string	$str	The string to write
mixed	$format	The XF format for the cell
	$xfIndex

[ Top ]

void _writeNote(
integer
$row, integer
$col, string
$note)

Writes a note associated with the cell given by the row and column.

Writes a note associated with the cell given by the row and column. NOTE records don't have a length limit.

Tags:

access:

private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
string	$note	The note to write

[ Top ]

integer _writeNumber(
integer
$row, integer
$col, float
$num, 
$xfIndex, mixed
$format)

Write a double to the specified row and column (zero indexed).

Write a double to the specified row and column (zero indexed). An integer can be written as a double. Excel will display an integer. $format is optional. Returns 0 : normal termination -2 : row or column out of range

Tags:

access:

private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
float	$num	The number to write
mixed	$format	The optional XF format
	$xfIndex

[ Top ]

void _writeObjectProtect(
)

Write OBJECTPROTECT

Tags:

access:

private

[ Top ]

void _writeScenProtect(
)

Write SCENPROTECT

Tags:

access:

private

[ Top ]

void _writeSheetProtection(
)

Write SHEETPROTECTION

Tags:

access:

private

[ Top ]

void _writeString(
int
$row, int
$col, string
$str, int
$xfIndex)

Write a LABELSST record or a LABEL record.

Write a LABELSST record or a LABEL record. Which one depends on BIFF version

Tags:

access:

private

Parameters:

int	$row	Row index (0-based)
int	$col	Column index (0-based)
string	$str	The string
int	$xfIndex	Index to XF record

[ Top ]

void _writeStringRecord(
string
$stringValue)

Write a STRING record.

Write a STRING record. This

Tags:

access:

private

Parameters:

string

$stringValue

[ Top ]

integer _writeUrl(
integer
$row, integer
$col, string
$url)

Write a hyperlink.

Write a hyperlink. This is comprised of two elements: the visible label and the invisible link. The visible label is the same as the link unless an alternative string is specified. The label is written using the _writeString() method. Therefore the 255 characters string limit applies. $string and $format are optional. The hyperlink can be to a http, ftp, mail, internal sheet (not yet), or external directory url. Returns 0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars

Tags:

access:

private

Parameters:

integer	$row	Row
integer	$col	Column
string	$url	URL string

[ Top ]

integer _writeUrlExternal(
integer
$row1, integer
$col1, integer
$row2, integer
$col2, string
$url)

Write links to external directory names such as 'c:\foo. c:\foo.

Write links to external directory names such as 'c:\foo.xls', c:\foo.xls#Sheet1!A1', '../../foo.xls'. and '../../foo.xls#Sheet1!A1'. Note: Excel writes some relative links with the $dir_long string. We ignore these cases for the sake of simpler code.

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_writeUrl()
access:	private

Parameters:

integer	$row1	Start row
integer	$col1	Start column
integer	$row2	End row
integer	$col2	End column
string	$url	URL string

[ Top ]

integer _writeUrlInternal(
integer
$row1, integer
$col1, integer
$row2, integer
$col2, string
$url)

Used to write internal reference hyperlinks such as "Sheet1!A1".

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_writeUrl()
access:	private

Parameters:

integer	$row1	Start row
integer	$col1	Start column
integer	$row2	End row
integer	$col2	End column
string	$url	URL string

[ Top ]

integer _writeUrlRange(
integer
$row1, integer
$col1, integer
$row2, integer
$col2, string
$url)

This is the more general form of _writeUrl(). written to a range of cells. to be written. (Sheet1!A1) or external ('c:\temp\foo.

This is the more general form of _writeUrl(). It allows a hyperlink to be written to a range of cells. This function also decides the type of hyperlink to be written. These are either, Web (http, ftp, mailto), Internal (Sheet1!A1) or external ('c:\temp\foo.xls#Sheet1!A1').

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_writeUrl()
access:	private

Parameters:

integer	$row1	Start row
integer	$col1	Start column
integer	$row2	End row
integer	$col2	End column
string	$url	URL string

[ Top ]

integer _writeUrlWeb(
integer
$row1, integer
$col1, integer
$row2, integer
$col2, string
$url)

Used to write http, ftp and mailto hyperlinks.

Used to write http, ftp and mailto hyperlinks. The link type ($options) is 0x03 is the same as absolute dir ref without sheet. However it is differentiated by the $unknown2 data stream.

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_writeUrl()
access:	private

Parameters:

integer	$row1	Start row
integer	$col1	Start column
integer	$row2	End row
integer	$col2	End column
string	$url	URL string

[ Top ]

Class: PHPExcel_Writer_Excel5_Worksheet

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Class: PHPExcel_Writer_Excel5_BIFFwriter

Inherited Methods

Class: PHPExcel_Writer_Excel5_BIFFwriter

Class Details

Tags:

Class Variables

$_active_pane =

Tags:

$_colinfo =

Tags:

$_colors =

Tags:

$_countCellStyleXfs =

Tags:

$_filehandle =

Tags:

$_firstColumnIndex =

Tags:

$_firstRowIndex =

Tags:

$_lastColumnIndex =

Tags:

$_lastRowIndex =

Tags:

$_outline_below =

Tags:

$_outline_on =

Tags:

$_outline_right =

Tags:

$_outline_style =

Tags:

$_parser =

Tags:

$_phpSheet =

Tags:

$_selection =

Tags:

$_str_table =

Tags:

$_str_total =

Tags:

$_str_unique =

Tags:

$_tempFilesCreated = array()

Tags:

$_tmp_dir =

Tags:

$_using_tmpfile =

Tags:

$_xls_strmax =

Tags:

Class Methods

constructor __construct [line 268]

Tags:

Parameters:

method cleanup [line 341]

Tags:

method close [line 378]

Tags:

method getData [line 646]

Tags:

method insertBitmap [line 2554]

Tags:

Parameters:

method printRowColHeaders [line 695]

Tags:

Parameters:

method setOutline [line 730]

Parameters:

method _append [line 707]

Tags:

Parameters: