Documentation

Workbook extends WriterPart
in package

Table of Contents

Properties

$parentWriter  : Xlsx
Parent Xlsx object.

Methods

__construct()  : mixed
Set parent Xlsx object.
getParentWriter()  : Xlsx
Get parent Xlsx object.
writeWorkbook()  : string
Write workbook to XML format.
writeBookViews()  : void
Write BookViews.
writeCalcPr()  : void
Write calcPr.
writeFileVersion()  : void
Write file version.
writeSheet()  : void
Write sheet.
writeSheets()  : void
Write sheets.
writeWorkbookPr()  : void
Write WorkbookPr.
writeWorkbookProtection()  : void
Write WorkbookProtection.

Properties

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

writeWorkbook()

Write workbook to XML format.

public writeWorkbook(Spreadsheet $spreadsheet[, bool $recalcRequired = false ]) : string
Parameters
$spreadsheet : Spreadsheet
$recalcRequired : bool = false

Indicate whether formulas should be recalculated before writing

Return values
string

XML Output

writeCalcPr()

Write calcPr.

private writeCalcPr(XMLWriter $objWriter[, bool $recalcRequired = true ]) : void
Parameters
$objWriter : XMLWriter
$recalcRequired : bool = true

Indicate whether formulas should be recalculated before writing

writeSheet()

Write sheet.

private writeSheet(XMLWriter $objWriter, string $worksheetName[, int $worksheetId = 1 ][, int $relId = 1 ][, string $sheetState = 'visible' ]) : void
Parameters
$objWriter : XMLWriter
$worksheetName : string

Sheet name

$worksheetId : int = 1

Sheet id

$relId : int = 1

Relationship ID

$sheetState : string = 'visible'

Sheet state (visible, hidden, veryHidden)


        
On this page

Search results