ExportTsv Class Reference

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

Inheritance diagram for ExportTsv:

Collaboration diagram for ExportTsv:

Public Member Functions
	__construct ($db)
	Constructor.
	getDriverId ()
	getDriverId
	getDriverLabel ()
	getDriverLabel
	getDriverDesc ()
	getDriverDesc
	getDriverExtension ()
	getDriverExtension
	getDriverVersion ()
	getDriverVersion
	getLibLabel ()
	getLibLabel
	getLibVersion ()
	getLibVersion
	open_file ($file, $outputlangs)
	Open output file.
	write_header ($outputlangs)
	Output header into file.
	write_title ($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
	Output title line into file.
	write_record ($array_selected_sorted, $objp, $outputlangs, $array_types)
	Output record line into file.
	write_footer ($outputlangs)
	Output footer into file.
	close_file ()
	Close file handle.
	tsv_clean ($newvalue, $charset)
	Clean a cell to respect rules of TSV file cells.
Public Member Functions inherited from ModeleExports
	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
	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

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

$db

Database 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	$file	Path of filename to generate
Translate	$outputlangs	Output language object

Returns

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

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

References dol_syslog().

tsv_clean()

ExportTsv::tsv_clean	(		$newvalue,
			$charset )

Clean a cell to respect rules of TSV file cells.

Parameters

string	$newvalue	String to clean
string	$charset	Input AND Output character set

Returns

string Value cleaned

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

References dol_string_nohtmltag().

Referenced by write_record(), and write_title().

write_footer()

ExportTsv::write_footer

(

$outputlangs

)

Output footer into file.

Parameters

Translate

$outputlangs

Output 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

$outputlangs

Output 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_sorted	Array with list of field to export
Resource	$objp	A record from a fetch with all fields from select
Translate	$outputlangs	Object lang to translate values
array	$array_types	Array with types of fields

Returns

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

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

References dol_print_error(), jsonOrUnserialize(), and tsv_clean().

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_label	Array with list of label of fields
array	$array_selected_sorted	Array with list of field to export
Translate	$outputlangs	Object lang to translate values
array	$array_types	Array with types of fields

Returns

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

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

References tsv_clean().

---

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

• dolibarr_20.0/htdocs/core/modules/export/export_tsv.modules.php