Inheritance diagram for Galette\IO\CsvOut:

Collaboration diagram for Galette\IO\CsvOut:

Public Member Functions
	__construct ()

	export (ResultSet\|array $rs, string $separator, string $quote, array\|bool $titles=false, mixed $file=false)

	getParamedtedExportName (string $id)

	getParametedExports ()

	runParametedExport (string $id)

Public Member Functions inherited from Galette\IO\Csv
	__construct (string $default_dir)

	getExisting ()

	remove (string $name)

	getAcceptedSeparators ()

	getAcceptedQuotes ()

	addError (string $msg)

	getErrors ()

Public Attributes
const	DEFAULT_DIRECTORY = GALETTE_EXPORTS_PATH

Public Attributes inherited from Galette\IO\Csv
const	NEWLINE = "\r\n"

const	BUFLINES = 100

const	DEFAULT_SEPARATOR = ';'

const	DEFAULT_QUOTE = '"'

const	FILE_NOT_WRITABLE = -1

const	DB_ERROR = -2

Additional Inherited Members
Protected Attributes inherited from Galette\IO\Csv
string	$separator

string	$quote

string	$escaped

mixed	$file

string	$result

int	$current_line

array	$extensions = array('csv')

array	$accepted_separators

array	$accepted_quotes

Detailed Description

CSV exports

Constructor & Destructor Documentation

Galette\IO\CsvOut::__construct ( )

Default constructor

Export Array result set to CSV

Parameters

	ResultSet\|array<int,mixed>	$rs Results as an array
string	$separator	The CSV separator (either '\t', ';' or ',' are accepted)
string	$quote	how does fields should be quoted
	array<string>\|bool	$titles does export shows column titles or not. Defaults to false.
resource \| false	$file	export to a file on disk. A file pointer should be passed here. Defaults to false.

Galette\IO\CsvOut::getParamedtedExportName ( string $id )

Retrieve parameted export name

Parameters

string $id Parameted export identifier

Galette\IO\CsvOut::getParametedExports ( )

Get al list of all parameted exports

Galette\IO\CsvOut::runParametedExport ( string $id )

Run selected export

Parameters

string $id export's id to run

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

/home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/IO/CsvOut.php

	Galette API documentation Gestionnaire d’Adhérents en Ligne Extrêmement Tarabiscoté mais Tellement Efficace
1.0.0