[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Writer/Common/Internal/ -> WorkbookInterface.php (summary)

(no description)

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

Defines 1 class

WorkbookInterface:: (7 methods):
  addNewSheet()
  addNewSheetAndMakeItCurrent()
  getWorksheets()
  getCurrentWorksheet()
  setCurrentSheet()
  addRowToCurrentWorksheet()
  close()


Interface: WorkbookInterface  - X-Ref

Interface WorkbookInterface

addNewSheet()   X-Ref
Creates a new sheet in the workbook. The current sheet remains unchanged.

return: WorksheetInterface The created sheet

addNewSheetAndMakeItCurrent()   X-Ref
Creates a new sheet in the workbook and make it the current sheet.
The writing will resume where it stopped (i.e. data won't be truncated).

return: WorksheetInterface The created sheet

getWorksheets()   X-Ref

return: WorksheetInterface[] All the workbook's sheets

getCurrentWorksheet()   X-Ref
Returns the current sheet

return: WorksheetInterface The current sheet

setCurrentSheet($sheet)   X-Ref
Sets the given sheet as the current one. New data will be written to this sheet.
The writing will resume where it stopped (i.e. data won't be truncated).

param: \Box\Spout\Writer\Common\Sheet $sheet The "external" sheet to set as current
return: void

addRowToCurrentWorksheet($dataRow, $style)   X-Ref
Adds data to the current sheet.
If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
with the creation of new worksheets if one worksheet has reached its maximum capicity.

param: array $dataRow Array containing data to be written.
param: \Box\Spout\Writer\Style\Style $style Style to be applied to the row.
return: void

close($finalFilePointer)   X-Ref
Closes the workbook and all its associated sheets.
All the necessary files are written to disk and zipped together to create the ODS file.
All the temporary files are then deleted.

param: resource $finalFilePointer Pointer to the ODS that will be created
return: void



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