ExportCsv Class Reference

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

Inheritance diagram for ExportCsv:

Collaboration diagram for ExportCsv:

Public Member Functions
	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.
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
	__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.
	printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
	Print a rounded rectangle on the 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 CSV.

Definition at line 33 of file exportcsv.class.php.

Member Function Documentation

close_file()

ExportCsv::close_file

(

)

Close file handle.

Returns

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

Reimplemented from ModeleExports.

Definition at line 317 of file exportcsv.class.php.

getDriverDesc()

ExportCsv::getDriverDesc

(

)

getDriverDesc

Returns

string

Reimplemented from ModeleExports.

Definition at line 96 of file exportcsv.class.php.

getDriverExtension()

ExportCsv::getDriverExtension

(

)

getDriverExtension

Returns

string

Reimplemented from ModeleExports.

Definition at line 106 of file exportcsv.class.php.

getDriverId()

ExportCsv::getDriverId

(

)

getDriverId

Returns

string

Definition at line 76 of file exportcsv.class.php.

getDriverLabel()

ExportCsv::getDriverLabel

(

)

getDriverLabel

Returns

string Return driver label

Reimplemented from ModeleExports.

Definition at line 86 of file exportcsv.class.php.

getDriverVersion()

ExportCsv::getDriverVersion

(

)

getDriverVersion

Returns

string

Reimplemented from ModeleExports.

Definition at line 116 of file exportcsv.class.php.

getLibLabel()

ExportCsv::getLibLabel

(

)

getLibLabel

Returns

string

Reimplemented from ModeleExports.

Definition at line 126 of file exportcsv.class.php.

getLibVersion()

ExportCsv::getLibVersion

(

)

getLibVersion

Returns

string

Reimplemented from ModeleExports.

Definition at line 136 of file exportcsv.class.php.

open_file()

ExportCsv::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 150 of file exportcsv.class.php.

References dol_syslog().

write_footer()

ExportCsv::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 305 of file exportcsv.class.php.

write_header()

ExportCsv::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 177 of file exportcsv.class.php.

write_record()

ExportCsv::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.

Reimplemented in ExportCsvIso, and ExportCsvUtf8.

Definition at line 243 of file exportcsv.class.php.

References csvClean(), dol_syslog(), getDolGlobalString(), and jsonOrUnserialize().

write_title()

ExportCsv::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.

Reimplemented in ExportCsvIso, and ExportCsvUtf8.

Definition at line 194 of file exportcsv.class.php.

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

---

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

• dolibarr_dev/htdocs/core/modules/export/exportcsv.class.php