OpenSpout\Writer\WriterInterface Interface Reference

Inheritance diagram for OpenSpout\Writer\WriterInterface:

Public Member Functions
	addRow (Row $row)
	Appends a row to the end of the stream.
	addRows (array $rows)
	Appends the rows to the end of the stream.
	close ()
	Closes the writer.
	getWrittenRowCount ()
	openToBrowser (string $outputFileName)
	Initializes the writer and opens it to accept data.
	openToFile (string $outputFilePath)
	setCreator (string $creator)
	Set document creator.

Member Function Documentation

addRow()

OpenSpout\Writer\WriterInterface::addRow

(

Row

$row

)

Appends a row to the end of the stream.

Parameters

Row

$row

The row to be appended to the stream

Exceptions

Exception::WriterNotOpenedException	If the writer has not been opened yet
IOException	If unable to write data

Implemented in OpenSpout\Writer\AbstractWriter.

addRows()

OpenSpout\Writer\WriterInterface::addRows

(

array

$rows

)

Appends the rows to the end of the stream.

Parameters

Row[]

$rows

The rows to be appended to the stream

Exceptions

InvalidArgumentException	If the input param is not valid
Exception::WriterNotOpenedException	If the writer has not been opened yet
IOException	If unable to write data

Implemented in OpenSpout\Writer\AbstractWriter.

close()

OpenSpout\Writer\WriterInterface::close

(

)

Closes the writer.

This will close the streamer as well, preventing new data to be written to the file.

Implemented in OpenSpout\Writer\AbstractWriter.

getWrittenRowCount()

OpenSpout\Writer\WriterInterface::getWrittenRowCount

(

)

Return values

0|positive-int

Implemented in OpenSpout\Writer\AbstractWriter.

openToBrowser()

OpenSpout\Writer\WriterInterface::openToBrowser

(

string

$outputFileName

)

Initializes the writer and opens it to accept data.

By using this method, the data will be outputted directly to the browser.

Parameters

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

Exceptions

IOException

If the writer cannot be opened

setCreator()

OpenSpout\Writer\WriterInterface::setCreator

(

string

$creator

)

Set document creator.

Parameters

string

$creator

document creator

Implemented in OpenSpout\Writer\CSV\Writer, OpenSpout\Writer\ODS\Writer, and OpenSpout\Writer\XLSX\Writer.

---

The documentation for this interface was generated from the following file:

• lib/openspout/src/Writer/WriterInterface.php