ModeleExports Class Reference

Parent class for export modules. More...

Inheritance diagram for ModeleExports:

Collaboration diagram for ModeleExports:

Public Member Functions
	listOfAvailableExportFormat ($db, $maxfilenamelength=0)
	Load into memory list of available export format.
	getPictoForKey ($key)
	Return picto of export driver.
	getDriverLabelForKey ($key)
	Return label of driver export.
	getDriverDescForKey ($key)
	Renvoi le descriptif d'un driver export.
	getDriverVersionForKey ($key)
	Renvoi version d'un driver export.
	getLibLabelForKey ($key)
	Renvoi label of driver lib.
	getLibVersionForKey ($key)
	Return version of driver lib.
Public Member Functions inherited from CommonDocGenerator
	__construct ($db)
	Constructor.
	get_substitutionarray_user ($user, $outputlangs)
	Define array with couple substitution key => substitution value.
	getSubstitutionarrayMember ($member, $outputlangs)
	Define array with couple substitution key => substitution value.
	get_substitutionarray_mysoc ($mysoc, $outputlangs)
	Define array with couple substitution key => substitution value.
	get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company')
	Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}.
	get_substitutionarray_contact ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value.
	get_substitutionarray_other ($outputlangs)
	Define array with couple substitution key => substitution value.
	get_substitutionarray_object ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
	get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
	get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
	get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
	Define array with couple substitution key => substitution value.
	fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs)
	Fill array with couple extrafield key => extrafield value Note that vars into substitutions array are formatted.
	printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
	Rect pdf.
	columnSort ($a, $b)
	uasort callback function to Sort columns fields
	prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Prepare Array Column Field.
	getColumnContentWidth ($colKey)
	get column content width from column key
	getColumnContentXStart ($colKey)
	get column content X (abscissa) left position from column key
	getColumnRank ($colKey)
	get column position rank from column key
	insertNewColumnDef ($newColKey, $defArray, $targetCol='', $insertAfterTarget=false)
	get column position rank from column key
	printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
	print standard column content
	printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
	print description column content
	getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null)
	get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block
	getColumnStatus ($colKey)
	get column status from column key
	pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0)
	Print standard column content.
	defineColumnExtrafield ($object, $outputlangs, $hidedetails=0)
	Define Array Column Field for extrafields.
	defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Define Array Column Field into $this->cols This method must be implemented by the module that generate the document with its own columns.

Detailed Description

Parent class for export modules.

Definition at line 31 of file modules_export.php.

Member Function Documentation

getDriverDescForKey()

ModeleExports::getDriverDescForKey

(

$key

)

Renvoi le descriptif d'un driver export.

Parameters

string

$key

Key of driver

Returns

string Description

Definition at line 169 of file modules_export.php.

getDriverLabelForKey()

ModeleExports::getDriverLabelForKey

(

$key

)

Return label of driver export.

Parameters

string

$key

Key of driver

Returns

string Label

Definition at line 158 of file modules_export.php.

getDriverVersionForKey()

ModeleExports::getDriverVersionForKey

(

$key

)

Renvoi version d'un driver export.

Parameters

string

$key

Key of driver

Returns

string Driver version

Definition at line 180 of file modules_export.php.

getLibLabelForKey()

ModeleExports::getLibLabelForKey

(

$key

)

Renvoi label of driver lib.

Parameters

string

$key

Key of driver

Returns

string Label of library

Definition at line 191 of file modules_export.php.

getLibVersionForKey()

ModeleExports::getLibVersionForKey

(

$key

)

Return version of driver lib.

Parameters

string

$key

Key of driver

Returns

string Version of library

Definition at line 202 of file modules_export.php.

getPictoForKey()

ModeleExports::getPictoForKey

(

$key

)

Return picto of export driver.

Parameters

string

$key

Key of driver

Returns

string Picto string

Definition at line 147 of file modules_export.php.

listOfAvailableExportFormat()

ModeleExports::listOfAvailableExportFormat	(		$db,
			$maxfilenamelength = 0 )

Load into memory list of available export format.

Parameters

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

Returns

array List of templates (same content than array this->driverlabel)

Definition at line 85 of file modules_export.php.

References dol_syslog().

---

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

• dolibarr_19.0/htdocs/core/modules/export/modules_export.php