dolibarr  20.0.0-alpha
Public Member Functions | List of all members
ExportTsv Class Reference

Class to build export files with format TSV. More...

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getDriverId ()
 getDriverId More...
 
 getDriverLabel ()
 getDriverLabel More...
 
 getDriverDesc ()
 getDriverDesc More...
 
 getDriverExtension ()
 getDriverExtension More...
 
 getDriverVersion ()
 getDriverVersion More...
 
 getLibLabel ()
 getLibLabel More...
 
 getLibVersion ()
 getLibVersion More...
 
 open_file ($file, $outputlangs)
 Open output file. More...
 
 write_header ($outputlangs)
 Output header into file. More...
 
 write_title ($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
 Output title line into file. More...
 
 write_record ($array_selected_sorted, $objp, $outputlangs, $array_types)
 Output record line into file. More...
 
 write_footer ($outputlangs)
 Output footer into file. More...
 
 close_file ()
 Close file handle. More...
 
 tsv_clean ($newvalue, $charset)
 Clean a cell to respect rules of TSV file cells. More...
 
- Public Member Functions inherited from ModeleExports
 listOfAvailableExportFormat ($db, $maxfilenamelength=0)
 Load into memory list of available export format. More...
 
 getPictoForKey ($key)
 Return picto of export driver. More...
 
 getDriverLabelForKey ($key)
 Return label of driver export. More...
 
 getDriverDescForKey ($key)
 Renvoi le descriptif d'un driver export. More...
 
 getDriverVersionForKey ($key)
 Renvoi version d'un driver export. More...
 
 getLibLabelForKey ($key)
 Renvoi label of driver lib. More...
 
 getLibVersionForKey ($key)
 Return version of driver lib. More...
 
- Public Member Functions inherited from CommonDocGenerator
 get_substitutionarray_user ($user, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 getSubstitutionarrayMember ($member, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_mysoc ($mysoc, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company')
 Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}. More...
 
 get_substitutionarray_contact ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_other ($outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...
 
 get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...
 
 get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
 Define array with couple substitution key => substitution value. More...
 
 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. More...
 
 printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
 Rect pdf. More...
 
 columnSort ($a, $b)
 uasort callback function to Sort columns fields More...
 
 prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Prepare Array Column Field. More...
 
 getColumnContentWidth ($colKey)
 get column content width from column key More...
 
 getColumnContentXStart ($colKey)
 get column content X (abscissa) left position from column key More...
 
 getColumnRank ($colKey)
 get column position rank from column key More...
 
 insertNewColumnDef ($newColKey, $defArray, $targetCol='', $insertAfterTarget=false)
 get column position rank from column key More...
 
 printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
 print standard column content More...
 
 printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
 print description column content More...
 
 getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null)
 get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block More...
 
 getColumnStatus ($colKey)
 get column status from column key More...
 
 pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0)
 Print standard column content. More...
 
 defineColumnExtrafield ($object, $outputlangs, $hidedetails=0)
 Define Array Column Field for extrafields. More...
 
 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. More...
 

Detailed Description

Class to build export files with format TSV.

Definition at line 31 of file export_tsv.modules.php.

Constructor & Destructor Documentation

◆ __construct()

ExportTsv::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 65 of file export_tsv.modules.php.

Member Function Documentation

◆ close_file()

ExportTsv::close_file ( )

Close file handle.

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

Definition at line 305 of file export_tsv.modules.php.

◆ getDriverDesc()

ExportTsv::getDriverDesc ( )

getDriverDesc

Returns
string

Definition at line 107 of file export_tsv.modules.php.

◆ getDriverExtension()

ExportTsv::getDriverExtension ( )

getDriverExtension

Returns
string

Definition at line 117 of file export_tsv.modules.php.

◆ getDriverId()

ExportTsv::getDriverId ( )

getDriverId

Returns
string

Definition at line 87 of file export_tsv.modules.php.

◆ getDriverLabel()

ExportTsv::getDriverLabel ( )

getDriverLabel

Returns
string Return driver label

Definition at line 97 of file export_tsv.modules.php.

◆ getDriverVersion()

ExportTsv::getDriverVersion ( )

getDriverVersion

Returns
string

Definition at line 127 of file export_tsv.modules.php.

◆ getLibLabel()

ExportTsv::getLibLabel ( )

getLibLabel

Returns
string

Definition at line 137 of file export_tsv.modules.php.

◆ getLibVersion()

ExportTsv::getLibVersion ( )

getLibVersion

Returns
string

Definition at line 147 of file export_tsv.modules.php.

◆ open_file()

ExportTsv::open_file (   $file,
  $outputlangs 
)

Open output file.

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

Definition at line 161 of file export_tsv.modules.php.

◆ tsv_clean()

ExportTsv::tsv_clean (   $newvalue,
  $charset 
)

Clean a cell to respect rules of TSV file cells.

Parameters
string$newvalueString to clean
string$charsetInput AND Output character set
Returns
string Value cleaned

Definition at line 320 of file export_tsv.modules.php.

◆ write_footer()

ExportTsv::write_footer (   $outputlangs)

Output footer into file.

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

Definition at line 293 of file export_tsv.modules.php.

◆ write_header()

ExportTsv::write_header (   $outputlangs)

Output header into file.

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

Definition at line 188 of file export_tsv.modules.php.

◆ write_record()

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

Output record line into file.

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

Definition at line 238 of file export_tsv.modules.php.

◆ write_title()

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

Output title line into file.

Parameters
array$array_export_fields_labelArray with list of label of fields
array$array_selected_sortedArray with list of field to export
Translate$outputlangsObject lang to translate values
array$array_typesArray with types of fields
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 205 of file export_tsv.modules.php.


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