Docs For Class PHPExcel_Writer_Excel5

$index =

[line 59]

Index for the Worksheet

Type:

integer

[ Top ]

$name =

[line 53]

Name of the Worksheet

Type:

string

[ Top ]

$selected =

[line 153]

Bit specifying if the worksheet is selected

Type:

integer

[ Top ]

$_active_pane =

[line 147]

The active pane for the worksheet

Tags:

access:

private

Type:

integer

[ Top ]

$_colinfo =

[line 135]

Array containing format information for columns

Tags:

access:

private

Type:

array

[ Top ]

$_dim_colmax =

[line 129]

Last column for the DIMENSIONS record

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_storeDimensions()
access:	private

Type:

integer

[ Top ]

$_dim_colmin =

[line 122]

First column for the DIMENSIONS record

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_storeDimensions()
access:	private

Type:

integer

[ Top ]

$_dim_rowmax =

[line 115]

Last row for the DIMENSIONS record

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_storeDimensions()
access:	private

Type:

integer

[ Top ]

$_dim_rowmin =

[line 108]

First row for the DIMENSIONS record

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::_storeDimensions()
access:	private

Type:

integer

[ Top ]

$_filehandle =

[line 77]

Filehandle to the temporary file for storing data

Tags:

access:

private

Type:

resource

[ Top ]

$_firstColumnIndex =

[line 231]

Index of first used column (at least 0)

Tags:

access:

private

Type:

int

[ Top ]

$_firstRowIndex =

[line 219]

Index of first used row (at least 0)

Tags:

access:

private

Type:

int

[ Top ]

$_lastColumnIndex =

[line 237]

Index of last used column (no used columns means -1)

Tags:

access:

private

Type:

int

[ Top ]

$_lastRowIndex =

[line 225]

Index of last used row.

Index of last used row. (no used rows means -1)

Tags:

access:

private

Type:

int

[ Top ]

$_outline_below =

[line 171]

Whether to have outline summary below.

Tags:

access:

private

Type:

bool

[ Top ]

$_outline_on =

[line 159]

Whether to use outline.

Tags:

access:

private

Type:

integer

[ Top ]

$_outline_right =

[line 177]

Whether to have outline summary at the right.

Tags:

access:

private

Type:

bool

[ Top ]

$_outline_row_level =

[line 183]

Outline row level.

Tags:

access:

private

Type:

integer

[ Top ]

$_outline_style =

[line 165]

Auto outline styles.

Tags:

access:

private

Type:

bool

[ Top ]

$_parser =

[line 71]

Reference to the parser used for parsing formulas

Tags:

access:

private

Type:

object Format

[ Top ]

$_phpSheet =

[line 243]

Sheet object

Tags:

access:

private

Type:

PHPExcel_Worksheet

[ Top ]

$_selection =

[line 141]

Array containing the selected area for the worksheet

Tags:

access:

private

Type:

array

[ Top ]

$_str_table =

[line 201]

Reference to the array containing all the unique strings in the workbook

Tags:

access:

private

Type:

array

[ Top ]

$_str_total =

[line 189]

Reference to the total number of strings in the workbook

Tags:

access:

private

Type:

integer

[ Top ]

$_str_unique =

[line 195]

Reference to the number of unique strings in the workbook

Tags:

access:

private

Type:

integer

[ Top ]

$_tempFilesCreated = array()

[line 213]

List of temporary files created

Tags:

access:

private

Type:

array

[ Top ]

$_tmp_dir =

[line 207]

The temporary dir for storing files

Tags:

access:

private

Type:

string

[ Top ]

$_url_format =

[line 65]

Reference to the (default) Format object for URLs

Tags:

access:

private

Type:

object Format

[ Top ]

$_using_tmpfile =

[line 83]

Boolean indicating if we are using a temporary file for storing data

Tags:

access:

private

Type:

bool

[ Top ]

$_xls_colmax =

[line 95]

Maximum number of columns for an Excel spreadsheet (BIFF5)

Tags:

access:

private

Type:

integer

[ Top ]

$_xls_rowmax =

[line 89]

Maximum number of rows for an Excel spreadsheet (BIFF5)

Tags:

access:

private

Type:

integer

[ Top ]

$_xls_strmax =

[line 101]

Maximum number of characters for a string (LABEL record in BIFF5)

Tags:

access:

private

Type:

integer

[ Top ]

constructor PHPExcel_Writer_Excel5_Worksheet [line 258]

PHPExcel_Writer_Excel5_Worksheet PHPExcel_Writer_Excel5_Worksheet(

$BIFF_version, string
$name, integer
$index, mixed
&$activesheet, mixed
&$firstsheet, 
&$str_total, 
&$str_unique, 
&$str_table, mixed
&$url_format, mixed
&$parser, [string
$tempDir = ''], PHPExcel_Worksheet
$phpSheet)

Constructor

Tags:

access:

private

Parameters:

string	$name	The name of the new worksheet
integer	$index	The index of the new worksheet
mixed	&$activesheet	The current activesheet of the workbook we belong to
mixed	&$firstsheet	The first worksheet in the workbook we belong to
mixed	&$url_format	The default format for hyperlinks
mixed	&$parser	The formula parser created for the Workbook
string	$tempDir	The temporary directory to be used
PHPExcel_Worksheet	$phpSheet
	$BIFF_version
	&$str_total
	&$str_unique
	&$str_table

[ Top ]

method activate [line 590]

void activate(
)

Set this worksheet as the active worksheet, i.

Set this worksheet as the active worksheet, i.e. the worksheet that is displayed when the workbook is opened. Also set it as selected.

Tags:

access:

public

[ Top ]

method cleanup [line 320]

void cleanup(
)

Cleanup

Tags:

access:

public

[ Top ]

method close [line 375]

void close(
array
$sheetnames)

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

Parameters:

array

$sheetnames

The array of sheetnames from the Workbook this worksheet belongs to

[ Top ]

method getData [line 547]

string getData(
)

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

Tags:

return:

The data

[ Top ]

method getName [line 536]

string getName(
)

Retrieve the worksheet name.

Retrieve the worksheet name. This is usefull when creating worksheets without a name.

Tags:

return:	The worksheet's name
access:	public

[ Top ]

method insertBitmap [line 2525]

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 ]

method printRowColHeaders [line 651]

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 ]

method select [line 578]

void select(
)

Set this worksheet as a selected worksheet, i.

Set this worksheet as a selected worksheet, i.e. the worksheet has its tab highlighted.

Tags:

access:

public

[ Top ]

method setColumn [line 619]

void setColumn(
integer
$firstcol, integer
$lastcol, integer
$width, [mixed
$format = null], [integer
$hidden = 0], [integer
$level = 0])

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

Tags:

access:

public

Parameters:

integer	$firstcol	first column on the range
integer	$lastcol	last column on the range
integer	$width	width to set
mixed	$format	The optional XF format to apply to the columns
integer	$hidden	The optional hidden atribute
integer	$level	The optional outline level

[ Top ]

method setDimensions [line 2955]

void setDimensions(
[int
$firstRowIndex = 0], [int
$lastRowIndex = -1], [int
$firstColumnIndex = 0], [int
$lastColumnIndex = -1])

Set sheet dimensions

Tags:

access:

public

Parameters:

int	$firstRowIndex
int	$lastRowIndex
int	$firstColumnIndex
int	$lastColumnIndex

[ Top ]

method setFirstSheet [line 603]

void setFirstSheet(
)

Set this worksheet as the first visible sheet.

Set this worksheet as the first visible sheet. This is necessary when there are a large number of worksheets and the activated worksheet is not visible on the screen.

Tags:

access:

public

[ Top ]

method setOutline [line 744]

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 ]

method setRow [line 1443]

void setRow(
integer
$row, integer
$height, [mixed
$format = null], [bool
$hidden = false], [integer
$level = 0])

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

Tags:

access:

public

Parameters:

integer	$row	The row to set
integer	$height	Height we are giving to the row. Use null to set XF without setting height
mixed	$format	XF format we are giving to the row
bool	$hidden	The optional hidden attribute
integer	$level	The optional outline level for row, in range [0,7]

[ Top ]

method setSelection [line 640]

void setSelection(
integer
$first_row, integer
$first_column, integer
$last_row, integer
$last_column)

Set which cell or cells are selected in a worksheet

Tags:

access:

public

Parameters:

integer	$first_row	first row in the selected quadrant
integer	$first_column	first column in the selected quadrant
integer	$last_row	last row in the selected quadrant
integer	$last_column	last column in the selected quadrant

[ Top ]

method setTempDir [line 357]

true setTempDir(
string
$dir)

Sets the temp dir used for storing files

Tags:

return:	if given dir is valid, false otherwise
access:	public

Parameters:

string

$dir

The dir to be used as temp dir

[ Top ]

method write [line 665]

void write(
integer
$row, integer
$col, mixed
$token, [mixed
$format = null], [
$numberFormat = null])

Map to the appropriate write method acording to the token recieved.

Tags:

access:

public

Parameters:

integer	$row	The row of the cell we are writing to
integer	$col	The column of the cell we are writing to
mixed	$token	What we are writing
mixed	$format	The optional format to apply to the cell
	$numberFormat

[ Top ]

method writeBlank [line 1025]

void writeBlank(
integer
$row, integer
$col, 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:

public

Parameters:

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

[ Top ]

method writeBoolErr [line 1065]

void writeBoolErr(

$row, 
$col, 
$value, 
$isError, 
$format)

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

Tags:

access:

public

Parameters:

	$row
	$col
	$value
	$isError
	$format

[ Top ]

method writeFormula [line 1113]

integer writeFormula(
integer
$row, integer
$col, string
$formula, [mixed
$format = null])

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:

public

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column
string	$formula	The formula text string
mixed	$format	The optional XF format

[ Top ]

method writeNote [line 965]

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:

public

Parameters:

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

[ Top ]

method writeNumber [line 779]

integer writeNumber(
integer
$row, integer
$col, float
$num, [mixed
$format = null])

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:

public

Parameters:

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

[ Top ]

method writeString [line 832]

integer writeString(
integer
$row, integer
$col, string
$str, [mixed
$format = null])

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:

public

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

[ Top ]

method writeStringBIFF8 [line 892]

integer writeStringBIFF8(
integer
$row, integer
$col, string
$str, [mixed
$format = null])

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:

public

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

[ Top ]

method writeUrl [line 1181]

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:

public

Parameters:

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

[ Top ]

method _append [line 721]

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 ]

method _checkRowCol [line 933]

boolean _checkRowCol(
integer
$row, integer
$col)

Check row and col before writing to a cell, and update the sheet's

Check row and col before writing to a cell, and update the sheet's dimensions accordingly

Tags:

return:	true for success, false if row and/or col are grester then maximums allowed.
access:	private

Parameters:

integer	$row	Zero indexed row
integer	$col	Zero indexed column

[ Top ]

method _initialize [line 335]

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 ]

method _positionImage [line 2599]

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

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 ]

method _processBitmap [line 2820]

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 ]

method _processBitmapGd [line 2790]

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 ]

method _sizeCol [line 2665]

integer _sizeCol(
integer
$col)

Convert the width of a cell from user's units to pixels. the relationship is: y = 7x +5. use the default value.

Convert the width of a cell from user's units to pixels. By interpolation the relationship is: y = 7x +5. If the width hasn't been set by the user we use the default value. If the col is hidden we use a value of zero.

Tags:

return:	The width in pixels
access:	private

Parameters:

integer

$col

The column

[ Top ]

method _sizeRow [line 2689]

integer _sizeRow(
integer
$row)

Convert the height of a cell from user's units to pixels. the relationship is: y = 4/3x. use the default value. possible to hide row yet).

Convert the height of a cell from user's units to pixels. By interpolation the relationship is: y = 4/3x. If the height hasn't been set by the user we use the default value. If the row is hidden we use a value of zero. (Not possible to hide row yet).

Tags:

return:	The width in pixels
access:	private

Parameters:

integer

$row

The row

[ Top ]

method _storeBreaks [line 2368]

void _storeBreaks(
)

Write the HORIZONTALPAGEBREAKS and VERTICALPAGEBREAKS BIFF records.

Tags:

access:

private

[ Top ]

method _storeColinfo [line 1643]

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 ]

method _storeDataValidity [line 2924]

void _storeDataValidity(
)

Store the DVAL and DV records.

Tags:

access:

private

[ Top ]

method _storeDefaultRowHeight [line 1588]

void _storeDefaultRowHeight(
)

Write BIFF record DEFAULTROWHEIGHT.

Tags:

access:

private

[ Top ]

method _storeDefcol [line 1612]

void _storeDefcol(
)

Write BIFF record DEFCOLWIDTH if COLINFO records are in use.

Tags:

access:

private

[ Top ]

method _storeDimensions [line 1500]

void _storeDimensions(
)

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

Tags:

access:

private

[ Top ]

method _storeExterncount [line 1848]

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 ]

method _storeExternsheet [line 1867]

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 ]

method _storeFooter [line 2083]

void _storeFooter(
)

Store the footer caption BIFF record.

Tags:

access:

private

[ Top ]

method _storeGridset [line 2271]

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 ]

method _storeGuts [line 2291]

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 ]

method _storeHcenter [line 2116]

void _storeHcenter(
)

Store the horizontal centering HCENTER BIFF record.

Tags:

access:

private

[ Top ]

method _storeHeader [line 2050]

void _storeHeader(
)

Store the header caption BIFF record.

Tags:

access:

private

[ Top ]

method _storeMarginBottom [line 2214]

void _storeMarginBottom(
)

Store the BOTTOMMARGIN BIFF record.

Tags:

access:

private

[ Top ]

method _storeMarginLeft [line 2151]

void _storeMarginLeft(
)

Store the LEFTMARGIN BIFF record.

Tags:

access:

private

[ Top ]

method _storeMarginRight [line 2172]

void _storeMarginRight(
)

Store the RIGHTMARGIN BIFF record.

Tags:

access:

private

[ Top ]

method _storeMarginTop [line 2193]

void _storeMarginTop(
)

Store the TOPMARGIN BIFF record.

Tags:

access:

private

[ Top ]

method _storeMergedCells [line 1736]

void _storeMergedCells(
)

Store the MERGEDCELLS records for all ranges of merged cells

Tags:

access:

private

[ Top ]

method _storeObjPicture [line 2717]

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 ]

method _storePanes [line 1898]

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 ]

method _storePassword [line 2494]

void _storePassword(
)

Write the worksheet PASSWORD record.

Tags:

access:

private

[ Top ]

method _storePrintGridlines [line 2253]

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 ]

method _storePrintHeaders [line 2235]

void _storePrintHeaders(
)

Write the PRINTHEADERS BIFF record.

Tags:

access:

private

[ Top ]

method _storeProtect [line 2471]

void _storeProtect(
)

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

Tags:

access:

private

[ Top ]

method _storeRangeProtection [line 1793]

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 ]

method _storeSelection [line 1695]

void _storeSelection(
array
$array)

Write BIFF record SELECTION.

Tags:

see:	PHPExcel_Writer_Excel5_Worksheet::setSelection()
access:	private

Parameters:

array

$array

array containing ($rwFirst,$colFirst,$rwLast,$colLast)

[ Top ]

method _storeSetup [line 1980]

void _storeSetup(
)

Store the page setup SETUP BIFF record.

Tags:

access:

private

[ Top ]

method _storeVcenter [line 2134]

void _storeVcenter(
)

Store the vertical centering VCENTER BIFF record.

Tags:

access:

private

[ Top ]

method _storeWindow2 [line 1529]

void _storeWindow2(
)

Write BIFF record Window2.

Tags:

access:

private

[ Top ]

method _storeWsbool [line 2333]

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 ]

method _storeZoom [line 2904]

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 ]

method _writeBIFF8CellRangeAddressFixed [line 502]

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 ]

method _writeUrlExternal [line 1327]

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 ]

method _writeUrlInternal [line 1276]

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 ]

method _writeUrlRange [line 1203]

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 ]

method _writeUrlWeb [line 1231]

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 ]

method _XF [line 697]

integer _XF(
mixed
&$format)

Returns an index to the XF record in the workbook

Tags:

return:	The XF record index
access:	private

Parameters:

mixed

&$format

The optional XF format

[ Top ]

Class: PHPExcel_Writer_Excel5_Worksheet

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Class: PHPExcel_Writer_Excel5_BIFFwriter

Inherited Methods

Class: PHPExcel_Writer_Excel5_BIFFwriter

Class Details

Tags:

Class Variables

$index =

$name =

$selected =

$_active_pane =

Tags:

$_colinfo =

Tags:

$_dim_colmax =

Tags:

$_dim_colmin =

Tags:

$_dim_rowmax =

Tags:

$_dim_rowmin =

Tags:

$_filehandle =

Tags:

$_firstColumnIndex =

Tags:

$_firstRowIndex =

Tags:

$_lastColumnIndex =

Tags:

$_lastRowIndex =

Tags:

$_outline_below =

Tags:

$_outline_on =

Tags:

$_outline_right =

Tags:

$_outline_row_level =

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:

$_url_format =

Tags:

$_using_tmpfile =

Tags:

$_xls_colmax =

Tags:

$_xls_rowmax =

Tags:

$_xls_strmax =

Tags:

Class Methods

constructor PHPExcel_Writer_Excel5_Worksheet [line 258]

Tags:

Parameters:

method activate [line 590]

Tags:

method cleanup [line 320]