PHPExcel_Writer_Excel5

# Class: PHPExcel_Writer_Excel5_Worksheet Source Location: /PHPExcel/Writer/Excel5/Worksheet.php
### Class Overview
    PHPExcel_Writer_Excel5_BIFFwriter
       |
       --PHPExcel_Writer_Excel5_Worksheet
PHPExcel_Writer_Excel5_Worksheet #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_active_pane $_colinfo $_colors $_countCellStyleXfs $_filehandle $_firstColumnIndex $_firstRowIndex $_lastColumnIndex $_lastRowIndex $_outline_below $_outline_on $_outline_right $_outline_style $_parser $_phpSheet $_selection $_str_table $_str_total $_str_unique $_tempFilesCreated $_tmp_dir $_using_tmpfile $_xls_strmax | ### Methods __construct cleanup close getData insertBitmap printRowColHeaders setOutline _append _initialize _mapErrorCode _positionImage _processBitmap _processBitmapGd _setColumn _setRow _storeBreaks _storeColinfo _storeDataValidity _storeDefaultRowHeight _storeDefcol _storeDimensions _storeExterncount _storeExternsheet _storeFooter _storeGridset _storeGuts _storeHcenter _storeHeader _storeMarginBottom _storeMarginLeft _storeMarginRight _storeMarginTop _storeMergedCells _storeMsoDrawing _storeObjPicture _storePanes _storePassword _storePrintGridlines _storePrintHeaders _storeProtect _storeRangeProtection _storeSelection _storeSetup _storeSheetLayout _storeVcenter _storeWindow2 _storeWsbool _storeZoom _writeBIFF8CellRangeAddressFixed _writeBlank _writeBoolErr _writeFormula _writeLabel _writeLabelSst _writeNote _writeNumber _writeObjectProtect _writeScenProtect _writeSheetProtection _writeString _writeStringRecord _writeUrl _writeUrlExternal _writeUrlInternal _writeUrlRange _writeUrlWeb
### Inherited Variables #### Class: PHPExcel_Writer_Excel5_BIFFwriter PHPExcel_Writer_Excel5_BIFFwriter::$_BIFF_version PHPExcel_Writer_Excel5_BIFFwriter::$_byte_order PHPExcel_Writer_Excel5_BIFFwriter::$_data PHPExcel_Writer_Excel5_BIFFwriter::$_datasize PHPExcel_Writer_Excel5_BIFFwriter::$_limit | ### Inherited Methods #### Class: PHPExcel_Writer_Excel5_BIFFwriter PHPExcel_Writer_Excel5_BIFFwriter::__construct() Constructor PHPExcel_Writer_Excel5_BIFFwriter::getByteOrder() Determine the byte order and store it as class data to avoid recalculating it for each call to new(). PHPExcel_Writer_Excel5_BIFFwriter::writeData() General storage function like _append, but returns string instead of modifying $this->_data PHPExcel_Writer_Excel5_BIFFwriter::writeEof() Writes Excel EOF record to indicate the end of a BIFF stream. PHPExcel_Writer_Excel5_BIFFwriter::_addContinue() Excel limits the size of BIFF records. Excel 97 the limit is 8228 bytes. must be split up into CONTINUE blocks. PHPExcel_Writer_Excel5_BIFFwriter::_append() General storage function PHPExcel_Writer_Excel5_BIFFwriter::_storeBof() Writes Excel BOF record to indicate the beginning of a stream or sub-stream in the BIFF file. PHPExcel_Writer_Excel5_BIFFwriter::_storeEof() Writes Excel EOF record to indicate the end of a BIFF stream.
### Class Details [line 116] PHPExcel_Writer_Excel5_Worksheet PHPExcel_Writer_Excel5_Worksheet #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_active_pane = [line 159] The active pane for the worksheet The active pane for the worksheet #### Tags:
access: | private
Type: | integer
[ Top ] #### $_colinfo = [line 147] Array containing format information for columns Array containing format information for columns #### Tags:
access: | private
Type: | array
[ Top ] #### $_colors = [line 206] Color cache Color cache #### Tags:
access: | private
Type: | mixed
[ Top ] #### $_countCellStyleXfs = [line 255] Count cell style Xfs Count cell style Xfs #### Tags:
access: | private
Type: | int
[ Top ] #### $_filehandle = [line 129] Filehandle to the temporary file for storing data Filehandle to the temporary file for storing data #### Tags:
access: | private
Type: | resource
[ Top ] #### $_firstColumnIndex = [line 236] Index of first used column (at least 0) Index of first used column (at least 0) #### Tags:
access: | private
Type: | int
[ Top ] #### $_firstRowIndex = [line 224] Index of first used row (at least 0) Index of first used row (at least 0) #### Tags:
access: | private
Type: | int
[ Top ] #### $_lastColumnIndex = [line 242] Index of last used column (no used columns means -1) Index of last used column (no used columns means -1) #### Tags:
access: | private
Type: | int
[ Top ] #### $_lastRowIndex = [line 230] Index of last used row. Index of last used row. (no used rows means -1) #### Tags:
access: | private
Type: | int
[ Top ] #### $_outline_below = [line 177] Whether to have outline summary below. Whether to have outline summary below. #### Tags:
access: | private
Type: | bool
[ Top ] #### $_outline_on = [line 165] Whether to use outline. Whether to use outline. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_outline_right = [line 183] Whether to have outline summary at the right. Whether to have outline summary at the right. #### Tags:
access: | private
Type: | bool
[ Top ] #### $_outline_style = [line 171] Auto outline styles. Auto outline styles. #### Tags:
access: | private
Type: | bool
[ Top ] #### $_parser = [line 123] Formula parser Formula parser #### Tags:
access: | private
Type: | PHPExcel_Writer_Excel5_Parser
[ Top ] #### $_phpSheet = [line 248] Sheet object Sheet object #### Tags:
access: | private
Type: | PHPExcel_Worksheet
[ Top ] #### $_selection = [line 153] Array containing the selected area for the worksheet 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 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 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 Reference to the number of unique strings in the workbook #### Tags:
access: | private
Type: | integer
[ Top ] #### $_tempFilesCreated = array() [line 218] List of temporary files created List of temporary files created #### Tags:
access: | private
Type: | array
[ Top ] #### $_tmp_dir = [line 212] The temporary dir for storing files The temporary dir for storing files #### Tags:
access: | private
Type: | string
[ Top ] #### $_using_tmpfile = [line 135] Boolean indicating if we are using a temporary file for storing data Boolean indicating if we are using a temporary file for storing data #### Tags:
access: | private
Type: | bool
[ Top ] #### $_xls_strmax = [line 141] Maximum number of characters for a string (LABEL record in BIFF5) Maximum number of characters for a string (LABEL record in BIFF5) #### Tags:
access: | private
Type: | integer
[ Top ] ### Class Methods ### constructor __construct [line 268]
`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 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 ] ### method cleanup [line 341]
`void cleanup( )`
Cleanup Cleanup #### Tags:
access: | public
[ Top ] ### method close [line 378]
`void close( )`
Add data to the beginning of the workbook (note the reverse order) and to the end of the workbook. 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 ] ### method getData [line 646]
`string getData( )`
Retrieves data from memory in one chunk, or from disk in $buffer sized chunks. Retrieves data from memory in one chunk, or from disk in $buffer sized chunks. #### Tags:
return: | The data
[ Top ] ### method insertBitmap [line 2554]
`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. 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 695]
`void printRowColHeaders( [integer $print = 1])`
Set the option to print the row and column headers on the printed page. 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 setOutline [line 730]
`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 _append [line 707]
`void _append( string $data)`
Store Worksheet data in memory using the parent's class append() or to a temporary file, the default. 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 _initialize [line 356]
`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 _mapErrorCode [line 3071]
`void _mapErrorCode( $errorCode)`
Map Error code Map Error code #### Tags:
access: | private
#### Parameters:
| $errorCode |
[ Top ] ### method _positionImage [line 2628]
`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 ] ### method _processBitmap [line 2802]
`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 2772]
`array _processBitmapGd( resource $image)`
Convert a GD-image into the internal format. 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 _setColumn [line 681]
`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. 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 ] ### method _setRow [line 1320]
`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. 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 ] ### method _storeBreaks [line 2349]
`void _storeBreaks( )`
Write the HORIZONTALPAGEBREAKS and VERTICALPAGEBREAKS BIFF records. Write the HORIZONTALPAGEBREAKS and VERTICALPAGEBREAKS BIFF records. #### Tags:
access: | private
[ Top ] ### method _storeColinfo [line 1517]
`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. 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 3045]
`void _storeDataValidity( )`
Store the DVAL and DV records. Store the DVAL and DV records. #### Tags:
access: | private
[ Top ] ### method _storeDefaultRowHeight [line 1466]
`void _storeDefaultRowHeight( )`
Write BIFF record DEFAULTROWHEIGHT. Write BIFF record DEFAULTROWHEIGHT. #### Tags:
access: | private
[ Top ] ### method _storeDefcol [line 1490]
`void _storeDefcol( )`
Write BIFF record DEFCOLWIDTH if COLINFO records are in use. Write BIFF record DEFCOLWIDTH if COLINFO records are in use. #### Tags:
access: | private
[ Top ] ### method _storeDimensions [line 1372]
`void _storeDimensions( )`
Writes Excel DIMENSIONS to define the area in which there is data. Writes Excel DIMENSIONS to define the area in which there is data. #### Tags:
access: | private
[ Top ] ### method _storeExterncount [line 1824]
`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 1843]
`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 2059]
`void _storeFooter( )`
Store the footer caption BIFF record. Store the footer caption BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeGridset [line 2247]
`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 2267]
`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 2092]
`void _storeHcenter( )`
Store the horizontal centering HCENTER BIFF record. Store the horizontal centering HCENTER BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeHeader [line 2026]
`void _storeHeader( )`
Store the header caption BIFF record. Store the header caption BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeMarginBottom [line 2190]
`void _storeMarginBottom( )`
Store the BOTTOMMARGIN BIFF record. Store the BOTTOMMARGIN BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeMarginLeft [line 2127]
`void _storeMarginLeft( )`
Store the LEFTMARGIN BIFF record. Store the LEFTMARGIN BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeMarginRight [line 2148]
`void _storeMarginRight( )`
Store the RIGHTMARGIN BIFF record. Store the RIGHTMARGIN BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeMarginTop [line 2169]
`void _storeMarginTop( )`
Store the TOPMARGIN BIFF record. Store the TOPMARGIN BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeMergedCells [line 1637]
`void _storeMergedCells( )`
Store the MERGEDCELLS records for all ranges of merged cells Store the MERGEDCELLS records for all ranges of merged cells #### Tags:
access: | private
[ Top ] ### method _storeMsoDrawing [line 2904]
`void _storeMsoDrawing( )`
Write MSODRAWING record Write MSODRAWING record #### Tags:
access: | private
[ Top ] ### method _storeObjPicture [line 2699]
`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 1874]
`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 2523]
`void _storePassword( )`
Write the worksheet PASSWORD record. Write the worksheet PASSWORD record. #### Tags:
access: | private
[ Top ] ### method _storePrintGridlines [line 2229]
`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 2211]
`void _storePrintHeaders( )`
Write the PRINTHEADERS BIFF record. Write the PRINTHEADERS BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeProtect [line 2452]
`void _storeProtect( )`
Set the Biff PROTECT record to indicate that the worksheet is protected. Set the Biff PROTECT record to indicate that the worksheet is protected. #### Tags:
access: | private
[ Top ] ### method _storeRangeProtection [line 1769]
`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 1567]
`void _storeSelection( )`
Write BIFF record SELECTION. Write BIFF record SELECTION. #### Tags:
access: | private
[ Top ] ### method _storeSetup [line 1956]
`void _storeSetup( )`
Store the page setup SETUP BIFF record. Store the page setup SETUP BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeSheetLayout [line 1695]
`void _storeSheetLayout( )`
Write SHEETLAYOUT record Write SHEETLAYOUT record #### Tags:
access: | private
[ Top ] ### method _storeVcenter [line 2110]
`void _storeVcenter( )`
Store the vertical centering VCENTER BIFF record. Store the vertical centering VCENTER BIFF record. #### Tags:
access: | private
[ Top ] ### method _storeWindow2 [line 1406]
`void _storeWindow2( )`
Write BIFF record Window2. Write BIFF record Window2. #### Tags:
access: | private
[ Top ] ### method _storeWsbool [line 2314]
`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 2886]
`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 613]
`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 _writeBlank [line 905]
`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 ] ### method _writeBoolErr [line 925]
`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) 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 ] ### method _writeFormula [line 952]
`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 ] ### method _writeLabel [line 804]
`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 ] ### method _writeLabelSst [line 840]
`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 ] ### method _writeNote [line 866]
`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 ] ### method _writeNumber [line 757]
`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 ] ### method _writeObjectProtect [line 2497]
`void _writeObjectProtect( )`
Write OBJECTPROTECT Write OBJECTPROTECT #### Tags:
access: | private
[ Top ] ### method _writeScenProtect [line 2473]
`void _writeScenProtect( )`
Write SCENPROTECT Write SCENPROTECT #### Tags:
access: | private
[ Top ] ### method _writeSheetProtection [line 1722]
`void _writeSheetProtection( )`
Write SHEETPROTECTION Write SHEETPROTECTION #### Tags:
access: | private
[ Top ] ### method _writeString [line 781]
`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 ] ### method _writeStringRecord [line 1046]
`void _writeStringRecord( string $stringValue)`
Write a STRING record. Write a STRING record. This #### Tags:
access: | private
#### Parameters:
string | $stringValue |
[ Top ] ### method _writeUrl [line 1077]
`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 ] ### method _writeUrlExternal [line 1225]
`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 1172]
`integer _writeUrlInternal( integer $row1, integer $col1, integer $row2, integer $col2, string $url)`
Used to write internal reference hyperlinks such as "Sheet1!A1". 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 1099]
`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 1127]
`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 ] Documentation generated on Mon, 11 Jan 2010 08:19:14 +0100 by phpDocumentor 1.4.1