ImportDocument Class Reference

Collaboration diagram for ImportDocument:

Public Member Functions
	setStrict ($strict)
	setPolicy ($policy)
	setReset ($reset)
	setCsvOptions ($csvSeparator= ';', $csvEnclosure= '"', $csvLinebreak = '\n')
	setTargetDirectory ($dirid)
	importDocuments (Action &$action, $file, $onlyAnalyze=false, $archive=false)
	setVerifyAttributeAccess ($verifyAttributeAccess)
	importSingleFile ($file)
	getErrorMessage ()
	writeHTMLImportLog ($log)
	writeHtmlCr (Layout &$lay)
	writeImportLog ($log)

Static Public Member Functions
static	isdoc ($var)
static	isprof ($var)

Protected Attributes
	$fileName = ''
	$csvSeparator = ';'
	$csvEnclosure = ''
	$csvLinebreak = '\n'
	$policy = "update"
	$verifyAttributeAccess = true
	$reset = array()

Detailed Description

Definition at line 7 of file Class.importDocument.php.

Member Function Documentation

getErrorMessage

(

)

return all error message concatenated

Returns

string

Definition at line 198 of file Class.importDocument.php.

importDocuments	(	Action &	$action,
			$file,
			$onlyAnalyze = false,
			$archive = false
	)

Parameters

Action	$action	current action
string	$file	filename path to import
bool	$onlyAnalyze	if true only analyze not import really
bool	$archive	if true to import file like an standard archive

Returns

array analyze report

Definition at line 89 of file Class.importDocument.php.

Here is the call graph for this function:

importSingleFile

(

$file

)

Definition at line 183 of file Class.importDocument.php.

static isdoc (   $var )

static

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

static isprof (   $var )

static

Definition at line 345 of file Class.importDocument.php.

setCsvOptions	(		$csvSeparator = ';',
			$csvEnclosure = '"',
			$csvLinebreak = '\n'
	)

Definition at line 71 of file Class.importDocument.php.

setPolicy

(

$policy

)

Definition at line 58 of file Class.importDocument.php.

setReset

(

$reset

)

Definition at line 62 of file Class.importDocument.php.

setStrict

(

$strict

)

set strict mode

Parameters

bool

$strict

set to false to accept error when import

Returns

void

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

setTargetDirectory

(

$dirid

)

Definition at line 78 of file Class.importDocument.php.

setVerifyAttributeAccess

(

$verifyAttributeAccess

)

Parameters

boolean

$verifyAttributeAccess

Definition at line 179 of file Class.importDocument.php.

writeHtmlCr

(

Layout &

$lay

)

internal method use only from freedom_import

Parameters

Layout

$lay

Returns

void

Definition at line 235 of file Class.importDocument.php.

Here is the call graph for this function:

writeHTMLImportLog

(

$log

)

write report in file

Parameters

string

$log

filename path to write in

Returns

void

Definition at line 215 of file Class.importDocument.php.

Here is the call graph for this function:

writeImportLog

(

$log

)

record a log file from import results

Parameters

string

$log

output file path

Definition at line 303 of file Class.importDocument.php.

Here is the call graph for this function:

Field Documentation

$csvEnclosure = ''

protected

Definition at line 33 of file Class.importDocument.php.

$csvLinebreak = '\n'

protected

Definition at line 37 of file Class.importDocument.php.

$csvSeparator = ';'

protected

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

$fileName = ''

protected

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

$policy = "update"

protected

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

$reset = array()

protected

Definition at line 48 of file Class.importDocument.php.

$verifyAttributeAccess = true

protected

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

---

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

• Class.importDocument.php