$_1904 =
[line 69]
Flag for 1904 date system (0 => base date is 1900, 1 => base date is 1904)
Flag for 1904 date system (0 => base date is 1900, 1 => base date is 1904)
Tags:
$_activesheet =
[line 75]
The active worksheet of the workbook (0 indexed)
The active worksheet of the workbook (0 indexed)
Tags:
$_biff8_input_encoding = 'UTF-16LE'
[line 308]
Tags:
$_biffsize =
[line 107]
The BIFF file size for the workbook.
The BIFF file size for the workbook.
Tags:
$_codepage =
[line 155]
The codepage indicates the text encoding used for strings
The codepage indicates the text encoding used for strings
Tags:
$_country_code =
[line 161]
The country code used for localization
The country code used for localization
Tags:
$_fileclosed =
[line 100]
Flag for preventing close from being called twice.
Flag for preventing close from being called twice.
Tags:
$_filename =
[line 57]
Filename for the Workbook
Filename for the Workbook
Tags:
$_firstsheet =
[line 81]
1st displayed worksheet in the workbook (0 indexed)
1st displayed worksheet in the workbook (0 indexed)
Tags:
$_formats =
[line 137]
Array containing references to all of this workbook's formats
Array containing references to all of this workbook's formats
Tags:
$_palette =
[line 143]
Array containing the colour palette
Array containing the colour palette
Tags:
$_parser =
[line 63]
Formula parser
Formula parser
Tags:
$_selected =
[line 87]
Number of workbook tabs selected
Number of workbook tabs selected
Tags:
$_sheetname =
[line 113]
The default sheetname for all sheets created.
The default sheetname for all sheets created.
Tags:
$_sheetnames =
[line 131]
Array of sheetnames for creating the EXTERNSHEET records
Array of sheetnames for creating the EXTERNSHEET records
Tags:
$_string_sizeinfo_size =
[line 173]
number of bytes for sizeinfo of strings
number of bytes for sizeinfo of strings
Tags:
$_tmp_dir =
[line 167]
The temporary dir for storing the OLE file
The temporary dir for storing the OLE file
Tags:
$_tmp_format =
[line 119]
The default XF format.
The default XF format.
Tags:
$_url_format =
[line 149]
The default format for URLs.
The default format for URLs.
Tags:
$_worksheets =
[line 125]
Array containing references to all of this workbook's worksheets
Array containing references to all of this workbook's worksheets
Tags:
$_xf_index =
[line 93]
Index for creating adding new formats to the workbook
Index for creating adding new formats to the workbook
Tags:
constructor PHPExcel_Writer_Excel5_Workbook [line 181]
PHPExcel_Writer_Excel5_Workbook PHPExcel_Writer_Excel5_Workbook(
string
$filename)
|
|
Class constructor
Class constructor
Tags:
Parameters:
method addFormat [line 378]
&PHPExcel_Writer_Excel5_Format &addFormat(
[array
$properties = array()])
|
|
Add a new format to the Excel workbook.
Add a new format to the Excel workbook. Also, pass any properties to the Format constructor.
Tags:
Parameters:
method addWorksheet [line 322]
mixed &addWorksheet(
[string
$name = ''])
|
|
Add a new worksheet to the Excel workbook.
Add a new worksheet to the Excel workbook. If no name is given the name of the worksheet will be Sheeti$i, with $i in [1..].
Tags:
Parameters:
method close [line 221]
Calls finalization methods.
Calls finalization methods. This method should always be the last one to be called on every workbook
Tags:
method setBIFF8InputEncoding [line 309]
void setBIFF8InputEncoding(
$encoding)
|
|
Parameters:
method setCountry [line 303]
void setCountry(
integer
$code)
|
|
Set the country identifier for the workbook
Set the country identifier for the workbook
Tags:
Parameters:
method setCustomColor [line 396]
integer setCustomColor(
integer
$index, integer
$red, integer
$green, integer
$blue)
|
|
Change the RGB components of the elements in the colour palette.
Change the RGB components of the elements in the colour palette.
Tags:
Parameters:
method setTempDir [line 578]
true setTempDir(
string
$dir)
|
|
Sets the temp dir used for storing the OLE file
Sets the temp dir used for storing the OLE file
Tags:
Parameters:
method setVersion [line 270]
void setVersion(
integer
$version)
|
|
Sets the BIFF version.
Sets the BIFF version. This method exists just to access experimental functionality from BIFF8. It will be deprecated ! Only possible value is 8 (Excel 97/2000). For any other value it fails silently.
Tags:
Parameters:
method sheets [line 243]
An accessor for the _worksheets[] array
An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets()
Tags:
method worksheets [line 255]
An accessor for the _worksheets[] array.
An accessor for the _worksheets[] array. Returns an array of the worksheet objects in a workbook
Tags:
method writeAllDefinedNamesBiff8 [line 880]
void writeAllDefinedNamesBiff8(
)
|
|
Writes all the DEFINEDNAME records (BIFF8).
Writes all the DEFINEDNAME records (BIFF8). So far this is only used for repeating rows/columns (print titles) and print areas
Tags:
method writeCountry [line 1363]
Stores the COUNTRY record for localization
Stores the COUNTRY record for localization
Tags:
method writeDefinedNameBiff8 [line 938]
string writeDefinedNameBiff8(
string
$name, string
$formulaData, [string
$sheetIndex = 0], [boolean
$isBuiltIn = false])
|
|
Write a DEFINEDNAME record for BIFF8 using explicit binary formula data
Write a DEFINEDNAME record for BIFF8 using explicit binary formula data
Tags:
Parameters:
method writeExternsheetBiff8 [line 1077]
void writeExternsheetBiff8(
string
$sheetname)
|
|
Writes the Excel BIFF EXTERNSHEET record. formulas.
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas.
Tags:
Parameters:
method writeSharedStringsTable [line 1555]
void writeSharedStringsTable(
)
|
|
Write all of the workbooks strings into an indexed array.
Write all of the workbooks strings into an indexed array. See the comments in _calculate_shared_string_sizes() for more information.
The Excel documentation says that the SST record should be followed by an EXTSST record. The EXTSST record is a hash table that is used to optimise access to SST. However, despite the documentation it doesn't seem to be required so we will ignore it.
Tags:
method writeSupbookInternal [line 1058]
void writeSupbookInternal(
)
|
|
Write Internal SUPBOOK record
Write Internal SUPBOOK record
Tags:
method _calcSheetOffsets [line 623]
void _calcSheetOffsets(
)
|
|
Calculate offsets for Worksheet BOF records.
Calculate offsets for Worksheet BOF records.
Tags:
method _calculateSharedStringsSizes [line 1410]
void _calculateSharedStringsSizes(
)
|
|
Calculate Handling of the SST continue blocks is complicated by the need to include an additional continuation byte depending on whether the string is split between blocks or whether it starts at the beginning of the block. additional complications that will arise later when/if Rich Strings are supported).
Calculate Handling of the SST continue blocks is complicated by the need to include an additional continuation byte depending on whether the string is split between blocks or whether it starts at the beginning of the block. (There are also additional complications that will arise later when/if Rich Strings are supported).
Tags:
method _setPaletteXl97 [line 429]
Sets the colour palette to the Excel 97+ default.
Sets the colour palette to the Excel 97+ default.
Tags:
method _storeAllFonts [line 663]
Store the Excel FONT records.
Store the Excel FONT records.
Tags:
method _storeAllNumFormats [line 707]
void _storeAllNumFormats(
)
|
|
Store user defined numerical formats i.
Store user defined numerical formats i.e. FORMAT records
Tags:
method _storeAllStyles [line 782]
Write all STYLE records.
Write all STYLE records.
Tags:
method _storeAllXfs [line 755]
Write all XF records.
Write all XF records.
Tags:
method _storeBoundsheet [line 1029]
void _storeBoundsheet(
string
$sheetname, integer
$offset)
|
|
Writes Excel BIFF BOUNDSHEET record.
Writes Excel BIFF BOUNDSHEET record. FIXME: inconsistent with BIFF documentation
Tags:
Parameters:
method _storeCodepage [line 979]
Stores the CODEPAGE biff record.
Stores the CODEPAGE biff record.
Tags:
method _storeDatemode [line 1149]
Write DATEMODE record to indicate the date system in use (1904 or 1900).
Write DATEMODE record to indicate the date system in use (1904 or 1900).
Tags:
method _storeExterncount [line 1175]
void _storeExterncount(
integer
$cxals)
|
|
Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook.
Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook.
Excel only stores references to external sheets that are used in NAME. The workbook NAME record is required to define the print area and the repeat rows and columns.
A similar method is used in Worksheet.php for a slightly different purpose.
Tags:
Parameters:
method _storeExterns [line 793]
Write the EXTERNCOUNT and EXTERNSHEET records. the NAME records.
Write the EXTERNCOUNT and EXTERNSHEET records. These are used as indexes for the NAME records.
Tags:
method _storeExternsheet [line 1196]
void _storeExternsheet(
string
$sheetname)
|
|
Writes the Excel BIFF EXTERNSHEET record. formulas. rows and columns.
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. NAME record is required to define the print area and the repeat rows and columns.
A similar method is used in Worksheet.php for a slightly different purpose.
Tags:
Parameters:
method _storeNameLong [line 1288]
void _storeNameLong(
integer
$index, integer
$type, integer
$rowmin, integer
$rowmax, integer
$colmin, integer
$colmax)
|
|
Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. _storeNameShort() but we use a separate method to keep the code clean.
Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. This shares a lot of code with _storeNameShort() but we use a separate method to keep the code clean. Code abstraction for reuse can be carried too far, and I should know. ;-)
Tags:
Parameters:
method _storeNames [line 809]
Write the NAME record to define the print area and the repeat rows and cols.
Write the NAME record to define the print area and the repeat rows and cols.
Tags:
method _storeNameShort [line 1222]
void _storeNameShort(
integer
$index, integer
$type, integer
$rowmin, integer
$rowmax, integer
$colmin, integer
$colmax)
|
|
Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.
Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.
Tags:
Parameters:
method _storeNumFormat [line 1120]
void _storeNumFormat(
string
$format, integer
$ifmt)
|
|
Writes Excel FORMAT record for non "built-in" numerical formats.
Writes Excel FORMAT record for non "built-in" numerical formats.
Tags:
Parameters:
method _storeOLEFile [line 593]
Store the workbook in an OLE container
Store the workbook in an OLE container
Tags:
method _storePalette [line 1380]
Stores the PALETTE biff record.
Stores the PALETTE biff record.
Tags:
method _storeStyle [line 1098]
Write Excel BIFF STYLE records.
Write Excel BIFF STYLE records.
Tags:
method _storeWindow1 [line 996]
Write Excel BIFF WINDOW1 record.
Write Excel BIFF WINDOW1 record.
Tags:
method _storeWorkbook [line 498]
Assemble worksheets into a workbook and send the BIFF data to an OLE storage.
Assemble worksheets into a workbook and send the BIFF data to an OLE storage.
Tags: