dolibarr  16.0.5
Public Member Functions | List of all members
ImportXlsx Class Reference

Class to import Excel files. More...

Inheritance diagram for ImportXlsx:
Inheritance graph
[legend]
Collaboration diagram for ImportXlsx:
Collaboration graph
[legend]

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 Excel files.

Definition at line 38 of file import_xlsx.modules.php.

Constructor & Destructor Documentation

◆ __construct()

ImportXlsx::__construct (   $db,
  $datatoimport 
)

Constructor.

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

Definition at line 106 of file import_xlsx.modules.php.

Member Function Documentation

◆ import_close_file()

ImportXlsx::import_close_file ( )

Close file handle.

Returns
integer

Definition at line 337 of file import_xlsx.modules.php.

◆ import_get_nb_of_lines()

ImportXlsx::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 267 of file import_xlsx.modules.php.

◆ import_insert()

ImportXlsx::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 358 of file import_xlsx.modules.php.

◆ import_open_file()

ImportXlsx::import_open_file (   $file)

Open input file.

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

Definition at line 243 of file import_xlsx.modules.php.

◆ import_read_header()

ImportXlsx::import_read_header ( )

Input header line from file.

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

Definition at line 288 of file import_xlsx.modules.php.

◆ import_read_record()

ImportXlsx::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 309 of file import_xlsx.modules.php.

◆ write_footer_example()

ImportXlsx::write_footer_example (   $outputlangs)

Output footer of an example file for this format.

Parameters
Translate$outputlangsOutput language
Returns
string String output

Definition at line 219 of file import_xlsx.modules.php.

◆ write_header_example()

ImportXlsx::write_header_example (   $outputlangs)

Output header of an example file for this format.

Parameters
Translate$outputlangsOutput language
Returns
string Empty string

Definition at line 148 of file import_xlsx.modules.php.

◆ write_record_example()

ImportXlsx::write_record_example (   $outputlangs,
  $contentlinevalues 
)

Output record of an example file for this format.

Parameters
Translate$outputlangsOutput language
array$contentlinevaluesArray of lines
Returns
string Empty string

Definition at line 199 of file import_xlsx.modules.php.

◆ write_title_example()

ImportXlsx::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 173 of file import_xlsx.modules.php.


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