dolibarr 20.0.0
ImportCsv Class Reference

Class to import CSV files. More...

Inheritance diagram for ImportCsv:
Collaboration diagram for ImportCsv:

Public Member Functions

 __construct ($db, $datatoimport)
 Constructor.
 
 write_header_example ($outputlangs)
 Output header of an example file for this format.
 
 write_title_example ($outputlangs, $headerlinefields)
 Output title line of an example file for this format.
 
 write_record_example ($outputlangs, $contentlinevalues)
 Output record of an example file for this format.
 
 write_footer_example ($outputlangs)
 Output footer of an example file for this format.
 
 import_open_file ($file)
 Open input file.
 
 import_get_nb_of_lines ($file)
 Return nb of records.
 
 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.
 
 import_insert ($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys)
 Insert a record into database.
 
- Public Member Functions inherited from ModeleImports
 __construct ()
 Constructor.
 
 getDriverId ()
 getDriverId
 
 getDriverLabel ()
 getDriverLabel
 
 getDriverDesc ()
 getDriverDesc
 
 getDriverExtension ()
 getDriverExtension
 
 getDriverVersion ()
 getDriverVersion
 
 getLibLabel ()
 getDriverLabel
 
 getLibVersion ()
 getLibVersion
 
 listOfAvailableImportFormat ($db, $maxfilenamelength=0)
 Load into memory list of available import format.
 
 getPictoForKey ($key)
 Return picto of import driver.
 
 getDriverLabelForKey ($key)
 Return label of driver import.
 
 getDriverDescForKey ($key)
 Return description of import drivervoi la description d'un driver import.
 
 getDriverVersionForKey ($key)
 Renvoi version d'un driver import.
 
 getLibLabelForKey ($key)
 Renvoi libelle de librairie externe du driver.
 
 getLibVersionForKey ($key)
 Renvoi version de librairie externe du driver.
 
 getElementFromTableWithPrefix ($tableNameWithPrefix)
 Get element from table name with prefix.
 

Detailed Description

Class to import CSV files.

Definition at line 35 of file import_csv.modules.php.

Constructor & Destructor Documentation

◆ __construct()

ImportCsv::__construct ( $db,
$datatoimport )

Constructor.

Parameters
DoliDB$dbDatabase handler
string$datatoimportString code describing import set (ex: 'societe_1')

Definition at line 82 of file import_csv.modules.php.

References dol_syslog(), getDolGlobalString(), GETPOST(), versioncompare(), and versionphparray().

Member Function Documentation

◆ import_close_file()

ImportCsv::import_close_file ( )

Close file handle.

Returns
integer

Definition at line 287 of file import_csv.modules.php.

◆ import_get_nb_of_lines()

ImportCsv::import_get_nb_of_lines ( $file)

Return nb of records.

File must be closed.

Parameters
string$filePath of filename
Returns
int Return integer <0 if KO, >=0 if OK

Definition at line 213 of file import_csv.modules.php.

References dol_count_nb_of_line().

◆ import_insert()

ImportCsv::import_insert ( $arrayrecord,
$array_match_file_to_database,
$objimport,
$maxfields,
$importid,
$updatekeys )

Insert a record into database.

Parameters
array$arrayrecordArray of read values: [fieldpos] => (['val']=>val, ['type']=>-1=null,0=blank,1=string), [fieldpos+1]...
array$array_match_file_to_databaseArray of target fields where to insert data: [fieldpos] => 's.fieldname', [fieldpos+1]...
Object$objimportObject import (contains objimport->array_import_tables, objimport->array_import_fields, objimport->array_import_convertvalue, ...)
int$maxfieldsMax number of fields to use
string$importidImport key
array$updatekeysArray of keys to use to try to do an update first before insert. This field are defined into the module descriptor.
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 307 of file import_csv.modules.php.

References dol_include_once(), dol_print_error(), dol_stringtotime(), dol_syslog(), dol_trunc(), getDolGlobalString(), ModeleImports\getElementFromTableWithPrefix(), num2Alpha(), price2num(), and testSqlAndScriptInject().

◆ import_open_file()

ImportCsv::import_open_file ( $file)

Open input file.

Parameters
string$filePath of filename
Returns
int Return integer <0 if KO, >=0 if OK

Definition at line 183 of file import_csv.modules.php.

References dol_osencode(), and dol_syslog().

◆ import_read_header()

ImportCsv::import_read_header ( )

Input header line from file.

Returns
int Return integer <0 if KO, >=0 if OK

Definition at line 226 of file import_csv.modules.php.

◆ import_read_record()

ImportCsv::import_read_record ( )

Return array of next record in input file.

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

Definition at line 239 of file import_csv.modules.php.

References dol_strlen(), getDolGlobalString(), and utf8_check().

◆ write_footer_example()

ImportCsv::write_footer_example ( $outputlangs)

Output footer of an example file for this format.

Parameters
Translate$outputlangsOutput language
Returns
string Empty string

Definition at line 169 of file import_csv.modules.php.

◆ write_header_example()

ImportCsv::write_header_example ( $outputlangs)

Output header of an example file for this format.

Parameters
Translate$outputlangsOutput language
Returns
string Empty string

Definition at line 126 of file import_csv.modules.php.

◆ write_record_example()

ImportCsv::write_record_example ( $outputlangs,
$contentlinevalues )

Output record of an example file for this format.

Parameters
Translate$outputlangsOutput language
array$contentlinevaluesArray of lines
Returns
string String output

Definition at line 155 of file import_csv.modules.php.

◆ write_title_example()

ImportCsv::write_title_example ( $outputlangs,
$headerlinefields )

Output title line of an example file for this format.

Parameters
Translate$outputlangsOutput language
array$headerlinefieldsArray of fields name
Returns
string String output

Definition at line 140 of file import_csv.modules.php.


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