• Accueil
• Box
• Spout
• Writer
• AbstractWriter

PHP Class Box\Spout\Writer\AbstractWriter

Afficher le fichier Open project: box/spout

Protected Properties

Свойство	Type	Description
$defaultRowStyle		Default row style. Each writer can have its own default style
$filePointer		Pointer to the file/stream we will write to
$globalFunctionsHelper		Helper to work with global functions
$headerContentType		Content-Type value for the header - to be defined by child class
$isWriterOpened		Indicates whether the writer has been opened or not
$outputFilePath		Path to the output file
$rowStyle		Style to be applied to the next written row(s)

Méthodes publiques

Méthode	Description
__construct ( )
addRow ( array $dataRow ) : AbstractWriter	Write given data to the output. New data will be appended to end of stream.
addRowWithStyle ( array $dataRow, Style $style ) : AbstractWriter	Write given data to the output and apply the given style.
addRows ( array $dataRows ) : AbstractWriter	Write given data to the output. New data will be appended to end of stream.
addRowsWithStyle ( array $dataRows, Style $style ) : AbstractWriter	Write given data to the output and apply the given style.
close ( ) : void	Closes the writer. This will close the streamer as well, preventing new data to be written to the file.
openToBrowser ( string $outputFileName ) : AbstractWriter	Inits the writer and opens it to accept data.
openToFile ( string $outputFilePath ) : AbstractWriter	Inits the writer and opens it to accept data.
setDefaultRowStyle ( Style $defaultStyle ) : AbstractWriter	Sets the default styles for all rows added with "addRow".
setGlobalFunctionsHelper ( Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper ) : AbstractWriter

Méthodes protégées

Méthode	Description
addRowToWriter ( array $dataRow, Style $style ) : void	Adds data to the currently openned writer.
closeWriter ( ) : void	Closes the streamer, preventing any additional writing.
getDefaultRowStyle ( ) : Style	Returns the default style to be applied to rows.
openWriter ( ) : void	Opens the streamer and makes it ready to accept data.
throwIfFilePointerIsNotAvailable ( ) : void	Checks if the pointer to the file/stream to write to is available.
throwIfWriterAlreadyOpened ( string $message ) : void	Checks if the writer has already been opened, since some actions must be done before it gets opened.

Private Methods

Méthode	Description
closeAndAttemptToCleanupAllFiles ( ) : void	Closes the writer and attempts to cleanup all files that were created during the writing process (temp files & final file).
resetRowStyleToDefault ( ) : void	Resets the style to be applied to the next written rows.
setRowStyle ( Style $style ) : void	Sets the style to be applied to the next written rows until it is changed or reset.

Method Details

Property Details