importSingleDocument Class Reference

Collaboration diagram for importSingleDocument:

Public Member Functions
	__construct ()
	analyzeOnly ($analyze)
	setPolicy ($policy)
	setPreValues (array $preValues)
	setVerifyAttributeAccess ($verifyAttributeAccess)
	setTargetDirectory ($dirid)
	setTargetDirectories (array $dirid)
	setFilePath ($path)
	setOrder (array $order)
	setKey (array $keys)
	getError ()
	getImportResult ()
	hasError ()
	import (array $data)
	importHtmltextFiles ($matches)
	setKnownLogicalNames ($knownLogicalNames=array())

Data Fields
	$dbaccess = ''
	$famId
	$specId
	$folderId

Protected Member Functions
	inhibitInvisibleAttributes (Doc $doc)
	getUnknownDocIdLogicalNames (Doc &$doc, NormalAttribute &$oattr, $value)

Protected Attributes
	$dirid = 0
	$analyze = false
	$importFilePath = ''
	$policy = 'add'
	$orders = array()
	$preValues = array()
	$verifyAttributeAccess = true
	$folderIds = array()
	$keys
	$tcr = array()
	$error = array()

Detailed Description

Definition at line 18 of file Class.ImportSingleDocument.php.

Constructor & Destructor Documentation

__construct

(

)

Definition at line 63 of file Class.ImportSingleDocument.php.

Here is the call graph for this function:

Member Function Documentation

analyzeOnly

(

$analyze

)

Definition at line 69 of file Class.ImportSingleDocument.php.

getError

(

)

Definition at line 119 of file Class.ImportSingleDocument.php.

getImportResult

(

)

Definition at line 124 of file Class.ImportSingleDocument.php.

getUnknownDocIdLogicalNames ( Doc &  $doc, NormalAttribute &  $oattr,   $value  )

protected

Parse a docid's raw value (single or multiple) for unknown logical names

Parameters

Doc	$doc
NormalAttribute	$oattr
string	$value	docid's raw value

Returns

array List of unknown logical names referenced by the value

Definition at line 682 of file Class.ImportSingleDocument.php.

Here is the call graph for this function:

hasError

(

)

Returns

bool

Definition at line 131 of file Class.ImportSingleDocument.php.

import

(

array

$data

)

import a single document from $data import line beginning with DOC

Parameters

array

$data

Returns

importSingleDocument

Check for unknown logical names in docid's raw value

Definition at line 162 of file Class.ImportSingleDocument.php.

Here is the call graph for this function:

importHtmltextFiles

(

$matches

)

Definition at line 623 of file Class.ImportSingleDocument.php.

Here is the call graph for this function:

inhibitInvisibleAttributes ( Doc  $doc )

protected

Definition at line 613 of file Class.ImportSingleDocument.php.

Here is the call graph for this function:

setFilePath

(

$path

)

Definition at line 103 of file Class.ImportSingleDocument.php.

setKey

(

array

$keys

)

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

setKnownLogicalNames

(

$knownLogicalNames = array()

)

Set the list of known logical names to check for unknown logical names

Parameters

array

$knownLogicalNames

List of known logical names

Returns

array|bool Return the previous list of known logical names or bool(false) if the given list is not an array

Definition at line 710 of file Class.ImportSingleDocument.php.

setOrder

(

array

$order

)

Definition at line 108 of file Class.ImportSingleDocument.php.

setPolicy

(

$policy

)

Definition at line 74 of file Class.ImportSingleDocument.php.

setPreValues

(

array

$preValues

)

Definition at line 79 of file Class.ImportSingleDocument.php.

setTargetDirectories

(

array

$dirid

)

identify where to insert document

Parameters

array

$dirid

folder identifier

Definition at line 99 of file Class.ImportSingleDocument.php.

setTargetDirectory

(

$dirid

)

Definition at line 90 of file Class.ImportSingleDocument.php.

setVerifyAttributeAccess

(

$verifyAttributeAccess

)

Parameters

boolean

$verifyAttributeAccess

Definition at line 86 of file Class.ImportSingleDocument.php.

Field Documentation

$analyze = false

protected

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

$dbaccess = ''

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

$dirid = 0

protected

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

$error = array()

protected

Definition at line 40 of file Class.ImportSingleDocument.php.

$famId

Definition at line 45 of file Class.ImportSingleDocument.php.

$folderId

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

$folderIds = array()

protected

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

$importFilePath = ''

protected

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

$keys

protected

Initial value:

= array(
        'title',
        null
    )

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

$orders = array()

protected

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

$policy = 'add'

protected

Definition at line 24 of file Class.ImportSingleDocument.php.

$preValues = array()

protected

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

$specId

Definition at line 49 of file Class.ImportSingleDocument.php.

$tcr = array()

protected

Definition at line 39 of file Class.ImportSingleDocument.php.

$verifyAttributeAccess = true

protected

Definition at line 30 of file Class.ImportSingleDocument.php.

---

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

• Class.ImportSingleDocument.php