StringTable extends WriterPart
Table of Contents
- $parentWriter : Xlsx
- Parent Xlsx object.
- __construct() : mixed
- Set parent Xlsx object.
- createStringTable() : array<string|int, string>
- Create worksheet stringtable.
- flipStringTable() : array<string|int, mixed>
- Flip string table (for index searching).
- getParentWriter() : Xlsx
- Get parent Xlsx object.
- writeRichText() : void
- Write Rich Text.
- writeRichTextForCharts() : void
- Write Rich Text.
- writeStringTable() : string
- Write string table to XML format.
- writeChartTextColor() : void
Properties
$parentWriter
Parent Xlsx object.
private
Xlsx
$parentWriter
Methods
__construct()
Set parent Xlsx object.
public
__construct(Xlsx $writer) : mixed
Parameters
- $writer : Xlsx
Return values
mixed —createStringTable()
Create worksheet stringtable.
public
createStringTable(Worksheet $worksheet[, array<string|int, string> $existingTable = null ]) : array<string|int, string>
Parameters
- $worksheet : Worksheet
- $existingTable : array<string|int, string> = null
-
Existing table to eventually merge with
Return values
array<string|int, string> —String table for worksheet
flipStringTable()
Flip string table (for index searching).
public
flipStringTable(array<string|int, mixed> $stringTable) : array<string|int, mixed>
Parameters
- $stringTable : array<string|int, mixed>
-
Stringtable
Return values
array<string|int, mixed> —getParentWriter()
Get parent Xlsx object.
public
getParentWriter() : Xlsx
Return values
Xlsx —writeRichText()
Write Rich Text.
public
writeRichText(XMLWriter $objWriter, RichText $richText[, string $prefix = null ]) : void
Parameters
Return values
void —writeRichTextForCharts()
Write Rich Text.
public
writeRichTextForCharts(XMLWriter $objWriter[, RichText|string $richText = null ][, string $prefix = '' ]) : void
Parameters
- $objWriter : XMLWriter
- $richText : RichText|string = null
-
text string or Rich text
- $prefix : string = ''
-
Optional Namespace prefix
Return values
void —writeStringTable()
Write string table to XML format.
public
writeStringTable(array<string|int, \PhpOffice\PhpSpreadsheet\RichText\RichText|string> $stringTable) : string
Parameters
- $stringTable : array<string|int, \PhpOffice\PhpSpreadsheet\RichText\RichText|string>
Return values
string —XML Output
writeChartTextColor()
private
writeChartTextColor(XMLWriter $objWriter, ChartColor|null $underlineColor, string $prefix[, string|null $openTag = '' ]) : void
Parameters
- $objWriter : XMLWriter
- $underlineColor : ChartColor|null
- $prefix : string
- $openTag : string|null = ''