exportXmlFolder Class Reference

Collaboration diagram for exportXmlFolder:

Public Member Functions
	__construct ()
	setOutputFormat ($xy)
	useIdentificator ($exportIdentificator=true)
	getOutputFile ()
	getXmlContent ()
	exportFromSearch (SearchDoc &$search, $outputFile= '')
	exportFromFolder ($folderId, $outputFile= '')
	exportFromSelection (Fdl_DocumentSelection $selection, $outputFile= '')

Data Fields
const	zipFormat = 'X'
const	xmlFormat = 'Y'

Detailed Description

Definition at line 19 of file Class.exportXmlFolder.php.

Constructor & Destructor Documentation

__construct

(

)

Definition at line 32 of file Class.exportXmlFolder.php.

Here is the call graph for this function:

Member Function Documentation

exportFromFolder	(		$folderId,
			$outputFile = ''
	)

export documents from search object

Parameters

string	$folderId	collection identifier
string	$outputFile	path to output file

Returns

void

Definition at line 110 of file Class.exportXmlFolder.php.

Here is the call graph for this function:

exportFromSearch	(	SearchDoc &	$search,
			$outputFile = ''
	)

export documents from search object

Parameters

SearchDoc	$search	search to export
string	$outputFile	path to output file

Returns

void

Definition at line 98 of file Class.exportXmlFolder.php.

Here is the call graph for this function:

exportFromSelection	(	Fdl_DocumentSelection	$selection,
			$outputFile = ''
	)

export documents from selection object

Parameters

Fdl_DocumentSelection	$selection
string	$outputFile

Definition at line 122 of file Class.exportXmlFolder.php.

Here is the call graph for this function:

getOutputFile

(

)

return exported file name

Returns

string file path

Definition at line 61 of file Class.exportXmlFolder.php.

getXmlContent

(

)

return content of xml file to be use only with xml format

Returns

string

Exceptions

Dcp\Exception

Definition at line 82 of file Class.exportXmlFolder.php.

setOutputFormat

(

$xy

)

export format xml or zip

Parameters

string

$xy

Exceptions

Dcp\Exception

Definition at line 41 of file Class.exportXmlFolder.php.

useIdentificator

(

$exportIdentificator = true

)

export (or not) system document identifier

Parameters

bool

$exportIdentificator

export option

Definition at line 53 of file Class.exportXmlFolder.php.

Field Documentation

const xmlFormat = 'Y'

Definition at line 22 of file Class.exportXmlFolder.php.

const zipFormat = 'X'

Definition at line 21 of file Class.exportXmlFolder.php.

---

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

• Class.exportXmlFolder.php