dolibarr  19.0.0-dev
Public Member Functions | List of all members
ModeleImports Class Reference

Parent class for import file readers. More...

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

Public Member Functions

 __construct ()
 Constructor.
 
 getDriverId ()
 getDriverId More...
 
 getDriverLabel ()
 getDriverLabel More...
 
 getDriverDesc ()
 getDriverDesc More...
 
 getDriverExtension ()
 getDriverExtension More...
 
 getDriverVersion ()
 getDriverVersion More...
 
 getLibLabel ()
 getDriverLabel More...
 
 getLibVersion ()
 getLibVersion More...
 
 listOfAvailableImportFormat ($db, $maxfilenamelength=0)
 Load into memory list of available import format. More...
 
 getPictoForKey ($key)
 Return picto of import driver. More...
 
 getDriverLabelForKey ($key)
 Return label of driver import. More...
 
 getDriverDescForKey ($key)
 Return description of import drivervoi 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...
 
 getElementFromTableWithPrefix ($tableNameWithPrefix)
 Get element from table name with prefix. More...
 

Detailed Description

Parent class for import file readers.

Definition at line 31 of file modules_import.php.

Member Function Documentation

◆ getDriverDesc()

ModeleImports::getDriverDesc ( )

getDriverDesc

Returns
string Description

Definition at line 154 of file modules_import.php.

◆ getDriverDescForKey()

ModeleImports::getDriverDescForKey (   $key)

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

Parameters
string$keyKey
Returns
string

Definition at line 275 of file modules_import.php.

◆ getDriverExtension()

ModeleImports::getDriverExtension ( )

getDriverExtension

Returns
string Driver suffix

Definition at line 164 of file modules_import.php.

◆ getDriverId()

ModeleImports::getDriverId ( )

getDriverId

Returns
int Id

Definition at line 134 of file modules_import.php.

◆ getDriverLabel()

ModeleImports::getDriverLabel ( )

getDriverLabel

Returns
string Label

Definition at line 144 of file modules_import.php.

◆ getDriverLabelForKey()

ModeleImports::getDriverLabelForKey (   $key)

Return label of driver import.

Parameters
string$keyKey
Returns
string

Definition at line 264 of file modules_import.php.

◆ getDriverVersion()

ModeleImports::getDriverVersion ( )

getDriverVersion

Returns
string Driver version

Definition at line 174 of file modules_import.php.

◆ getDriverVersionForKey()

ModeleImports::getDriverVersionForKey (   $key)

Renvoi version d'un driver import.

Parameters
string$keyKey
Returns
string

Definition at line 286 of file modules_import.php.

◆ getElementFromTableWithPrefix()

ModeleImports::getElementFromTableWithPrefix (   $tableNameWithPrefix)

Get element from table name with prefix.

Parameters
string$tableNameWithPrefixTable name with prefix
Returns
string Element name or table element as default

Definition at line 319 of file modules_import.php.

◆ getLibLabel()

ModeleImports::getLibLabel ( )

getDriverLabel

Returns
string Label of external lib

Definition at line 184 of file modules_import.php.

◆ getLibLabelForKey()

ModeleImports::getLibLabelForKey (   $key)

Renvoi libelle de librairie externe du driver.

Parameters
string$keyKey
Returns
string

Definition at line 297 of file modules_import.php.

◆ getLibVersion()

ModeleImports::getLibVersion ( )

getLibVersion

Returns
string Version of external lib

Definition at line 194 of file modules_import.php.

◆ getLibVersionForKey()

ModeleImports::getLibVersionForKey (   $key)

Renvoi version de librairie externe du driver.

Parameters
string$keyKey
Returns
string

Definition at line 308 of file modules_import.php.

◆ getPictoForKey()

ModeleImports::getPictoForKey (   $key)

Return picto of import driver.

Parameters
string$keyKey
Returns
string

Definition at line 253 of file modules_import.php.

◆ listOfAvailableImportFormat()

ModeleImports::listOfAvailableImportFormat (   $db,
  $maxfilenamelength = 0 
)

Load into memory list of available import format.

Parameters
DoliDB$dbDatabase handler
integer$maxfilenamelengthMax length of value to show
Returns
array List of templates

Definition at line 207 of file modules_import.php.

References dol_syslog().


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