| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Class AbstractWriter
| File Size: | 330 lines (11 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct() X-Ref |
| No description |
| setGlobalFunctionsHelper($globalFunctionsHelper) X-Ref |
param: \Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper return: AbstractWriter |
| openToFile($outputFilePath) X-Ref |
| Inits the writer and opens it to accept data. By using this method, the data will be written to a file. param: string $outputFilePath Path of the output file that will contain the data return: AbstractWriter |
| openToBrowser($outputFileName) X-Ref |
| Inits the writer and opens it to accept data. By using this method, the data will be outputted directly to the browser. param: string $outputFileName Name of the output file that will contain the data. If a path is passed in, only the file name will be kept return: AbstractWriter |
| throwIfFilePointerIsNotAvailable() X-Ref |
| Checks if the pointer to the file/stream to write to is available. Will throw an exception if not available. return: void |
| throwIfWriterAlreadyOpened($message) X-Ref |
| Checks if the writer has already been opened, since some actions must be done before it gets opened. Throws an exception if already opened. param: string $message Error message return: void |
| addRow(array $dataRow) X-Ref |
| Write given data to the output. New data will be appended to end of stream. param: array $dataRow Array containing data to be streamed. return: AbstractWriter |
| addRowWithStyle(array $dataRow, $style) X-Ref |
| Write given data to the output and apply the given style. param: array $dataRow Array of array containing data to be streamed. param: Style\Style $style Style to be applied to the row. return: AbstractWriter |
| addRows(array $dataRows) X-Ref |
| Write given data to the output. New data will be appended to end of stream. param: array $dataRows Array of array containing data to be streamed. return: AbstractWriter |
| addRowsWithStyle(array $dataRows, $style) X-Ref |
| Write given data to the output and apply the given style. param: array $dataRows Array of array containing data to be streamed. param: Style\Style $style Style to be applied to the rows. return: AbstractWriter |
| getDefaultRowStyle() X-Ref |
| Returns the default style to be applied to rows. Can be overriden by children to have a custom style. return: Style\Style |
| setRowStyle($style) X-Ref |
| Sets the style to be applied to the next written rows until it is changed or reset. param: Style\Style $style return: void |
| resetRowStyleToDefault() X-Ref |
| Resets the style to be applied to the next written rows. return: void |
| close() X-Ref |
| Closes the writer. This will close the streamer as well, preventing new data to be written to the file. return: void |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |