[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Writer/ODS/Internal/ -> Worksheet.php (summary)

(no description)

File Size: 223 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Worksheet:: (10 methods):
  __construct()
  startSheet()
  throwIfSheetFilePointerIsNotAvailable()
  getWorksheetFilePath()
  getTableElementStartAsString()
  getExternalSheet()
  getLastWrittenRowIndex()
  addRow()
  getCellContent()
  close()


Class: Worksheet  - X-Ref

Class Worksheet
Represents a worksheet within a ODS file. The difference with the Sheet object is
that this class provides an interface to write data

__construct($externalSheet, $worksheetFilesFolder)   X-Ref

param: \Box\Spout\Writer\Common\Sheet $externalSheet The associated "external" sheet
param: string $worksheetFilesFolder Temporary folder where the files to create the XLSX will be stored

startSheet()   X-Ref
Prepares the worksheet to accept data
The XML file does not contain the "<table:table>" node as it contains the sheet's name
which may change during the execution of the program. It will be added at the end.

return: void

throwIfSheetFilePointerIsNotAvailable()   X-Ref
Checks if the book has been created. Throws an exception if not created yet.

return: void

getWorksheetFilePath()   X-Ref

return: string Path to the temporary sheet content XML file

getTableElementStartAsString()   X-Ref
Returns the table XML root node as string.

return: string <table> node as string

getExternalSheet()   X-Ref

return: \Box\Spout\Writer\Common\Sheet The "external" sheet

getLastWrittenRowIndex()   X-Ref

return: int The index of the last written row

addRow($dataRow, $style)   X-Ref
Adds data to the worksheet.

param: array $dataRow Array containing data to be written. Cannot be empty.
param: \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
return: void

getCellContent($cellValue, $styleIndex, $numTimesValueRepeated)   X-Ref
Returns the cell XML content, given its value.

param: mixed $cellValue The value to be written
param: int $styleIndex Index of the used style
param: int $numTimesValueRepeated Number of times the value is consecutively repeated
return: string The cell XML content

close()   X-Ref
Closes the worksheet

return: void



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1