ImportCsv

class ImportCsv extends ModeleImports (View source)

Class to import CSV files

Properties

DoliDB $db
string $datatoimport from  ModeleImports
string $error from  ModeleImports
string[]|array<int, array<string, string>> $errors from  ModeleImports
string[]|array<int, array<string, string>> $warnings from  ModeleImports
string $id
string $label from  ModeleImports
string $extension from  ModeleImports
string $version

Dolibarr version of driver
array{0: int, 1: int} $phpmin

PHP minimal version required by driver

 from  ModeleImports
string $label_lib
string $version_lib
array<string, string> $driverlabel from  ModeleImports
array<string, string> $driverdesc from  ModeleImports
array<string, string> $driverversion from  ModeleImports
array<string, string> $drivererror from  ModeleImports
array<string, string> $liblabel from  ModeleImports
array<string, string> $libversion from  ModeleImports
$charset
array<string, string>|string $picto from  ModeleImports
string $desc from  ModeleImports
string $escape from  ModeleImports
string $enclosure from  ModeleImports
Societe $thirdpartyobject from  ModeleImports
static array<string, string> $mapTableToElement from  ModeleImports
string|string[] $separator
string $file
resource $handle
$cacheconvert
$cachefieldtable
$nbinsert
$nbupdate
int $col

Methods

__construct(DoliDB $db, string $datatoimport)

Constructor

string
getDriverId()

getDriverId

from  ModeleImports
string
getDriverLabel()

getDriverLabel

from  ModeleImports
string
getDriverDesc()

getDriverDesc

from  ModeleImports
string
getDriverExtension()

getDriverExtension

from  ModeleImports
string
getDriverVersion()

getDriverVersion

from  ModeleImports
string
getLibLabel()

getDriverLabel

from  ModeleImports
string
getLibVersion()

getLibVersion

from  ModeleImports
listOfAvailableImportFormat($db, int $maxfilenamelength = 0)

Load into memory list of available import format

from  ModeleImports
string
getPictoForKey(string $key)

Return picto of import driver

from  ModeleImports
string
getDriverLabelForKey(string $key)

Return label of driver import

from  ModeleImports
string
getDriverDescForKey(string $key)

Return description of import drivervoi la description d'un driver import

from  ModeleImports
string
getDriverVersionForKey(string $key)

Renvoi version d'un driver import

from  ModeleImports
string
getLibLabelForKey(string $key)

Renvoi libelle de librairie externe du driver

from  ModeleImports
string
getLibVersionForKey(string $key)

Renvoi version de librairie externe du driver

from  ModeleImports
string
getElementFromTableWithPrefix(string $tableNameWithPrefix)

Get element from table name with prefix

from  ModeleImports
import_open_file(string $file)

Open input file

import_get_nb_of_lines(string $file)

Return nb of records. File must be closed.

import_read_header()

Input header line from file

import_read_record()

Return array of next record in input file.

import_close_file()

Close file handle

int
import_insert(array<string, array{val: mixed, type: int<-1, 1>}>|bool $arrayrecord, array<int|string, string> $array_match_file_to_database, object $objimport, int $maxfields, string $importid, string[] $updatekeys)

Insert a record into database

string
write_header_example($outputlangs)

Output header of an example file for this format

write_title_example($outputlangs, string[] $headerlinefields)

Output title line of an example file for this format

write_record_example($outputlangs, mixed[] $contentlinevalues)

Output record of an example file for this format

string
write_footer_example($outputlangs)

Output footer of an example file for this format

Details

at line 101
__construct(DoliDB $db, string $datatoimport)

Constructor

Parameters

DoliDB $db

Database handler
string $datatoimport

String code describing import set (ex: 'societe_1')

in ModeleImports at line 189
string getDriverId()

getDriverId

Return Value

string

Code of driver

in ModeleImports at line 199
string getDriverLabel()

getDriverLabel

Return Value

string Label

in ModeleImports at line 209
string getDriverDesc()

getDriverDesc

Return Value

string Description

in ModeleImports at line 219
string getDriverExtension()

getDriverExtension

Return Value

string

Driver suffix

in ModeleImports at line 229
string getDriverVersion()

getDriverVersion

Return Value

string

Driver version

in ModeleImports at line 239
string getLibLabel()

getDriverLabel

Return Value

string

Label of external lib

in ModeleImports at line 249
string getLibVersion()

getLibVersion

Return Value

string

Version of external lib

in ModeleImports at line 262
listOfAvailableImportFormat($db, int $maxfilenamelength = 0)

Load into memory list of available import format

@param DoliDB $db Database handler

Parameters

$db
int $maxfilenamelength

Max length of value to show @return array<int,string> List of templates

in ModeleImports at line 308
string getPictoForKey(string $key)

Return picto of import driver

Parameters

string $key Key

Return Value

string

in ModeleImports at line 319
string getDriverLabelForKey(string $key)

Return label of driver import

Parameters

string $key Key

Return Value

string

in ModeleImports at line 330
string getDriverDescForKey(string $key)

Return description of import drivervoi la description d'un driver import

Parameters

string $key Key

Return Value

string

in ModeleImports at line 341
string getDriverVersionForKey(string $key)

Renvoi version d'un driver import

Parameters

string $key Key

Return Value

string

in ModeleImports at line 352
string getLibLabelForKey(string $key)

Renvoi libelle de librairie externe du driver

Parameters

string $key Key

Return Value

string

in ModeleImports at line 363
string getLibVersionForKey(string $key)

Renvoi version de librairie externe du driver

Parameters

string $key Key

Return Value

string

in ModeleImports at line 374
string getElementFromTableWithPrefix(string $tableNameWithPrefix)

Get element from table name with prefix

Parameters

string $tableNameWithPrefix

Table name with prefix

Return Value

string

Element name or table element as default

at line 202
import_open_file(string $file)

Open input file

Parameters

string $file

Path of filename @return int Return integer <0 if KO, >=0 if OK

at line 233
import_get_nb_of_lines(string $file)

Return nb of records. File must be closed.

Parameters

string $file

Path of filename @return int Return integer <0 if KO, >=0 if OK

at line 246
import_read_header()

Input header line from file

@return     int     Return integer <0 if KO, >=0 if OK

at line 259
import_read_record()

Return array of next record in input file.

@return     array|boolean       Array of field values. Data are UTF8 encoded. [fieldpos] => (['val']=>val, ['type']=>-1=null,0=blank,1=not empty string)

at line 309
import_close_file()

Close file handle

@return integer

at line 329
int import_insert(array<string, array{val: mixed, type: int<-1, 1>}>|bool $arrayrecord, array<int|string, string> $array_match_file_to_database, object $objimport, int $maxfields, string $importid, string[] $updatekeys)

Insert a record into database

Parameters

array<string, array{val: mixed, type: int<-1, 1>}>|bool $arrayrecord

Array of read values: [fieldpos] => (['val']=>val, ['type']=>-1=null,0=blank,1=string), [fieldpos+1]...
array<int|string, string> $array_match_file_to_database

Array of target fields where to insert data: [fieldpos] => 's.fieldname', [fieldpos+1]...
object $objimport

Object import (contains objimport->array_import_tables, objimport->array_import_fields, objimport->array_import_convertvalue, ...)
int $maxfields

Max number of fields to use
string $importid

Import key
string[] $updatekeys

Array of keys to use to try to do an update first before insert. This field are defined into the module descriptor.

Return Value

int

Return integer <0 if KO, >0 if OK

at line 145
string write_header_example($outputlangs)

Output header of an example file for this format

@param  Translate   $outputlangs        Output language

Parameters

$outputlangs

Return Value

string

Empty string

at line 159
write_title_example($outputlangs, string[] $headerlinefields)

Output title line of an example file for this format

@param  Translate   $outputlangs        Output language

Parameters

$outputlangs
string[] $headerlinefields

Array of fields name @return string String output

at line 174
write_record_example($outputlangs, mixed[] $contentlinevalues)

Output record of an example file for this format

@param  Translate   $outputlangs        Output language

Parameters

$outputlangs
mixed[] $contentlinevalues

Array of lines @return string Empty string

Output footer of an example file for this format

@param  Translate   $outputlangs        Output language

Parameters

$outputlangs

Return Value

string

String output