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

Public Member Functions

 __construct (Db $zdb, Login $login, array $members_fields, FieldsConfig $fields_config)
 
 exportMembers (MembersList $filters)
 
 getPath ()
 
 getFileName ()
 
- Public Member Functions inherited from Galette\IO\CsvOut
 __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 ()
 

Additional Inherited Members

- Public Attributes inherited from Galette\IO\CsvOut
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
 
- 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

Members CSV exports

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

Constructor & Destructor Documentation

◆ __construct()

Galette\IO\MembersCsv::__construct ( Db  $zdb,
Login  $login,
array  $members_fields,
FieldsConfig  $fields_config 
)

Default constructor

Parameters
Db$zdbDb instance
Login$loginLogin instance
array<string,mixed>$members_fields Members fields
FieldsConfig$fields_configFields configuration

Member Function Documentation

◆ exportMembers()

Galette\IO\MembersCsv::exportMembers ( MembersList  $filters)

Export members CSV

Parameters
MembersList$filtersCurrent filters
Returns
void

◆ getFileName()

Galette\IO\MembersCsv::getFileName ( )

Get file name

Returns
string

◆ getPath()

Galette\IO\MembersCsv::getPath ( )

Get file path on disk

Returns
string

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