[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Writer/ -> AbstractMultiSheetsWriter.php (summary)

Class AbstractMultiSheetsWriter

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

Defines 6 functions

  setShouldCreateNewSheetsAutomatically()
  getSheets()
  addNewSheetAndMakeItCurrent()
  getCurrentSheet()
  setCurrentSheet()
  throwIfBookIsNotAvailable()

Functions
Functions that are not part of a class:

setShouldCreateNewSheetsAutomatically($shouldCreateNewSheetsAutomatically)   X-Ref
Sets whether new sheets should be automatically created when the max rows limit per sheet is reached.
This must be set before opening the writer.

param: bool $shouldCreateNewSheetsAutomatically Whether new sheets should be automatically created when the max rows limit per sheet is reached
return: AbstractMultiSheetsWriter

getSheets()   X-Ref
Returns all the workbook's sheets

return: Common\Sheet[] All the workbook's sheets

addNewSheetAndMakeItCurrent()   X-Ref
Creates a new sheet and make it the current sheet. The data will now be written to this sheet.

return: Common\Sheet The created sheet

getCurrentSheet()   X-Ref
Returns the current sheet

return: Common\Sheet 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: Common\Sheet $sheet The sheet to set as current
return: void

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

return: void



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