$_data
$_data : string
The string containing the data of the BIFF stream.
$phpSheet : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
Sheet object.
$parser : \PhpOffice\PhpSpreadsheet\Writer\Xls\Parser
Formula parser.
$escher : \PhpOffice\PhpSpreadsheet\Shared\Escher
Escher object corresponding to MSODRAWING.
__construct(integer $str_total, integer $str_unique, $str_table, $colors, \PhpOffice\PhpSpreadsheet\Writer\Xls\Parser $parser, boolean $preCalculateFormulas, \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $phpSheet)
Constructor.
| integer | $str_total | Total number of strings |
| integer | $str_unique | Total number of unique strings |
| $str_table | ||
| $colors | ||
| \PhpOffice\PhpSpreadsheet\Writer\Xls\Parser | $parser | The formula parser created for the Workbook |
| boolean | $preCalculateFormulas | Flag indicating whether formulas should be calculated or just written |
| \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet | $phpSheet | The worksheet to write |
setOutline(boolean $visible = true, boolean $symbols_below = true, boolean $symbols_right = true, boolean $auto_style = false)
This method sets the properties for outlining and grouping. The defaults correspond to Excel's defaults.
| boolean | $visible | |
| boolean | $symbols_below | |
| boolean | $symbols_right | |
| boolean | $auto_style |
writeBlank(integer $row, integer $col, mixed $xfIndex) : integer
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
| integer | $row | Zero indexed row |
| integer | $col | Zero indexed column |
| mixed | $xfIndex | The XF format index |
writeUrlRange(integer $row1, integer $col1, integer $row2, integer $col2, string $url) : integer
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').
| integer | $row1 | Start row |
| integer | $col1 | Start column |
| integer | $row2 | End row |
| integer | $col2 | End column |
| string | $url | URL string |
writeUrlWeb(integer $row1, integer $col1, integer $row2, integer $col2, string $url) : integer
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.
| integer | $row1 | Start row |
| integer | $col1 | Start column |
| integer | $row2 | End row |
| integer | $col2 | End column |
| string | $url | URL string |
writeUrlInternal(integer $row1, integer $col1, integer $row2, integer $col2, string $url) : integer
Used to write internal reference hyperlinks such as "Sheet1!A1".
| integer | $row1 | Start row |
| integer | $col1 | Start column |
| integer | $row2 | End row |
| integer | $col2 | End column |
| string | $url | URL string |
writeUrlExternal(integer $row1, integer $col1, integer $row2, integer $col2, string $url) : integer
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.
| integer | $row1 | Start row |
| integer | $col1 | Start column |
| integer | $row2 | End row |
| integer | $col2 | End column |
| string | $url | URL string |
insertBitmap(integer $row, integer $col, mixed $bitmap, integer $x, integer $y, float $scale_x = 1, float $scale_y = 1)
Insert a 24bit bitmap image in a worksheet.
| 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 |
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.
| +------------+------------+ | 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 cellThe SDK incorrectly states that the height should be expressed as a percentage of 1024.
| 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 |
processBitmap(string $bitmap) : array
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.
| string | $bitmap | The bitmap to process |
Array with data and properties of the bitmap
getEscher() : \PhpOffice\PhpSpreadsheet\Shared\Escher
Get Escher object.
setEscher(\PhpOffice\PhpSpreadsheet\Shared\Escher $pValue = null)
Set Escher object.
| \PhpOffice\PhpSpreadsheet\Shared\Escher | $pValue |
addContinue(string $data) : string
Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In Excel 97 the limit is 8228 bytes. Records that are longer than these limits must be split up into CONTINUE blocks.
This function takes a long BIFF record and inserts CONTINUE records as necessary.
| string | $data | The original binary data to be written |
A very convenient string of continue blocks
writeBIFF8CellRangeAddressFixed(string $range) : string
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.
| string | $range | E.g. 'A1' or 'A1:B6' |
Binary data
writeNumber(integer $row, integer $col, float $num, mixed $xfIndex) : integer
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
| integer | $row | Zero indexed row |
| integer | $col | Zero indexed column |
| float | $num | The number to write |
| mixed | $xfIndex | The optional XF format |
writeString(integer $row, integer $col, string $str, integer $xfIndex)
Write a LABELSST record or a LABEL record. Which one depends on BIFF version.
| integer | $row | Row index (0-based) |
| integer | $col | Column index (0-based) |
| string | $str | The string |
| integer | $xfIndex | Index to XF record |
writeRichTextString(integer $row, integer $col, string $str, integer $xfIndex, array $arrcRun)
Write a LABELSST record or a LABEL record. Which one depends on BIFF version It differs from writeString by the writing of rich text strings.
| integer | $row | Row index (0-based) |
| integer | $col | Column index (0-based) |
| string | $str | The string |
| integer | $xfIndex | The XF format index for the cell |
| array | $arrcRun | Index to Font record and characters beginning |
writeLabelSst(integer $row, integer $col, string $str, mixed $xfIndex)
Write a string to the specified row and column (zero indexed).
This is the BIFF8 version (no 255 chars limit). $format is optional.
| integer | $row | Zero indexed row |
| integer | $col | Zero indexed column |
| string | $str | The string to write |
| mixed | $xfIndex | The XF format index for the cell |
writeBoolErr(integer $row, integer $col, integer $value, boolean $isError, integer $xfIndex) : integer
Write a boolean or an error type to the specified row and column (zero indexed).
| integer | $row | Row index (0-based) |
| integer | $col | Column index (0-based) |
| integer | $value | |
| boolean | $isError | Error or Boolean? |
| integer | $xfIndex |
writeFormula(integer $row, integer $col, string $formula, mixed $xfIndex, mixed $calculatedValue) : integer
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
| integer | $row | Zero indexed row |
| integer | $col | Zero indexed column |
| string | $formula | The formula text string |
| mixed | $xfIndex | The XF format index |
| mixed | $calculatedValue | Calculated value |
writeUrl(integer $row, integer $col, string $url) : integer
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
| integer | $row | Row |
| integer | $col | Column |
| string | $url | URL string |
writeRow(integer $row, integer $height, integer $xfIndex, boolean $hidden = false, integer $level)
This method is used to set the height and format for a row.
| 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 |
| boolean | $hidden | The optional hidden attribute |
| integer | $level | The optional outline level for row, in range [0,7] |
writeColinfo(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.
| array | $col_array | This is the only parameter received and is composed of the following: 0 => First formatted column, 1 => Last formatted column, 2 => Col width (8.43 is Excel default), 3 => The optional XF format of the column, 4 => Option flags. 5 => Optional outline level |
writeObjPicture(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. This could be generalise to support other Excel objects.
| 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 |
writeCFRule(\PhpOffice\PhpSpreadsheet\Style\Conditional $conditional)
Write CFRule Record.
| \PhpOffice\PhpSpreadsheet\Style\Conditional | $conditional |