dolibarr  7.0.0-beta
Public Member Functions | List of all members
ImportCsv Class Reference

Class to import CSV files. More...

+ Inheritance diagram for ImportCsv:
+ Collaboration diagram for ImportCsv:

Public Member Functions

 __construct ($db, $datatoimport)
 Constructor. More...
 
 write_header_example ($outputlangs)
 Output header of an example file for this format. More...
 
 write_title_example ($outputlangs, $headerlinefields)
 Output title line of an example file for this format. More...
 
 write_record_example ($outputlangs, $contentlinevalues)
 Output record of an example file for this format. More...
 
 write_footer_example ($outputlangs)
 Output footer of an example file for this format. More...
 
 import_open_file ($file)
 Open input file. More...
 
 import_get_nb_of_lines ($file)
 Return nb of records. More...
 
 import_read_header ()
 Input header line from file. More...
 
 import_read_record ()
 Return array of next record in input file. More...
 
 import_close_file ()
 Close file handle. More...
 
 import_insert ($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys)
 Insert a record into database. More...
 
- Public Member Functions inherited from ModeleImports
 __construct ()
 Constructor.
 
 getDriverId ()
 getDriverId More...
 
 getDriverLabel ()
 getDriverLabel More...
 
 getDriverDesc ()
 getDriverDesc More...
 
 getDriverExtension ()
 getDriverExtension More...
 
 getDriverVersion ()
 getDriverVersion More...
 
 getLibLabel ()
 getDriverLabel More...
 
 getLibVersion ()
 getLibVersion More...
 
 liste_modeles ($db, $maxfilenamelength=0)
 Charge en memoire et renvoie la liste des modeles actifs. More...
 
 getPictoForKey ($key)
 Return picto of import driver. More...
 
 getDriverLabelForKey ($key)
 Renvoi libelle d'un driver import. More...
 
 getDriverDescForKey ($key)
 Renvoi la description d'un driver import. More...
 
 getDriverVersionForKey ($key)
 Renvoi version d'un driver import. More...
 
 getLibLabelForKey ($key)
 Renvoi libelle de librairie externe du driver. More...
 
 getLibVersionForKey ($key)
 Renvoi version de librairie externe du driver. More...
 

Detailed Description

Class to import CSV files.

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

Constructor & Destructor Documentation

ImportCsv::__construct (   $db,
  $datatoimport 
)

Constructor.

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

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

References GETPOST().

Member Function Documentation

ImportCsv::import_close_file ( )

Close file handle.

Returns
integer

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

ImportCsv::import_get_nb_of_lines (   $file)

Return nb of records.

File must be closed.

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

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

References dol_count_nb_of_line().

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 <0 if KO, >0 if OK

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

References $resql, dol_include_once(), dol_print_error(), dol_syslog(), and price2num().

ImportCsv::import_open_file (   $file)

Open input file.

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

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

References dol_osencode(), and dol_syslog().

ImportCsv::import_read_header ( )

Input header line from file.

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

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

ImportCsv::import_read_record ( )

Return array of next record in input file.

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

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

References dol_strlen(), and utf8_check().

ImportCsv::write_footer_example (   $outputlangs)

Output footer of an example file for this format.

Parameters
Translate$outputlangsOutput language
Returns
string

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

ImportCsv::write_header_example (   $outputlangs)

Output header of an example file for this format.

Parameters
Translate$outputlangsOutput language
Returns
string

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

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

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

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

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


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