Galette API documentation
Gestionnaire d’Adhérents en Ligne Extrêmement Tarabiscoté mais Tellement Efficace
1.0.0
Galette\IO\Csv Class Reference
Inheritance diagram for Galette\IO\Csv:

Public Member Functions

 __construct (string $default_dir)
 
 getExisting ()
 
 remove (string $name)
 
 getAcceptedSeparators ()
 
 getAcceptedQuotes ()
 
 addError (string $msg)
 
 getErrors ()
 

Public Attributes

const NEWLINE = "\r\n"
 
const BUFLINES = 100
 
const DEFAULT_SEPARATOR = ';'
 
const DEFAULT_QUOTE = '"'
 
const FILE_NOT_WRITABLE = -1
 
const DB_ERROR = -2
 

Protected Attributes

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 files

Author
Johan Cwiklinski johan.nosp@m.@x-t.nosp@m.nd.be

Constructor & Destructor Documentation

◆ __construct()

Galette\IO\Csv::__construct ( string  $default_dir)

Default constructor

Parameters
string$default_dirDefault directory

Member Function Documentation

◆ addError()

Galette\IO\Csv::addError ( string  $msg)

Add an error

Parameters
string$msgError message
Returns
void

◆ getAcceptedQuotes()

Galette\IO\Csv::getAcceptedQuotes ( )

Accepted quotes

Returns
array<string> list of accepted quotes

◆ getAcceptedSeparators()

Galette\IO\Csv::getAcceptedSeparators ( )

Accepted separators

Returns
array<string> list of accepted separators

◆ getErrors()

Galette\IO\Csv::getErrors ( )

Get errors

Returns
array<string>

◆ getExisting()

Galette\IO\Csv::getExisting ( )

Retrieve a list of already existing CSV files

Returns
array<int, array<string,string>>

◆ remove()

Galette\IO\Csv::remove ( string  $name)

Remove existing CSV file

Parameters
string$nameFile name
Returns
boolean

Member Data Documentation

◆ $accepted_quotes

array Galette\IO\Csv::$accepted_quotes
protected
Initial value:
= array(
'"',
"'"
)

◆ $accepted_separators

array Galette\IO\Csv::$accepted_separators
protected
Initial value:
= array(
',',
';',
'\t'
)

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