Core  3.2
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions | Data Fields | Protected Member Functions | Static Protected Member Functions | Protected Attributes
ExportCollection Class Reference
+ Collaboration diagram for ExportCollection:

Public Member Functions

 setVerifyAttributeAccess ($verifyAttributeAccess)
 
 setCvsEnclosure ($cvsEnclosure)
 
 setCollectionDocument (\DocCollection $collectionDocument)
 
 setOutputFilePath ($outputFilePath)
 
 setExportStatusId ($exportStatusId)
 
 setProfileAccountType ($profileAccountType)
 
 getOutputFilePath ()
 
 setCvsSeparator ($cvsSeparator)
 
 setExportDocumentNumericIdentiers ($exportDocumentNumericIdentiers)
 
 setExportFiles ($exportFiles)
 
 setExportProfil ($exportProfil)
 
 setOutputFileEncoding ($outputFileEncding)
 
 setOutputFormat ($outputFormat)
 
 setUseUserColumnParameter ($useUserColumnParameter)
 
 export ()
 
 setDocumentlist (\DocumentList $documentList)
 
 recordStatus ($msg, $endStatus=false)
 

Data Fields

const utf8Encoding = "utf-8"
 
const latinEncoding = "iso8859-15"
 
const csvRawOutputFormat = "I"
 
const csvRawOnlyDataOutputFormat = "R"
 
const csvDisplayValueOutputFormat = "F"
 
const xmlArchiveOutputFormat = "X"
 
const xmlFileOutputFormat = "Y"
 

Protected Member Functions

 addDocumentToExport ($documentId)
 
 csvFamilyExport (\DocFam $family)
 
 writeFamilies ()
 
 zipFiles ($directory, array $infos)
 
 zipXml ($directory)
 
 catXml ($directory)
 

Static Protected Member Functions

static cleanFileName ($fileName)
 

Protected Attributes

 $exportProfil = false
 
 $exportFiles = false
 
 $exportDocumentNumericIdentiers = false
 
 $outputFileEncoding = self::utf8Encoding
 
 $useUserColumnParameter = false
 
 $outputFormat = self::csvRawOutputFormat
 
 $verifyAttributeAccess = false
 
 $cvsSeparator = ";"
 
 $cvsEnclosure = ""
 
 $profileAccountType = ExportDocument::useAclAccountType
 
 $outputFilePath = ''
 
 $exportStatusId = ''
 
 $collectionDocument = null
 
 $documentList = null
 
 $outHandler = null
 
 $moreDocuments = array()
 
 $familyData = array()
 

Detailed Description

Definition at line 8 of file Class.ExportCollection.php.

Member Function Documentation

addDocumentToExport (   $documentId)
protected

Record document relative to family

Parameters
string$documentId

Definition at line 331 of file Class.ExportCollection.php.

catXml (   $directory)
protected

concatenate Xml files included in directory into single XML file

Parameters
string$directory
Exceptions
Exception

Definition at line 622 of file Class.ExportCollection.php.

+ Here is the call graph for this function:

static cleanFileName (   $fileName)
staticprotected

Replace special character for a file name

Parameters
string$fileName
Returns
string

Definition at line 581 of file Class.ExportCollection.php.

csvFamilyExport ( \DocFam  $family)
protected

Record family data which are write by writeFamilies

See Also
ExportCollection::writeFamilies
Parameters
\DocFam$family

Definition at line 340 of file Class.ExportCollection.php.

+ Here is the call graph for this function:

export ( )

Export Document LIst

See Also
ExportCollection::setDocumentlist
Exceptions
Exception

Definition at line 202 of file Class.ExportCollection.php.

getOutputFilePath ( )

Get output file name

See Also
ExportCollection::setOutputFilePath
Returns
string

Definition at line 113 of file Class.ExportCollection.php.

recordStatus (   $msg,
  $endStatus = false 
)

Write message to session var. Used by interfaces to see progress

Parameters
string$msg
bool$endStatus

Definition at line 307 of file Class.ExportCollection.php.

setCollectionDocument ( \DocCollection  $collectionDocument)

Use document collection (folder or searcch) to export documents

See Also
ExportCollection::setDocumentlist
Parameters
\DocCollection$collectionDocument

Definition at line 77 of file Class.ExportCollection.php.

+ Here is the call graph for this function:

setCvsEnclosure (   $cvsEnclosure)
Parameters
string$cvsEnclosure

Definition at line 68 of file Class.ExportCollection.php.

setCvsSeparator (   $cvsSeparator)

Set CSV separator character

Parameters
string$cvsSeparator
Exceptions
Exception

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

setDocumentlist ( \DocumentList  $documentList)

Set documentList to export

Parameters
\DocumentList$documentList

Definition at line 231 of file Class.ExportCollection.php.

setExportDocumentNumericIdentiers (   $exportDocumentNumericIdentiers)

Only in csv, and no profil, export numeric identifier if no logical name Else identifier is not exported

Parameters
boolean$exportDocumentNumericIdentiers

Definition at line 134 of file Class.ExportCollection.php.

setExportFiles (   $exportFiles)

Indicate if export also attached files

Parameters
boolean$exportFiles

Definition at line 142 of file Class.ExportCollection.php.

setExportProfil (   $exportProfil)

Indicate if Profile data must be exported also

Parameters
boolean$exportProfil

Definition at line 150 of file Class.ExportCollection.php.

setExportStatusId (   $exportStatusId)

Set identifier key to write status

See Also
ExportCollection::setStatus
Parameters
string$exportStatusId

Definition at line 96 of file Class.ExportCollection.php.

setOutputFileEncoding (   $outputFileEncding)

Set encoding format default is UTF-8

Parameters
string$outputFileEncding
Exceptions
Exception

Definition at line 159 of file Class.ExportCollection.php.

setOutputFilePath (   $outputFilePath)

File to record result of export (must be writable) The file will be overwrite if exists

Parameters
string$outputFilePath

Definition at line 87 of file Class.ExportCollection.php.

setOutputFormat (   $outputFormat)

Indicate file output format

Parameters
string$outputFormat
Exceptions
Exception

Definition at line 175 of file Class.ExportCollection.php.

setProfileAccountType (   $profileAccountType)

Type of acl reference when export profile

Parameters
string$profileAccountType

Definition at line 104 of file Class.ExportCollection.php.

setUseUserColumnParameter (   $useUserColumnParameter)

Only for csv mode. Set true if need to export only column set by applicative parameter "FREEDOM_EXPORTCOLS"

Parameters
boolean$useUserColumnParameter

Definition at line 193 of file Class.ExportCollection.php.

setVerifyAttributeAccess (   $verifyAttributeAccess)

If true, attribute with "I" visibility are not returned

Parameters
boolean$verifyAttributeAccess

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

writeFamilies ( )
protected

write family data

Definition at line 477 of file Class.ExportCollection.php.

+ Here is the call graph for this function:

zipFiles (   $directory,
array  $infos 
)
protected

Definition at line 509 of file Class.ExportCollection.php.

zipXml (   $directory)
protected

zip Xml files included in directory

Parameters
string$directory
Exceptions
Exception

Definition at line 605 of file Class.ExportCollection.php.

Field Documentation

DocCollection $collectionDocument = null
protected

Definition at line 46 of file Class.ExportCollection.php.

$cvsEnclosure = ""
protected

Definition at line 35 of file Class.ExportCollection.php.

$cvsSeparator = ";"
protected

Definition at line 34 of file Class.ExportCollection.php.

$documentList = null
protected

Definition at line 50 of file Class.ExportCollection.php.

$exportDocumentNumericIdentiers = false
protected

Definition at line 17 of file Class.ExportCollection.php.

$exportFiles = false
protected

Definition at line 15 of file Class.ExportCollection.php.

$exportProfil = false
protected

Definition at line 13 of file Class.ExportCollection.php.

$exportStatusId = ''
protected

Definition at line 42 of file Class.ExportCollection.php.

$familyData = array()
protected

Definition at line 56 of file Class.ExportCollection.php.

$moreDocuments = array()
protected

Definition at line 55 of file Class.ExportCollection.php.

$outHandler = null
protected

Definition at line 54 of file Class.ExportCollection.php.

$outputFileEncoding = self::utf8Encoding
protected

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

$outputFilePath = ''
protected

Definition at line 38 of file Class.ExportCollection.php.

$outputFormat = self::csvRawOutputFormat
protected

Definition at line 31 of file Class.ExportCollection.php.

$profileAccountType = ExportDocument::useAclAccountType
protected

Definition at line 36 of file Class.ExportCollection.php.

$useUserColumnParameter = false
protected

Definition at line 23 of file Class.ExportCollection.php.

$verifyAttributeAccess = false
protected

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

const csvDisplayValueOutputFormat = "F"

Definition at line 27 of file Class.ExportCollection.php.

const csvRawOnlyDataOutputFormat = "R"

Definition at line 26 of file Class.ExportCollection.php.

const csvRawOutputFormat = "I"

Definition at line 25 of file Class.ExportCollection.php.

const latinEncoding = "iso8859-15"

Definition at line 20 of file Class.ExportCollection.php.

const utf8Encoding = "utf-8"

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

const xmlArchiveOutputFormat = "X"

Definition at line 28 of file Class.ExportCollection.php.

const xmlFileOutputFormat = "Y"

Definition at line 29 of file Class.ExportCollection.php.

The documentation for this class was generated from the following file:
← centre documentaire © anakeen