dolibarr 21.0.0-alpha
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.
 
 write_record ($array_selected_sorted, $objp, $outputlangs, $array_types)
 Output record line into file.
 
 getDriverLabel ()
 getDriverLabel
 
 getDriverDesc ()
 getDriverDesc
 
 getDriverVersion ()
 getDriverVersion
 
 getLibLabel ()
 getLibLabel
 
 getLibVersion ()
 getLibVersion
 
 getDriverExtension ()
 getDriverExtension
 
 open_file ($file, $outputlangs)
 Open output file.
 
 write_header ($outputlangs)
 Write header.
 
 write_title ($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
 Output title line into file.
 
 write_footer ($outputlangs)
 Write footer.
 
 close_file ()
 Close Excel file.
 
- 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_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 32 of file modules_export.php.

Member Function Documentation

◆ close_file()

ModeleExports::close_file ( )

Close Excel file.

Returns
int Return integer <0 if KO, >0 if OK

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 408 of file modules_export.php.

References dol_syslog().

◆ getDriverDesc()

ModeleExports::getDriverDesc ( )

getDriverDesc

Returns
string

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 275 of file modules_export.php.

References dol_syslog().

◆ getDriverDescForKey()

ModeleExports::getDriverDescForKey ( $key)

Renvoi le descriptif d'un driver export.

Parameters
string$keyKey of driver
Returns
string Description

Definition at line 198 of file modules_export.php.

◆ getDriverExtension()

ModeleExports::getDriverExtension ( )

getDriverExtension

Returns
string

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 327 of file modules_export.php.

References dol_syslog().

◆ getDriverLabel()

ModeleExports::getDriverLabel ( )

getDriverLabel

Returns
string Return driver label

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 262 of file modules_export.php.

References dol_syslog().

◆ getDriverLabelForKey()

ModeleExports::getDriverLabelForKey ( $key)

Return label of driver export.

Parameters
string$keyKey of driver
Returns
string Label

Definition at line 187 of file modules_export.php.

◆ getDriverVersion()

ModeleExports::getDriverVersion ( )

getDriverVersion

Returns
string

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 288 of file modules_export.php.

References dol_syslog().

◆ getDriverVersionForKey()

ModeleExports::getDriverVersionForKey ( $key)

Renvoi version d'un driver export.

Parameters
string$keyKey of driver
Returns
string Driver version

Definition at line 209 of file modules_export.php.

◆ getLibLabel()

ModeleExports::getLibLabel ( )

getLibLabel

Returns
string

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 301 of file modules_export.php.

References dol_syslog().

◆ getLibLabelForKey()

ModeleExports::getLibLabelForKey ( $key)

Renvoi label of driver lib.

Parameters
string$keyKey of driver
Returns
string Label of library

Definition at line 220 of file modules_export.php.

◆ getLibVersion()

ModeleExports::getLibVersion ( )

getLibVersion

Returns
string

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 314 of file modules_export.php.

References dol_syslog().

◆ getLibVersionForKey()

ModeleExports::getLibVersionForKey ( $key)

Return version of driver lib.

Parameters
string$keyKey of driver
Returns
string Version of library

Definition at line 231 of file modules_export.php.

◆ getPictoForKey()

ModeleExports::getPictoForKey ( $key)

Return picto of export driver.

Parameters
string$keyKey of driver
Returns
string Picto string

Definition at line 176 of file modules_export.php.

◆ listOfAvailableExportFormat()

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

Load into memory list of available export format.

Parameters
DoliDB$dbDatabase handler
integer$maxfilenamelengthMax length of value to show
Returns
string[] List of templates (same content as array this->driverlabel)

Definition at line 111 of file modules_export.php.

References dol_syslog().

◆ open_file()

ModeleExports::open_file ( $file,
$outputlangs )

Open output file.

Parameters
string$fileFile name to generate
Translate$outputlangsOutput language object
Returns
int Return integer <0 if KO, >=0 if OK

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 343 of file modules_export.php.

References dol_syslog().

◆ write_footer()

ModeleExports::write_footer ( $outputlangs)

Write footer.

Parameters
Translate$outputlangsOutput language object
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 394 of file modules_export.php.

References dol_syslog().

◆ write_header()

ModeleExports::write_header ( $outputlangs)

Write header.

Parameters
Translate$outputlangsObject lang to translate values
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented in ExportCsv, ExportExcel2007, and ExportTsv.

Definition at line 359 of file modules_export.php.

References dol_syslog().

◆ write_record()

ModeleExports::write_record ( $array_selected_sorted,
$objp,
$outputlangs,
$array_types )

Output record line into file.

Parameters
array<string,string>$array_selected_sorted Array with list of field to export
Resource$objpA record from a fetch with all fields from select
Translate$outputlangsObject lang to translate values
array<string,string>$array_types Array with types of fields
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented in ExportCsv, ExportCsvIso, ExportCsvUtf8, ExportExcel2007, and ExportTsv.

Definition at line 247 of file modules_export.php.

References dol_syslog().

◆ write_title()

ModeleExports::write_title ( $array_export_fields_label,
$array_selected_sorted,
$outputlangs,
$array_types )

Output title line into file.

Parameters
array<string,string>$array_export_fields_label Array with list of label of fields
array<string,string>$array_selected_sorted Array with list of field to export
Translate$outputlangsObject lang to translate values
array<string,string>$array_types Array with types of fields
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented in ExportCsv, ExportCsvIso, ExportCsvUtf8, ExportExcel2007, and ExportTsv.

Definition at line 378 of file modules_export.php.

References dol_syslog().


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