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.
	printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
	Print a rounded rectangle on the PDF.
	getMaxAfterColsLinePositionsData ()
	Get position in PDF after col display.
	resetAfterColsLinePositionsData (float $y, int $pageNumb)
	Used for reset afterColsLinePositions var in start of a new pdf draw line loop.
	setAfterColsLinePositionsData (string $colId, float $y, int $pageNumb)
	Used for to set afterColsLinePositions var in a pdf draw line loop.
	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 34 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 78 of file export_tsv.modules.php.

References $conf.

Member Function Documentation

close_file()

ExportTsv::close_file

(

)

Close file handle.

Returns

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

Reimplemented from ModeleExports.

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

getDriverDesc()

ExportTsv::getDriverDesc

(

)

getDriverDesc

Returns

string

Reimplemented from ModeleExports.

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

getDriverExtension()

ExportTsv::getDriverExtension

(

)

getDriverExtension

Returns

string

Reimplemented from ModeleExports.

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

getDriverId()

ExportTsv::getDriverId

(

)

getDriverId

Returns

string

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

getDriverLabel()

ExportTsv::getDriverLabel

(

)

getDriverLabel

Returns

string Return driver label

Reimplemented from ModeleExports.

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

getDriverVersion()

ExportTsv::getDriverVersion

(

)

getDriverVersion

Returns

string

Reimplemented from ModeleExports.

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

getLibLabel()

ExportTsv::getLibLabel

(

)

getLibLabel

Returns

string

Reimplemented from ModeleExports.

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

getLibVersion()

ExportTsv::getLibVersion

(

)

getLibVersion

Returns

string

Reimplemented from ModeleExports.

Definition at line 160 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

Reimplemented from ModeleExports.

Definition at line 174 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 350 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

Reimplemented from ModeleExports.

Definition at line 323 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

Reimplemented from ModeleExports.

Definition at line 201 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<string,string>	$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<string,string>	$array_types Array with types of fields

Returns

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

Reimplemented from ModeleExports.

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

References dol_syslog(), getDolGlobalString(), 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<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	$outputlangs	Object 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 from ModeleExports.

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

References dol_syslog(), getDolGlobalString(), and tsv_clean().

---

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

• dolibarr_dev/htdocs/core/modules/export/export_tsv.modules.php