Fossology\Lib\Application\ObligationCsvExport Class Reference

Helper class to export obligations as a CSV. More...

Collaboration diagram for Fossology\Lib\Application\ObligationCsvExport:

Public Member Functions
	__construct (DbManager $dbManager)
	setDelimiter ($delimiter=',')
	Update the delimiter. More...
	setEnclosure ($enclosure='"')
	Update the enclosure. More...
	createCsv ($ob=0, $generateJson=false)
	Create CSV from the obligations. More...

Protected Attributes
	$dbManager
	$delimiter = ','
	$enclosure = '"'

Detailed Description

Helper class to export obligations as a CSV.

Definition at line 21 of file ObligationCsvExport.php.

Constructor & Destructor Documentation

__construct()

Fossology\Lib\Application\ObligationCsvExport::__construct

(

DbManager

$dbManager

)

Constructor

Parameters

DbManager

$dbManager

DbManager to be used.

Definition at line 37 of file ObligationCsvExport.php.

Member Function Documentation

createCsv()

Fossology\Lib\Application\ObligationCsvExport::createCsv	(		$ob = 0,
			$generateJson = false
	)

Create CSV from the obligations.

Parameters

int

$ob

Obligation id to be returned, else set 0 to get all.

Returns

string CSV

Definition at line 66 of file ObligationCsvExport.php.

setDelimiter()

Fossology\Lib\Application\ObligationCsvExport::setDelimiter

(

$delimiter = ','

)

Update the delimiter.

Parameters

string

$delimiter

New delimiter to use.

Definition at line 47 of file ObligationCsvExport.php.

setEnclosure()

Fossology\Lib\Application\ObligationCsvExport::setEnclosure

(

$enclosure = '"'

)

Update the enclosure.

Parameters

string

$enclosure

New enclosure to use.

Definition at line 56 of file ObligationCsvExport.php.

Member Data Documentation

$dbManager

DbManager Fossology\Lib\Application\ObligationCsvExport::$dbManager

protected

DB manager to be used

Definition at line 25 of file ObligationCsvExport.php.

$delimiter

string Fossology\Lib\Application\ObligationCsvExport::$delimiter = ','

protected

Delimiter used in the CSV

Definition at line 28 of file ObligationCsvExport.php.

$enclosure

string Fossology\Lib\Application\ObligationCsvExport::$enclosure = '"'

protected

Ecnlosure used in the CSV

Definition at line 31 of file ObligationCsvExport.php.

---

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

• src/lib/php/Application/ObligationCsvExport.php