ModeleImports Class Reference

Parent class for import file readers. More...

Inheritance diagram for ModeleImports:

Collaboration diagram for ModeleImports:

Public Member Functions
	__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

Parent class for import file readers.

Definition at line 33 of file modules_import.php.

Member Function Documentation

getDriverDesc()

ModeleImports::getDriverDesc

(

)

getDriverDesc

Returns

string Description

Definition at line 188 of file modules_import.php.

getDriverDescForKey()

ModeleImports::getDriverDescForKey

(

$key

)

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

Parameters

string

$key

Key

Returns

string

Definition at line 308 of file modules_import.php.

getDriverExtension()

ModeleImports::getDriverExtension

(

)

getDriverExtension

Returns

string Driver suffix

Definition at line 198 of file modules_import.php.

getDriverId()

ModeleImports::getDriverId

(

)

getDriverId

Returns

string Code of driver

Definition at line 168 of file modules_import.php.

getDriverLabel()

ModeleImports::getDriverLabel

(

)

getDriverLabel

Returns

string Label

Definition at line 178 of file modules_import.php.

getDriverLabelForKey()

ModeleImports::getDriverLabelForKey

(

$key

)

Return label of driver import.

Parameters

string

$key

Key

Returns

string

Definition at line 297 of file modules_import.php.

getDriverVersion()

ModeleImports::getDriverVersion

(

)

getDriverVersion

Returns

string Driver version

Definition at line 208 of file modules_import.php.

getDriverVersionForKey()

ModeleImports::getDriverVersionForKey

(

$key

)

Renvoi version d'un driver import.

Parameters

string

$key

Key

Returns

string

Definition at line 319 of file modules_import.php.

getElementFromTableWithPrefix()

ModeleImports::getElementFromTableWithPrefix

(

$tableNameWithPrefix

)

Get element from table name with prefix.

Parameters

string

$tableNameWithPrefix

Table name with prefix

Returns

string Element name or table element as default

Definition at line 352 of file modules_import.php.

Referenced by ImportCsv\import_insert(), and ImportXlsx\import_insert().

getLibLabel()

ModeleImports::getLibLabel

(

)

getDriverLabel

Returns

string Label of external lib

Definition at line 218 of file modules_import.php.

getLibLabelForKey()

ModeleImports::getLibLabelForKey

(

$key

)

Renvoi libelle de librairie externe du driver.

Parameters

string

$key

Key

Returns

string

Definition at line 330 of file modules_import.php.

getLibVersion()

ModeleImports::getLibVersion

(

)

getLibVersion

Returns

string Version of external lib

Definition at line 228 of file modules_import.php.

getLibVersionForKey()

ModeleImports::getLibVersionForKey

(

$key

)

Renvoi version de librairie externe du driver.

Parameters

string

$key

Key

Returns

string

Definition at line 341 of file modules_import.php.

getPictoForKey()

ModeleImports::getPictoForKey

(

$key

)

Return picto of import driver.

Parameters

string

$key

Key

Returns

string

Definition at line 286 of file modules_import.php.

listOfAvailableImportFormat()

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

Load into memory list of available import format.

Parameters

DoliDB	$db	Database handler
integer	$maxfilenamelength	Max length of value to show

Returns

array List of templates

Definition at line 241 of file modules_import.php.

References dol_syslog().

---

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

• dolibarr_20.0/htdocs/core/modules/import/modules_import.php