ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
Public Member Functions | |
__construct (PHPExcel $phpExcel=null, &$str_total, &$str_unique, &$str_table, &$colors, $parser) | |
Class constructor. More... | |
addXfWriter ($style, $isStyleXf=false) | |
Add a new XF writer. More... | |
_addFont (PHPExcel_Style_Font $font) | |
Add a font to added fonts. More... | |
_setPaletteXl97 () | |
Sets the colour palette to the Excel 97+ default. More... | |
writeWorkbook ($pWorksheetSizes=null) | |
Assemble worksheets into a workbook and send the BIFF data to an OLE storage. More... | |
_calcSheetOffsets () | |
Calculate offsets for Worksheet BOF records. More... | |
getEscher () | |
Get Escher object. More... | |
setEscher (PHPExcel_Shared_Escher $pValue=null) | |
Set Escher object. More... | |
Public Member Functions inherited from PHPExcel_Writer_Excel5_BIFFwriter | |
__construct () | |
Constructor. More... | |
_append ($data) | |
General storage function. More... | |
writeData ($data) | |
General storage function like _append, but returns string instead of modifying $this->_data. More... | |
_storeBof ($type) | |
Writes Excel BOF record to indicate the beginning of a stream or sub-stream in the BIFF file. More... | |
_storeEof () | |
Writes Excel EOF record to indicate the end of a BIFF stream. More... | |
writeEof () | |
Writes Excel EOF record to indicate the end of a BIFF stream. More... | |
_addContinue ($data) | |
Excel limits the size of BIFF records. More... | |
Data Fields | |
$_biffsize | |
$_palette | |
$_codepage | |
$_country_code | |
Data Fields inherited from PHPExcel_Writer_Excel5_BIFFwriter | |
$_data | |
$_datasize | |
$_limit = 8224 | |
Private Member Functions | |
_addColor ($rgb) | |
Alter color palette adding a custom color. More... | |
_writeAllFonts () | |
Store the Excel FONT records. More... | |
_writeAllNumFormats () | |
Store user defined numerical formats i.e. More... | |
_writeAllXfs () | |
Write all XF records. More... | |
_writeAllStyles () | |
Write all STYLE records. More... | |
_writeExterns () | |
Write the EXTERNCOUNT and EXTERNSHEET records. More... | |
_writeNames () | |
Write the NAME record to define the print area and the repeat rows and cols. More... | |
_writeAllDefinedNamesBiff8 () | |
Writes all the DEFINEDNAME records (BIFF8). More... | |
_writeDefinedNameBiff8 ($name, $formulaData, $sheetIndex=0, $isBuiltIn=false) | |
Write a DEFINEDNAME record for BIFF8 using explicit binary formula data. More... | |
_writeShortNameBiff8 ($name, $sheetIndex=0, $rangeBounds, $isHidden=false) | |
Write a short NAME record. More... | |
_writeCodepage () | |
Stores the CODEPAGE biff record. More... | |
_writeWindow1 () | |
Write Excel BIFF WINDOW1 record. More... | |
_writeBoundsheet ($sheet, $offset) | |
Writes Excel BIFF BOUNDSHEET record. More... | |
_writeSupbookInternal () | |
Write Internal SUPBOOK record. More... | |
_writeExternsheetBiff8 () | |
Writes the Excel BIFF EXTERNSHEET record. More... | |
_writeStyle () | |
Write Excel BIFF STYLE records. More... | |
_writeNumFormat ($format, $ifmt) | |
Writes Excel FORMAT record for non "built-in" numerical formats. More... | |
_writeDatemode () | |
Write DATEMODE record to indicate the date system in use (1904 or 1900). More... | |
_writeExterncount ($cxals) | |
Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook. More... | |
_writeExternsheet ($sheetname) | |
Writes the Excel BIFF EXTERNSHEET record. More... | |
_writeNameShort ($index, $type, $rowmin, $rowmax, $colmin, $colmax) | |
Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only. More... | |
_writeNameLong ($index, $type, $rowmin, $rowmax, $colmin, $colmax) | |
Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. More... | |
_writeCountry () | |
Stores the COUNTRY record for localization. More... | |
_writeRecalcId () | |
Write the RECALCID record. More... | |
_writePalette () | |
Stores the PALETTE biff record. More... | |
_writeSharedStringsTable () | |
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. More... | |
_writeMsoDrawingGroup () | |
Writes the MSODRAWINGGROUP record if needed. More... | |
Private Attributes | |
$_parser | |
$_xfWriters = array() | |
$_phpExcel | |
$_fontWriters = array() | |
$_addedFonts = array() | |
$_numberFormats = array() | |
$_addedNumberFormats = array() | |
$_worksheetSizes = array() | |
$_worksheetOffsets = array() | |
$_str_total | |
$_str_unique | |
$_str_table | |
$_colors | |
Color cache. More... | |
$_escher | |
Additional Inherited Members | |
Static Public Member Functions inherited from PHPExcel_Writer_Excel5_BIFFwriter | |
static | getByteOrder () |
Determine the byte order and store it as class data to avoid recalculating it for each call to new(). More... | |
Definition at line 71 of file Workbook.php.
PHPExcel_Writer_Excel5_Workbook::__construct | ( | PHPExcel | $phpExcel = null , |
& | $str_total, | ||
& | $str_unique, | ||
& | $str_table, | ||
& | $colors, | ||
$parser | |||
) |
Class constructor.
PHPExcel | $phpExcel | The Workbook |
int | &$str_total | Total number of strings |
int | &$str_unique | Total number of unique strings |
array | &$str_table | String Table |
array | &$colors | Colour Table |
mixed | $parser | The formula parser created for the Workbook |
Definition at line 203 of file Workbook.php.
References $i, $parser, _addColor(), _setPaletteXl97(), and array.
|
private |
Alter color palette adding a custom color.
string | $rgb | E.g. 'FF00AA' |
Definition at line 327 of file Workbook.php.
References array.
Referenced by __construct(), _addFont(), and addXfWriter().
PHPExcel_Writer_Excel5_Workbook::_addFont | ( | PHPExcel_Style_Font | $font | ) |
Add a font to added fonts.
PHPExcel_Style_Font | $font |
Definition at line 303 of file Workbook.php.
References _addColor(), PHPExcel_Style_Font\getColor(), and PHPExcel_Style_Font\getHashCode().
Referenced by addXfWriter().
PHPExcel_Writer_Excel5_Workbook::_calcSheetOffsets | ( | ) |
Calculate offsets for Worksheet BOF records.
private
Definition at line 480 of file Workbook.php.
References PHPExcel_Writer_Excel5_BIFFwriter\$_datasize, $i, and PHPExcel_Shared_String\UTF8toBIFF8UnicodeShort().
Referenced by writeWorkbook().
PHPExcel_Writer_Excel5_Workbook::_setPaletteXl97 | ( | ) |
Sets the colour palette to the Excel 97+ default.
private
Definition at line 357 of file Workbook.php.
References array.
Referenced by __construct().
|
private |
Writes all the DEFINEDNAME records (BIFF8).
So far this is only used for repeating rows/columns (print titles) and print areas
Definition at line 652 of file Workbook.php.
References $i, and PHPExcel_Cell\splitRange().
Referenced by writeWorkbook().
|
private |
Store the Excel FONT records.
Definition at line 504 of file Workbook.php.
References PHPExcel_Writer_Excel5_BIFFwriter\_append().
Referenced by writeWorkbook().
|
private |
Store user defined numerical formats i.e.
FORMAT records
Definition at line 514 of file Workbook.php.
References _writeNumFormat().
Referenced by writeWorkbook().
|
private |
Write all STYLE records.
Definition at line 534 of file Workbook.php.
References _writeStyle().
Referenced by writeWorkbook().
|
private |
Write all XF records.
Definition at line 524 of file Workbook.php.
References PHPExcel_Writer_Excel5_BIFFwriter\_append().
Referenced by writeWorkbook().
|
private |
Writes Excel BIFF BOUNDSHEET record.
PHPExcel_Worksheet | $sheet | Worksheet name |
integer | $offset | Location of worksheet BOF |
Definition at line 925 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Stores the CODEPAGE biff record.
Definition at line 875 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Stores the COUNTRY record for localization.
Definition at line 1230 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Write DATEMODE record to indicate the date system in use (1904 or 1900).
Definition at line 1023 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Write a DEFINEDNAME record for BIFF8 using explicit binary formula data.
string | $name | The name in UTF-8 |
string | $formulaData | The binary formula data |
string | $sheetIndex | 1-based sheet index the defined name applies to. 0 = global |
boolean | $isBuiltIn | Built-in name? |
Definition at line 810 of file Workbook.php.
|
private |
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.
integer | $cxals | Number of external references |
Definition at line 1048 of file Workbook.php.
Referenced by _writeExterns().
|
private |
Write the EXTERNCOUNT and EXTERNSHEET records.
These are used as indexes for the NAME records.
Definition at line 543 of file Workbook.php.
References $i, _writeExterncount(), and _writeExternsheet().
|
private |
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.
string | $sheetname | Worksheet name |
Definition at line 1067 of file Workbook.php.
Referenced by _writeExterns().
|
private |
Writes the Excel BIFF EXTERNSHEET record.
These references are used by formulas.
Definition at line 969 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Writes the MSODRAWINGGROUP record if needed.
Possibly split using CONTINUE records.
Definition at line 1413 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
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 _writeNameShort() but we use a separate method to keep the code clean. Code abstraction for reuse can be carried too far, and I should know. ;-)
integer | $index | Sheet index |
integer | $type | Built-in name type |
integer | $rowmin | Start row |
integer | $rowmax | End row |
integer | $colmin | Start colum |
integer | $colmax | End column |
Definition at line 1155 of file Workbook.php.
Referenced by _writeNames().
|
private |
Write the NAME record to define the print area and the repeat rows and cols.
Definition at line 558 of file Workbook.php.
References $i, _writeNameLong(), _writeNameShort(), PHPExcel_Cell\columnIndexFromString(), PHPExcel_Cell\coordinateFromString(), and PHPExcel_Cell\splitRange().
|
private |
Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.
integer | $index | Sheet index |
integer | $type | Built-in name type |
integer | $rowmin | Start row |
integer | $rowmax | End row |
integer | $colmin | Start colum |
integer | $colmax | End column |
Definition at line 1091 of file Workbook.php.
Referenced by _writeNames().
|
private |
Writes Excel FORMAT record for non "built-in" numerical formats.
string | $format | Custom format string |
integer | $ifmt | Format index code |
Definition at line 1007 of file Workbook.php.
Referenced by _writeAllNumFormats().
|
private |
Stores the PALETTE biff record.
Definition at line 1263 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Write the RECALCID record.
Definition at line 1247 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
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).
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.
Definition at line 1297 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Write a short NAME record.
string | $name | |
string | $sheetIndex | 1-based sheet index the defined name applies to. 0 = global |
integer[][] | $rangeBounds range boundaries | |
boolean | $isHidden |
Definition at line 845 of file Workbook.php.
|
private |
Write Excel BIFF STYLE records.
Definition at line 987 of file Workbook.php.
Referenced by _writeAllStyles().
|
private |
Write Internal SUPBOOK record.
Definition at line 954 of file Workbook.php.
Referenced by writeWorkbook().
|
private |
Write Excel BIFF WINDOW1 record.
Definition at line 890 of file Workbook.php.
Referenced by writeWorkbook().
PHPExcel_Writer_Excel5_Workbook::addXfWriter | ( | $style, | |
$isStyleXf = false |
|||
) |
Add a new XF writer.
PHPExcel_Style | |
boolean | Is it a style XF? |
Definition at line 253 of file Workbook.php.
References $style, _addColor(), and _addFont().
PHPExcel_Writer_Excel5_Workbook::getEscher | ( | ) |
PHPExcel_Writer_Excel5_Workbook::setEscher | ( | PHPExcel_Shared_Escher | $pValue = null | ) |
Set Escher object.
PHPExcel_Shared_Escher | $pValue |
Definition at line 1446 of file Workbook.php.
PHPExcel_Writer_Excel5_Workbook::writeWorkbook | ( | $pWorksheetSizes = null | ) |
Assemble worksheets into a workbook and send the BIFF data to an OLE storage.
array | $pWorksheetSizes | The sizes in bytes of the binary worksheet streams |
Definition at line 426 of file Workbook.php.
References PHPExcel_Writer_Excel5_BIFFwriter\$_data, $i, _calcSheetOffsets(), PHPExcel_Writer_Excel5_BIFFwriter\_storeBof(), _writeAllDefinedNamesBiff8(), _writeAllFonts(), _writeAllNumFormats(), _writeAllStyles(), _writeAllXfs(), _writeBoundsheet(), _writeCodepage(), _writeCountry(), _writeDatemode(), _writeExternsheetBiff8(), _writeMsoDrawingGroup(), _writePalette(), _writeRecalcId(), _writeSharedStringsTable(), _writeSupbookInternal(), _writeWindow1(), and PHPExcel_Writer_Excel5_BIFFwriter\writeEof().
|
private |
Definition at line 129 of file Workbook.php.
|
private |
Definition at line 143 of file Workbook.php.
PHPExcel_Writer_Excel5_Workbook::$_biffsize |
Definition at line 85 of file Workbook.php.
PHPExcel_Writer_Excel5_Workbook::$_codepage |
Definition at line 103 of file Workbook.php.
|
private |
Color cache.
Definition at line 183 of file Workbook.php.
PHPExcel_Writer_Excel5_Workbook::$_country_code |
Definition at line 109 of file Workbook.php.
|
private |
Definition at line 190 of file Workbook.php.
|
private |
Definition at line 122 of file Workbook.php.
|
private |
Definition at line 136 of file Workbook.php.
PHPExcel_Writer_Excel5_Workbook::$_palette |
Definition at line 97 of file Workbook.php.
|
private |
Definition at line 78 of file Workbook.php.
|
private |
Definition at line 115 of file Workbook.php.
|
private |
Definition at line 178 of file Workbook.php.
|
private |
Definition at line 164 of file Workbook.php.
|
private |
Definition at line 171 of file Workbook.php.
|
private |
Definition at line 157 of file Workbook.php.
|
private |
Definition at line 150 of file Workbook.php.
|
private |
Definition at line 91 of file Workbook.php.