Galette\IO\CsvIn Class Reference

Inheritance diagram for Galette\IO\CsvIn:

Collaboration diagram for Galette\IO\CsvIn:

Public Member Functions
	__construct (Db $zdb)
	getDefaultFields ()
	import (Db $zdb, Preferences $preferences, History $history, string $filename, array $members_fields, array $members_fields_cats, bool $dryrun)
	getErrorMessage (int $code)
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_IMPORTS_PATH
const	DATA_IMPORT_ERROR = -10
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
Public Attributes inherited from Galette\IO\FileInterface
const	INVALID_FILENAME = -1
const	INVALID_EXTENSION = -2
const	FILE_TOO_BIG = -3
const	IMAGE_TOO_SMALL = -4
const	MIME_NOT_ALLOWED = -5
const	NEW_FILE_EXISTS = -6
const	INVALID_FILE = -7
const	CANT_WRITE = -8
const	MAX_FILE_SIZE = 2048
const	MIN_CROP_SIZE = 267

Protected Attributes
array	$extensions = array('csv', 'txt')
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 imports

Author

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

Constructor & Destructor Documentation

__construct()

Galette\IO\CsvIn::__construct

(

Db

$zdb

)

Default constructor

Parameters

Db

$zdb

Database

Member Function Documentation

getDefaultFields()

Galette\IO\CsvIn::getDefaultFields

(

)

Get default fields

Returns

array<string>

getErrorMessage()

Galette\IO\CsvIn::getErrorMessage

(

int

$code

)

Return textual error message

Parameters

int

$code

The error code

Returns

string Localized message

import()

Galette\IO\CsvIn::import	(	Db	$zdb,
		Preferences	$preferences,
		History	$history,
		string	$filename,
		array	$members_fields,
		array	$members_fields_cats,
		bool	$dryrun
	)

Import members from CSV file

Parameters

Db	$zdb	Database instance
Preferences	$preferences	Preferences instance
History	$history	History instance
string	$filename	CSV filename
	array<string,mixed>	$members_fields Members fields
	array<string,mixed>	$members_fields_cats Members fields categories
boolean	$dryrun	Run in dry run mode (do not store in database)

Returns

bool|int

---

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/CsvIn.php