Elgg\Controllers\CsvDownloadAction Class Reference

Helper class for CSV download actions. More...

Inheritance diagram for Elgg\Controllers\CsvDownloadAction:

Protected Member Functions
	getFilename ()
	{File name for download. Returns string } More...
	getMimeType ()
	{Return the content mimetype for the Content-Type header. Returns string } More...
	getSeparator ()
	Returns the separator. More...
	getEnclosure ()
	Returns the enclosure. More...
	getEscape ()
	Returns the escape. More...
	getContentHeaders ()
	Returns the first row of headers for your file. More...
	getContentRows ()
	Returns an array of rows with data for your file. More...
	getContents ()
	{File contents. Returns mixed } More...
Protected Member Functions inherited from Elgg\Controllers\DownloadAction
	getHeaders ()
	Returns headers for download response. More...
	success ()
	{Will be used when an action is successfully finished. Returns OkResponse } More...
Protected Member Functions inherited from Elgg\Controllers\GenericAction
	sanitize ()
	Sanitizes input for the action. More...
	validate ()
	Validates the action. More...
	executeBefore ()
	Preparation before executing the action. More...
	execute ()
	Main part of the action. More...
	executeAfter ()
	Action part after the main execution. More...
	error (string $message)
	Will be used when something wrong happened during the handling of the action. More...

Additional Inherited Members
Public Member Functions inherited from Elgg\Controllers\GenericAction
	__invoke (\Elgg\Request $request)
	Invoke the action steps. More...
Protected Attributes inherited from Elgg\Controllers\GenericAction
Elgg Request	$request

Detailed Description

Helper class for CSV download actions.

Since

7.0

Definition at line 12 of file CsvDownloadAction.php.

Member Function Documentation

getContentHeaders()

Elgg\Controllers\CsvDownloadAction::getContentHeaders ( )

protected

Returns the first row of headers for your file.

Returns

array

Definition at line 60 of file CsvDownloadAction.php.

getContentRows()

Elgg\Controllers\CsvDownloadAction::getContentRows ( )

abstractprotected

Returns an array of rows with data for your file.

Returns

array

getContents()

Elgg\Controllers\CsvDownloadAction::getContents ( )

finalprotected

{File contents.

Returns

mixed

}

Reimplemented from Elgg\Controllers\DownloadAction.

Definition at line 74 of file CsvDownloadAction.php.

getEnclosure()

Elgg\Controllers\CsvDownloadAction::getEnclosure ( )

protected

Returns the enclosure.

Returns

string

Definition at line 42 of file CsvDownloadAction.php.

getEscape()

Elgg\Controllers\CsvDownloadAction::getEscape ( )

protected

Returns the escape.

Returns

string

Definition at line 51 of file CsvDownloadAction.php.

getFilename()

Elgg\Controllers\CsvDownloadAction::getFilename ( )

protected

{File name for download.

Returns

string

}

Reimplemented from Elgg\Controllers\DownloadAction.

Definition at line 17 of file CsvDownloadAction.php.

getMimeType()

Elgg\Controllers\CsvDownloadAction::getMimeType ( )

protected

{Return the content mimetype for the Content-Type header.

Returns

string

}

Reimplemented from Elgg\Controllers\DownloadAction.

Definition at line 24 of file CsvDownloadAction.php.

getSeparator()

Elgg\Controllers\CsvDownloadAction::getSeparator ( )

protected

Returns the separator.

Returns

string

Definition at line 33 of file CsvDownloadAction.php.

---

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

• engine/classes/Elgg/Controllers/CsvDownloadAction.php