| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Class Workbook Represents a workbook within a spreadsheet file. It provides the functions to work with worksheets.
| File Size: | 188 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct($shouldCreateNewSheetsAutomatically, $defaultRowStyle) X-Ref |
param: bool $shouldCreateNewSheetsAutomatically param: \Box\Spout\Writer\Style\Style $defaultRowStyle |
| 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 |
| setCurrentWorksheet($worksheet) X-Ref |
param: WorksheetInterface $worksheet return: void |
| getWorksheetFromExternalSheet($sheet) X-Ref |
| Returns the worksheet associated to the given external sheet. param: \Box\Spout\Writer\Common\Sheet $sheet return: WorksheetInterface|null The worksheet associated to the given external sheet or null if not found. |
| 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. Cannot be empty. param: \Box\Spout\Writer\Style\Style $style Style to be applied to the row. return: void |
| hasCurrentWorkseetReachedMaxRows() X-Ref |
return: bool Whether the current worksheet has reached the maximum number of rows per sheet. |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |