Core  3.2
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
importDocumentDescription Class Reference
+ Collaboration diagram for importDocumentDescription:

Public Member Functions

 __construct ($importFile)
 
 setVerifyAttributeAccess ($verifyAttributeAccess)
 
 analyzeOnly ($analyze)
 
 setPolicy ($policy)
 
 setImportDirectory ($dirid)
 
 reinitAttribute ($reinit)
 
 reset ($reset)
 
 setComma ($comma)
 
 setCsvOptions ($csvSeparator= ';', $csvEnclosure= '"', $csvLinebreak = '\n')
 
 import ()
 
 getImportedAttribute ($famId, $attrId)
 

Static Public Member Functions

static detectAutoCsvOptions ($csvFileName, &$separator= 'auto', &$enclosure= 'auto')
 
static recordEnum ($famid, $attrid, $phpfunc, $reset=false)
 

Data Fields

const attributePrefix = ":ATTR:"
 
const documentPrefix = ":DOC:"
 

Protected Member Functions

 setAutoCsvOptions ()
 
 doATag (array $data)
 
 doBegin (array $data)
 
 doEnd (array $data)
 
 cleanStructure ()
 
 cleanDefaultAndParametersValues ()
 
 doReset (array $data)
 
 doDoc (array $data)
 
 doSearch (array $data)
 
 doDocIcon (array $data)
 
 doDocAtag (array $data)
 
 doIcon (array $data)
 
 doDfldid (array $data)
 
 doCfldid (array $data)
 
 doWid (array $data)
 
 doCvid (array $data)
 
 doClass (array $data)
 
 doMethod (array $data)
 
 doCprofid (array $data)
 
 doProfid (array $data)
 
 doInitial (array $data)
 
 doDefault (array $data)
 
 doAccess (array $data)
 
 doTagable (array $data)
 
 doProfil (array $data)
 
 getProfilUid ($defaultReferenceType, $reference)
 
 getUserId ($login)
 
 doKeys (array $data)
 
 doOrder (array $data)
 
 doLdapmap (array $data)
 
 isTypeCompatible ($curType, $newType)
 
 doAttr (array $data)
 
 doIattr (array $data)
 
 doProp ($data)
 
 addImportedAttribute ($famId, DocAttr &$oa)
 

Detailed Description

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

Constructor & Destructor Documentation

__construct (   $importFile)
Parameters
string$importFile
Exceptions
Dcp\Exception

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

+ Here is the call graph for this function:

Member Function Documentation

addImportedAttribute (   $famId,
DocAttr $oa 
)
protected

Definition at line 2021 of file Class.ImportDescription.php.

analyzeOnly (   $analyze)

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

cleanDefaultAndParametersValues ( )
protected

Definition at line 699 of file Class.ImportDescription.php.

cleanStructure ( )
protected

Delete undeclared sql columns

Definition at line 678 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

static detectAutoCsvOptions (   $csvFileName,
$separator = 'auto',
$enclosure = 'auto' 
)
static

Detect csv options - separator and enclosure arguments are modified if set to auto

Parameters
$csvFileName
string&$separatorneed to set to 'auto' to detect
string&$enclosureneed to set to 'auto' to detect
Returns
array associaive array "enclosure", "separator" keys
Exceptions
Dcp\Exception

Definition at line 163 of file Class.ImportDescription.php.

doAccess ( array  $data)
protected

analyze ACCESS

Parameters
array$dataline of description file

Definition at line 1374 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doATag ( array  $data)
protected

add application tag

Parameters
array$data

Definition at line 473 of file Class.ImportDescription.php.

doAttr ( array  $data)
protected

analyze IATTR

Parameters
array$dataline of description file

Definition at line 1760 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doBegin ( array  $data)
protected

analyze BEGIN

Parameters
array$dataline of description file

Definition at line 487 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doCfldid ( array  $data)
protected

analyze CFLDID

Parameters
array$dataline of description file

Definition at line 1065 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doClass ( array  $data)
protected

analyze CLASS

Parameters
array$dataline of description file

Definition at line 1176 of file Class.ImportDescription.php.

doCprofid ( array  $data)
protected

analyze CPROFID

Parameters
array$dataline of description file

Definition at line 1247 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doCvid ( array  $data)
protected

analyze CVID

Parameters
array$dataline of description file

Definition at line 1134 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doDefault ( array  $data)
protected

analyze DEFAULT

Parameters
array$dataline of description file

Definition at line 1334 of file Class.ImportDescription.php.

doDfldid ( array  $data)
protected

analyze DFLDID

Parameters
array$dataline of description file

Definition at line 1028 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doDoc ( array  $data)
protected

analyze DOC

Parameters
array$dataline of description file

Append current document's logical name to list of known logical names and configure the importer to use this list to check for unknown logical names

Definition at line 797 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doDocAtag ( array  $data)
protected

analyze DOCATAG

Parameters
array$dataline of description file

Definition at line 947 of file Class.ImportDescription.php.

doDocIcon ( array  $data)
protected

analyze DOCICON

Parameters
array$dataline of description file

Definition at line 933 of file Class.ImportDescription.php.

doEnd ( array  $data)
protected

analyze END

Parameters
array$dataline of description file

Definition at line 571 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doIattr ( array  $data)
protected

analyze IATTR

Parameters
array$dataline of description file

Definition at line 1921 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doIcon ( array  $data)
protected

analyze ICON

Parameters
array$dataline of description file

Definition at line 1013 of file Class.ImportDescription.php.

doInitial ( array  $data)
protected

analyze INITIAL

Parameters
array$dataline of description file

Definition at line 1295 of file Class.ImportDescription.php.

doKeys ( array  $data)
protected

analyze KEYS

Parameters
array$dataline of description file

Definition at line 1640 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doLdapmap ( array  $data)
protected

analyze LDAPMAP

Parameters
array$dataline of description file

Definition at line 1699 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doMethod ( array  $data)
protected

analyze METHOD

Parameters
array$dataline of description file

Definition at line 1197 of file Class.ImportDescription.php.

doOrder ( array  $data)
protected

analyze ORDER

Parameters
array$dataline of description file

Definition at line 1669 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doProfid ( array  $data)
protected

analyze PROFID

Parameters
array$dataline of description file

Definition at line 1271 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doProfil ( array  $data)
protected

analyze PROFIL

Parameters
array$dataline of description file

Definition at line 1488 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doProp (   $data)
protected

analyze PROP

Parameters
array$dataline of description file

Definition at line 1990 of file Class.ImportDescription.php.

doReset ( array  $data)
protected

analyze RESET²

Parameters
array$dataline of description file

Definition at line 723 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doSearch ( array  $data)
protected

analyze SEARCH

Parameters
array$dataline of description file

Definition at line 871 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doTagable ( array  $data)
protected

analyze TAGABLE

Parameters
array$datatagable parameter

PhpUndefinedClassInspection Defined in dynacase-tags module

Definition at line 1452 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

doWid ( array  $data)
protected

analyze WID

Parameters
array$dataline of description file

Definition at line 1089 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

getImportedAttribute (   $famId,
  $attrId 
)

Definition at line 2028 of file Class.ImportDescription.php.

getProfilUid (   $defaultReferenceType,
  $reference 
)
protected

Definition at line 1584 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

getUserId (   $login)
protected

Definition at line 1624 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

import ( )

Definition at line 206 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

isTypeCompatible (   $curType,
  $newType 
)
protected

Verify compatibility between 2 type

Parameters
string$curType
string$newType
Returns
bool

Definition at line 1740 of file Class.ImportDescription.php.

static recordEnum (   $famid,
  $attrid,
  $phpfunc,
  $reset = false 
)
static
Parameters
int$famidfamily identifier
string$attridattribute identifier
string$phpfuncenum flat description
bool$resetset to true to delete old items before recorded
Returns
string error message

Definition at line 1875 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

reinitAttribute (   $reinit)

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

reset (   $reset)

Definition at line 127 of file Class.ImportDescription.php.

setAutoCsvOptions ( )
protected

Definition at line 192 of file Class.ImportDescription.php.

+ Here is the call graph for this function:

setComma (   $comma)

Definition at line 137 of file Class.ImportDescription.php.

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

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

+ Here is the call graph for this function:

setImportDirectory (   $dirid)

Definition at line 117 of file Class.ImportDescription.php.

setPolicy (   $policy)

Definition at line 109 of file Class.ImportDescription.php.

setVerifyAttributeAccess (   $verifyAttributeAccess)
Parameters
boolean$verifyAttributeAccess

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

Field Documentation

const attributePrefix = ":ATTR:"

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

const documentPrefix = ":DOC:"

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


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