core\dataformat\spout_base Class Reference

Common Spout class for dataformat. More...

Inheritance diagram for core\dataformat\spout_base:

Public Member Functions
	close_output ()
	Write the end of the file.
	close_output_to_file ()
	Write data to disk.
	close_sheet ($columns)
	Write the end of the sheet containing the data.
	get_extension ()
	Get the file extension.
	send_http_headers ()
	Output file headers to initialise the download of the file.
	set_filename ($filename)
	Set download filename base.
	set_filepath (string $filepath)
	Set file path when writing to file.
	set_sheettitle ($title)
	Set the title of the worksheet inside a spreadsheet.
	start_output ()
	Write the start of the file.
	start_output_to_file ()
	Set the dataformat to be output to current file.
	start_sheet ($columns)
	Write the start of the sheet we will be adding data to.
	supports_html ()
	Method to define whether the dataformat supports export of HTML.
	write_record ($record, $rownum)
	Write a single record.

Protected Member Functions
	export_html_image_source (\stored_file $file)
	Given a stored_file, return a suitable source attribute for an img element in the export (or null to use the original)
	format_record ($record)
	Apply formatting to the cells of a given record.
	replace_pluginfile_images (?string $content)
	We need to locate all img tags within a given cell that match pluginfile URL's.

Protected Attributes
$extension	$extension = ".txt"
$filename	$filename = ''
string	$filepath = ''
	The location to store the output content.
$mimetype	$mimetype = "text/plain"
$renamecurrentsheet	$renamecurrentsheet = false
$sheettitle	$sheettitle
$writer	$writer

Detailed Description

Common Spout class for dataformat.

@subpackage dataformat

Copyright

2016 Brendan Heywood (brend.nosp@m.an@c.nosp@m.ataly.nosp@m.st-a.nosp@m.u.net)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

close_output()

core\dataformat\spout_base::close_output

(

)

Write the end of the file.

Reimplemented from core\dataformat\base.

close_output_to_file()

core\dataformat\spout_base::close_output_to_file

(

)

Write data to disk.

Return values

bool

Reimplemented from core\dataformat\base.

close_sheet()

core\dataformat\base::close_sheet ( $columns )

inherited

Write the end of the sheet containing the data.

Parameters

array

$columns

Reimplemented in dataformat_html\writer, and dataformat_json\writer.

export_html_image_source()

core\dataformat\base::export_html_image_source ( \stored_file $file )

protectedinherited

Given a stored_file, return a suitable source attribute for an img element in the export (or null to use the original)

Parameters

stored_file

$file

Return values

string|null

Reimplemented in dataformat_pdf\writer.

format_record()

core\dataformat\base::format_record ( $record )

protectedinherited

Apply formatting to the cells of a given record.

Parameters

array | stdClass

$record

Return values

array

get_extension()

core\dataformat\base::get_extension ( )

inherited

Get the file extension.

Return values

string

file extension

replace_pluginfile_images()

core\dataformat\base::replace_pluginfile_images ( ?string $content )

protectedinherited

We need to locate all img tags within a given cell that match pluginfile URL's.

Partly so the exported file will show the image without requiring the user is logged in; and also to prevent some of the dataformats requesting the file themselves, which is likely to fail due to them not having an active session

Parameters

string | null

$content

Return values

string

send_http_headers()

core\dataformat\spout_base::send_http_headers

(

)

Output file headers to initialise the download of the file.

Reimplemented from core\dataformat\base.

set_filename()

core\dataformat\base::set_filename ( $filename )

inherited

Set download filename base.

Parameters

string

$filename

set_filepath()

core\dataformat\base::set_filepath ( string $filepath )

inherited

Set file path when writing to file.

Parameters

string

$filepath

Exceptions

coding_exception

set_sheettitle()

core\dataformat\spout_base::set_sheettitle

(

$title

)

Set the title of the worksheet inside a spreadsheet.

For some formats this will be ignored.

Parameters

string

$title

Reimplemented from core\dataformat\base.

Reimplemented in dataformat_excel\writer, and dataformat_ods\writer.

start_output()

core\dataformat\base::start_output ( )

inherited

Write the start of the file.

Reimplemented in dataformat_html\writer, dataformat_json\writer, and dataformat_pdf\writer.

start_output_to_file()

core\dataformat\spout_base::start_output_to_file

(

)

Set the dataformat to be output to current file.

Reimplemented from core\dataformat\base.

start_sheet()

core\dataformat\spout_base::start_sheet

(

$columns

)

Write the start of the sheet we will be adding data to.

Parameters

array

$columns

Reimplemented from core\dataformat\base.

supports_html()

core\dataformat\base::supports_html ( )

inherited

Method to define whether the dataformat supports export of HTML.

Return values

bool

Reimplemented in dataformat_html\writer, and dataformat_pdf\writer.

write_record()

core\dataformat\spout_base::write_record	(		$record,
			$rownum )

Write a single record.

Parameters

array	$record
int	$rownum

Reimplemented from core\dataformat\base.

---

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

• lib/classes/dataformat/spout_base.php