Documentation

Worksheet extends WriterPart
in package

Table of Contents

Properties

$evalError  : string
$explicitStyle0  : bool
$formula  : string
$numberStoredAsText  : string
$parentWriter  : Xlsx
Parent Xlsx object.
$twoDigitTextYear  : string
$useDynamicArrays  : bool

Methods

__construct()  : mixed
Set parent Xlsx object.
getParentWriter()  : Xlsx
Get parent Xlsx object.
writeWorksheet()  : string
Write worksheet to XML format.
parseRef()  : string
writeAlternateContent()  : void
writeAttributeIf()  : void
writeAttributeNotNull()  : void
writeAutoFilter()  : void
Write AutoFilter.
writeBackgroundImage()  : void
Write Background Image.
writeBreaks()  : void
Write Breaks.
writeCell()  : void
Write Cell.
writeCellBoolean()  : void
writeCellError()  : void
writeCellFormula()  : void
writeCellInlineStr()  : void
writeCellNumeric()  : void
writeCellString()  : void
writeColorScaleElements()  : void
writeCols()  : void
Write Cols.
writeConditionalFormatting()  : void
Write ConditionalFormatting.
writeDataBarElements()  : void
writeDataValidations()  : void
Write DataValidations.
writeDimension()  : void
Write Dimension.
writeDrawings()  : void
Write Drawings.
writeElementIf()  : void
writeExtConditionalFormattingElements()  : void
writeExtLst()  : void
write <ExtLst> only implementation conditionalFormattings.
writeHeaderFooter()  : void
Write Header / Footer.
writeHyperlinks()  : void
Write Hyperlinks.
writeIgnoredError()  : void
writeIgnoredErrors()  : void
writeLegacyDrawing()  : void
Write LegacyDrawing.
writeLegacyDrawingHF()  : void
Write LegacyDrawingHF.
writeMergeCells()  : void
Write MergeCells.
writeOtherCondElements()  : void
writePageMargins()  : void
Write PageMargins.
writePageSetup()  : void
Write PageSetup.
writePrintOptions()  : void
Write PrintOptions.
writeProtectedRanges()  : void
Write ProtectedRanges.
writeProtectionAttribute()  : void
writeSheetData()  : void
Write SheetData.
writeSheetFormatPr()  : void
Write SheetFormatPr.
writeSheetPr()  : void
Write SheetPr.
writeSheetProtection()  : void
Write SheetProtection.
writeSheetViews()  : void
Write SheetViews.
writeTable()  : void
Write Table.
writeTextCondElements()  : void
writeTimePeriodCondElements()  : void

Properties

$explicitStyle0

private bool $explicitStyle0

$numberStoredAsText

private string $numberStoredAsText = ''

$twoDigitTextYear

private string $twoDigitTextYear = ''

$useDynamicArrays

private bool $useDynamicArrays = false

Methods

__construct()

Set parent Xlsx object.

public __construct(Xlsx $writer) : mixed
Parameters
$writer : Xlsx

getParentWriter()

Get parent Xlsx object.

public getParentWriter() : Xlsx
Return values
Xlsx

writeWorksheet()

Write worksheet to XML format.

public writeWorksheet(Worksheet $worksheet[, array<string|int, string> $stringTable = [] ][, bool $includeCharts = false ]) : string
Parameters
$worksheet : Worksheet
$stringTable : array<string|int, string> = []
$includeCharts : bool = false

Flag indicating if we should write charts

Return values
string —

XML Output

parseRef()

private parseRef(string $coordinate, string $ref) : string
Parameters
$coordinate : string
$ref : string
Return values
string

writeAttributeIf()

private static writeAttributeIf(XMLWriter $objWriter, bool|null $condition, string $attr, string $val) : void
Parameters
$objWriter : XMLWriter
$condition : bool|null
$attr : string
$val : string

writeAttributeNotNull()

private static writeAttributeNotNull(XMLWriter $objWriter, string $attr, string|null $val) : void
Parameters
$objWriter : XMLWriter
$attr : string
$val : string|null

writeCell()

Write Cell.

private writeCell(XMLWriter $objWriter, Worksheet $worksheet, string $cellAddress, array<string|int, string> $flippedStringTable) : void
Parameters
$objWriter : XMLWriter
$worksheet : Worksheet
$cellAddress : string

Cell Address

$flippedStringTable : array<string|int, string>

String table (flipped), for faster index searching

writeCellBoolean()

private writeCellBoolean(XMLWriter $objWriter, string $mappedType, bool $cellValue) : void
Parameters
$objWriter : XMLWriter
$mappedType : string
$cellValue : bool

writeCellError()

private writeCellError(XMLWriter $objWriter, string $mappedType, string $cellValue[, string $formulaerr = '#NULL!' ]) : void
Parameters
$objWriter : XMLWriter
$mappedType : string
$cellValue : string
$formulaerr : string = '#NULL!'

writeCellFormula()

private writeCellFormula(XMLWriter $objWriter, string $cellValue, Cell $cell) : void
Parameters
$objWriter : XMLWriter
$cellValue : string
$cell : Cell

writeCellNumeric()

private writeCellNumeric(XMLWriter $objWriter, float|int $cellValue) : void
Parameters
$objWriter : XMLWriter
$cellValue : float|int

writeCellString()

private writeCellString(XMLWriter $objWriter, string $mappedType, RichText|string $cellValue, array<string|int, string> $flippedStringTable) : void
Parameters
$objWriter : XMLWriter
$mappedType : string
$cellValue : RichText|string
$flippedStringTable : array<string|int, string>

writeDrawings()

Write Drawings.

private writeDrawings(XMLWriter $objWriter, Worksheet $worksheet[, bool $includeCharts = false ]) : void
Parameters
$objWriter : XMLWriter
$worksheet : Worksheet
$includeCharts : bool = false

Flag indicating if we should include drawing details for charts

writeElementIf()

private static writeElementIf(XMLWriter $objWriter, bool $condition, string $attr, string $val) : void
Parameters
$objWriter : XMLWriter
$condition : bool
$attr : string
$val : string

writeExtLst()

write <ExtLst> only implementation conditionalFormattings.

private writeExtLst(XMLWriter $objWriter, Worksheet $worksheet) : void
Parameters
$objWriter : XMLWriter
$worksheet : Worksheet
Tags
url

https://docs.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/07d607af-5618-4ca2-b683-6a78dc0d9627

writeIgnoredError()

private writeIgnoredError(XMLWriter $objWriter, bool &$started, string $attr, string $cells) : void
Parameters
$objWriter : XMLWriter
$started : bool
$attr : string
$cells : string

writeProtectionAttribute()

private static writeProtectionAttribute(XMLWriter $objWriter, string $name, bool|null $value) : void
Parameters
$objWriter : XMLWriter
$name : string
$value : bool|null

writeSheetData()

Write SheetData.

private writeSheetData(XMLWriter $objWriter, Worksheet $worksheet, array<string|int, string> $stringTable) : void
Parameters
$objWriter : XMLWriter
$worksheet : Worksheet
$stringTable : array<string|int, string>

String table


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results