csv() function - Documentation for SproutCMS

function csv()

Exports a database query result as a CSV file.

File: /sprout/Helpers/QueryTo.php, line 36
Namespace: Sprout\Helpers
Class: QueryTo, Static method

Usage

bool|string QueryTo::csv ( PDOStatement|array $result , array $modifiers , array $headings );

Arguments

PDOStatement|array $result

Result set. N.B. the cursor on this statement WILL BE CLOSED by this function.

array $modifiers

ColModifier objects to apply result set before exporting their values,
       as column_name => ColModifier instance

array $headings

Headings to use on the first row of the CSV; as column_name => heading.
       The column name itself will be used if a specific heading isn't requested.

Return value

string
```
The CSV file
```
bool
```
False on error
```